AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccountTakeoverActionsType

Account takeover actions type.

Class AccountTakeoverActionType

Account takeover action type.

Class AccountTakeoverRiskConfigurationType

Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.

Class AddCustomAttributesRequest

Container for the parameters to the AddCustomAttributes operation. Adds additional user attributes to the user pool schema.

Class AddCustomAttributesResponse

Represents the response from the server for the request to add custom attributes.

Class AdminAddUserToGroupRequest

Container for the parameters to the AdminAddUserToGroup operation. Adds the specified user to the specified group.

Requires developer credentials.

Class AdminAddUserToGroupResponse

This is the response object from the AdminAddUserToGroup operation.

Class AdminConfirmSignUpRequest

Container for the parameters to the AdminConfirmSignUp operation. Confirms user registration as an admin without using a confirmation code. Works on any user.

Requires developer credentials.

Class AdminConfirmSignUpResponse

Represents the response from the server for the request to confirm registration.

Class AdminCreateUserConfigType

The configuration for creating a new user profile.

Class AdminCreateUserRequest

Container for the parameters to the AdminCreateUser operation. Creates a new user in the specified user pool.

If MessageAction is not set, the default is to send a welcome message via email or phone (SMS).

This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email.

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.

AdminCreateUser requires developer credentials.

Class AdminCreateUserResponse

Represents the response from the server to the request to create the user.

Class AdminDeleteUserAttributesRequest

Container for the parameters to the AdminDeleteUserAttributes operation. Deletes the user attributes in a user pool as an administrator. Works on any user.

Requires developer credentials.

Class AdminDeleteUserAttributesResponse

Represents the response received from the server for a request to delete user attributes.

Class AdminDeleteUserRequest

Container for the parameters to the AdminDeleteUser operation. Deletes a user as an administrator. Works on any user.

Requires developer credentials.

Class AdminDeleteUserResponse

This is the response object from the AdminDeleteUser operation.

Class AdminDisableProviderForUserRequest

Container for the parameters to the AdminDisableProviderForUser operation. Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See .

This action is enabled only for admin access and requires developer credentials.

The ProviderName must match the value specified when creating an IdP for the pool.

To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user.

The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.

Class AdminDisableProviderForUserResponse

This is the response object from the AdminDisableProviderForUser operation.

Class AdminDisableUserRequest

Container for the parameters to the AdminDisableUser operation. Disables the specified user as an administrator. Works on any user.

Requires developer credentials.

Class AdminDisableUserResponse

Represents the response received from the server to disable the user as an administrator.

Class AdminEnableUserRequest

Container for the parameters to the AdminEnableUser operation. Enables the specified user as an administrator. Works on any user.

Requires developer credentials.

Class AdminEnableUserResponse

Represents the response from the server for the request to enable a user as an administrator.

Class AdminForgetDeviceRequest

Container for the parameters to the AdminForgetDevice operation. Forgets the device, as an administrator.

Requires developer credentials.

Class AdminForgetDeviceResponse

This is the response object from the AdminForgetDevice operation.

Class AdminGetDeviceRequest

Container for the parameters to the AdminGetDevice operation. Gets the device, as an administrator.

Requires developer credentials.

Class AdminGetDeviceResponse

Gets the device response, as an administrator.

Class AdminGetUserRequest

Container for the parameters to the AdminGetUser operation. Gets the specified user by user name in a user pool as an administrator. Works on any user.

Requires developer credentials.

Class AdminGetUserResponse

Represents the response from the server from the request to get the specified user as an administrator.

Class AdminInitiateAuthRequest

Container for the parameters to the AdminInitiateAuth operation. Initiates the authentication flow, as an administrator.

Requires developer credentials.

Class AdminInitiateAuthResponse

Initiates the authentication response, as an administrator.

Class AdminLinkProviderForUserRequest

Container for the parameters to the AdminLinkProviderForUser operation. Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account.

For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.

Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.

See also .

This action is enabled only for admin access and requires developer credentials.

Class AdminLinkProviderForUserResponse

