Skip to content

Cognito Idp Classes

AccountRecoverySettingType

RecoveryMechanisms

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.RecoveryOptionType]]

AccountRecoverySettingTypeOutput

RecoveryMechanisms

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.RecoveryOptionType]]

AccountTakeoverActionType

Notify

  • Type:
  • Required: Yes

EventAction

  • Type: typing.Literal['BLOCK', 'MFA_IF_CONFIGURED', 'MFA_REQUIRED', 'NO_ACTION']
  • Required: Yes

AccountTakeoverActionsType

LowAction

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AccountTakeoverActionType]

MediumAction

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AccountTakeoverActionType]

HighAction

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AccountTakeoverActionType]

AccountTakeoverRiskConfigurationType

Actions

  • Type:
  • Required: Yes

NotifyConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.NotifyConfigurationType]

AddCustomAttributesRequest

UserPoolId

  • Type:
  • Required: Yes

CustomAttributes

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SchemaAttributeType]
  • Required: Yes

AdminAddUserToGroupRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

GroupName

  • Type:
  • Required: Yes

AdminConfirmSignUpRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

AdminCreateUserConfigType

AllowAdminCreateUserOnly

  • Type: typing.Optional[bool]

UnusedAccountValidityDays

  • Type: typing.Optional[int]

InviteMessageTemplate

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.MessageTemplateType]

AdminCreateUserRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

UserAttributes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AttributeType]]

ValidationData

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AttributeType]]

TemporaryPassword

  • Type: typing.Optional[str]

ForceAliasCreation

  • Type: typing.Optional[bool]

MessageAction

  • Type: typing.Optional[typing.Literal['RESEND', 'SUPPRESS']]

DesiredDeliveryMediums

  • Type: typing.Optional[typing.List[typing.Literal['EMAIL', 'SMS']]]

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

AdminCreateUserResponse

User

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AdminDeleteUserAttributesRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

UserAttributeNames

  • Type: typing.List[str]
  • Required: Yes

AdminDeleteUserRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

AdminDisableProviderForUserRequest

UserPoolId

  • Type:
  • Required: Yes

User

  • Type:
  • Required: Yes

AdminDisableUserRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

AdminEnableUserRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

AdminForgetDeviceRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

DeviceKey

  • Type:
  • Required: Yes

AdminGetDeviceRequest

DeviceKey

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

AdminGetDeviceResponse

Device

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AdminGetUserRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

AdminGetUserResponse

Username

  • Type:
  • Required: Yes

UserAttributes

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AttributeType]
  • Required: Yes

UserCreateDate

  • Type:
  • Required: Yes

UserLastModifiedDate

  • Type:
  • Required: Yes

Enabled

  • Type:
  • Required: Yes

UserStatus

  • Type: typing.Literal['ARCHIVED', 'COMPROMISED', 'CONFIRMED', 'EXTERNAL_PROVIDER', 'FORCE_CHANGE_PASSWORD', 'RESET_REQUIRED', 'UNCONFIRMED', 'UNKNOWN']
  • Required: Yes

MFAOptions

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.MFAOptionType]
  • Required: Yes

PreferredMfaSetting

  • Type:
  • Required: Yes

UserMFASettingList

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AdminInitiateAuthRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type:
  • Required: Yes

AuthFlow

  • Type: typing.Literal['ADMIN_NO_SRP_AUTH', 'ADMIN_USER_PASSWORD_AUTH', 'CUSTOM_AUTH', 'REFRESH_TOKEN', 'REFRESH_TOKEN_AUTH', 'USER_AUTH', 'USER_PASSWORD_AUTH', 'USER_SRP_AUTH']
  • Required: Yes

AuthParameters

  • Type: typing.Optional[typing.Dict[str, str]]

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

AnalyticsMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsMetadataType]

ContextData

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.ContextDataType]

Session

  • Type: typing.Optional[str]

AdminInitiateAuthResponse

ChallengeName

  • Type: typing.Literal['ADMIN_NO_SRP_AUTH', 'CUSTOM_CHALLENGE', 'DEVICE_PASSWORD_VERIFIER', 'DEVICE_SRP_AUTH', 'EMAIL_OTP', 'MFA_SETUP', 'NEW_PASSWORD_REQUIRED', 'PASSWORD', 'PASSWORD_SRP', 'PASSWORD_VERIFIER', 'SELECT_CHALLENGE', 'SELECT_MFA_TYPE', 'SMS_MFA', 'SMS_OTP', 'SOFTWARE_TOKEN_MFA', 'WEB_AUTHN']
  • Required: Yes

Session

  • Type:
  • Required: Yes

ChallengeParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

AuthenticationResult

  • Type:
  • Required: Yes

AvailableChallenges

  • Type: typing.List[typing.Literal['ADMIN_NO_SRP_AUTH', 'CUSTOM_CHALLENGE', 'DEVICE_PASSWORD_VERIFIER', 'DEVICE_SRP_AUTH', 'EMAIL_OTP', 'MFA_SETUP', 'NEW_PASSWORD_REQUIRED', 'PASSWORD', 'PASSWORD_SRP', 'PASSWORD_VERIFIER', 'SELECT_CHALLENGE', 'SELECT_MFA_TYPE', 'SMS_MFA', 'SMS_OTP', 'SOFTWARE_TOKEN_MFA', 'WEB_AUTHN']]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AdminLinkProviderForUserRequest

UserPoolId

  • Type:
  • Required: Yes

DestinationUser

  • Type:
  • Required: Yes

SourceUser

  • Type:
  • Required: Yes

AdminListDevicesRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

Limit

  • Type: typing.Optional[int]

PaginationToken

  • Type: typing.Optional[str]

AdminListDevicesResponse

Devices

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.DeviceType]
  • Required: Yes

PaginationToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AdminListGroupsForUserRequest

Username

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

Limit

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

AdminListGroupsForUserRequestPaginate

Username

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PaginatorConfig]

AdminListGroupsForUserResponse

Groups

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.GroupType]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

AdminListUserAuthEventsRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

AdminListUserAuthEventsRequestPaginate

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PaginatorConfig]

AdminListUserAuthEventsResponse

AuthEvents

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AuthEventType]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

AdminRemoveUserFromGroupRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

GroupName

  • Type:
  • Required: Yes

AdminResetUserPasswordRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

AdminRespondToAuthChallengeRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type:
  • Required: Yes

ChallengeName

  • Type: typing.Literal['ADMIN_NO_SRP_AUTH', 'CUSTOM_CHALLENGE', 'DEVICE_PASSWORD_VERIFIER', 'DEVICE_SRP_AUTH', 'EMAIL_OTP', 'MFA_SETUP', 'NEW_PASSWORD_REQUIRED', 'PASSWORD', 'PASSWORD_SRP', 'PASSWORD_VERIFIER', 'SELECT_CHALLENGE', 'SELECT_MFA_TYPE', 'SMS_MFA', 'SMS_OTP', 'SOFTWARE_TOKEN_MFA', 'WEB_AUTHN']
  • Required: Yes

ChallengeResponses

  • Type: typing.Optional[typing.Dict[str, str]]

Session

  • Type: typing.Optional[str]

AnalyticsMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsMetadataType]

ContextData

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.ContextDataType]

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

AdminRespondToAuthChallengeResponse

ChallengeName

  • Type: typing.Literal['ADMIN_NO_SRP_AUTH', 'CUSTOM_CHALLENGE', 'DEVICE_PASSWORD_VERIFIER', 'DEVICE_SRP_AUTH', 'EMAIL_OTP', 'MFA_SETUP', 'NEW_PASSWORD_REQUIRED', 'PASSWORD', 'PASSWORD_SRP', 'PASSWORD_VERIFIER', 'SELECT_CHALLENGE', 'SELECT_MFA_TYPE', 'SMS_MFA', 'SMS_OTP', 'SOFTWARE_TOKEN_MFA', 'WEB_AUTHN']
  • Required: Yes

Session

  • Type:
  • Required: Yes

ChallengeParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

AuthenticationResult

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AdminSetUserMFAPreferenceRequest

Username

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

SMSMfaSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SMSMfaSettingsType]

SoftwareTokenMfaSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SoftwareTokenMfaSettingsType]

EmailMfaSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.EmailMfaSettingsType]

AdminSetUserPasswordRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

Password

  • Type:
  • Required: Yes

Permanent

  • Type: typing.Optional[bool]

AdminSetUserSettingsRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

MFAOptions

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.MFAOptionType]
  • Required: Yes

AdminUpdateAuthEventFeedbackRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

EventId

  • Type:
  • Required: Yes

FeedbackValue

  • Type: typing.Literal['Invalid', 'Valid']
  • Required: Yes

AdminUpdateDeviceStatusRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

DeviceKey

  • Type:
  • Required: Yes

DeviceRememberedStatus

  • Type: typing.Optional[typing.Literal['not_remembered', 'remembered']]

AdminUpdateUserAttributesRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

UserAttributes

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AttributeType]
  • Required: Yes

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

AdminUserGlobalSignOutRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

AdvancedSecurityAdditionalFlowsType

CustomAuthMode

  • Type: typing.Optional[typing.Literal['AUDIT', 'ENFORCED']]

AnalyticsConfigurationType

ApplicationId

  • Type: typing.Optional[str]

ApplicationArn

  • Type: typing.Optional[str]

RoleArn

  • Type: typing.Optional[str]

ExternalId

  • Type: typing.Optional[str]

UserDataShared

  • Type: typing.Optional[bool]

AnalyticsMetadataType

AnalyticsEndpointId

  • Type: typing.Optional[str]

AssetType

Category

  • Type: typing.Literal['AUTH_APP_GRAPHIC', 'EMAIL_GRAPHIC', 'FAVICON_ICO', 'FAVICON_SVG', 'FORM_BACKGROUND', 'FORM_LOGO', 'IDP_BUTTON_ICON', 'PAGE_BACKGROUND', 'PAGE_FOOTER_BACKGROUND', 'PAGE_FOOTER_LOGO', 'PAGE_HEADER_BACKGROUND', 'PAGE_HEADER_LOGO', 'PASSKEY_GRAPHIC', 'PASSWORD_GRAPHIC', 'SMS_GRAPHIC']
  • Required: Yes

ColorMode

  • Type: typing.Literal['DARK', 'DYNAMIC', 'LIGHT']
  • Required: Yes

Extension

  • Type: typing.Literal['ICO', 'JPEG', 'PNG', 'SVG', 'WEBP']
  • Required: Yes

Bytes

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

ResourceId

  • Type: typing.Optional[str]

AssetTypeOutput

Category

  • Type: typing.Literal['AUTH_APP_GRAPHIC', 'EMAIL_GRAPHIC', 'FAVICON_ICO', 'FAVICON_SVG', 'FORM_BACKGROUND', 'FORM_LOGO', 'IDP_BUTTON_ICON', 'PAGE_BACKGROUND', 'PAGE_FOOTER_BACKGROUND', 'PAGE_FOOTER_LOGO', 'PAGE_HEADER_BACKGROUND', 'PAGE_HEADER_LOGO', 'PASSKEY_GRAPHIC', 'PASSWORD_GRAPHIC', 'SMS_GRAPHIC']
  • Required: Yes

ColorMode

  • Type: typing.Literal['DARK', 'DYNAMIC', 'LIGHT']
  • Required: Yes

Extension

  • Type: typing.Literal['ICO', 'JPEG', 'PNG', 'SVG', 'WEBP']
  • Required: Yes

Bytes

  • Type: typing.Optional[bytes]

ResourceId

  • Type: typing.Optional[str]

AssociateSoftwareTokenRequest

AccessToken

  • Type: typing.Optional[str]

Session

  • Type: typing.Optional[str]

AssociateSoftwareTokenResponse

SecretCode

  • Type:
  • Required: Yes

Session

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AttributeType

Name

  • Type:
  • Required: Yes

Value

  • Type: typing.Optional[str]

AuthEventType

EventId

  • Type: typing.Optional[str]

EventType

  • Type: typing.Optional[typing.Literal['ForgotPassword', 'PasswordChange', 'ResendCode', 'SignIn', 'SignUp']]

CreationDate

  • Type: typing.Optional[datetime.datetime]

EventResponse

  • Type: typing.Optional[typing.Literal['Fail', 'InProgress', 'Pass']]

EventRisk

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.EventRiskType]

ChallengeResponses

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.ChallengeResponseType]]

EventContextData

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.EventContextDataType]

EventFeedback

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.EventFeedbackType]

AuthenticationResultType

AccessToken

  • Type: typing.Optional[str]

ExpiresIn

  • Type: typing.Optional[int]

TokenType

  • Type: typing.Optional[str]

RefreshToken

  • Type: typing.Optional[str]

IdToken

  • Type: typing.Optional[str]

NewDeviceMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.NewDeviceMetadataType]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

ChallengeResponseType

ChallengeName

  • Type: typing.Optional[typing.Literal['Mfa', 'Password']]

ChallengeResponse

  • Type: typing.Optional[typing.Literal['Failure', 'Success']]

ChangePasswordRequest

ProposedPassword

  • Type:
  • Required: Yes

AccessToken

  • Type:
  • Required: Yes

PreviousPassword

  • Type: typing.Optional[str]

CloudWatchLogsConfigurationType

LogGroupArn

  • Type: typing.Optional[str]

CodeDeliveryDetailsType

Destination

  • Type: typing.Optional[str]

DeliveryMedium

  • Type: typing.Optional[typing.Literal['EMAIL', 'SMS']]

AttributeName

  • Type: typing.Optional[str]

CompleteWebAuthnRegistrationRequest

AccessToken

  • Type:
  • Required: Yes

Credential

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

CompromisedCredentialsActionsType

EventAction

  • Type: typing.Literal['BLOCK', 'NO_ACTION']
  • Required: Yes

CompromisedCredentialsRiskConfigurationType

Actions

  • Type:
  • Required: Yes

EventFilter

  • Type: typing.Optional[typing.List[typing.Literal['PASSWORD_CHANGE', 'SIGN_IN', 'SIGN_UP']]]

CompromisedCredentialsRiskConfigurationTypeOutput

Actions

  • Type:
  • Required: Yes

EventFilter

  • Type: typing.Optional[typing.List[typing.Literal['PASSWORD_CHANGE', 'SIGN_IN', 'SIGN_UP']]]

ConfirmDeviceRequest

AccessToken

  • Type:
  • Required: Yes

DeviceKey

  • Type:
  • Required: Yes

DeviceSecretVerifierConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.DeviceSecretVerifierConfigType]

DeviceName

  • Type: typing.Optional[str]

ConfirmDeviceResponse

UserConfirmationNecessary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ConfirmForgotPasswordRequest

ClientId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

ConfirmationCode

  • Type:
  • Required: Yes

Password

  • Type:
  • Required: Yes

SecretHash

  • Type: typing.Optional[str]

AnalyticsMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsMetadataType]

UserContextData

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserContextDataType]

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

ConfirmSignUpRequest

ClientId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

ConfirmationCode

  • Type:
  • Required: Yes

SecretHash

  • Type: typing.Optional[str]

ForceAliasCreation

  • Type: typing.Optional[bool]

AnalyticsMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsMetadataType]

UserContextData

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserContextDataType]

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

Session

  • Type: typing.Optional[str]

ConfirmSignUpResponse

Session

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ContextDataType

IpAddress

  • Type:
  • Required: Yes

ServerName

  • Type:
  • Required: Yes

ServerPath

  • Type:
  • Required: Yes

HttpHeaders

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.HttpHeader]
  • Required: Yes

EncodedData

  • Type: typing.Optional[str]

CreateGroupRequest

GroupName

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

RoleArn

  • Type: typing.Optional[str]

Precedence

  • Type: typing.Optional[int]

CreateGroupResponse

Group

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateIdentityProviderRequest

UserPoolId

  • Type:
  • Required: Yes

ProviderName

  • Type:
  • Required: Yes

ProviderType

  • Type: typing.Literal['Facebook', 'Google', 'LoginWithAmazon', 'OIDC', 'SAML', 'SignInWithApple']
  • Required: Yes

ProviderDetails

  • Type: typing.Dict[str, str]
  • Required: Yes

AttributeMapping

  • Type: typing.Optional[typing.Dict[str, str]]

