Package com.amazonaws.services.cognitoidentityprovider.model

Classes modeling the various types represented by AmazonCognitoIdentityProvider

See: Description

Class Summary

Class	Description
AccountRecoverySettingType	The data type for AccountRecoverySetting.
AccountTakeoverActionsType	Account takeover actions type.
AccountTakeoverActionType	Account takeover action type.
AccountTakeoverRiskConfigurationType	Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
AddCustomAttributesRequest	Adds additional user attributes to the user pool schema.
AddCustomAttributesResult	Represents the response from the server for the request to add custom attributes.
AdminAddUserToGroupRequest	Adds the specified user to the specified group.
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.
AdminCreateUserConfigType	The configuration for creating a new user profile.
AdminCreateUserRequest	Creates a new user in the specified user pool.
AdminCreateUserResult	Represents the response from the server to the request to create the user.
AdminDeleteUserAttributesRequest	Deletes the user attributes in a user pool as an administrator.
AdminDeleteUserAttributesResult	Represents the response received from the server for a request to delete user attributes.
AdminDeleteUserRequest	Deletes a user as an administrator.
AdminDisableProviderForUserRequest	Disables the user from signing in with the specified external (SAML or social) identity provider.
AdminDisableProviderForUserResult
AdminDisableUserRequest	Disables the specified user.
AdminDisableUserResult	Represents the response received from the server to disable the user as an administrator.
AdminEnableUserRequest	Enables the specified user as an administrator.
AdminEnableUserResult	Represents the response from the server for the request to enable a user as an administrator.
AdminForgetDeviceRequest	Forgets the device, as an administrator.
AdminGetDeviceRequest	Gets the device, as an administrator.
AdminGetDeviceResult	Gets the device response, as an administrator.
AdminGetUserRequest	Gets the specified user by user name in a user pool as an administrator.
AdminGetUserResult	Represents the response from the server from the request to get the specified user as an administrator.
AdminInitiateAuthRequest	Initiates the authentication flow, as an administrator.
AdminInitiateAuthResult	Initiates the authentication response, as an administrator.
AdminLinkProviderForUserRequest	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.
AdminLinkProviderForUserResult
AdminListDevicesRequest	Lists devices, as an administrator.
AdminListDevicesResult	Lists the device's response, as an administrator.
AdminListGroupsForUserRequest	Lists the groups that the user belongs to.
AdminListGroupsForUserResult
AdminListUserAuthEventsRequest	Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
AdminListUserAuthEventsResult
AdminRemoveUserFromGroupRequest	Removes the specified user from the specified group.
AdminResetUserPasswordRequest	Resets the specified user's password in a user pool as an administrator.
AdminResetUserPasswordResult	Represents the response from the server to reset a user password as an administrator.
AdminRespondToAuthChallengeRequest	Responds to an authentication challenge, as an administrator.
AdminRespondToAuthChallengeResult	Responds to the authentication challenge, as an administrator.
AdminSetUserMFAPreferenceRequest	Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred.
AdminSetUserMFAPreferenceResult
AdminSetUserPasswordRequest	Sets the specified user's password in a user pool as an administrator.
AdminSetUserPasswordResult
AdminSetUserSettingsRequest	This action is no longer supported. You can use it to configure only SMS MFA.
AdminSetUserSettingsResult	Represents the response from the server to set user settings as an administrator.
AdminUpdateAuthEventFeedbackRequest	Provides feedback for an authentication event as to whether it was from a valid user.
AdminUpdateAuthEventFeedbackResult
AdminUpdateDeviceStatusRequest	Updates the device status as an administrator.
AdminUpdateDeviceStatusResult	The status response from the request to update the device, as an administrator.
AdminUpdateUserAttributesRequest	Updates the specified user's attributes, including developer attributes, as an administrator.
AdminUpdateUserAttributesResult	Represents the response from the server for the request to update user attributes as an administrator.
AdminUserGlobalSignOutRequest	Signs out users from all devices, as an administrator.
AdminUserGlobalSignOutResult	The global sign-out response, as an administrator.
AnalyticsConfigurationType	The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.
AnalyticsMetadataType	An Amazon Pinpoint analytics endpoint.
AssociateSoftwareTokenRequest	Returns a unique generated shared secret key code for the user account.
AssociateSoftwareTokenResult
AttributeType	Specifies whether the attribute is standard or custom.
AuthenticationResultType	The authentication result.
AuthEventType	The authentication event type.
ChallengeResponseType	The challenge response type.
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 code delivery details being returned from the server.
CompromisedCredentialsActionsType	The compromised credentials actions type
CompromisedCredentialsRiskConfigurationType	The compromised credentials risk configuration type.
ConfirmDeviceRequest	Confirms tracking of the device.
ConfirmDeviceResult	Confirms the device response.
ConfirmForgotPasswordRequest	Allows a user to enter a confirmation code to reset a forgotten 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.
ContextDataType	Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
CreateGroupRequest	Creates a new group in the specified user pool.
CreateGroupResult
CreateIdentityProviderRequest	Creates an identity provider for a user pool.
CreateIdentityProviderResult
CreateResourceServerRequest	Creates a new OAuth2.0 resource server and defines custom scopes in it.
CreateResourceServerResult
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.
CreateUserPoolDomainRequest	Creates a new domain for a user pool.
CreateUserPoolDomainResult
CreateUserPoolRequest	Creates a new Amazon Cognito user pool and sets the password policy for the pool.
CreateUserPoolResult	Represents the response from the server for the request to create a user pool.
CustomDomainConfigType	The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
DeleteGroupRequest	Deletes a group.
DeleteIdentityProviderRequest	Deletes an identity provider for a user pool.
DeleteResourceServerRequest	Deletes a resource server.
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.
DeleteUserPoolDomainRequest	Deletes a domain for a user pool.
DeleteUserPoolDomainResult
DeleteUserPoolRequest	Deletes the specified Amazon Cognito user pool.
DeleteUserRequest	Allows a user to delete himself or herself.
DescribeIdentityProviderRequest	Gets information about a specific identity provider.
DescribeIdentityProviderResult
DescribeResourceServerRequest	Describes a resource server.
DescribeResourceServerResult
DescribeRiskConfigurationRequest	Describes the risk configuration.
DescribeRiskConfigurationResult
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 app client.
DescribeUserPoolClientResult	Represents the response from the server from a request to describe the user pool client.
DescribeUserPoolDomainRequest	Gets information about a domain.
DescribeUserPoolDomainResult
DescribeUserPoolRequest	Returns the configuration information and metadata of the specified user pool.
DescribeUserPoolResult	Represents the response to describe the user pool.
DeviceConfigurationType	The configuration for the user pool's device tracking.
DeviceSecretVerifierConfigType	The device verifier against which it will be authenticated.
DeviceType	The device type.
DomainDescriptionType	A container for information about a domain.
EmailConfigurationType	The email configuration type.
EventContextDataType	Specifies the user context data captured at the time of an event request.
EventFeedbackType	Specifies the event feedback type.
EventRiskType	The event risk type.
ForgetDeviceRequest	Forgets the specified device.
ForgotPasswordRequest	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.
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.
GetGroupRequest	Gets a group.
GetGroupResult
GetIdentityProviderByIdentifierRequest	Gets the specified identity provider.
GetIdentityProviderByIdentifierResult
GetSigningCertificateRequest	This method takes a user pool ID, and returns the signing certificate.
GetSigningCertificateResult	Response from Cognito for a signing certificate request.
GetUICustomizationRequest	Gets the UI Customization information for a particular app client's app UI, if there is something set.
GetUICustomizationResult
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.
GetUserPoolMfaConfigRequest	Gets the user pool multi-factor authentication (MFA) configuration.
GetUserPoolMfaConfigResult
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.
GroupType	The group type.
HttpHeader	The HTTP header.
IdentityProviderType	A container for information about an identity provider.
InitiateAuthRequest	Initiates the authentication flow.
InitiateAuthResult	Initiates the authentication response.
LambdaConfigType	Specifies the configuration for AWS Lambda triggers.
ListDevicesRequest	Lists the devices.
ListDevicesResult	Represents the response to list devices.
ListGroupsRequest	Lists the groups associated with a user pool.
ListGroupsResult
ListIdentityProvidersRequest	Lists information about all identity providers for a user pool.
ListIdentityProvidersResult
ListResourceServersRequest	Lists the resource servers for a user pool.
ListResourceServersResult
ListTagsForResourceRequest	Lists the tags that are assigned to an Amazon Cognito user pool.
ListTagsForResourceResult
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.
ListUserPoolsRequest	Lists the user pools associated with an AWS account.
ListUserPoolsResult	Represents the response to list user pools.
ListUsersInGroupRequest	Lists the users in the specified group.
ListUsersInGroupResult
ListUsersRequest	Lists the users in the Amazon Cognito user pool.
ListUsersResult	The response from the request to list users.
MessageTemplateType	The message template structure.
MFAOptionType	This data type is no longer supported. You can use it only for SMS MFA configurations.
NewDeviceMetadataType	The new device metadata type.
NotifyConfigurationType	The notify configuration type.
NotifyEmailType	The notify email type.
NumberAttributeConstraintsType	The minimum and maximum value of an attribute that is of the number data type.
PasswordPolicyType	The password policy type.
ProviderDescription	A container for identity provider details.
ProviderUserIdentifierType	A container for information about an identity provider for a user pool.
RecoveryOptionType	A map containing a priority as a key, and recovery method name as a value.
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 Your User Pools service makes the request to resend a confirmation code.
ResourceServerScopeType	A resource server scope.
ResourceServerType	A container for information about a resource server for a user pool.
RespondToAuthChallengeRequest	Responds to the authentication challenge.
RespondToAuthChallengeResult	The response to respond to the authentication challenge.
RiskConfigurationType	The risk configuration type.
RiskExceptionConfigurationType	The type of the configuration to override the risk decision.
SchemaAttributeType	Contains information about the schema attribute.
SetRiskConfigurationRequest	Configures actions on detected risks.
SetRiskConfigurationResult
SetUICustomizationRequest	Sets the UI customization information for a user pool's built-in app UI.
SetUICustomizationResult
SetUserMFAPreferenceRequest	Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred.
SetUserMFAPreferenceResult
SetUserPoolMfaConfigRequest	Set the user pool multi-factor authentication (MFA) configuration.
SetUserPoolMfaConfigResult
SetUserSettingsRequest	This action is no longer supported. You can use it to configure only SMS 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.
SmsConfigurationType	The SMS configuration type that includes the settings the Cognito User Pool needs to call for the Amazon SNS service to send an SMS message from your AWS account.
SmsMfaConfigType	The SMS text message multi-factor authentication (MFA) configuration type.
SMSMfaSettingsType	The type used for enabling SMS MFA at the user level.
SoftwareTokenMfaConfigType	The type used for enabling software token MFA at the user pool level.
SoftwareTokenMfaSettingsType	The type used for enabling software token MFA at the user level.
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 constraints associated with a string attribute.
TagResourceRequest	Assigns a set of tags to an Amazon Cognito user pool.
TagResourceResult
UICustomizationType	A container for the UI customization information for a user pool's built-in app UI.
UntagResourceRequest	Removes the specified tags from an Amazon Cognito user pool.
UntagResourceResult
UpdateAuthEventFeedbackRequest	Provides the feedback for an authentication event whether it was from a valid user or not.
UpdateAuthEventFeedbackResult
UpdateDeviceStatusRequest	Updates the device status.
UpdateDeviceStatusResult	The response to the request to update the device status.
UpdateGroupRequest	Updates the specified group with the specified attributes.
UpdateGroupResult
UpdateIdentityProviderRequest	Updates identity provider information for a user pool.
UpdateIdentityProviderResult
UpdateResourceServerRequest	Updates the name and scopes of resource server.
UpdateResourceServerResult
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	Updates the specified user pool app client with the specified attributes.
UpdateUserPoolClientResult	Represents the response from the server to the request to update the user pool client.
UpdateUserPoolDomainRequest	Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
UpdateUserPoolDomainResult	The UpdateUserPoolDomain response output.
UpdateUserPoolRequest	Updates the specified user pool with the specified attributes.
UpdateUserPoolResult	Represents the response from the server when you make a request to update the user pool.
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.
UserImportJobType	The user import job type.
UsernameConfigurationType	The username configuration type.
UserPoolAddOnsType	The user pool add-ons type.
UserPoolClientDescription	The description of the user pool client.
UserPoolClientType	Contains information about a user pool client.
UserPoolDescriptionType	A user pool description.
UserPoolPolicyType	The policy associated with a user pool.
UserPoolType	A container for information about the user pool.
UserType	The user type.
VerificationMessageTemplateType	The template for verification messages.
VerifySoftwareTokenRequest	Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful.
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 Summary

