C# (CSharp) Amazon.CognitoIdentityProvider.Model Namespace

Nested Namespaces

Amazon.CognitoIdentityProvider.Model.Internal

Classes

Name Description
AddCustomAttributesRequest Container for the parameters to the AddCustomAttributes operation. Adds additional user attributes to the user pool schema.
AdminConfirmSignUpRequest Container for the parameters to the AdminConfirmSignUp operation. Confirms user registration as an admin without using a confirmation code. Works on any user.
AdminCreateUserConfigType The type of configuration for creating a new user profile.
AdminCreateUserRequest Container for the parameters to the AdminCreateUser operation. Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Requires developer credentials.

AdminCreateUserResponse Represents the response from the server to the request to create the user.
AdminDeleteUserAttributesRequest Container for the parameters to the AdminDeleteUserAttributes operation. Deletes the user attributes in a user pool as an administrator. Works on any user.
AdminDeleteUserRequest Container for the parameters to the AdminDeleteUser operation. Deletes a user as an administrator. Works on any user.
AdminDisableUserRequest Container for the parameters to the AdminDisableUser operation. Disables the specified user as an administrator. Works on any user.
AdminEnableUserRequest Container for the parameters to the AdminEnableUser operation. Enables the specified user as an administrator. Works on any user.
AdminForgetDeviceRequest Container for the parameters to the AdminForgetDevice operation. Forgets the device, as an administrator.
AdminGetDeviceRequest Container for the parameters to the AdminGetDevice operation. Gets the device, as an administrator.
AdminGetDeviceResponse Gets the device response, as an administrator.
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.
AdminGetUserResponse Represents the response from the server from the request to get the specified user as an administrator.
AdminInitiateAuthRequest Container for the parameters to the AdminInitiateAuth operation. Initiates the authentication flow, as an administrator.
AdminInitiateAuthResponse Initiates the authentication response, as an administrator.
AdminListDevicesRequest Container for the parameters to the AdminListDevices operation. Lists devices, as an administrator.
AdminListDevicesResponse Lists the device's response, as an administrator.
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.