This is the response object from the AdminLinkProviderForUser operation.

Class AdminListDevicesRequest

Container for the parameters to the AdminListDevices operation. Lists devices, as an administrator.

Requires developer credentials.

Class AdminListDevicesResponse

Lists the device's response, as an administrator.

Class AdminListGroupsForUserRequest

Container for the parameters to the AdminListGroupsForUser operation. Lists the groups that the user belongs to.

Requires developer credentials.

Class AdminListGroupsForUserResponse

This is the response object from the AdminListGroupsForUser operation.

Class AdminListUserAuthEventsRequest

Container for the parameters to the AdminListUserAuthEvents operation. Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.

Class AdminListUserAuthEventsResponse

This is the response object from the AdminListUserAuthEvents operation.

Class AdminRemoveUserFromGroupRequest

Container for the parameters to the AdminRemoveUserFromGroup operation. Removes the specified user from the specified group.

Requires developer credentials.

Class AdminRemoveUserFromGroupResponse

This is the response object from the AdminRemoveUserFromGroup operation.

Class AdminResetUserPasswordRequest

Container for the parameters to the AdminResetUserPassword operation. Resets the specified user's password in a user pool as an administrator. Works on any user.

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

Requires developer credentials.

Class AdminResetUserPasswordResponse

Represents the response from the server to reset a user password as an administrator.

Class AdminRespondToAuthChallengeRequest

Container for the parameters to the AdminRespondToAuthChallenge operation. Responds to an authentication challenge, as an administrator.

Requires developer credentials.

Class AdminRespondToAuthChallengeResponse

Responds to the authentication challenge, as an administrator.

Class AdminSetUserMFAPreferenceRequest

Container for the parameters to the AdminSetUserMFAPreference operation. Sets the user's multi-factor authentication (MFA) preference.

Class AdminSetUserMFAPreferenceResponse

This is the response object from the AdminSetUserMFAPreference operation.

Class AdminSetUserSettingsRequest

Container for the parameters to the AdminSetUserSettings operation. Sets all the user settings for a specified user name. Works on any user.

Requires developer credentials.

Class AdminSetUserSettingsResponse

Represents the response from the server to set user settings as an administrator.

Class AdminUpdateAuthEventFeedbackRequest

Container for the parameters to the AdminUpdateAuthEventFeedback operation. Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

Class AdminUpdateAuthEventFeedbackResponse

This is the response object from the AdminUpdateAuthEventFeedback operation.

Class AdminUpdateDeviceStatusRequest

Container for the parameters to the AdminUpdateDeviceStatus operation. Updates the device status as an administrator.

Requires developer credentials.

Class AdminUpdateDeviceStatusResponse

The status response from the request to update the device, as an administrator.

Class AdminUpdateUserAttributesRequest

Container for the parameters to the AdminUpdateUserAttributes operation. Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

For custom attributes, you must prepend the custom: prefix to the attribute name.

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

Requires developer credentials.

Class AdminUpdateUserAttributesResponse

Represents the response from the server for the request to update user attributes as an administrator.

Class AdminUserGlobalSignOutRequest

Container for the parameters to the AdminUserGlobalSignOut operation. Signs out users from all devices, as an administrator.

Requires developer credentials.

Class AdminUserGlobalSignOutResponse

The global sign-out response, as an administrator.

Class AliasExistsException

CognitoIdentityProvider exception

Class AnalyticsConfigurationType

The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.

Class AnalyticsMetadataType

An Amazon Pinpoint analytics endpoint.

An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.

Class AssociateSoftwareTokenRequest

Container for the parameters to the AssociateSoftwareToken operation. Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.

Class AssociateSoftwareTokenResponse

This is the response object from the AssociateSoftwareToken operation.

Class AttributeType

Specifies whether the attribute is standard or custom.

Class AuthenticationResultType

The authentication result.

Class AuthEventType

The authentication event type.

Class ChallengeResponseType

The challenge response type.

Class ChangePasswordRequest

