Literals
Index > CognitoIdentityProvider > Literals
Auto-generated documentation for CognitoIdentityProvider type annotations stubs module mypy-boto3-cognito-idp.
AccountTakeoverEventActionTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import AccountTakeoverEventActionTypeType
def get_value() -> AccountTakeoverEventActionTypeType:
return "BLOCK"
Definition
AccountTakeoverEventActionTypeType = Literal[
"BLOCK",
"MFA_IF_CONFIGURED",
"MFA_REQUIRED",
"NO_ACTION",
]
AdminListGroupsForUserPaginatorName
Usage Example
from mypy_boto3_cognito_idp.literals import AdminListGroupsForUserPaginatorName
def get_value() -> AdminListGroupsForUserPaginatorName:
return "admin_list_groups_for_user"
AdminListUserAuthEventsPaginatorName
Usage Example
from mypy_boto3_cognito_idp.literals import AdminListUserAuthEventsPaginatorName
def get_value() -> AdminListUserAuthEventsPaginatorName:
return "admin_list_user_auth_events"
AdvancedSecurityModeTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import AdvancedSecurityModeTypeType
def get_value() -> AdvancedSecurityModeTypeType:
return "AUDIT"
AliasAttributeTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import AliasAttributeTypeType
def get_value() -> AliasAttributeTypeType:
return "email"
AttributeDataTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import AttributeDataTypeType
def get_value() -> AttributeDataTypeType:
return "Boolean"
AuthFlowTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import AuthFlowTypeType
def get_value() -> AuthFlowTypeType:
return "ADMIN_NO_SRP_AUTH"
Definition
AuthFlowTypeType = Literal[
"ADMIN_NO_SRP_AUTH",
"ADMIN_USER_PASSWORD_AUTH",
"CUSTOM_AUTH",
"REFRESH_TOKEN",
"REFRESH_TOKEN_AUTH",
"USER_PASSWORD_AUTH",
"USER_SRP_AUTH",
]
ChallengeNameType
Usage Example
from mypy_boto3_cognito_idp.literals import ChallengeNameType
def get_value() -> ChallengeNameType:
return "Mfa"
ChallengeNameTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import ChallengeNameTypeType
def get_value() -> ChallengeNameTypeType:
return "ADMIN_NO_SRP_AUTH"
Definition
ChallengeNameTypeType = Literal[
"ADMIN_NO_SRP_AUTH",
"CUSTOM_CHALLENGE",
"DEVICE_PASSWORD_VERIFIER",
"DEVICE_SRP_AUTH",
"MFA_SETUP",
"NEW_PASSWORD_REQUIRED",
"PASSWORD_VERIFIER",
"SELECT_MFA_TYPE",
"SMS_MFA",
"SOFTWARE_TOKEN_MFA",
]
ChallengeResponseType
Usage Example
from mypy_boto3_cognito_idp.literals import ChallengeResponseType
def get_value() -> ChallengeResponseType:
return "Failure"
CompromisedCredentialsEventActionTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import CompromisedCredentialsEventActionTypeType
def get_value() -> CompromisedCredentialsEventActionTypeType:
return "BLOCK"
CustomEmailSenderLambdaVersionTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import CustomEmailSenderLambdaVersionTypeType
def get_value() -> CustomEmailSenderLambdaVersionTypeType:
return "V1_0"
CustomSMSSenderLambdaVersionTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import CustomSMSSenderLambdaVersionTypeType
def get_value() -> CustomSMSSenderLambdaVersionTypeType:
return "V1_0"
DefaultEmailOptionTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import DefaultEmailOptionTypeType
def get_value() -> DefaultEmailOptionTypeType:
return "CONFIRM_WITH_CODE"
DeletionProtectionTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import DeletionProtectionTypeType
def get_value() -> DeletionProtectionTypeType:
return "ACTIVE"
DeliveryMediumTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import DeliveryMediumTypeType
def get_value() -> DeliveryMediumTypeType:
return "EMAIL"
DeviceRememberedStatusTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import DeviceRememberedStatusTypeType
def get_value() -> DeviceRememberedStatusTypeType:
return "not_remembered"
DomainStatusTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import DomainStatusTypeType
def get_value() -> DomainStatusTypeType:
return "ACTIVE"
EmailSendingAccountTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import EmailSendingAccountTypeType
def get_value() -> EmailSendingAccountTypeType:
return "COGNITO_DEFAULT"
EventFilterTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import EventFilterTypeType
def get_value() -> EventFilterTypeType:
return "PASSWORD_CHANGE"
EventResponseTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import EventResponseTypeType
def get_value() -> EventResponseTypeType:
return "Fail"
EventTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import EventTypeType
def get_value() -> EventTypeType:
return "ForgotPassword"
Definition
EventTypeType = Literal[
"ForgotPassword",
"PasswordChange",
"ResendCode",
"SignIn",
"SignUp",
]
ExplicitAuthFlowsTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import ExplicitAuthFlowsTypeType
def get_value() -> ExplicitAuthFlowsTypeType:
return "ADMIN_NO_SRP_AUTH"
Definition
ExplicitAuthFlowsTypeType = Literal[
"ADMIN_NO_SRP_AUTH",
"ALLOW_ADMIN_USER_PASSWORD_AUTH",
"ALLOW_CUSTOM_AUTH",
"ALLOW_REFRESH_TOKEN_AUTH",
"ALLOW_USER_PASSWORD_AUTH",
"ALLOW_USER_SRP_AUTH",
"CUSTOM_AUTH_FLOW_ONLY",
"USER_PASSWORD_AUTH",
]
FeedbackValueTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import FeedbackValueTypeType
def get_value() -> FeedbackValueTypeType:
return "Invalid"
IdentityProviderTypeTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import IdentityProviderTypeTypeType
def get_value() -> IdentityProviderTypeTypeType:
return "Facebook"
Definition
IdentityProviderTypeTypeType = Literal[
"Facebook",
"Google",
"LoginWithAmazon",
"OIDC",
"SAML",
"SignInWithApple",
]
ListGroupsPaginatorName
Usage Example
from mypy_boto3_cognito_idp.literals import ListGroupsPaginatorName
def get_value() -> ListGroupsPaginatorName:
return "list_groups"
ListIdentityProvidersPaginatorName
Usage Example
from mypy_boto3_cognito_idp.literals import ListIdentityProvidersPaginatorName
def get_value() -> ListIdentityProvidersPaginatorName:
return "list_identity_providers"
ListResourceServersPaginatorName
Usage Example
from mypy_boto3_cognito_idp.literals import ListResourceServersPaginatorName
def get_value() -> ListResourceServersPaginatorName:
return "list_resource_servers"
ListUserPoolClientsPaginatorName
Usage Example
from mypy_boto3_cognito_idp.literals import ListUserPoolClientsPaginatorName
def get_value() -> ListUserPoolClientsPaginatorName:
return "list_user_pool_clients"
ListUserPoolsPaginatorName
Usage Example
from mypy_boto3_cognito_idp.literals import ListUserPoolsPaginatorName
def get_value() -> ListUserPoolsPaginatorName:
return "list_user_pools"
ListUsersInGroupPaginatorName
Usage Example
from mypy_boto3_cognito_idp.literals import ListUsersInGroupPaginatorName
def get_value() -> ListUsersInGroupPaginatorName:
return "list_users_in_group"
ListUsersPaginatorName
Usage Example
from mypy_boto3_cognito_idp.literals import ListUsersPaginatorName
def get_value() -> ListUsersPaginatorName:
return "list_users"
MessageActionTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import MessageActionTypeType
def get_value() -> MessageActionTypeType:
return "RESEND"
OAuthFlowTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import OAuthFlowTypeType
def get_value() -> OAuthFlowTypeType:
return "client_credentials"
PreventUserExistenceErrorTypesType
Usage Example
from mypy_boto3_cognito_idp.literals import PreventUserExistenceErrorTypesType
def get_value() -> PreventUserExistenceErrorTypesType:
return "ENABLED"
RecoveryOptionNameTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import RecoveryOptionNameTypeType
def get_value() -> RecoveryOptionNameTypeType:
return "admin_only"
Definition
RecoveryOptionNameTypeType = Literal[
"admin_only",
"verified_email",
"verified_phone_number",
]
RiskDecisionTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import RiskDecisionTypeType
def get_value() -> RiskDecisionTypeType:
return "AccountTakeover"
RiskLevelTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import RiskLevelTypeType
def get_value() -> RiskLevelTypeType:
return "High"
StatusTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import StatusTypeType
def get_value() -> StatusTypeType:
return "Disabled"
TimeUnitsTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import TimeUnitsTypeType
def get_value() -> TimeUnitsTypeType:
return "days"
UserImportJobStatusTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import UserImportJobStatusTypeType
def get_value() -> UserImportJobStatusTypeType:
return "Created"
Definition
UserImportJobStatusTypeType = Literal[
"Created",
"Expired",
"Failed",
"InProgress",
"Pending",
"Stopped",
"Stopping",
"Succeeded",
]
UserPoolMfaTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import UserPoolMfaTypeType
def get_value() -> UserPoolMfaTypeType:
return "OFF"
UserStatusTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import UserStatusTypeType
def get_value() -> UserStatusTypeType:
return "ARCHIVED"
Definition
UserStatusTypeType = Literal[
"ARCHIVED",
"COMPROMISED",
"CONFIRMED",
"FORCE_CHANGE_PASSWORD",
"RESET_REQUIRED",
"UNCONFIRMED",
"UNKNOWN",
]
UsernameAttributeTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import UsernameAttributeTypeType
def get_value() -> UsernameAttributeTypeType:
return "email"
VerifiedAttributeTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import VerifiedAttributeTypeType
def get_value() -> VerifiedAttributeTypeType:
return "email"
VerifySoftwareTokenResponseTypeType
Usage Example
from mypy_boto3_cognito_idp.literals import VerifySoftwareTokenResponseTypeType
def get_value() -> VerifySoftwareTokenResponseTypeType:
return "ERROR"
CognitoIdentityProviderServiceName
Usage Example
from mypy_boto3_cognito_idp.literals import CognitoIdentityProviderServiceName
def get_value() -> CognitoIdentityProviderServiceName:
return "cognito-idp"
ServiceName
Usage Example
from mypy_boto3_cognito_idp.literals import ServiceName
def get_value() -> ServiceName:
return "accessanalyzer"
Definition
ServiceName = Literal[
"accessanalyzer",
"account",
"acm",
"acm-pca",
"alexaforbusiness",
"amp",
"amplify",
"amplifybackend",
"amplifyuibuilder",
"apigateway",
"apigatewaymanagementapi",
"apigatewayv2",
"appconfig",
"appconfigdata",
"appflow",
"appintegrations",
"application-autoscaling",
"application-insights",
"applicationcostprofiler",
"appmesh",
"apprunner",
"appstream",
"appsync",
"arc-zonal-shift",
"athena",
"auditmanager",
"autoscaling",
"autoscaling-plans",
"backup",
"backup-gateway",
"backupstorage",
"batch",
"billingconductor",
"braket",
"budgets",
"ce",
"chime",
"chime-sdk-identity",
"chime-sdk-media-pipelines",
"chime-sdk-meetings",
"chime-sdk-messaging",
"chime-sdk-voice",
"cleanrooms",
"cloud9",
"cloudcontrol",
"clouddirectory",
"cloudformation",
"cloudfront",
"cloudhsm",
"cloudhsmv2",
"cloudsearch",
"cloudsearchdomain",
"cloudtrail",
"cloudtrail-data",
"cloudwatch",
"codeartifact",
"codebuild",
"codecatalyst",
"codecommit",
"codedeploy",
"codeguru-reviewer",
"codeguruprofiler",
"codepipeline",
"codestar",
"codestar-connections",
"codestar-notifications",
"cognito-identity",
"cognito-idp",
"cognito-sync",
"comprehend",
"comprehendmedical",
"compute-optimizer",
"config",
"connect",
"connect-contact-lens",
"connectcampaigns",
"connectcases",
"connectparticipant",
"controltower",
"cur",
"customer-profiles",
"databrew",
"dataexchange",
"datapipeline",
"datasync",
"dax",
"detective",
"devicefarm",
"devops-guru",
"directconnect",
"discovery",
"dlm",
"dms",
"docdb",
"docdb-elastic",
"drs",
"ds",
"dynamodb",
"dynamodbstreams",
"ebs",
"ec2",
"ec2-instance-connect",
"ecr",
"ecr-public",
"ecs",
"efs",
"eks",
"elastic-inference",
"elasticache",
"elasticbeanstalk",
"elastictranscoder",
"elb",
"elbv2",
"emr",
"emr-containers",
"emr-serverless",
"es",
"events",
"evidently",
"finspace",
"finspace-data",
"firehose",
"fis",
"fms",
"forecast",
"forecastquery",
"frauddetector",
"fsx",
"gamelift",
"gamesparks",
"glacier",
"globalaccelerator",
"glue",
"grafana",
"greengrass",
"greengrassv2",
"groundstation",
"guardduty",
"health",
"healthlake",
"honeycode",
"iam",
"identitystore",
"imagebuilder",
"importexport",
"inspector",
"inspector2",
"internetmonitor",
"iot",
"iot-data",
"iot-jobs-data",
"iot-roborunner",
"iot1click-devices",
"iot1click-projects",
"iotanalytics",
"iotdeviceadvisor",
"iotevents",
"iotevents-data",
"iotfleethub",
"iotfleetwise",
"iotsecuretunneling",
"iotsitewise",
"iotthingsgraph",
"iottwinmaker",
"iotwireless",
"ivs",
"ivschat",
"kafka",
"kafkaconnect",
"kendra",
"kendra-ranking",
"keyspaces",
"kinesis",
"kinesis-video-archived-media",
"kinesis-video-media",
"kinesis-video-signaling",
"kinesis-video-webrtc-storage",
"kinesisanalytics",
"kinesisanalyticsv2",
"kinesisvideo",
"kms",
"lakeformation",
"lambda",
"lex-models",
"lex-runtime",
"lexv2-models",
"lexv2-runtime",
"license-manager",
"license-manager-linux-subscriptions",
"license-manager-user-subscriptions",
"lightsail",
"location",
"logs",
"lookoutequipment",
"lookoutmetrics",
"lookoutvision",
"m2",
"machinelearning",
"macie",
"macie2",
"managedblockchain",
"marketplace-catalog",
"marketplace-entitlement",
"marketplacecommerceanalytics",
"mediaconnect",
"mediaconvert",
"medialive",
"mediapackage",
"mediapackage-vod",
"mediastore",
"mediastore-data",
"mediatailor",
"memorydb",
"meteringmarketplace",
"mgh",
"mgn",
"migration-hub-refactor-spaces",
"migrationhub-config",
"migrationhuborchestrator",
"migrationhubstrategy",
"mobile",
"mq",
"mturk",
"mwaa",
"neptune",
"network-firewall",
"networkmanager",
"nimble",
"oam",
"omics",
"opensearch",
"opensearchserverless",
"opsworks",
"opsworkscm",
"organizations",
"outposts",
"panorama",
"personalize",
"personalize-events",
"personalize-runtime",
"pi",
"pinpoint",
"pinpoint-email",
"pinpoint-sms-voice",
"pinpoint-sms-voice-v2",
"pipes",
"polly",
"pricing",
"privatenetworks",
"proton",
"qldb",
"qldb-session",
"quicksight",
"ram",
"rbin",
"rds",
"rds-data",
"redshift",
"redshift-data",
"redshift-serverless",
"rekognition",
"resiliencehub",
"resource-explorer-2",
"resource-groups",
"resourcegroupstaggingapi",
"robomaker",
"rolesanywhere",
"route53",
"route53-recovery-cluster",
"route53-recovery-control-config",
"route53-recovery-readiness",
"route53domains",
"route53resolver",
"rum",
"s3",
"s3control",
"s3outposts",
"sagemaker",
"sagemaker-a2i-runtime",
"sagemaker-edge",
"sagemaker-featurestore-runtime",
"sagemaker-geospatial",
"sagemaker-metrics",
"sagemaker-runtime",
"savingsplans",
"scheduler",
"schemas",
"sdb",
"secretsmanager",
"securityhub",
"securitylake",
"serverlessrepo",
"service-quotas",
"servicecatalog",
"servicecatalog-appregistry",
"servicediscovery",
"ses",
"sesv2",
"shield",
"signer",
"simspaceweaver",
"sms",
"sms-voice",
"snow-device-management",
"snowball",
"sns",
"sqs",
"ssm",
"ssm-contacts",
"ssm-incidents",
"ssm-sap",
"sso",
"sso-admin",
"sso-oidc",
"stepfunctions",
"storagegateway",
"sts",
"support",
"support-app",
"swf",
"synthetics",
"textract",
"timestream-query",
"timestream-write",
"tnb",
"transcribe",
"transfer",
"translate",
"voice-id",
"waf",
"waf-regional",
"wafv2",
"wellarchitected",
"wisdom",
"workdocs",
"worklink",
"workmail",
"workmailmessageflow",
"workspaces",
"workspaces-web",
"xray",
]
ResourceServiceName
Usage Example
from mypy_boto3_cognito_idp.literals import ResourceServiceName
def get_value() -> ResourceServiceName:
return "cloudformation"
Definition
ResourceServiceName = Literal[
"cloudformation",
"cloudwatch",
"dynamodb",
"ec2",
"glacier",
"iam",
"opsworks",
"s3",
"sns",
"sqs",
]
PaginatorName
Usage Example
from mypy_boto3_cognito_idp.literals import PaginatorName
def get_value() -> PaginatorName:
return "admin_list_groups_for_user"
Definition
PaginatorName = Literal[
"admin_list_groups_for_user",
"admin_list_user_auth_events",
"list_groups",
"list_identity_providers",
"list_resource_servers",
"list_user_pool_clients",
"list_user_pools",
"list_users",
"list_users_in_group",
]