Enum	Description
AccountTakeoverEventActionType	Account Takeover Event Action Type
AdvancedSecurityModeType	Advanced Security Mode Type
AliasAttributeType	Alias Attribute Type
AttributeDataType	Attribute Data Type
AuthFlowType	Auth Flow Type
ChallengeName	Challenge Name
ChallengeNameType	Challenge Name Type
ChallengeResponse	Challenge Response
CompromisedCredentialsEventActionType	Compromised Credentials Event Action Type
DefaultEmailOptionType	Default Email Option Type
DeliveryMediumType	Delivery Medium Type
DeviceRememberedStatusType	Device Remembered Status Type
DomainStatusType	Domain Status Type
EmailSendingAccountType	Email Sending Account Type
EventFilterType	Event Filter Type
EventResponseType	Event Response Type
EventType	Event Type
ExplicitAuthFlowsType	Explicit Auth Flows Type
FeedbackValueType	Feedback Value Type
IdentityProviderTypeType	Identity Provider Type Type
MessageActionType	Message Action Type
OAuthFlowType	OAuth Flow Type
PreventUserExistenceErrorTypes	Prevent User Existence Error Types
RecoveryOptionNameType	Recovery Option Name Type
RiskDecisionType	Risk Decision Type
RiskLevelType	Risk Level Type
StatusType	Status Type
UserImportJobStatusType	User Import Job Status Type
UsernameAttributeType	Username Attribute Type
UserPoolMfaType	User Pool Mfa Type
UserStatusType	User Status Type
VerifiedAttributeType	Verified Attribute Type
VerifySoftwareTokenResponseType	Verify Software Token Response Type

Exception Summary

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.
ConcurrentModificationException	This exception is thrown if two or more modifications are happening concurrently.
DuplicateProviderException	This exception is thrown when the provider is already supported by the user pool.
EnableSoftwareTokenMFAException	This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).
ExpiredCodeException	This exception is thrown if a code has expired.
GroupExistsException	This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.
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.
InvalidOAuthFlowException	This exception is thrown when the specified OAuth flow is invalid.
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 is 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.
ScopeDoesNotExistException	This exception is thrown when the specified scope does not exist.
SoftwareTokenMFANotFoundException	This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled for the user pool.
TooManyFailedAttemptsException	This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign in).
TooManyRequestsException	This exception is thrown when the user has made too many requests for a given operation.
UnexpectedLambdaException	This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
UnsupportedIdentityProviderException	This exception is thrown when the specified identifier is not supported.
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 is 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.
UserPoolAddOnNotEnabledException	This exception is thrown when user pool add-ons are not enabled.
UserPoolTaggingException	This exception is thrown when a user pool tag cannot be set or updated.

Package com.amazonaws.services.cognitoidentityprovider.model Description

Classes modeling the various types represented by AmazonCognitoIdentityProvider