Container for the parameters to the ChangePassword operation. Changes the password for a specified user in a user pool.

Class ChangePasswordResponse

The response from the server to the change password request.

Class CodeDeliveryDetailsType

The code delivery details being returned from the server.

Class CodeDeliveryFailureException

CognitoIdentityProvider exception

Class CodeMismatchException

CognitoIdentityProvider exception

Class CompromisedCredentialsActionsType

The compromised credentials actions type

Class CompromisedCredentialsRiskConfigurationType

The compromised credentials risk configuration type.

Class ConcurrentModificationException

CognitoIdentityProvider exception

Class ConfirmDeviceRequest

Container for the parameters to the ConfirmDevice operation. Confirms tracking of the device. This API call is the call that begins device tracking.

Class ConfirmDeviceResponse

Confirms the device response.

Class ConfirmForgotPasswordRequest

Container for the parameters to the ConfirmForgotPassword operation. Allows a user to enter a confirmation code to reset a forgotten password.

Class ConfirmForgotPasswordResponse

The response from the server that results from a user's request to retrieve a forgotten password.

Class ConfirmSignUpRequest

Container for the parameters to the ConfirmSignUp operation. Confirms registration of a user and handles the existing alias from a previous user.

Class ConfirmSignUpResponse

Represents the response from the server for the registration confirmation.

Class ContextDataType

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Class CreateGroupRequest

Container for the parameters to the CreateGroup operation. Creates a new group in the specified user pool.

Requires developer credentials.

Class CreateGroupResponse

This is the response object from the CreateGroup operation.

Class CreateIdentityProviderRequest

Container for the parameters to the CreateIdentityProvider operation. Creates an identity provider for a user pool.

Class CreateIdentityProviderResponse

This is the response object from the CreateIdentityProvider operation.

Class CreateResourceServerRequest

Container for the parameters to the CreateResourceServer operation. Creates a new OAuth2.0 resource server and defines custom scopes in it.

Class CreateResourceServerResponse

This is the response object from the CreateResourceServer operation.

Class CreateUserImportJobRequest

Container for the parameters to the CreateUserImportJob operation. Creates the user import job.

Class CreateUserImportJobResponse

Represents the response from the server to the request to create the user import job.

Class CreateUserPoolClientRequest

Container for the parameters to the CreateUserPoolClient operation. Creates the user pool client.

Class CreateUserPoolClientResponse

Represents the response from the server to create a user pool client.

Class CreateUserPoolDomainRequest

Container for the parameters to the CreateUserPoolDomain operation. Creates a new domain for a user pool.

Class CreateUserPoolDomainResponse

This is the response object from the CreateUserPoolDomain operation.

Class CreateUserPoolRequest

Container for the parameters to the CreateUserPool operation. Creates a new Amazon Cognito user pool and sets the password policy for the pool.

Class CreateUserPoolResponse

Represents the response from the server for the request to create a user pool.

Class DeleteGroupRequest

Container for the parameters to the DeleteGroup operation. Deletes a group. Currently only groups with no members can be deleted.

Requires developer credentials.

Class DeleteGroupResponse

This is the response object from the DeleteGroup operation.

Class DeleteIdentityProviderRequest

Container for the parameters to the DeleteIdentityProvider operation. Deletes an identity provider for a user pool.

Class DeleteIdentityProviderResponse

This is the response object from the DeleteIdentityProvider operation.

Class DeleteResourceServerRequest

Container for the parameters to the DeleteResourceServer operation. Deletes a resource server.

Class DeleteResourceServerResponse

This is the response object from the DeleteResourceServer operation.

Class DeleteUserAttributesRequest

Container for the parameters to the DeleteUserAttributes operation. Deletes the attributes for a user.

Class DeleteUserAttributesResponse

Represents the response from the server to delete user attributes.

Class DeleteUserPoolClientRequest

Container for the parameters to the DeleteUserPoolClient operation. Allows the developer to delete the user pool client.

Class DeleteUserPoolClientResponse

This is the response object from the DeleteUserPoolClient operation.

