See: Description
| Class | Description |
|---|---|
| AddCustomAttributesRequest |
Adds additional user attributes to the user pool schema.
|
| AddCustomAttributesResult |
Represents the response from the server for the request to add custom
attributes.
|
| AdminConfirmSignUpRequest |
Confirms user registration as an admin without using a confirmation code.
|
| AdminConfirmSignUpResult |
Represents the response from the server for the request to confirm
registration.
|
| AdminCreateUserRequest |
Creates a new user in the specified user pool and sends a welcome message via
email or phone (SMS).
|
| AdminCreateUserResult |
Represents the response from the server to the request to create the user.
|
| AdminForgetDeviceRequest |
Forgets the device, as an administrator.
|
| AdminGetDeviceRequest |
Gets the device, as an administrator.
|
| AdminGetDeviceResult |
Gets the device response, as an administrator.
|
| AdminInitiateAuthRequest |
Initiates the authentication flow, as an administrator.
|
| AdminInitiateAuthResult |
Initiates the authentication response, as an administrator.
|
| AdminListDevicesRequest |
Lists devices, as an administrator.
|
| AdminListDevicesResult |
Lists the device's response, as an administrator.
|
| AdminRespondToAuthChallengeRequest |
Responds to an authentication challenge, as an administrator.
|
| AdminRespondToAuthChallengeResult |
Responds to the authentication challenge, as an administrator.
|
| AdminSetUserSettingsRequest |
Sets all the user settings for a specified user name.
|
| AdminSetUserSettingsResult |
Represents the response from the server to set user settings as an
administrator.
|
| AdminUpdateDeviceStatusRequest |
Updates the device status as an administrator.
|
| AdminUpdateDeviceStatusResult |
The status response from the request to update the device, as an
administrator.
|
| AdminUserGlobalSignOutRequest |
Signs out users from all devices, as an administrator.
|
| AdminUserGlobalSignOutResult |
The global sign-out response, as an administrator.
|
| AnalyticsMetadataType | |
| AssociateSoftwareTokenRequest | |
| AssociateSoftwareTokenResult | |
| AttributeType |
Specifies whether the attribute is standard or custom.
|
| AuthenticationResultType |
The result type of the authentication result.
|
| ChangePasswordRequest |
Changes the password for a specified user in a user pool.
|
| ChangePasswordResult |
The response from the server to the change password request.
|
| CodeDeliveryDetailsType |
The type of code delivery details being returned from the server.
|
| ConfirmDeviceRequest |
Confirms tracking of the device.
|
| ConfirmDeviceResult |
Confirms the device response.
|
| ConfirmForgotPasswordRequest |
Allows a user to enter a code provided when they reset their password to
update their password.
|
| ConfirmForgotPasswordResult |
The response from the server that results from a user's request to retrieve a
forgotten password.
|
| ConfirmSignUpRequest |
Confirms registration of a user and handles the existing alias from a
previous user.
|
| ConfirmSignUpResult |
Represents the response from the server for the registration confirmation.
|
| CreateUserImportJobRequest |
Creates the user import job.
|
| CreateUserImportJobResult |
Represents the response from the server to the request to create the user
import job.
|
| CreateUserPoolClientRequest |
Creates the user pool client.
|
| CreateUserPoolClientResult |
Represents the response from the server to create a user pool client.
|
| DeleteUserAttributesRequest |
Deletes the attributes for a user.
|
| DeleteUserAttributesResult |
Represents the response from the server to delete user attributes.
|
| DeleteUserPoolClientRequest |
Allows the developer to delete the user pool client.
|
| DeleteUserPoolRequest |
Deletes the specified Amazon Cognito user pool.
|
| DeleteUserRequest |
Allows a user to delete one's self.
|
| DescribeUserImportJobRequest |
Describes the user import job.
|
| DescribeUserImportJobResult |
Represents the response from the server to the request to describe the user
import job.
|
| DescribeUserPoolClientRequest |
Client method for returning the configuration information and metadata of the
specified user pool client.
|
| DescribeUserPoolClientResult |
Represents the response from the server from a request to describe the user
pool client.
|
| DeviceSecretVerifierConfigType |
The device verifier against which it will be authenticated.
|
| DeviceType |
The device type.
|
| ForgetDeviceRequest |
Forgets the specified device.
|
| ForgotPasswordRequest |
Retrieves the password for the specified client ID or username.
|
| ForgotPasswordResult |
Respresents the response from the server regarding the request to reset a
password.
|
| GetCSVHeaderRequest |
Gets the header information for the .csv file to be used as input for the
user import job.
|
| GetCSVHeaderResult |
Represents the response from the server to the request to get the header
information for the .csv file for the user import job.
|
| GetDeviceRequest |
Gets the device.
|
| GetDeviceResult |
Gets the device response.
|
| GetUserAttributeVerificationCodeRequest |
Gets the user attribute verification code for the specified attribute name.
|
| GetUserAttributeVerificationCodeResult |
The verification code response returned by the server response to get the
user attribute verification code.
|
| GetUserRequest |
Gets the user attributes and metadata for a user.
|
| GetUserResult |
Represents the response from the server from the request to get information
about the user.
|
| GlobalSignOutRequest |
Signs out users from all devices.
|
| GlobalSignOutResult |
The response to the request to sign out all devices.
|
| InitiateAuthRequest |
Initiates the authentication flow.
|
| InitiateAuthResult |
Initiates the authentication response.
|
| ListDevicesRequest |
Lists the devices.
|
| ListDevicesResult |
Represents the response to list devices.
|
| ListUserImportJobsRequest |
Lists the user import jobs.
|
| ListUserImportJobsResult |
Represents the response from the server to the request to list the user
import jobs.
|
| ListUserPoolClientsRequest |
Lists the clients that have been created for the specified user pool.
|
| ListUserPoolClientsResult |
Represents the response from the server that lists user pool clients.
|
| ListUsersRequest |
Lists the users in the Amazon Cognito user pool.
|
| ListUsersResult |
The response from the request to list users.
|
| MFAOptionType |
Specifies the different settings for multi-factor authentication (MFA).
|
| NewDeviceMetadataType |
The new device metadata type.
|
| NumberAttributeConstraintsType |
The minimum and maximum value of an attribute that is of the number data
type.
|
| ResendConfirmationCodeRequest |
Resends the confirmation (for confirmation of registration) to a specific
user in the user pool.
|
| ResendConfirmationCodeResult |
The response from the server when the Amazon Cognito service makes the
request to resend a confirmation code.
|
| RespondToAuthChallengeRequest |
Responds to the authentication challenge.
|
| RespondToAuthChallengeResult |
The response to respond to the authentication challenge.
|
| SchemaAttributeType |
Contains information about the schema attribute.
|
| SetUserMFAPreferenceRequest | |
| SetUserMFAPreferenceResult | |
| SetUserSettingsRequest |
Sets the user settings like multi-factor authentication (MFA).
|
| SetUserSettingsResult |
The response from the server for a set user settings request.
|
| SignUpRequest |
Registers the user in the specified user pool and creates a user name,
password, and user attributes.
|
| SignUpResult |
The response from the server for a registration request.
|
| SMSMfaSettingsType | |
| SoftwareTokenMfaSettingsType | |
| StartUserImportJobRequest |
Starts the user import.
|
| StartUserImportJobResult |
Represents the response from the server to the request to start the user
import job.
|
| StopUserImportJobRequest |
Stops the user import job.
|
| StopUserImportJobResult |
Represents the response from the server to the request to stop the user
import job.
|
| StringAttributeConstraintsType |
The type of constraints associated with an attribute of the string type.
|
| UpdateDeviceStatusRequest |
Updates the device status.
|
| UpdateDeviceStatusResult |
The response to the request to update the device status.
|
| UpdateUserAttributesRequest |
Allows a user to update a specific attribute (one at a time).
|
| UpdateUserAttributesResult |
Represents the response from the server for the request to update user
attributes.
|
| UpdateUserPoolClientRequest |
Allows the developer to update the specified user pool client and password
policy.
|
| UpdateUserPoolClientResult |
Represents the response from the server to the request to update the user
pool client.
|
| UserContextDataType |
Base64 encoded string for user context data collected for risk evaluation
|
| UserImportJobType |
The user import job type.
|
| UserPoolClientDescription |
The description of the user poool client.
|
| UserPoolClientType |
A user pool of the client type.
|
| UserType |
The user type.
|
| VerifySoftwareTokenRequest | |
| VerifySoftwareTokenResult | |
| VerifyUserAttributeRequest |
Verifies the specified user attributes in the user pool.
|
| VerifyUserAttributeResult |
A container representing the response from the server from the request to
verify user attributes.
|
| Enum | Description |
|---|---|
| AttributeDataType |
Attribute Data Type
|
| AuthFlowType |
Auth Flow Type
|
| ChallengeNameType |
Challenge Name Type
|
| DeliveryMediumType |
Delivery Medium Type
|
| DeviceRememberedStatusType |
Device Remembered Status Type
|
| ExplicitAuthFlowsType |
Explicit Auth Flows Type
|
| MessageActionType |
Message Action Type
|
| UserImportJobStatusType |
User Import Job Status Type
|
| UserStatusType |
User Status Type
|
| VerifySoftwareTokenResponseType |
Verify Software Token Response Type
|
| Exception | Description |
|---|---|
| AliasExistsException |
This exception is thrown when a user tries to confirm the account with an
email or phone number that has already been supplied as an alias from a
different account.
|
| CodeDeliveryFailureException |
This exception is thrown when a verification code fails to deliver
successfully.
|
| CodeMismatchException |
This exception is thrown if the provided code does not match what the server
was expecting.
|
| EnableSoftwareTokenMFAException | |
| ExpiredCodeException |
This exception is thrown if a code has expired.
|
| InternalErrorException |
This exception is thrown when Amazon Cognito encounters an internal error.
|
| InvalidEmailRoleAccessPolicyException |
This exception is thrown when Amazon Cognito is not allowed to use your email
identity.
|
| InvalidLambdaResponseException |
This exception is thrown when the Amazon Cognito service encounters an
invalid AWS Lambda response.
|
| InvalidParameterException |
This exception is thrown when the Amazon Cognito service encounters an
invalid parameter.
|
| InvalidPasswordException |
This exception is thrown when the Amazon Cognito service encounters an
invalid password.
|
| InvalidSmsRoleAccessPolicyException |
This exception is returned when the role provided for SMS configuration does
not have permission to publish using Amazon SNS.
|
| InvalidSmsRoleTrustRelationshipException |
This exception is thrown when the trust relationship is invalid for the role
provided for SMS configuration.
|
| InvalidUserPoolConfigurationException |
This exception is thrown when the user pool configuration is invalid.
|
| LimitExceededException |
This exception is thrown when a user exceeds the limit for a requested AWS
resource.
|
| MFAMethodNotFoundException |
This exception is thrown when Amazon Cognito cannot find a multi-factor
authentication (MFA) method.
|
| NotAuthorizedException |
This exception gets thrown when a user is not authorized.
|
| PasswordResetRequiredException |
This exception is thrown when a password reset is required.
|
| PreconditionNotMetException |
This exception is thrown when a precondition is not met.
|
| ResourceNotFoundException |
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.
|
| SoftwareTokenMFANotFoundException | |
| TooManyFailedAttemptsException |
This exception gets thrown when the user has made too many failed attempts
for a given action (e.g., sign in).
|
| TooManyRequestsException |
This exception gets thrown when the user has made too many requests for a
given operation.
|
| UnexpectedLambdaException |
This exception gets thrown when the Amazon Cognito service encounters an
unexpected exception with the AWS Lambda service.
|
| UnsupportedUserStateException |
The request failed because the user is in an unsupported state.
|
| UserImportInProgressException |
This exception is thrown when you are trying to modify a user pool while a
user import job is in progress for that pool.
|
| UserLambdaValidationException |
This exception gets thrown when the Amazon Cognito service encounters a user
validation exception with the AWS Lambda service.
|
| UsernameExistsException |
This exception is thrown when Amazon Cognito encounters a user name that
already exists in the user pool.
|
| UserNotConfirmedException |
This exception is thrown when a user is not confirmed successfully.
|
| UserNotFoundException |
This exception is thrown when a user is not found.
|
Copyright © 2018. All rights reserved.