IdpIdentifiers

  • Type: typing.Optional[typing.List[str]]

CreateIdentityProviderResponse

IdentityProvider

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateManagedLoginBrandingRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type:
  • Required: Yes

UseCognitoProvidedValues

  • Type: typing.Optional[bool]

Settings

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

Assets

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AssetType, aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AssetTypeOutput]]]

CreateManagedLoginBrandingResponse

ManagedLoginBranding

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateResourceServerRequest

UserPoolId

  • Type:
  • Required: Yes

Identifier

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Scopes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.ResourceServerScopeType]]

CreateResourceServerResponse

ResourceServer

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateUserImportJobRequest

JobName

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

CloudWatchLogsRoleArn

  • Type:
  • Required: Yes

CreateUserImportJobResponse

UserImportJob

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateUserPoolClientRequest

UserPoolId

  • Type:
  • Required: Yes

ClientName

  • Type:
  • Required: Yes

GenerateSecret

  • Type: typing.Optional[bool]

RefreshTokenValidity

  • Type: typing.Optional[int]

AccessTokenValidity

  • Type: typing.Optional[int]

IdTokenValidity

  • Type: typing.Optional[int]

TokenValidityUnits

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.TokenValidityUnitsType]

ReadAttributes

  • Type: typing.Optional[typing.List[str]]

WriteAttributes

  • Type: typing.Optional[typing.List[str]]

ExplicitAuthFlows

  • Type: typing.Optional[typing.List[typing.Literal['ADMIN_NO_SRP_AUTH', 'ALLOW_ADMIN_USER_PASSWORD_AUTH', 'ALLOW_CUSTOM_AUTH', 'ALLOW_REFRESH_TOKEN_AUTH', 'ALLOW_USER_AUTH', 'ALLOW_USER_PASSWORD_AUTH', 'ALLOW_USER_SRP_AUTH', 'CUSTOM_AUTH_FLOW_ONLY', 'USER_PASSWORD_AUTH']]]

SupportedIdentityProviders

  • Type: typing.Optional[typing.List[str]]

CallbackURLs

  • Type: typing.Optional[typing.List[str]]

LogoutURLs

  • Type: typing.Optional[typing.List[str]]

DefaultRedirectURI

  • Type: typing.Optional[str]

AllowedOAuthFlows

  • Type: typing.Optional[typing.List[typing.Literal['client_credentials', 'code', 'implicit']]]

AllowedOAuthScopes

  • Type: typing.Optional[typing.List[str]]

AllowedOAuthFlowsUserPoolClient

  • Type: typing.Optional[bool]

AnalyticsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsConfigurationType]

PreventUserExistenceErrors

  • Type: typing.Optional[typing.Literal['ENABLED', 'LEGACY']]

EnableTokenRevocation

  • Type: typing.Optional[bool]

EnablePropagateAdditionalUserContextData

  • Type: typing.Optional[bool]

AuthSessionValidity

  • Type: typing.Optional[int]

CreateUserPoolClientResponse

UserPoolClient

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateUserPoolDomainRequest

Domain

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

ManagedLoginVersion

  • Type: typing.Optional[int]

CustomDomainConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.CustomDomainConfigType]

CreateUserPoolDomainResponse

ManagedLoginVersion

  • Type:
  • Required: Yes

CloudFrontDomain

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateUserPoolRequest

PoolName

  • Type:
  • Required: Yes

Policies

  • Type: typing.Union[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserPoolPolicyType, aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserPoolPolicyTypeOutput, NoneType]

DeletionProtection

  • Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]

LambdaConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.LambdaConfigType]

AutoVerifiedAttributes

  • Type: typing.Optional[typing.List[typing.Literal['email', 'phone_number']]]

AliasAttributes

  • Type: typing.Optional[typing.List[typing.Literal['email', 'phone_number', 'preferred_username']]]

UsernameAttributes

  • Type: typing.Optional[typing.List[typing.Literal['email', 'phone_number']]]

SmsVerificationMessage

  • Type: typing.Optional[str]

EmailVerificationMessage

  • Type: typing.Optional[str]

EmailVerificationSubject

  • Type: typing.Optional[str]

VerificationMessageTemplate

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.VerificationMessageTemplateType]

SmsAuthenticationMessage

  • Type: typing.Optional[str]

MfaConfiguration

  • Type: typing.Optional[typing.Literal['OFF', 'ON', 'OPTIONAL']]

UserAttributeUpdateSettings

  • Type: typing.Union[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserAttributeUpdateSettingsType, aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserAttributeUpdateSettingsTypeOutput, NoneType]

DeviceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.DeviceConfigurationType]

EmailConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.EmailConfigurationType]

SmsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SmsConfigurationType]

UserPoolTags

  • Type: typing.Optional[typing.Dict[str, str]]

AdminCreateUserConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AdminCreateUserConfigType]

Schema

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SchemaAttributeType]]

UserPoolAddOns

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserPoolAddOnsType]

UsernameConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UsernameConfigurationType]

AccountRecoverySetting

  • Type: typing.Union[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AccountRecoverySettingType, aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AccountRecoverySettingTypeOutput, NoneType]

UserPoolTier

  • Type: typing.Optional[typing.Literal['ESSENTIALS', 'LITE', 'PLUS']]

CreateUserPoolResponse

UserPool

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CustomDomainConfigType

CertificateArn

  • Type:
  • Required: Yes

CustomEmailLambdaVersionConfigType

LambdaVersion

  • Type: typing.Literal['V1_0']
  • Required: Yes

LambdaArn

  • Type:
  • Required: Yes

CustomSMSLambdaVersionConfigType

LambdaVersion

  • Type: typing.Literal['V1_0']
  • Required: Yes

LambdaArn

  • Type:
  • Required: Yes

DeleteGroupRequest

GroupName

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

DeleteIdentityProviderRequest

UserPoolId

  • Type:
  • Required: Yes

ProviderName

  • Type:
  • Required: Yes

DeleteManagedLoginBrandingRequest

ManagedLoginBrandingId

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

DeleteResourceServerRequest

UserPoolId

  • Type:
  • Required: Yes

Identifier

  • Type:
  • Required: Yes

DeleteUserAttributesRequest

UserAttributeNames

  • Type: typing.List[str]
  • Required: Yes

AccessToken

  • Type:
  • Required: Yes

DeleteUserPoolClientRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type:
  • Required: Yes

DeleteUserPoolDomainRequest

Domain

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

DeleteUserPoolRequest

UserPoolId

  • Type:
  • Required: Yes

DeleteUserRequest

AccessToken

  • Type:
  • Required: Yes

DeleteWebAuthnCredentialRequest

AccessToken

  • Type:
  • Required: Yes

CredentialId

  • Type:
  • Required: Yes

DescribeIdentityProviderRequest

UserPoolId

  • Type:
  • Required: Yes

ProviderName

  • Type:
  • Required: Yes

DescribeIdentityProviderResponse

IdentityProvider

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeManagedLoginBrandingByClientRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type:
  • Required: Yes

ReturnMergedResources

  • Type: typing.Optional[bool]

DescribeManagedLoginBrandingByClientResponse

ManagedLoginBranding

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeManagedLoginBrandingRequest

UserPoolId

  • Type:
  • Required: Yes

ManagedLoginBrandingId

  • Type:
  • Required: Yes

ReturnMergedResources

  • Type: typing.Optional[bool]

DescribeManagedLoginBrandingResponse

ManagedLoginBranding

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeResourceServerRequest

UserPoolId

  • Type:
  • Required: Yes

Identifier

  • Type:
  • Required: Yes

DescribeResourceServerResponse

ResourceServer

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeRiskConfigurationRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type: typing.Optional[str]

DescribeRiskConfigurationResponse

RiskConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeUserImportJobRequest

UserPoolId

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

DescribeUserImportJobResponse

UserImportJob

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeUserPoolClientRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type:
  • Required: Yes

DescribeUserPoolClientResponse

UserPoolClient

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeUserPoolDomainRequest

Domain

  • Type:
  • Required: Yes

DescribeUserPoolDomainResponse

DomainDescription

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeUserPoolRequest

UserPoolId

  • Type:
  • Required: Yes

DescribeUserPoolResponse

UserPool

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeviceConfigurationType

ChallengeRequiredOnNewDevice

  • Type: typing.Optional[bool]

DeviceOnlyRememberedOnUserPrompt

  • Type: typing.Optional[bool]

DeviceSecretVerifierConfigType

PasswordVerifier

  • Type: typing.Optional[str]

Salt

  • Type: typing.Optional[str]

DeviceType

DeviceKey

  • Type: typing.Optional[str]

DeviceAttributes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AttributeType]]

DeviceCreateDate

  • Type: typing.Optional[datetime.datetime]

DeviceLastModifiedDate

  • Type: typing.Optional[datetime.datetime]

DeviceLastAuthenticatedDate

  • Type: typing.Optional[datetime.datetime]

DomainDescriptionType

UserPoolId

  • Type: typing.Optional[str]

AWSAccountId

  • Type: typing.Optional[str]

Domain

  • Type: typing.Optional[str]

S3Bucket

  • Type: typing.Optional[str]

CloudFrontDistribution

  • Type: typing.Optional[str]

Version

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]

CustomDomainConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.CustomDomainConfigType]

ManagedLoginVersion

  • Type: typing.Optional[int]

EmailConfigurationType

SourceArn

  • Type: typing.Optional[str]

ReplyToEmailAddress

  • Type: typing.Optional[str]

EmailSendingAccount

  • Type: typing.Optional[typing.Literal['COGNITO_DEFAULT', 'DEVELOPER']]

From

  • Type: typing.Optional[str]

ConfigurationSet

  • Type: typing.Optional[str]

EmailMfaConfigType

Message

  • Type: typing.Optional[str]

Subject

  • Type: typing.Optional[str]

EmailMfaSettingsType

Enabled

  • Type: typing.Optional[bool]

PreferredMfa

  • Type: typing.Optional[bool]

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

EventContextDataType

IpAddress

  • Type: typing.Optional[str]

DeviceName

  • Type: typing.Optional[str]

Timezone

  • Type: typing.Optional[str]

City

  • Type: typing.Optional[str]

Country

  • Type: typing.Optional[str]

EventFeedbackType

FeedbackValue

  • Type: typing.Literal['Invalid', 'Valid']
  • Required: Yes

Provider

  • Type:
  • Required: Yes

FeedbackDate

  • Type: typing.Optional[datetime.datetime]

EventRiskType

RiskDecision

  • Type: typing.Optional[typing.Literal['AccountTakeover', 'Block', 'NoRisk']]

RiskLevel

  • Type: typing.Optional[typing.Literal['High', 'Low', 'Medium']]

CompromisedCredentialsDetected

  • Type: typing.Optional[bool]

FirehoseConfigurationType

StreamArn

  • Type: typing.Optional[str]

ForgetDeviceRequest

DeviceKey

  • Type:
  • Required: Yes

AccessToken

  • Type: typing.Optional[str]

ForgotPasswordRequest

ClientId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

SecretHash

  • Type: typing.Optional[str]

UserContextData

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserContextDataType]

AnalyticsMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsMetadataType]

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

ForgotPasswordResponse

CodeDeliveryDetails

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetCSVHeaderRequest

UserPoolId

  • Type:
  • Required: Yes

GetCSVHeaderResponse

UserPoolId

  • Type:
  • Required: Yes

CSVHeader

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDeviceRequest

DeviceKey

  • Type:
  • Required: Yes

AccessToken

  • Type: typing.Optional[str]

GetDeviceResponse

Device

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetGroupRequest

GroupName

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

GetGroupResponse

Group

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetIdentityProviderByIdentifierRequest

UserPoolId

  • Type:
  • Required: Yes

IdpIdentifier

  • Type:
  • Required: Yes

GetIdentityProviderByIdentifierResponse

IdentityProvider

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetLogDeliveryConfigurationRequest

UserPoolId

  • Type:
  • Required: Yes

GetLogDeliveryConfigurationResponse

LogDeliveryConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSigningCertificateRequest

UserPoolId

  • Type:
  • Required: Yes

GetSigningCertificateResponse

Certificate

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetUICustomizationRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type: typing.Optional[str]

GetUICustomizationResponse

UICustomization

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetUserAttributeVerificationCodeRequest

AccessToken

  • Type:
  • Required: Yes

AttributeName

  • Type:
  • Required: Yes

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

GetUserAttributeVerificationCodeResponse

CodeDeliveryDetails

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetUserAuthFactorsRequest

AccessToken

  • Type:
  • Required: Yes

GetUserAuthFactorsResponse

Username

  • Type:
  • Required: Yes

PreferredMfaSetting

  • Type:
  • Required: Yes

UserMFASettingList

  • Type: typing.List[str]
  • Required: Yes

ConfiguredUserAuthFactors

  • Type: typing.List[typing.Literal['EMAIL_OTP', 'PASSWORD', 'SMS_OTP', 'WEB_AUTHN']]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetUserPoolMfaConfigRequest

UserPoolId

  • Type:
  • Required: Yes

GetUserPoolMfaConfigResponse

SmsMfaConfiguration

  • Type:
  • Required: Yes

SoftwareTokenMfaConfiguration

  • Type:
  • Required: Yes

EmailMfaConfiguration

  • Type:
  • Required: Yes

MfaConfiguration

  • Type: typing.Literal['OFF', 'ON', 'OPTIONAL']
  • Required: Yes

WebAuthnConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetUserRequest

AccessToken

  • Type:
  • Required: Yes

GetUserResponse

Username

  • Type:
  • Required: Yes

UserAttributes

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AttributeType]
  • Required: Yes

MFAOptions

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.MFAOptionType]
  • Required: Yes

PreferredMfaSetting

  • Type:
  • Required: Yes

UserMFASettingList

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GlobalSignOutRequest

AccessToken

  • Type:
  • Required: Yes

GroupType

GroupName

  • Type: typing.Optional[str]

UserPoolId

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

RoleArn

  • Type: typing.Optional[str]

Precedence

  • Type: typing.Optional[int]

LastModifiedDate

  • Type: typing.Optional[datetime.datetime]

CreationDate

  • Type: typing.Optional[datetime.datetime]

HttpHeader

headerName

  • Type: typing.Optional[str]

headerValue

  • Type: typing.Optional[str]

IdentityProviderType

UserPoolId

  • Type: typing.Optional[str]

ProviderName

  • Type: typing.Optional[str]

ProviderType

  • Type: typing.Optional[typing.Literal['Facebook', 'Google', 'LoginWithAmazon', 'OIDC', 'SAML', 'SignInWithApple']]

ProviderDetails

  • Type: typing.Optional[typing.Dict[str, str]]

AttributeMapping

  • Type: typing.Optional[typing.Dict[str, str]]

IdpIdentifiers

  • Type: typing.Optional[typing.List[str]]

LastModifiedDate

  • Type: typing.Optional[datetime.datetime]

CreationDate

  • Type: typing.Optional[datetime.datetime]

InitiateAuthRequest

AuthFlow

  • Type: typing.Literal['ADMIN_NO_SRP_AUTH', 'ADMIN_USER_PASSWORD_AUTH', 'CUSTOM_AUTH', 'REFRESH_TOKEN', 'REFRESH_TOKEN_AUTH', 'USER_AUTH', 'USER_PASSWORD_AUTH', 'USER_SRP_AUTH']
  • Required: Yes

ClientId

  • Type:
  • Required: Yes

AuthParameters

  • Type: typing.Optional[typing.Dict[str, str]]

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

AnalyticsMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsMetadataType]

UserContextData

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserContextDataType]

Session

  • Type: typing.Optional[str]

InitiateAuthResponse

ChallengeName

  • Type: typing.Literal['ADMIN_NO_SRP_AUTH', 'CUSTOM_CHALLENGE', 'DEVICE_PASSWORD_VERIFIER', 'DEVICE_SRP_AUTH', 'EMAIL_OTP', 'MFA_SETUP', 'NEW_PASSWORD_REQUIRED', 'PASSWORD', 'PASSWORD_SRP', 'PASSWORD_VERIFIER', 'SELECT_CHALLENGE', 'SELECT_MFA_TYPE', 'SMS_MFA', 'SMS_OTP', 'SOFTWARE_TOKEN_MFA', 'WEB_AUTHN']
  • Required: Yes