Class DeleteUserPoolDomainRequest

Container for the parameters to the DeleteUserPoolDomain operation. Deletes a domain for a user pool.

Class DeleteUserPoolDomainResponse

This is the response object from the DeleteUserPoolDomain operation.

Class DeleteUserPoolRequest

Container for the parameters to the DeleteUserPool operation. Deletes the specified Amazon Cognito user pool.

Class DeleteUserPoolResponse

This is the response object from the DeleteUserPool operation.

Class DeleteUserRequest

Container for the parameters to the DeleteUser operation. Allows a user to delete himself or herself.

Class DeleteUserResponse

This is the response object from the DeleteUser operation.

Class DescribeIdentityProviderRequest

Container for the parameters to the DescribeIdentityProvider operation. Gets information about a specific identity provider.

Class DescribeIdentityProviderResponse

This is the response object from the DescribeIdentityProvider operation.

Class DescribeResourceServerRequest

Container for the parameters to the DescribeResourceServer operation. Describes a resource server.

Class DescribeResourceServerResponse

This is the response object from the DescribeResourceServer operation.

Class DescribeRiskConfigurationRequest

Container for the parameters to the DescribeRiskConfiguration operation. Describes the risk configuration.

Class DescribeRiskConfigurationResponse

This is the response object from the DescribeRiskConfiguration operation.

Class DescribeUserImportJobRequest

Container for the parameters to the DescribeUserImportJob operation. Describes the user import job.

Class DescribeUserImportJobResponse

Represents the response from the server to the request to describe the user import job.

Class DescribeUserPoolClientRequest

Container for the parameters to the DescribeUserPoolClient operation. Client method for returning the configuration information and metadata of the specified user pool client.

Class DescribeUserPoolClientResponse

Represents the response from the server from a request to describe the user pool client.

Class DescribeUserPoolDomainRequest

Container for the parameters to the DescribeUserPoolDomain operation. Gets information about a domain.

Class DescribeUserPoolDomainResponse

This is the response object from the DescribeUserPoolDomain operation.

Class DescribeUserPoolRequest

Container for the parameters to the DescribeUserPool operation. Returns the configuration information and metadata of the specified user pool.

Class DescribeUserPoolResponse

Represents the response to describe the user pool.

Class DeviceConfigurationType

The configuration for the user pool's device tracking.

Class DeviceSecretVerifierConfigType

The device verifier against which it will be authenticated.

Class DeviceType

The device type.

Class DomainDescriptionType

A container for information about a domain.

Class DuplicateProviderException

CognitoIdentityProvider exception

Class EmailConfigurationType

The email configuration type.

Class EnableSoftwareTokenMFAException

CognitoIdentityProvider exception

Class EventContextDataType

Specifies the user context data captured at the time of an event request.

Class EventFeedbackType

Specifies the event feedback type.

Class EventRiskType

The event risk type.

Class ExpiredCodeException

CognitoIdentityProvider exception

Class ForgetDeviceRequest

Container for the parameters to the ForgetDevice operation. Forgets the specified device.

Class ForgetDeviceResponse

This is the response object from the ForgetDevice operation.

Class ForgotPasswordRequest

Container for the parameters to the ForgotPassword operation. Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .

Class ForgotPasswordResponse

Respresents the response from the server regarding the request to reset a password.

Class GetCSVHeaderRequest

Container for the parameters to the GetCSVHeader operation. Gets the header information for the .csv file to be used as input for the user import job.

Class GetCSVHeaderResponse

Represents the response from the server to the request to get the header information for the .csv file for the user import job.

Class GetDeviceRequest

Container for the parameters to the GetDevice operation. Gets the device.

Class GetDeviceResponse

Gets the device response.

Class GetGroupRequest

Container for the parameters to the GetGroup operation. Gets a group.

Requires developer credentials.

Class GetGroupResponse

This is the response object from the GetGroup operation.

Class GetIdentityProviderByIdentifierRequest

Container for the parameters to the GetIdentityProviderByIdentifier operation. Gets the specified identity provider.