AdminRespondToAuthChallengeRequest Container for the parameters to the AdminRespondToAuthChallenge operation. Responds to an authentication challenge, as an administrator.
AdminRespondToAuthChallengeResponse Responds to the authentication challenge, as an administrator.
AdminSetUserSettingsRequest Container for the parameters to the AdminSetUserSettings operation. Sets all the user settings for a specified user name. Works on any user.
AdminUpdateDeviceStatusRequest Container for the parameters to the AdminUpdateDeviceStatus operation. Updates the device status as an administrator.
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.
AdminUserGlobalSignOutRequest Container for the parameters to the AdminUserGlobalSignOut operation. Signs out users from all devices, as an administrator.
AliasExistsException
AttributeType Specifies whether the attribute is standard or custom.
AuthenticationResultType The result type of the authentication result.
CodeDeliveryDetailsType The type of code delivery details being returned from the server.
CodeDeliveryFailureException
CodeMismatchException
ConcurrentModificationException
ConfirmDeviceRequest Container for the parameters to the ConfirmDevice operation. Confirms tracking of the device. This API call is the call that beings device tracking.
ConfirmDeviceResponse Confirms the device response.
ConfirmForgotPasswordRequest Container for the parameters to the ConfirmForgotPassword operation. Allows a user to enter a code provided when they reset their password to update their password.
ConfirmSignUpRequest Container for the parameters to the ConfirmSignUp operation. Confirms registration of a user and handles the existing alias from a previous user.
CreateUserImportJobRequest Container for the parameters to the CreateUserImportJob operation. Creates the user import job.
CreateUserImportJobResponse Represents the response from the server to the request to create the user import job.
CreateUserPoolClientRequest Container for the parameters to the CreateUserPoolClient operation. Creates the user pool client.
CreateUserPoolClientResponse Represents the response from the server to create a user pool client.
CreateUserPoolRequest Container for the parameters to the CreateUserPool operation. Creates a new Amazon Cognito user pool and sets the password policy for the pool.
CreateUserPoolResponse Represents the response from the server for the request to create a user pool.
DeleteUserAttributesRequest Container for the parameters to the DeleteUserAttributes operation. Deletes the attributes for a user.
DeleteUserPoolClientRequest Container for the parameters to the DeleteUserPoolClient operation. Allows the developer to delete the user pool client.
DeleteUserPoolRequest Container for the parameters to the DeleteUserPool operation. Deletes the specified Amazon Cognito user pool.
DeleteUserRequest Container for the parameters to the DeleteUser operation. Allows a user to delete one's self.
DescribeUserImportJobResponse Represents the response from the server to the request to describe the user import job.
DescribeUserPoolClientRequest Container for the parameters to the DescribeUserPoolClient operation. Client method for returning the configuration information and metadata of the specified user pool client.
DescribeUserPoolClientResponse Represents the response from the server from a request to describe the user pool client.
DescribeUserPoolRequest Container for the parameters to the DescribeUserPool operation. Returns the configuration information and metadata of the specified user pool.
DescribeUserPoolResponse Represents the response to describe the user pool.
DeviceConfigurationType The type of configuration for the user pool's device tracking.
DeviceSecretVerifierConfigType The device verifier against which it will be authenticated.
DeviceType The device type.
EmailConfigurationType The email configuration type.
ExpiredCodeException
ForgetDeviceRequest Container for the parameters to the ForgetDevice operation. Forgets the specified device.
ForgotPasswordRequest Container for the parameters to the ForgotPassword operation. Retrieves the password for the specified client ID or username.
ForgotPasswordResponse Respresents the response from the server regarding the request to reset a password.
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.
GetCSVHeaderResponse Represents the response from the server to the request to get the header information for the .csv file for the user import job.
GetDeviceRequest Container for the parameters to the GetDevice operation. Gets the device.
GetDeviceResponse Gets the device response.
GetUserAttributeVerificationCodeRequest Container for the parameters to the GetUserAttributeVerificationCode operation. Gets the user attribute verification code for the specified attribute name.
GetUserAttributeVerificationCodeResponse The verification code response returned by the server response to get the user attribute verification code.
GetUserRequest Container for the parameters to the GetUser operation. Gets the user attributes and metadata for a user.
GetUserResponse Represents the response from the server from the request to get information about the user.
GlobalSignOutRequest Container for the parameters to the GlobalSignOut operation. Signs out users from all devices.
InitiateAuthRequest Container for the parameters to the InitiateAuth operation. Initiates the authentication flow.
InitiateAuthResponse Initiates the authentication response.
InternalErrorException
InvalidEmailRoleAccessPolicyException
InvalidLambdaResponseException
InvalidParameterException
InvalidPasswordException
InvalidSmsRoleAccessPolicyException
InvalidSmsRoleTrustRelationshipException
InvalidUserPoolConfigurationException
LambdaConfigType Specifies the type of configuration for AWS Lambda triggers.
LimitExceededException
ListDevicesRequest Container for the parameters to the ListDevices operation. Lists the devices.
ListDevicesResponse Represents the response to list devices.
ListUserImportJobsRequest Container for the parameters to the ListUserImportJobs operation. Lists the user import jobs.
ListUserImportJobsResponse Represents the response from the server to the request to list the user import jobs.
ListUserPoolClientsRequest Container for the parameters to the ListUserPoolClients operation. Lists the clients that have been created for the specified user pool.
ListUserPoolClientsResponse Represents the response from the server that lists user pool clients.
ListUserPoolsRequest Container for the parameters to the ListUserPools operation. Lists the user pools associated with an AWS account.
ListUserPoolsResponse Represents the response to list user pools.
ListUsersRequest Container for the parameters to the ListUsers operation. Lists the users in the Amazon Cognito user pool.
ListUsersResponse The response from the request to list users.
MFAMethodNotFoundException
MFAOptionType Specifies the different settings for multi-factor authentication (MFA).
MessageTemplateType The message template structure.
NewDeviceMetadataType The new device metadata type.
NotAuthorizedException
NumberAttributeConstraintsType The minimum and maximum value of an attribute that is of the number data type.
PasswordPolicyType The password policy type.
PasswordResetRequiredException
PreconditionNotMetException
ResendConfirmationCodeRequest Container for the parameters to the ResendConfirmationCode operation. Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
ResendConfirmationCodeResponse The response from the server when the Amazon Cognito Your User Pools service makes the request to resend a confirmation code.
ResourceNotFoundException
RespondToAuthChallengeRequest Container for the parameters to the RespondToAuthChallenge operation. Responds to the authentication challenge.
RespondToAuthChallengeResponse The response to respond to the authentication challenge.
SchemaAttributeType Contains information about the schema attribute.
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.
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.
SignUpResponse The response from the server for a registration request.
SmsConfigurationType The SMS configuratoin type.
StartUserImportJobRequest Container for the parameters to the StartUserImportJob operation. Starts the user import.
StartUserImportJobResponse Represents the response from the server to the request to start the user import job.
StopUserImportJobRequest Container for the parameters to the StopUserImportJob operation. Stops the user import job.
StopUserImportJobResponse 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.
TooManyFailedAttemptsException
TooManyRequestsException
UnexpectedLambdaException
UnsupportedUserStateException
UpdateDeviceStatusRequest Container for the parameters to the UpdateDeviceStatus operation. Updates the device status.
UpdateUserAttributesRequest Container for the parameters to the UpdateUserAttributes operation. Allows a user to update a specific attribute (one at a time).
UpdateUserAttributesResponse Represents the response from the server for the request to update user attributes.
UpdateUserPoolClientRequest Container for the parameters to the UpdateUserPoolClient operation. Allows the developer to update the specified user pool client and password policy.
UpdateUserPoolClientResponse Represents the response from the server to the request to update the user pool client.
UpdateUserPoolRequest Container for the parameters to the UpdateUserPool operation. Updates the specified user pool with the specified attributes.
UserImportInProgressException
UserImportJobType The user import job type.
UserLambdaValidationException
UserNotConfirmedException
UserNotFoundException
UserPoolClientDescription The description of the user poool client.
UserPoolClientType A user pool of the client type.
UserPoolDescriptionType A user pool description.
UserPoolPolicyType The type of policy in a user pool.
UserPoolType A container with information about the user pool type.
UserType The user type.
UsernameExistsException
VerifyUserAttributeRequest Container for the parameters to the VerifyUserAttribute operation. Verifies the specified user attributes in the user pool.