Session

  • Type:
  • Required: Yes

ChallengeParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

AuthenticationResult

  • Type:
  • Required: Yes

AvailableChallenges

  • Type: typing.List[typing.Literal['ADMIN_NO_SRP_AUTH', 'CUSTOM_CHALLENGE', 'DEVICE_PASSWORD_VERIFIER', 'DEVICE_SRP_AUTH', 'EMAIL_OTP', 'MFA_SETUP', 'NEW_PASSWORD_REQUIRED', 'PASSWORD', 'PASSWORD_SRP', 'PASSWORD_VERIFIER', 'SELECT_CHALLENGE', 'SELECT_MFA_TYPE', 'SMS_MFA', 'SMS_OTP', 'SOFTWARE_TOKEN_MFA', 'WEB_AUTHN']]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

LambdaConfigType

PreSignUp

  • Type: typing.Optional[str]

CustomMessage

  • Type: typing.Optional[str]

PostConfirmation

  • Type: typing.Optional[str]

PreAuthentication

  • Type: typing.Optional[str]

PostAuthentication

  • Type: typing.Optional[str]

DefineAuthChallenge

  • Type: typing.Optional[str]

CreateAuthChallenge

  • Type: typing.Optional[str]

VerifyAuthChallengeResponse

  • Type: typing.Optional[str]

PreTokenGeneration

  • Type: typing.Optional[str]

UserMigration

  • Type: typing.Optional[str]

PreTokenGenerationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PreTokenGenerationVersionConfigType]

CustomSMSSender

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.CustomSMSLambdaVersionConfigType]

CustomEmailSender

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.CustomEmailLambdaVersionConfigType]

KMSKeyID

  • Type: typing.Optional[str]

ListDevicesRequest

AccessToken

  • Type:
  • Required: Yes

Limit

  • Type: typing.Optional[int]

PaginationToken

  • Type: typing.Optional[str]

ListDevicesResponse

Devices

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.DeviceType]
  • Required: Yes

PaginationToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListGroupsRequest

UserPoolId

  • Type:
  • Required: Yes

Limit

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListGroupsRequestPaginate

UserPoolId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PaginatorConfig]

ListGroupsResponse

Groups

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.GroupType]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListIdentityProvidersRequest

UserPoolId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListIdentityProvidersRequestPaginate

UserPoolId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PaginatorConfig]

ListIdentityProvidersResponse

Providers

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.ProviderDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListResourceServersRequest

UserPoolId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListResourceServersRequestPaginate

UserPoolId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PaginatorConfig]

ListResourceServersResponse

ResourceServers

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.ResourceServerType]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

ResourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListUserImportJobsRequest

UserPoolId

  • Type:
  • Required: Yes

MaxResults

  • Type:
  • Required: Yes

PaginationToken

  • Type: typing.Optional[str]

ListUserImportJobsResponse

UserImportJobs

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserImportJobType]
  • Required: Yes

PaginationToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListUserPoolClientsRequest

UserPoolId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListUserPoolClientsRequestPaginate

UserPoolId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PaginatorConfig]

ListUserPoolClientsResponse

UserPoolClients

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserPoolClientDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListUserPoolsRequest

MaxResults

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListUserPoolsRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PaginatorConfig]

ListUserPoolsResponse

UserPools

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserPoolDescriptionType]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListUsersInGroupRequest

UserPoolId

  • Type:
  • Required: Yes

GroupName

  • Type:
  • Required: Yes

Limit

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListUsersInGroupRequestPaginate

UserPoolId

  • Type:
  • Required: Yes

GroupName

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PaginatorConfig]

ListUsersInGroupResponse

Users

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserType]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListUsersRequest

UserPoolId

  • Type:
  • Required: Yes

AttributesToGet

  • Type: typing.Optional[typing.List[str]]

Limit

  • Type: typing.Optional[int]

PaginationToken

  • Type: typing.Optional[str]

Filter

  • Type: typing.Optional[str]

ListUsersRequestPaginate

UserPoolId

  • Type:
  • Required: Yes

AttributesToGet

  • Type: typing.Optional[typing.List[str]]

Filter

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PaginatorConfig]

ListUsersResponse

Users

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserType]
  • Required: Yes

PaginationToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListWebAuthnCredentialsRequest

AccessToken

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListWebAuthnCredentialsResponse

Credentials

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.WebAuthnCredentialDescription]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

LogConfigurationType

LogLevel

  • Type: typing.Literal['ERROR', 'INFO']
  • Required: Yes

EventSource

  • Type: typing.Literal['userAuthEvents', 'userNotification']
  • Required: Yes

CloudWatchLogsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.CloudWatchLogsConfigurationType]

S3Configuration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.S3ConfigurationType]

FirehoseConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.FirehoseConfigurationType]

LogDeliveryConfigurationType

UserPoolId

  • Type:
  • Required: Yes

LogConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.LogConfigurationType]
  • Required: Yes

MFAOptionType

DeliveryMedium

  • Type: typing.Optional[typing.Literal['EMAIL', 'SMS']]

AttributeName

  • Type: typing.Optional[str]

ManagedLoginBrandingType

ManagedLoginBrandingId

  • Type: typing.Optional[str]

UserPoolId

  • Type: typing.Optional[str]

UseCognitoProvidedValues

  • Type: typing.Optional[bool]

Settings

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

Assets

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AssetTypeOutput]]

CreationDate

  • Type: typing.Optional[datetime.datetime]

LastModifiedDate

  • Type: typing.Optional[datetime.datetime]

MessageTemplateType

SMSMessage

  • Type: typing.Optional[str]

EmailMessage

  • Type: typing.Optional[str]

EmailSubject

  • Type: typing.Optional[str]

NewDeviceMetadataType

DeviceKey

  • Type: typing.Optional[str]

DeviceGroupKey

  • Type: typing.Optional[str]

NotifyConfigurationType

SourceArn

  • Type:
  • Required: Yes

From

  • Type: typing.Optional[str]

ReplyTo

  • Type: typing.Optional[str]

BlockEmail

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.NotifyEmailType]

NoActionEmail

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.NotifyEmailType]

MfaEmail

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.NotifyEmailType]

NotifyEmailType

Subject

  • Type:
  • Required: Yes

HtmlBody

  • Type: typing.Optional[str]

TextBody

  • Type: typing.Optional[str]

NumberAttributeConstraintsType

MinValue

  • Type: typing.Optional[str]

MaxValue

  • Type: typing.Optional[str]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PasswordPolicyType

MinimumLength

  • Type: typing.Optional[int]

RequireUppercase

  • Type: typing.Optional[bool]

RequireLowercase

  • Type: typing.Optional[bool]

RequireNumbers

  • Type: typing.Optional[bool]

RequireSymbols

  • Type: typing.Optional[bool]

PasswordHistorySize

  • Type: typing.Optional[int]

TemporaryPasswordValidityDays

  • Type: typing.Optional[int]

PreTokenGenerationVersionConfigType

LambdaVersion

  • Type: typing.Literal['V1_0', 'V2_0', 'V3_0']
  • Required: Yes

LambdaArn

  • Type:
  • Required: Yes

ProviderDescription

ProviderName

  • Type: typing.Optional[str]

ProviderType

  • Type: typing.Optional[typing.Literal['Facebook', 'Google', 'LoginWithAmazon', 'OIDC', 'SAML', 'SignInWithApple']]

LastModifiedDate

  • Type: typing.Optional[datetime.datetime]

CreationDate

  • Type: typing.Optional[datetime.datetime]

ProviderUserIdentifierType

ProviderName

  • Type: typing.Optional[str]

ProviderAttributeName

  • Type: typing.Optional[str]

ProviderAttributeValue

  • Type: typing.Optional[str]

RecoveryOptionType

Priority

  • Type:
  • Required: Yes

Name

  • Type: typing.Literal['admin_only', 'verified_email', 'verified_phone_number']
  • Required: Yes

ResendConfirmationCodeRequest

ClientId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

SecretHash

  • Type: typing.Optional[str]

UserContextData

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserContextDataType]

AnalyticsMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsMetadataType]

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

ResendConfirmationCodeResponse

