# Packages
Package cognitoidentityprovideriface provides an interface to enable mocking the Amazon Cognito Identity Provider service client for testing your code.
# Functions
New creates a new instance of the CognitoIdentityProvider client with a session.
# Constants
AliasAttributeTypeEmail is a AliasAttributeType enum value.
AliasAttributeTypePhoneNumber is a AliasAttributeType enum value.
AliasAttributeTypePreferredUsername is a AliasAttributeType enum value.
AttributeDataTypeBoolean is a AttributeDataType enum value.
AttributeDataTypeDateTime is a AttributeDataType enum value.
AttributeDataTypeNumber is a AttributeDataType enum value.
AttributeDataTypeString is a AttributeDataType enum value.
AuthFlowTypeAdminNoSrpAuth is a AuthFlowType enum value.
AuthFlowTypeCustomAuth is a AuthFlowType enum value.
AuthFlowTypeRefreshToken is a AuthFlowType enum value.
AuthFlowTypeRefreshTokenAuth is a AuthFlowType enum value.
AuthFlowTypeUserSrpAuth is a AuthFlowType enum value.
ChallengeNameTypeAdminNoSrpAuth is a ChallengeNameType enum value.
ChallengeNameTypeCustomChallenge is a ChallengeNameType enum value.
ChallengeNameTypeDevicePasswordVerifier is a ChallengeNameType enum value.
ChallengeNameTypeDeviceSrpAuth is a ChallengeNameType enum value.
ChallengeNameTypeNewPasswordRequired is a ChallengeNameType enum value.
ChallengeNameTypePasswordVerifier is a ChallengeNameType enum value.
ChallengeNameTypeSmsMfa is a ChallengeNameType enum value.
DeliveryMediumTypeEmail is a DeliveryMediumType enum value.
DeliveryMediumTypeSms is a DeliveryMediumType enum value.
DeviceRememberedStatusTypeNotRemembered is a DeviceRememberedStatusType enum value.
DeviceRememberedStatusTypeRemembered is a DeviceRememberedStatusType enum value.
DomainStatusTypeActive is a DomainStatusType enum value.
DomainStatusTypeCreating is a DomainStatusType enum value.
DomainStatusTypeDeleting is a DomainStatusType enum value.
DomainStatusTypeUpdating is a DomainStatusType enum value.
Service ID for Regions and Endpoints metadata.
ErrCodeAliasExistsException for service response error code "AliasExistsException".
ErrCodeCodeDeliveryFailureException for service response error code "CodeDeliveryFailureException".
ErrCodeCodeMismatchException for service response error code "CodeMismatchException".
ErrCodeConcurrentModificationException for service response error code "ConcurrentModificationException".
ErrCodeDuplicateProviderException for service response error code "DuplicateProviderException".
ErrCodeExpiredCodeException for service response error code "ExpiredCodeException".
ErrCodeGroupExistsException for service response error code "GroupExistsException".
ErrCodeInternalErrorException for service response error code "InternalErrorException".
ErrCodeInvalidEmailRoleAccessPolicyException for service response error code "InvalidEmailRoleAccessPolicyException".
ErrCodeInvalidLambdaResponseException for service response error code "InvalidLambdaResponseException".
ErrCodeInvalidOAuthFlowException for service response error code "InvalidOAuthFlowException".
ErrCodeInvalidParameterException for service response error code "InvalidParameterException".
ErrCodeInvalidPasswordException for service response error code "InvalidPasswordException".
ErrCodeInvalidSmsRoleAccessPolicyException for service response error code "InvalidSmsRoleAccessPolicyException".
ErrCodeInvalidSmsRoleTrustRelationshipException for service response error code "InvalidSmsRoleTrustRelationshipException".
ErrCodeInvalidUserPoolConfigurationException for service response error code "InvalidUserPoolConfigurationException".
ErrCodeLimitExceededException for service response error code "LimitExceededException".
ErrCodeMFAMethodNotFoundException for service response error code "MFAMethodNotFoundException".
ErrCodeNotAuthorizedException for service response error code "NotAuthorizedException".
ErrCodePasswordResetRequiredException for service response error code "PasswordResetRequiredException".
ErrCodePreconditionNotMetException for service response error code "PreconditionNotMetException".
ErrCodeResourceNotFoundException for service response error code "ResourceNotFoundException".
ErrCodeScopeDoesNotExistException for service response error code "ScopeDoesNotExistException".
ErrCodeTooManyFailedAttemptsException for service response error code "TooManyFailedAttemptsException".
ErrCodeTooManyRequestsException for service response error code "TooManyRequestsException".
ErrCodeUnexpectedLambdaException for service response error code "UnexpectedLambdaException".
ErrCodeUnsupportedIdentityProviderException for service response error code "UnsupportedIdentityProviderException".
ErrCodeUnsupportedUserStateException for service response error code "UnsupportedUserStateException".
ErrCodeUserImportInProgressException for service response error code "UserImportInProgressException".
ErrCodeUserLambdaValidationException for service response error code "UserLambdaValidationException".
ErrCodeUsernameExistsException for service response error code "UsernameExistsException".
ErrCodeUserNotConfirmedException for service response error code "UserNotConfirmedException".
ErrCodeUserNotFoundException for service response error code "UserNotFoundException".
ErrCodeUserPoolTaggingException for service response error code "UserPoolTaggingException".
ExplicitAuthFlowsTypeAdminNoSrpAuth is a ExplicitAuthFlowsType enum value.
ExplicitAuthFlowsTypeCustomAuthFlowOnly is a ExplicitAuthFlowsType enum value.
IdentityProviderTypeTypeSaml is a IdentityProviderTypeType enum value.
MessageActionTypeResend is a MessageActionType enum value.
MessageActionTypeSuppress is a MessageActionType enum value.
OAuthFlowTypeClientCredentials is a OAuthFlowType enum value.
OAuthFlowTypeCode is a OAuthFlowType enum value.
OAuthFlowTypeImplicit is a OAuthFlowType enum value.
Service endpoint prefix API calls made to.
StatusTypeDisabled is a StatusType enum value.
StatusTypeEnabled is a StatusType enum value.
UserImportJobStatusTypeCreated is a UserImportJobStatusType enum value.
UserImportJobStatusTypeExpired is a UserImportJobStatusType enum value.
UserImportJobStatusTypeFailed is a UserImportJobStatusType enum value.
UserImportJobStatusTypeInProgress is a UserImportJobStatusType enum value.
UserImportJobStatusTypePending is a UserImportJobStatusType enum value.
UserImportJobStatusTypeStopped is a UserImportJobStatusType enum value.
UserImportJobStatusTypeStopping is a UserImportJobStatusType enum value.
UserImportJobStatusTypeSucceeded is a UserImportJobStatusType enum value.
UsernameAttributeTypeEmail is a UsernameAttributeType enum value.
UsernameAttributeTypePhoneNumber is a UsernameAttributeType enum value.
UserPoolMfaTypeOff is a UserPoolMfaType enum value.
UserPoolMfaTypeOn is a UserPoolMfaType enum value.
UserPoolMfaTypeOptional is a UserPoolMfaType enum value.
UserStatusTypeArchived is a UserStatusType enum value.
UserStatusTypeCompromised is a UserStatusType enum value.
UserStatusTypeConfirmed is a UserStatusType enum value.
UserStatusTypeForceChangePassword is a UserStatusType enum value.
UserStatusTypeResetRequired is a UserStatusType enum value.
UserStatusTypeUnconfirmed is a UserStatusType enum value.
UserStatusTypeUnknown is a UserStatusType enum value.
VerifiedAttributeTypeEmail is a VerifiedAttributeType enum value.
VerifiedAttributeTypePhoneNumber is a VerifiedAttributeType enum value.
# Structs
Represents the request to add custom attributes.
Represents the response from the server for the request to add custom attributes.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminAddUserToGroupRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminAddUserToGroupOutput.
Represents the request to confirm user registration.
Represents the response from the server for the request to confirm registration.
The type of configuration for creating a new user profile.
Represents the request to create a user in the specified user pool.
Represents the response from the server to the request to create the user.
Represents the request to delete user attributes as an administrator.
Represents the response received from the server for a request to delete user attributes.
Represents the request to delete a user as an administrator.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserOutput.
Represents the request to disable any user as an administrator.
Represents the response received from the server to disable the user as an administrator.
Represents the request that enables the user as an administrator.
Represents the response from the server for the request to enable a user as an administrator.
Sends the forgot device request, as an administrator.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminForgetDeviceOutput.
Represents the request to get the device, as an administrator.
Gets the device response, as an administrator.
Represents the request to get the specified user as an administrator.
Represents the response from the server from the request to get the specified user as an administrator.
Initiates the authorization request, as an administrator.
Initiates the authentication response, as an administrator.
Represents the request to list devices, as an administrator.
Lists the device's response, as an administrator.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListGroupsForUserRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListGroupsForUserResponse.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRemoveUserFromGroupRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRemoveUserFromGroupOutput.
Represents the request to reset a user's password as an administrator.
Represents the response from the server to reset a user password as an administrator.
The request to respond to the authentication challenge, as an administrator.
Responds to the authentication challenge, as an administrator.
Represents the request to set user settings as an administrator.
Represents the response from the server to set user settings as an administrator.
The request to update the device status, as an administrator.
The status response from the request to update the device, as an administrator.
Represents the request to update the user's attributes as an administrator.
Represents the response from the server for the request to update user attributes as an administrator.
The request to sign out of all devices, as an administrator.
The global sign-out response, as an administrator.
Specifies whether the attribute is standard or custom.
The result type of the authentication result.
Represents the request to change a user password.
The response from the server to the change password request.
The type of code delivery details being returned from the server.
CognitoIdentityProvider provides the API operation methods for making requests to Amazon Cognito Identity Provider.
Confirms the device request.
Confirms the device response.
The request representing the confirmation for a password reset.
The response from the server that results from a user's request to retrieve a forgotten password.
Represents the request to confirm registration of a user.
Represents the response from the server for the registration confirmation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateGroupRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateGroupResponse.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateIdentityProviderRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateIdentityProviderResponse.
Represents the request to create the user import job.
Represents the response from the server to the request to create the user import job.
Represents the request to create a user pool client.
Represents the response from the server to create a user pool client.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolDomainRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolDomainResponse.
Represents the request to create a user pool.
Represents the response from the server for the request to create a user pool.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteGroupRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteGroupOutput.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteIdentityProviderRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteIdentityProviderOutput.
Represents the request to delete user attributes.
Represents the response from the server to delete user attributes.
Represents the request to delete a user.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserOutput.
Represents the request to delete a user pool client.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolClientOutput.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolDomainRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolDomainResponse.
Represents the request to delete a user pool.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolOutput.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeIdentityProviderRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeIdentityProviderResponse.
Represents the request to describe the user import job.
Represents the response from the server to the request to describe the user import job.
Represents the request to describe a user pool client.
Represents the response from the server from a request to describe the user pool client.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolDomainRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolDomainResponse.
Represents the request to describe the user pool.
Represents the response to describe the user pool.
The type of configuration for the user pool's device tracking.
The device verifier against which it will be authenticated.
The device type.
A container for information about a domain.
The email configuration type.
Represents the request to forget the device.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgetDeviceOutput.
Represents the request to reset a user's password.
Respresents the response from the server regarding the request to reset a password.
Represents the request to get the header information for the .csv file for the user import job.
Represents the response from the server to the request to get the header information for the .csv file for the user import job.
Represents the request to get the device.
Gets the device response.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetGroupRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetGroupResponse.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetIdentityProviderByIdentifierRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetIdentityProviderByIdentifierResponse.
Represents the request to get user attribute verification.
The verification code response returned by the server response to get the user attribute verification code.
Represents the request to get information about the user.
Represents the response from the server from the request to get information about the user.
Represents the request to sign out all devices.
The response to the request to sign out all devices.
The group type.
A container for information about an identity provider.
Initiates the authentication request.
Initiates the authentication response.
Specifies the type of configuration for AWS Lambda triggers.
Represents the request to list the devices.
Represents the response to list devices.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListGroupsRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListGroupsResponse.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListIdentityProvidersRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListIdentityProvidersResponse.
Represents the request to list the user import jobs.
Represents the response from the server to the request to list the user import jobs.
Represents the request to list the user pool clients.
Represents the response from the server that lists user pool clients.
Represents the request to list user pools.
Represents the response to list user pools.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersInGroupRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersInGroupResponse.
Represents the request to list users.
The response from the request to list users.
The message template structure.
Specifies the different settings for multi-factor authentication (MFA).
The new device metadata type.
The minimum and maximum value of an attribute that is of the number data type.
The password policy type.
A container for identity provider details.
Represents the request to resend the confirmation code.
The response from the server when the Amazon Cognito Your User Pools service makes the request to resend a confirmation code.
The request to respond to an authentication challenge.
The response to respond to the authentication challenge.
Contains information about the schema attribute.
Represents the request to set user settings.
The response from the server for a set user settings request.
Represents the request to register a user.
The response from the server for a registration request.
The SMS configuration type.
Represents the request to start the user import job.
Represents the response from the server to the request to start the user import job.
Represents the request to stop the user import job.
Represents the response from the server to the request to stop the user import job.
The type of constraints associated with an attribute of the string type.
Represents the request to update the device status.
The response to the request to update the device status.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateGroupRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateGroupResponse.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateIdentityProviderRequest.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateIdentityProviderResponse.
Represents the request to update user attributes.
Represents the response from the server for the request to update user attributes.
Represents the request to update the user pool client.
Represents the response from the server to the request to update the user pool client.
Represents the request to update the user pool.
Represents the response from the server when you make a request to update the user pool.
The user import job type.
The description of the user pool client.
A user pool of the client type.
A user pool description.
The type of policy in a user pool.
A container for information about the user pool type.
The user type.
Represents the request to verify user attributes.
A container representing the response from the server from the request to verify user attributes.