Class GetIdentityProviderByIdentifierResponse

This is the response object from the GetIdentityProviderByIdentifier operation.

Class GetUICustomizationRequest

Container for the parameters to the GetUICustomization operation. Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned.

Class GetUICustomizationResponse

This is the response object from the GetUICustomization operation.

Class GetUserAttributeVerificationCodeRequest

Container for the parameters to the GetUserAttributeVerificationCode operation. Gets the user attribute verification code for the specified attribute name.

Class GetUserAttributeVerificationCodeResponse

The verification code response returned by the server response to get the user attribute verification code.

Class GetUserPoolMfaConfigRequest

Container for the parameters to the GetUserPoolMfaConfig operation. Gets the user pool multi-factor authentication (MFA) configuration.

Class GetUserPoolMfaConfigResponse

This is the response object from the GetUserPoolMfaConfig operation.

Class GetUserRequest

Container for the parameters to the GetUser operation. Gets the user attributes and metadata for a user.

Class GetUserResponse

Represents the response from the server from the request to get information about the user.

Class GlobalSignOutRequest

Container for the parameters to the GlobalSignOut operation. Signs out users from all devices.

Class GlobalSignOutResponse

The response to the request to sign out all devices.

Class GroupExistsException

CognitoIdentityProvider exception

Class GroupType

The group type.

Class HttpHeader

The HTTP header.

Class IdentityProviderType

A container for information about an identity provider.

Class InitiateAuthRequest

Container for the parameters to the InitiateAuth operation. Initiates the authentication flow.

Class InitiateAuthResponse

Initiates the authentication response.

Class InternalErrorException

CognitoIdentityProvider exception

Class InvalidEmailRoleAccessPolicyException

CognitoIdentityProvider exception

Class InvalidLambdaResponseException

CognitoIdentityProvider exception

Class InvalidOAuthFlowException

CognitoIdentityProvider exception

Class InvalidParameterException

CognitoIdentityProvider exception

Class InvalidPasswordException

CognitoIdentityProvider exception

Class InvalidSmsRoleAccessPolicyException

CognitoIdentityProvider exception

Class InvalidSmsRoleTrustRelationshipException

CognitoIdentityProvider exception

Class InvalidUserPoolConfigurationException

CognitoIdentityProvider exception

Class LambdaConfigType

Specifies the configuration for AWS Lambda triggers.

Class LimitExceededException

CognitoIdentityProvider exception

Class ListDevicesRequest

Container for the parameters to the ListDevices operation. Lists the devices.

Class ListDevicesResponse

Represents the response to list devices.

Class ListGroupsRequest

Container for the parameters to the ListGroups operation. Lists the groups associated with a user pool.

Requires developer credentials.

Class ListGroupsResponse

This is the response object from the ListGroups operation.

Class ListIdentityProvidersRequest

Container for the parameters to the ListIdentityProviders operation. Lists information about all identity providers for a user pool.

Class ListIdentityProvidersResponse

This is the response object from the ListIdentityProviders operation.

Class ListResourceServersRequest

Container for the parameters to the ListResourceServers operation. Lists the resource servers for a user pool.

Class ListResourceServersResponse

This is the response object from the ListResourceServers operation.

Class ListUserImportJobsRequest

Container for the parameters to the ListUserImportJobs operation. Lists the user import jobs.

Class ListUserImportJobsResponse

Represents the response from the server to the request to list the user import jobs.

Class ListUserPoolClientsRequest

Container for the parameters to the ListUserPoolClients operation. Lists the clients that have been created for the specified user pool.

Class ListUserPoolClientsResponse

Represents the response from the server that lists user pool clients.

Class ListUserPoolsRequest

Container for the parameters to the ListUserPools operation. Lists the user pools associated with an AWS account.

Class ListUserPoolsResponse

Represents the response to list user pools.

Class ListUsersInGroupRequest

Container for the parameters to the ListUsersInGroup operation. Lists the users in the specified group.

Requires developer credentials.