CodeDeliveryDetails

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResourceServerScopeType

ScopeName

  • Type:
  • Required: Yes

ScopeDescription

  • Type:
  • Required: Yes

ResourceServerType

UserPoolId

  • Type: typing.Optional[str]

Identifier

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Scopes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.ResourceServerScopeType]]

RespondToAuthChallengeRequest

ClientId

  • Type:
  • Required: Yes

ChallengeName

  • Type: typing.Literal['ADMIN_NO_SRP_AUTH', 'CUSTOM_CHALLENGE', 'DEVICE_PASSWORD_VERIFIER', 'DEVICE_SRP_AUTH', 'EMAIL_OTP', 'MFA_SETUP', 'NEW_PASSWORD_REQUIRED', 'PASSWORD', 'PASSWORD_SRP', 'PASSWORD_VERIFIER', 'SELECT_CHALLENGE', 'SELECT_MFA_TYPE', 'SMS_MFA', 'SMS_OTP', 'SOFTWARE_TOKEN_MFA', 'WEB_AUTHN']
  • Required: Yes

Session

  • Type: typing.Optional[str]

ChallengeResponses

  • Type: typing.Optional[typing.Dict[str, str]]

AnalyticsMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsMetadataType]

UserContextData

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserContextDataType]

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

RespondToAuthChallengeResponse

ChallengeName

  • Type: typing.Literal['ADMIN_NO_SRP_AUTH', 'CUSTOM_CHALLENGE', 'DEVICE_PASSWORD_VERIFIER', 'DEVICE_SRP_AUTH', 'EMAIL_OTP', 'MFA_SETUP', 'NEW_PASSWORD_REQUIRED', 'PASSWORD', 'PASSWORD_SRP', 'PASSWORD_VERIFIER', 'SELECT_CHALLENGE', 'SELECT_MFA_TYPE', 'SMS_MFA', 'SMS_OTP', 'SOFTWARE_TOKEN_MFA', 'WEB_AUTHN']
  • Required: Yes

Session

  • Type:
  • Required: Yes

ChallengeParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

AuthenticationResult

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

RevokeTokenRequest

Token

  • Type:
  • Required: Yes

ClientId

  • Type:
  • Required: Yes

ClientSecret

  • Type: typing.Optional[str]

RiskConfigurationType

UserPoolId

  • Type: typing.Optional[str]

ClientId

  • Type: typing.Optional[str]

CompromisedCredentialsRiskConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.CompromisedCredentialsRiskConfigurationTypeOutput]

AccountTakeoverRiskConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AccountTakeoverRiskConfigurationType]

RiskExceptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.RiskExceptionConfigurationTypeOutput]

LastModifiedDate

  • Type: typing.Optional[datetime.datetime]

RiskExceptionConfigurationType

BlockedIPRangeList

  • Type: typing.Optional[typing.List[str]]

SkippedIPRangeList

  • Type: typing.Optional[typing.List[str]]

RiskExceptionConfigurationTypeOutput

BlockedIPRangeList

  • Type: typing.Optional[typing.List[str]]

SkippedIPRangeList

  • Type: typing.Optional[typing.List[str]]

S3ConfigurationType

BucketArn

  • Type: typing.Optional[str]

SMSMfaSettingsType

Enabled

  • Type: typing.Optional[bool]

PreferredMfa

  • Type: typing.Optional[bool]

SchemaAttributeType

Name

  • Type: typing.Optional[str]

AttributeDataType

  • Type: typing.Optional[typing.Literal['Boolean', 'DateTime', 'Number', 'String']]

DeveloperOnlyAttribute

  • Type: typing.Optional[bool]

Mutable

  • Type: typing.Optional[bool]

Required

  • Type: typing.Optional[bool]

NumberAttributeConstraints

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.NumberAttributeConstraintsType]

StringAttributeConstraints

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.StringAttributeConstraintsType]

SetLogDeliveryConfigurationRequest

UserPoolId

  • Type:
  • Required: Yes

LogConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.LogConfigurationType]
  • Required: Yes

SetLogDeliveryConfigurationResponse

LogDeliveryConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SetRiskConfigurationRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type: typing.Optional[str]

CompromisedCredentialsRiskConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.CompromisedCredentialsRiskConfigurationType, aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.CompromisedCredentialsRiskConfigurationTypeOutput, NoneType]

AccountTakeoverRiskConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AccountTakeoverRiskConfigurationType]

RiskExceptionConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.RiskExceptionConfigurationType, aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.RiskExceptionConfigurationTypeOutput, NoneType]

SetRiskConfigurationResponse

RiskConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SetUICustomizationRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type: typing.Optional[str]

CSS

  • Type: typing.Optional[str]

ImageFile

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

SetUICustomizationResponse

UICustomization

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SetUserMFAPreferenceRequest

AccessToken

  • Type:
  • Required: Yes

SMSMfaSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SMSMfaSettingsType]

SoftwareTokenMfaSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SoftwareTokenMfaSettingsType]

EmailMfaSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.EmailMfaSettingsType]

SetUserPoolMfaConfigRequest

UserPoolId

  • Type:
  • Required: Yes

SmsMfaConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SmsMfaConfigType]

SoftwareTokenMfaConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SoftwareTokenMfaConfigType]

EmailMfaConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.EmailMfaConfigType]

MfaConfiguration

  • Type: typing.Optional[typing.Literal['OFF', 'ON', 'OPTIONAL']]

WebAuthnConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.WebAuthnConfigurationType]

SetUserPoolMfaConfigResponse

SmsMfaConfiguration

  • Type:
  • Required: Yes

SoftwareTokenMfaConfiguration

  • Type:
  • Required: Yes

EmailMfaConfiguration

  • Type:
  • Required: Yes

MfaConfiguration

  • Type: typing.Literal['OFF', 'ON', 'OPTIONAL']
  • Required: Yes

WebAuthnConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SetUserSettingsRequest

AccessToken

  • Type:
  • Required: Yes

MFAOptions

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.MFAOptionType]
  • Required: Yes

SignInPolicyType

AllowedFirstAuthFactors

  • Type: typing.Optional[typing.List[typing.Literal['EMAIL_OTP', 'PASSWORD', 'SMS_OTP', 'WEB_AUTHN']]]

SignInPolicyTypeOutput

AllowedFirstAuthFactors

  • Type: typing.Optional[typing.List[typing.Literal['EMAIL_OTP', 'PASSWORD', 'SMS_OTP', 'WEB_AUTHN']]]

SignUpRequest

ClientId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

SecretHash

  • Type: typing.Optional[str]

Password

  • Type: typing.Optional[str]

UserAttributes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AttributeType]]

ValidationData

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AttributeType]]

AnalyticsMetadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsMetadataType]

UserContextData

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserContextDataType]

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

SignUpResponse

UserConfirmed

  • Type:
  • Required: Yes

CodeDeliveryDetails

  • Type:
  • Required: Yes

UserSub

  • Type:
  • Required: Yes

Session

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SmsConfigurationType

SnsCallerArn

  • Type:
  • Required: Yes

ExternalId

  • Type: typing.Optional[str]

SnsRegion

  • Type: typing.Optional[str]

SmsMfaConfigType

SmsAuthenticationMessage

  • Type: typing.Optional[str]

SmsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SmsConfigurationType]

SoftwareTokenMfaConfigType

Enabled

  • Type: typing.Optional[bool]

SoftwareTokenMfaSettingsType

Enabled

  • Type: typing.Optional[bool]

PreferredMfa

  • Type: typing.Optional[bool]

StartUserImportJobRequest

UserPoolId

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

StartUserImportJobResponse

UserImportJob

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartWebAuthnRegistrationRequest

AccessToken

  • Type:
  • Required: Yes

StartWebAuthnRegistrationResponse

CredentialCreationOptions

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopUserImportJobRequest

UserPoolId

  • Type:
  • Required: Yes

JobId

  • Type:
  • Required: Yes

StopUserImportJobResponse

UserImportJob

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StringAttributeConstraintsType

MinLength

  • Type: typing.Optional[str]

MaxLength

  • Type: typing.Optional[str]

TagResourceRequest

ResourceArn

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

TokenValidityUnitsType

AccessToken

  • Type: typing.Optional[typing.Literal['days', 'hours', 'minutes', 'seconds']]

IdToken

  • Type: typing.Optional[typing.Literal['days', 'hours', 'minutes', 'seconds']]

RefreshToken

  • Type: typing.Optional[typing.Literal['days', 'hours', 'minutes', 'seconds']]

UICustomizationType

UserPoolId

  • Type: typing.Optional[str]

ClientId

  • Type: typing.Optional[str]

ImageUrl

  • Type: typing.Optional[str]

CSS

  • Type: typing.Optional[str]

CSSVersion

  • Type: typing.Optional[str]

LastModifiedDate

  • Type: typing.Optional[datetime.datetime]

CreationDate

  • Type: typing.Optional[datetime.datetime]

UntagResourceRequest

ResourceArn

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateAuthEventFeedbackRequest

UserPoolId

  • Type:
  • Required: Yes

Username

  • Type:
  • Required: Yes

EventId

  • Type:
  • Required: Yes

FeedbackToken

  • Type:
  • Required: Yes

FeedbackValue

  • Type: typing.Literal['Invalid', 'Valid']
  • Required: Yes

UpdateDeviceStatusRequest

AccessToken

  • Type:
  • Required: Yes

DeviceKey

  • Type:
  • Required: Yes

DeviceRememberedStatus

  • Type: typing.Optional[typing.Literal['not_remembered', 'remembered']]

UpdateGroupRequest

GroupName

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

RoleArn

  • Type: typing.Optional[str]

Precedence

  • Type: typing.Optional[int]

UpdateGroupResponse

Group

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateIdentityProviderRequest

UserPoolId

  • Type:
  • Required: Yes

ProviderName

  • Type:
  • Required: Yes

ProviderDetails

  • Type: typing.Optional[typing.Dict[str, str]]

AttributeMapping

  • Type: typing.Optional[typing.Dict[str, str]]

IdpIdentifiers

  • Type: typing.Optional[typing.List[str]]

UpdateIdentityProviderResponse

IdentityProvider

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateManagedLoginBrandingRequest

UserPoolId

  • Type: typing.Optional[str]

ManagedLoginBrandingId

  • Type: typing.Optional[str]

UseCognitoProvidedValues

  • Type: typing.Optional[bool]

Settings

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

Assets

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AssetType, aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AssetTypeOutput]]]

UpdateManagedLoginBrandingResponse

ManagedLoginBranding

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateResourceServerRequest

UserPoolId

  • Type:
  • Required: Yes

Identifier

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Scopes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.ResourceServerScopeType]]

UpdateResourceServerResponse

ResourceServer

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateUserAttributesRequest

UserAttributes

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AttributeType]
  • Required: Yes

AccessToken

  • Type:
  • Required: Yes

ClientMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

UpdateUserAttributesResponse

CodeDeliveryDetailsList

  • Type: typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.CodeDeliveryDetailsType]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateUserPoolClientRequest

UserPoolId

  • Type:
  • Required: Yes

ClientId

  • Type:
  • Required: Yes

ClientName

  • Type: typing.Optional[str]

RefreshTokenValidity

  • Type: typing.Optional[int]

AccessTokenValidity

  • Type: typing.Optional[int]

IdTokenValidity

  • Type: typing.Optional[int]

TokenValidityUnits

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.TokenValidityUnitsType]

ReadAttributes

  • Type: typing.Optional[typing.List[str]]

WriteAttributes

  • Type: typing.Optional[typing.List[str]]

ExplicitAuthFlows

  • Type: typing.Optional[typing.List[typing.Literal['ADMIN_NO_SRP_AUTH', 'ALLOW_ADMIN_USER_PASSWORD_AUTH', 'ALLOW_CUSTOM_AUTH', 'ALLOW_REFRESH_TOKEN_AUTH', 'ALLOW_USER_AUTH', 'ALLOW_USER_PASSWORD_AUTH', 'ALLOW_USER_SRP_AUTH', 'CUSTOM_AUTH_FLOW_ONLY', 'USER_PASSWORD_AUTH']]]

SupportedIdentityProviders

  • Type: typing.Optional[typing.List[str]]

CallbackURLs

  • Type: typing.Optional[typing.List[str]]

LogoutURLs

  • Type: typing.Optional[typing.List[str]]

DefaultRedirectURI

  • Type: typing.Optional[str]

AllowedOAuthFlows

  • Type: typing.Optional[typing.List[typing.Literal['client_credentials', 'code', 'implicit']]]

AllowedOAuthScopes

  • Type: typing.Optional[typing.List[str]]

AllowedOAuthFlowsUserPoolClient

  • Type: typing.Optional[bool]

AnalyticsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsConfigurationType]

PreventUserExistenceErrors

  • Type: typing.Optional[typing.Literal['ENABLED', 'LEGACY']]

EnableTokenRevocation

  • Type: typing.Optional[bool]

EnablePropagateAdditionalUserContextData

  • Type: typing.Optional[bool]

AuthSessionValidity

  • Type: typing.Optional[int]

UpdateUserPoolClientResponse

UserPoolClient

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateUserPoolDomainRequest

Domain

  • Type:
  • Required: Yes

UserPoolId

  • Type:
  • Required: Yes

ManagedLoginVersion

  • Type: typing.Optional[int]

CustomDomainConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.CustomDomainConfigType]

UpdateUserPoolDomainResponse

ManagedLoginVersion

  • Type:
  • Required: Yes

CloudFrontDomain

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateUserPoolRequest

UserPoolId

  • Type:
  • Required: Yes

Policies

  • Type: typing.Union[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserPoolPolicyType, aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserPoolPolicyTypeOutput, NoneType]

DeletionProtection

  • Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]

LambdaConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.LambdaConfigType]

AutoVerifiedAttributes

  • Type: typing.Optional[typing.List[typing.Literal['email', 'phone_number']]]

SmsVerificationMessage

  • Type: typing.Optional[str]

EmailVerificationMessage

  • Type: typing.Optional[str]

EmailVerificationSubject

  • Type: typing.Optional[str]

VerificationMessageTemplate

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.VerificationMessageTemplateType]

SmsAuthenticationMessage

  • Type: typing.Optional[str]

UserAttributeUpdateSettings

  • Type: typing.Union[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserAttributeUpdateSettingsType, aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserAttributeUpdateSettingsTypeOutput, NoneType]

MfaConfiguration

  • Type: typing.Optional[typing.Literal['OFF', 'ON', 'OPTIONAL']]

DeviceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.DeviceConfigurationType]

EmailConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.EmailConfigurationType]

SmsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SmsConfigurationType]

UserPoolTags

  • Type: typing.Optional[typing.Dict[str, str]]

AdminCreateUserConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AdminCreateUserConfigType]

UserPoolAddOns

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserPoolAddOnsType]

AccountRecoverySetting

  • Type: typing.Union[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AccountRecoverySettingType, aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AccountRecoverySettingTypeOutput, NoneType]

PoolName

  • Type: typing.Optional[str]

UserPoolTier

  • Type: typing.Optional[typing.Literal['ESSENTIALS', 'LITE', 'PLUS']]

UserAttributeUpdateSettingsType

AttributesRequireVerificationBeforeUpdate

  • Type: typing.Optional[typing.List[typing.Literal['email', 'phone_number']]]

UserAttributeUpdateSettingsTypeOutput

AttributesRequireVerificationBeforeUpdate

  • Type: typing.Optional[typing.List[typing.Literal['email', 'phone_number']]]

UserContextDataType

IpAddress

  • Type: typing.Optional[str]

EncodedData

  • Type: typing.Optional[str]

UserImportJobType

JobName

  • Type: typing.Optional[str]

JobId

  • Type: typing.Optional[str]

UserPoolId

  • Type: typing.Optional[str]

PreSignedUrl

  • Type: typing.Optional[str]

CreationDate

  • Type: typing.Optional[datetime.datetime]

StartDate

  • Type: typing.Optional[datetime.datetime]

CompletionDate

  • Type: typing.Optional[datetime.datetime]

Status

  • Type: typing.Optional[typing.Literal['Created', 'Expired', 'Failed', 'InProgress', 'Pending', 'Stopped', 'Stopping', 'Succeeded']]