Class ListUsersInGroupResponse

This is the response object from the ListUsersInGroup operation.

Class ListUsersRequest

Container for the parameters to the ListUsers operation. Lists the users in the Amazon Cognito user pool.

Class ListUsersResponse

The response from the request to list users.

Class MessageTemplateType

The message template structure.

Class MFAMethodNotFoundException

CognitoIdentityProvider exception

Class MFAOptionType

Specifies the different settings for multi-factor authentication (MFA).

Class NewDeviceMetadataType

The new device metadata type.

Class NotAuthorizedException

CognitoIdentityProvider exception

Class NotifyConfigurationType

The notify configuration type.

Class NotifyEmailType

The notify email type.

Class NumberAttributeConstraintsType

The minimum and maximum value of an attribute that is of the number data type.

Class PasswordPolicyType

The password policy type.

Class PasswordResetRequiredException

CognitoIdentityProvider exception

Class PreconditionNotMetException

CognitoIdentityProvider exception

Class ProviderDescription

A container for identity provider details.

Class ProviderUserIdentifierType

A container for information about an identity provider for a user pool.

Class ResendConfirmationCodeRequest

Container for the parameters to the ResendConfirmationCode operation. Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

Class ResendConfirmationCodeResponse

The response from the server when the Amazon Cognito Your User Pools service makes the request to resend a confirmation code.

Class ResourceNotFoundException

CognitoIdentityProvider exception

Class ResourceServerScopeType

A resource server scope.

Class ResourceServerType

A container for information about a resource server for a user pool.

Class RespondToAuthChallengeRequest

Container for the parameters to the RespondToAuthChallenge operation. Responds to the authentication challenge.

Class RespondToAuthChallengeResponse

The response to respond to the authentication challenge.

Class RiskConfigurationType

The risk configuration type.

Class RiskExceptionConfigurationType

The type of the configuration to override the risk decision.

Class SchemaAttributeType

Contains information about the schema attribute.

Class ScopeDoesNotExistException

CognitoIdentityProvider exception

Class SetRiskConfigurationRequest

Container for the parameters to the SetRiskConfiguration operation. Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.

To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.

See .

Class SetRiskConfigurationResponse

This is the response object from the SetRiskConfiguration operation.

Class SetUICustomizationRequest

Container for the parameters to the SetUICustomization operation. Sets the UI customization information for a user pool's built-in app UI.

You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration.

To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.

Class SetUICustomizationResponse

This is the response object from the SetUICustomization operation.

Class SetUserMFAPreferenceRequest

Container for the parameters to the SetUserMFAPreference operation. Set the user's multi-factor authentication (MFA) method preference.

Class SetUserMFAPreferenceResponse

This is the response object from the SetUserMFAPreference operation.

Class SetUserPoolMfaConfigRequest

Container for the parameters to the SetUserPoolMfaConfig operation. Set the user pool MFA configuration.

Class SetUserPoolMfaConfigResponse

This is the response object from the SetUserPoolMfaConfig operation.

Class SetUserSettingsRequest

Container for the parameters to the SetUserSettings operation. Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.

Class SetUserSettingsResponse

The response from the server for a set user settings request.

Class SignUpRequest

Container for the parameters to the SignUp operation. Registers the user in the specified user pool and creates a user name, password, and user attributes.

Class SignUpResponse

The response from the server for a registration request.

Class SmsConfigurationType

The SMS configuration type.

Class SmsMfaConfigType

The SMS text message multi-factor authentication (MFA) configuration type.

Class SMSMfaSettingsType

The SMS multi-factor authentication (MFA) settings type.

Class SoftwareTokenMfaConfigType

The type used for enabling software token MFA at the user pool level.

Class SoftwareTokenMFANotFoundException

CognitoIdentityProvider exception

Class SoftwareTokenMfaSettingsType

The type used for enabling software token MFA at the user level.

Class StartUserImportJobRequest

Container for the parameters to the StartUserImportJob operation. Starts the user import.

Class StartUserImportJobResponse