CloudWatchLogsRoleArn

  • Type: typing.Optional[str]

ImportedUsers

  • Type: typing.Optional[int]

SkippedUsers

  • Type: typing.Optional[int]

FailedUsers

  • Type: typing.Optional[int]

CompletionMessage

  • Type: typing.Optional[str]

UserPoolAddOnsType

AdvancedSecurityMode

  • Type: typing.Literal['AUDIT', 'ENFORCED', 'OFF']
  • Required: Yes

AdvancedSecurityAdditionalFlows

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AdvancedSecurityAdditionalFlowsType]

UserPoolClientDescription

ClientId

  • Type: typing.Optional[str]

UserPoolId

  • Type: typing.Optional[str]

ClientName

  • Type: typing.Optional[str]

UserPoolClientType

UserPoolId

  • Type: typing.Optional[str]

ClientName

  • Type: typing.Optional[str]

ClientId

  • Type: typing.Optional[str]

ClientSecret

  • Type: typing.Optional[str]

LastModifiedDate

  • Type: typing.Optional[datetime.datetime]

CreationDate

  • Type: typing.Optional[datetime.datetime]

RefreshTokenValidity

  • Type: typing.Optional[int]

AccessTokenValidity

  • Type: typing.Optional[int]

IdTokenValidity

  • Type: typing.Optional[int]

TokenValidityUnits

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.TokenValidityUnitsType]

ReadAttributes

  • Type: typing.Optional[typing.List[str]]

WriteAttributes

  • Type: typing.Optional[typing.List[str]]

ExplicitAuthFlows

  • Type: typing.Optional[typing.List[typing.Literal['ADMIN_NO_SRP_AUTH', 'ALLOW_ADMIN_USER_PASSWORD_AUTH', 'ALLOW_CUSTOM_AUTH', 'ALLOW_REFRESH_TOKEN_AUTH', 'ALLOW_USER_AUTH', 'ALLOW_USER_PASSWORD_AUTH', 'ALLOW_USER_SRP_AUTH', 'CUSTOM_AUTH_FLOW_ONLY', 'USER_PASSWORD_AUTH']]]

SupportedIdentityProviders

  • Type: typing.Optional[typing.List[str]]

CallbackURLs

  • Type: typing.Optional[typing.List[str]]

LogoutURLs

  • Type: typing.Optional[typing.List[str]]

DefaultRedirectURI

  • Type: typing.Optional[str]

AllowedOAuthFlows

  • Type: typing.Optional[typing.List[typing.Literal['client_credentials', 'code', 'implicit']]]

AllowedOAuthScopes

  • Type: typing.Optional[typing.List[str]]

AllowedOAuthFlowsUserPoolClient

  • Type: typing.Optional[bool]

AnalyticsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AnalyticsConfigurationType]

PreventUserExistenceErrors

  • Type: typing.Optional[typing.Literal['ENABLED', 'LEGACY']]

EnableTokenRevocation

  • Type: typing.Optional[bool]

EnablePropagateAdditionalUserContextData

  • Type: typing.Optional[bool]

AuthSessionValidity

  • Type: typing.Optional[int]

UserPoolDescriptionType

Id

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

LambdaConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.LambdaConfigType]

Status

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

LastModifiedDate

  • Type: typing.Optional[datetime.datetime]

CreationDate

  • Type: typing.Optional[datetime.datetime]

UserPoolPolicyType

PasswordPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PasswordPolicyType]

SignInPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SignInPolicyType]

UserPoolPolicyTypeOutput

PasswordPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.PasswordPolicyType]

SignInPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SignInPolicyTypeOutput]

UserPoolType

Id

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Policies

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserPoolPolicyTypeOutput]

DeletionProtection

  • Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]

LambdaConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.LambdaConfigType]

Status

  • Type: typing.Optional[typing.Literal['Disabled', 'Enabled']]

LastModifiedDate

  • Type: typing.Optional[datetime.datetime]

CreationDate

  • Type: typing.Optional[datetime.datetime]

SchemaAttributes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SchemaAttributeType]]

AutoVerifiedAttributes

  • Type: typing.Optional[typing.List[typing.Literal['email', 'phone_number']]]

AliasAttributes

  • Type: typing.Optional[typing.List[typing.Literal['email', 'phone_number', 'preferred_username']]]

UsernameAttributes

  • Type: typing.Optional[typing.List[typing.Literal['email', 'phone_number']]]

SmsVerificationMessage

  • Type: typing.Optional[str]

EmailVerificationMessage

  • Type: typing.Optional[str]

EmailVerificationSubject

  • Type: typing.Optional[str]

VerificationMessageTemplate

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.VerificationMessageTemplateType]

SmsAuthenticationMessage

  • Type: typing.Optional[str]

UserAttributeUpdateSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserAttributeUpdateSettingsTypeOutput]

MfaConfiguration

  • Type: typing.Optional[typing.Literal['OFF', 'ON', 'OPTIONAL']]

DeviceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.DeviceConfigurationType]

EstimatedNumberOfUsers

  • Type: typing.Optional[int]

EmailConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.EmailConfigurationType]

SmsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.SmsConfigurationType]

UserPoolTags

  • Type: typing.Optional[typing.Dict[str, str]]

SmsConfigurationFailure

  • Type: typing.Optional[str]

EmailConfigurationFailure

  • Type: typing.Optional[str]

Domain

  • Type: typing.Optional[str]

CustomDomain

  • Type: typing.Optional[str]

AdminCreateUserConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AdminCreateUserConfigType]

UserPoolAddOns

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UserPoolAddOnsType]

UsernameConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.UsernameConfigurationType]

Arn

  • Type: typing.Optional[str]

AccountRecoverySetting

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AccountRecoverySettingTypeOutput]

UserPoolTier

  • Type: typing.Optional[typing.Literal['ESSENTIALS', 'LITE', 'PLUS']]

UserType

Username

  • Type: typing.Optional[str]

Attributes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.AttributeType]]

UserCreateDate

  • Type: typing.Optional[datetime.datetime]

UserLastModifiedDate

  • Type: typing.Optional[datetime.datetime]

Enabled

  • Type: typing.Optional[bool]

UserStatus

  • Type: typing.Optional[typing.Literal['ARCHIVED', 'COMPROMISED', 'CONFIRMED', 'EXTERNAL_PROVIDER', 'FORCE_CHANGE_PASSWORD', 'RESET_REQUIRED', 'UNCONFIRMED', 'UNKNOWN']]

MFAOptions

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.cognito_idp.cognito_idp_classes.MFAOptionType]]

UsernameConfigurationType

CaseSensitive

  • Type:
  • Required: Yes

VerificationMessageTemplateType

SmsMessage

  • Type: typing.Optional[str]

EmailMessage

  • Type: typing.Optional[str]

EmailSubject

  • Type: typing.Optional[str]
  • Type: typing.Optional[str]
  • Type: typing.Optional[str]

DefaultEmailOption

  • Type: typing.Optional[typing.Literal['CONFIRM_WITH_CODE', 'CONFIRM_WITH_LINK']]

VerifySoftwareTokenRequest

UserCode

  • Type:
  • Required: Yes

AccessToken

  • Type: typing.Optional[str]

Session

  • Type: typing.Optional[str]

FriendlyDeviceName

  • Type: typing.Optional[str]

VerifySoftwareTokenResponse

Status

  • Type: typing.Literal['ERROR', 'SUCCESS']
  • Required: Yes

Session

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

VerifyUserAttributeRequest

AccessToken

  • Type:
  • Required: Yes

AttributeName

  • Type:
  • Required: Yes

Code

  • Type:
  • Required: Yes

WebAuthnConfigurationType

RelyingPartyId

  • Type: typing.Optional[str]

UserVerification

  • Type: typing.Optional[typing.Literal['preferred', 'required']]

WebAuthnCredentialDescription

CredentialId

  • Type:
  • Required: Yes

FriendlyCredentialName

  • Type:
  • Required: Yes

RelyingPartyId

  • Type:
  • Required: Yes

AuthenticatorTransports

  • Type: typing.List[str]
  • Required: Yes

CreatedAt

  • Type:
  • Required: Yes

AuthenticatorAttachment

  • Type: typing.Optional[str]