Represents the response from the server to the request to start the user import job.

Class StopUserImportJobRequest

Container for the parameters to the StopUserImportJob operation. Stops the user import job.

Class StopUserImportJobResponse

Represents the response from the server to the request to stop the user import job.

Class StringAttributeConstraintsType

The constraints associated with a string attribute.

Class TooManyFailedAttemptsException

CognitoIdentityProvider exception

Class TooManyRequestsException

CognitoIdentityProvider exception

Class UICustomizationType

A container for the UI customization information for a user pool's built-in app UI.

Class UnexpectedLambdaException

CognitoIdentityProvider exception

Class UnsupportedIdentityProviderException

CognitoIdentityProvider exception

Class UnsupportedUserStateException

CognitoIdentityProvider exception

Class UpdateAuthEventFeedbackRequest

Container for the parameters to the UpdateAuthEventFeedback operation. Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

Class UpdateAuthEventFeedbackResponse

This is the response object from the UpdateAuthEventFeedback operation.

Class UpdateDeviceStatusRequest

Container for the parameters to the UpdateDeviceStatus operation. Updates the device status.

Class UpdateDeviceStatusResponse

The response to the request to update the device status.

Class UpdateGroupRequest

Container for the parameters to the UpdateGroup operation. Updates the specified group with the specified attributes.

Requires developer credentials.

Class UpdateGroupResponse

This is the response object from the UpdateGroup operation.

Class UpdateIdentityProviderRequest

Container for the parameters to the UpdateIdentityProvider operation. Updates identity provider information for a user pool.

Class UpdateIdentityProviderResponse

This is the response object from the UpdateIdentityProvider operation.

Class UpdateResourceServerRequest

Container for the parameters to the UpdateResourceServer operation. Updates the name and scopes of resource server. All other fields are read-only.

Class UpdateResourceServerResponse

This is the response object from the UpdateResourceServer operation.

Class UpdateUserAttributesRequest

Container for the parameters to the UpdateUserAttributes operation. Allows a user to update a specific attribute (one at a time).

Class UpdateUserAttributesResponse

Represents the response from the server for the request to update user attributes.

Class UpdateUserPoolClientRequest

Container for the parameters to the UpdateUserPoolClient operation. Allows the developer to update the specified user pool client and password policy.

Class UpdateUserPoolClientResponse

Represents the response from the server to the request to update the user pool client.

Class UpdateUserPoolRequest

Container for the parameters to the UpdateUserPool operation. Updates the specified user pool with the specified attributes.

Class UpdateUserPoolResponse

Represents the response from the server when you make a request to update the user pool.

Class UserContextDataType

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Class UserImportInProgressException

CognitoIdentityProvider exception

Class UserImportJobType

The user import job type.

Class UserLambdaValidationException

CognitoIdentityProvider exception

Class UsernameExistsException

CognitoIdentityProvider exception

Class UserNotConfirmedException

CognitoIdentityProvider exception

Class UserNotFoundException

CognitoIdentityProvider exception

Class UserPoolAddOnNotEnabledException

CognitoIdentityProvider exception

Class UserPoolAddOnsType

The user pool add-ons type.

Class UserPoolClientDescription

The description of the user pool client.

Class UserPoolClientType

Contains information about a user pool client.

Class UserPoolDescriptionType

A user pool description.

Class UserPoolPolicyType

The policy associated with a user pool.

Class UserPoolTaggingException

CognitoIdentityProvider exception

Class UserPoolType

A container for information about the user pool.

Class UserType

The user type.

Class VerificationMessageTemplateType

The template for verification messages.

Class VerifySoftwareTokenRequest

Container for the parameters to the VerifySoftwareToken operation. Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful,

Class VerifySoftwareTokenResponse

This is the response object from the VerifySoftwareToken operation.

Class VerifyUserAttributeRequest

Container for the parameters to the VerifyUserAttribute operation. Verifies the specified user attributes in the user pool.

Class VerifyUserAttributeResponse

A container representing the response from the server from the request to verify user attributes.