models.cognito-idp-2016-04-18-model.json Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidp Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-04-18",
"endpointPrefix":"cognito-idp",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Cognito Identity Provider",
"signatureVersion":"v4",
"targetPrefix":"AWSCognitoIdentityProviderService"
},
"operations":{
"AddCustomAttributes":{
"name":"AddCustomAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddCustomAttributesRequest"},
"output":{"shape":"AddCustomAttributesResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Adds additional user attributes to the user pool schema.
"
},
"AdminConfirmSignUp":{
"name":"AdminConfirmSignUp",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminConfirmSignUpRequest"},
"output":{"shape":"AdminConfirmSignUpResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"UnexpectedLambdaException"},
{"shape":"UserLambdaValidationException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyFailedAttemptsException"},
{"shape":"InvalidLambdaResponseException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalErrorException"}
],
"documentation":"Confirms user registration as an admin without using a confirmation code. Works on any user.
"
},
"AdminDeleteUser":{
"name":"AdminDeleteUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminDeleteUserRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Deletes a user as an administrator. Works on any user.
"
},
"AdminDeleteUserAttributes":{
"name":"AdminDeleteUserAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminDeleteUserAttributesRequest"},
"output":{"shape":"AdminDeleteUserAttributesResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Deletes the user attributes in a user pool as an administrator. Works on any user.
"
},
"AdminDisableUser":{
"name":"AdminDisableUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminDisableUserRequest"},
"output":{"shape":"AdminDisableUserResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Disables the specified user as an administrator. Works on any user.
"
},
"AdminEnableUser":{
"name":"AdminEnableUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminEnableUserRequest"},
"output":{"shape":"AdminEnableUserResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Enables the specified user as an administrator. Works on any user.
"
},
"AdminGetUser":{
"name":"AdminGetUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminGetUserRequest"},
"output":{"shape":"AdminGetUserResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Gets the specified user by user name in a user pool as an administrator. Works on any user.
"
},
"AdminResetUserPassword":{
"name":"AdminResetUserPassword",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminResetUserPasswordRequest"},
"output":{"shape":"AdminResetUserPasswordResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"UnexpectedLambdaException"},
{"shape":"UserLambdaValidationException"},
{"shape":"NotAuthorizedException"},
{"shape":"InvalidLambdaResponseException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalErrorException"}
],
"documentation":"Resets the specified user's password in a user pool as an administrator. Works on any user.
"
},
"AdminSetUserSettings":{
"name":"AdminSetUserSettings",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminSetUserSettingsRequest"},
"output":{"shape":"AdminSetUserSettingsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"NotAuthorizedException"}
],
"documentation":"Sets all the user settings for a specified user name. Works on any user.
"
},
"AdminUpdateUserAttributes":{
"name":"AdminUpdateUserAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminUpdateUserAttributesRequest"},
"output":{"shape":"AdminUpdateUserAttributesResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"UnexpectedLambdaException"},
{"shape":"UserLambdaValidationException"},
{"shape":"InvalidLambdaResponseException"},
{"shape":"AliasExistsException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
"
},
"ChangePassword":{
"name":"ChangePassword",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ChangePasswordRequest"},
"output":{"shape":"ChangePasswordResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidPasswordException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Changes the password for a specified user in a user pool.
",
"authtype":"none"
},
"ConfirmForgotPassword":{
"name":"ConfirmForgotPassword",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ConfirmForgotPasswordRequest"},
"output":{"shape":"ConfirmForgotPasswordResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"UnexpectedLambdaException"},
{"shape":"UserLambdaValidationException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidPasswordException"},
{"shape":"NotAuthorizedException"},
{"shape":"CodeMismatchException"},
{"shape":"ExpiredCodeException"},
{"shape":"TooManyFailedAttemptsException"},
{"shape":"InvalidLambdaResponseException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalErrorException"}
],
"documentation":"Allows a user to enter a code provided when they reset their password to update their password.
",
"authtype":"none"
},
"ConfirmSignUp":{
"name":"ConfirmSignUp",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ConfirmSignUpRequest"},
"output":{"shape":"ConfirmSignUpResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"UnexpectedLambdaException"},
{"shape":"UserLambdaValidationException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyFailedAttemptsException"},
{"shape":"CodeMismatchException"},
{"shape":"ExpiredCodeException"},
{"shape":"InvalidLambdaResponseException"},
{"shape":"AliasExistsException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalErrorException"}
],
"documentation":"Confirms registration of a user and handles the existing alias from a previous user.
",
"authtype":"none"
},
"CreateUserPool":{
"name":"CreateUserPool",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateUserPoolRequest"},
"output":{"shape":"CreateUserPoolResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"Creates a new Amazon Cognito user pool and sets the password policy for the pool.
"
},
"CreateUserPoolClient":{
"name":"CreateUserPoolClient",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateUserPoolClientRequest"},
"output":{"shape":"CreateUserPoolClientResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalErrorException"}
],
"documentation":"Creates the user pool client.
"
},
"DeleteUser":{
"name":"DeleteUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteUserRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Allows a user to delete one's self.
",
"authtype":"none"
},
"DeleteUserAttributes":{
"name":"DeleteUserAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteUserAttributesRequest"},
"output":{"shape":"DeleteUserAttributesResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Deletes the attributes for a user.
",
"authtype":"none"
},
"DeleteUserPool":{
"name":"DeleteUserPool",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteUserPoolRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Deletes the specified Amazon Cognito user pool.
"
},
"DeleteUserPoolClient":{
"name":"DeleteUserPoolClient",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteUserPoolClientRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Allows the developer to delete the user pool client.
"
},
"DescribeUserPool":{
"name":"DescribeUserPool",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeUserPoolRequest"},
"output":{"shape":"DescribeUserPoolResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Returns the configuration information and metadata of the specified user pool.
"
},
"DescribeUserPoolClient":{
"name":"DescribeUserPoolClient",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeUserPoolClientRequest"},
"output":{"shape":"DescribeUserPoolClientResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Client method for returning the configuration information and metadata of the specified user pool client.
"
},
"ForgotPassword":{
"name":"ForgotPassword",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ForgotPasswordRequest"},
"output":{"shape":"ForgotPasswordResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"UnexpectedLambdaException"},
{"shape":"UserLambdaValidationException"},
{"shape":"NotAuthorizedException"},
{"shape":"InvalidLambdaResponseException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalErrorException"}
],
"documentation":"Retrieves the password for the specified client ID or username.
",
"authtype":"none"
},
"GetUser":{
"name":"GetUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetUserRequest"},
"output":{"shape":"GetUserResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Gets the user attributes and metadata for a user.
",
"authtype":"none"
},
"GetUserAttributeVerificationCode":{
"name":"GetUserAttributeVerificationCode",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetUserAttributeVerificationCodeRequest"},
"output":{"shape":"GetUserAttributeVerificationCodeResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotAuthorizedException"},
{"shape":"UnexpectedLambdaException"},
{"shape":"UserLambdaValidationException"},
{"shape":"InvalidLambdaResponseException"},
{"shape":"InternalErrorException"}
],
"documentation":"Gets the user attribute verification code for the specified attribute name.
",
"authtype":"none"
},
"ListUserPoolClients":{
"name":"ListUserPoolClients",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListUserPoolClientsRequest"},
"output":{"shape":"ListUserPoolClientsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Lists the clients that have been created for the specified user pool.
"
},
"ListUserPools":{
"name":"ListUserPools",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListUserPoolsRequest"},
"output":{"shape":"ListUserPoolsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Lists the user pools associated with an AWS account.
"
},
"ListUsers":{
"name":"ListUsers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListUsersRequest"},
"output":{"shape":"ListUsersResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Lists the users in the Amazon Cognito user pool.
"
},
"ResendConfirmationCode":{
"name":"ResendConfirmationCode",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResendConfirmationCodeRequest"},
"output":{"shape":"ResendConfirmationCodeResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"UnexpectedLambdaException"},
{"shape":"UserLambdaValidationException"},
{"shape":"NotAuthorizedException"},
{"shape":"InvalidLambdaResponseException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalErrorException"}
],
"documentation":"Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
",
"authtype":"none"
},
"SetUserSettings":{
"name":"SetUserSettings",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetUserSettingsRequest"},
"output":{"shape":"SetUserSettingsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"NotAuthorizedException"}
],
"documentation":"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.
",
"authtype":"none"
},
"SignUp":{
"name":"SignUp",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SignUpRequest"},
"output":{"shape":"SignUpResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"UnexpectedLambdaException"},
{"shape":"UserLambdaValidationException"},
{"shape":"NotAuthorizedException"},
{"shape":"InvalidPasswordException"},
{"shape":"InvalidLambdaResponseException"},
{"shape":"UsernameExistsException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Registers the user in the specified user pool and creates a user name, password, and user attributes.
",
"authtype":"none"
},
"UpdateUserAttributes":{
"name":"UpdateUserAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateUserAttributesRequest"},
"output":{"shape":"UpdateUserAttributesResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"CodeMismatchException"},
{"shape":"ExpiredCodeException"},
{"shape":"NotAuthorizedException"},
{"shape":"UnexpectedLambdaException"},
{"shape":"UserLambdaValidationException"},
{"shape":"InvalidLambdaResponseException"},
{"shape":"TooManyRequestsException"},
{"shape":"AliasExistsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Allows a user to update a specific attribute (one at a time).
",
"authtype":"none"
},
"UpdateUserPool":{
"name":"UpdateUserPool",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateUserPoolRequest"},
"output":{"shape":"UpdateUserPoolResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"ConcurrentModificationException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Updates the specified user pool with the specified attributes.
"
},
"UpdateUserPoolClient":{
"name":"UpdateUserPoolClient",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateUserPoolClientRequest"},
"output":{"shape":"UpdateUserPoolClientResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Allows the developer to update the specified user pool client and password policy.
"
},
"VerifyUserAttribute":{
"name":"VerifyUserAttribute",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"VerifyUserAttributeRequest"},
"output":{"shape":"VerifyUserAttributeResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"CodeMismatchException"},
{"shape":"ExpiredCodeException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
],
"documentation":"Verifies the specified user attributes in the user pool.
",
"authtype":"none"
}
},
"shapes":{
"AddCustomAttributesRequest":{
"type":"structure",
"required":[
"UserPoolId",
"CustomAttributes"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to add custom attributes.
"
},
"CustomAttributes":{
"shape":"CustomAttributesListType",
"documentation":"An array of custom attributes, such as Mutable and Name.
"
}
},
"documentation":"Represents the request to add custom attributes.
"
},
"AddCustomAttributesResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response from the server for the request to add custom attributes.
"
},
"AdminConfirmSignUpRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Username"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for which you want to confirm user registration.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name for which you want to confirm user registration.
"
}
},
"documentation":"Represents the request to confirm user registration.
"
},
"AdminConfirmSignUpResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response from the server for the request to confirm registration.
"
},
"AdminDeleteUserAttributesRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Username",
"UserAttributeNames"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to delete user attributes.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user from which you would like to delete attributes.
"
},
"UserAttributeNames":{
"shape":"AttributeNameListType",
"documentation":"An array of strings representing the user attribute names you wish to delete.
"
}
},
"documentation":"Represents the request to delete user attributes as an administrator.
"
},
"AdminDeleteUserAttributesResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response received from the server for a request to delete user attributes.
"
},
"AdminDeleteUserRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Username"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to delete the user.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user you wish to delete.
"
}
},
"documentation":"Represents the request to delete a user as an administrator.
"
},
"AdminDisableUserRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Username"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to disable the user.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user you wish to disable.
"
}
},
"documentation":"Represents the request to disable any user as an administrator.
"
},
"AdminDisableUserResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response received from the server to disable the user as an administrator.
"
},
"AdminEnableUserRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Username"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to enable the user.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user you wish to ebable.
"
}
},
"documentation":"Represents the request that enables the user as an administrator.
"
},
"AdminEnableUserResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response from the server for the request to enable a user as an administrator.
"
},
"AdminGetUserRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Username"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to get information about the user.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user you wish to retrieve.
"
}
},
"documentation":"Represents the request to get the specified user as an administrator.
"
},
"AdminGetUserResponse":{
"type":"structure",
"required":["Username"],
"members":{
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user about whom you are receiving information.
"
},
"UserAttributes":{
"shape":"AttributeListType",
"documentation":"An array of name-value pairs representing user attributes.
"
},
"UserCreateDate":{
"shape":"DateType",
"documentation":"The date the user was created.
"
},
"UserLastModifiedDate":{
"shape":"DateType",
"documentation":"The date the user was last modified.
"
},
"Enabled":{
"shape":"BooleanType",
"documentation":"Indicates that the status is enabled.
"
},
"UserStatus":{
"shape":"UserStatusType",
"documentation":"The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
"
},
"MFAOptions":{
"shape":"MFAOptionListType",
"documentation":"Specifies the options for MFA (e.g., email or phone number).
"
}
},
"documentation":"Represents the response from the server from the request to get the specified user as an administrator.
"
},
"AdminResetUserPasswordRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Username"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to reset the user's password.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user whose password you wish to reset.
"
}
},
"documentation":"Represents the request to reset a user's password as an administrator.
"
},
"AdminResetUserPasswordResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response from the server to reset a user password as an administrator.
"
},
"AdminSetUserSettingsRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Username",
"MFAOptions"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user for whom you wish to set user settings.
"
},
"MFAOptions":{
"shape":"MFAOptionListType",
"documentation":"Specifies the options for MFA (e.g., email or phone number).
"
}
},
"documentation":"Represents the request to set user settings as an administrator.
"
},
"AdminSetUserSettingsResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response from the server to set user settings as an administrator.
"
},
"AdminUpdateUserAttributesRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Username",
"UserAttributes"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to update user attributes.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user for whom you want to update user attributes.
"
},
"UserAttributes":{
"shape":"AttributeListType",
"documentation":"An array of name-value pairs representing user attributes.
"
}
},
"documentation":"Represents the request to update the user's attributes as an administrator.
"
},
"AdminUpdateUserAttributesResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response from the server for the request to update user attributes as an administrator.
"
},
"AliasAttributeType":{
"type":"string",
"enum":[
"phone_number",
"email",
"preferred_username"
]
},
"AliasAttributesListType":{
"type":"list",
"member":{"shape":"AliasAttributeType"}
},
"AliasExistsException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message sent to the user when an alias exists.
"
}
},
"documentation":"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. This exception tells user that an account with this email or phone already exists.
",
"exception":true
},
"ArnType":{
"type":"string",
"max":2048,
"min":20
},
"AttributeDataType":{
"type":"string",
"enum":[
"String",
"Number",
"DateTime",
"Boolean"
]
},
"AttributeListType":{
"type":"list",
"member":{"shape":"AttributeType"}
},
"AttributeNameListType":{
"type":"list",
"member":{"shape":"AttributeNameType"}
},
"AttributeNameType":{
"type":"string",
"max":32,
"min":1,
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
},
"AttributeType":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"AttributeNameType",
"documentation":"The name of the attribute.
"
},
"Value":{
"shape":"AttributeValueType",
"documentation":"The value of the attribute.
"
}
},
"documentation":"Specifies whether the attribute is standard or custom.
"
},
"AttributeValueType":{
"type":"string",
"max":256,
"sensitive":true
},
"BooleanType":{"type":"boolean"},
"ChangePasswordRequest":{
"type":"structure",
"required":[
"PreviousPassword",
"ProposedPassword"
],
"members":{
"PreviousPassword":{
"shape":"PasswordType",
"documentation":"The old password in the change password request.
"
},
"ProposedPassword":{
"shape":"PasswordType",
"documentation":"The new password in the change password request.
"
},
"AccessToken":{
"shape":"TokenModelType",
"documentation":"The access token in the change password request.
"
}
},
"documentation":"Represents the request to change a user password.
"
},
"ChangePasswordResponse":{
"type":"structure",
"members":{
},
"documentation":"The response from the server to the change password request.
"
},
"ClientIdType":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\w+]+",
"sensitive":true
},
"ClientNameType":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\w\\s+=,.@-]+"
},
"ClientSecretType":{
"type":"string",
"max":64,
"min":1,
"pattern":"[\\w+]+",
"sensitive":true
},
"CodeDeliveryDetailsListType":{
"type":"list",
"member":{"shape":"CodeDeliveryDetailsType"}
},
"CodeDeliveryDetailsType":{
"type":"structure",
"members":{
"Destination":{
"shape":"StringType",
"documentation":"The destination for the code delivery details.
"
},
"DeliveryMedium":{
"shape":"DeliveryMediumType",
"documentation":"The delivery medium (email message or phone number).
"
},
"AttributeName":{
"shape":"AttributeNameType",
"documentation":"The name of the attribute in the code delivery details type.
"
}
},
"documentation":"The type of code delivery details being returned from the server.
"
},
"CodeMismatchException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message provided when the code mismatch exception is thrown.
"
}
},
"documentation":"This exception is thrown if the provided code does not match what the server was expecting.
",
"exception":true
},
"ConcurrentModificationException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message provided when the concurrent exception is thrown.
"
}
},
"documentation":"This exception is thrown if two or more modifications are happening concurrently.
",
"exception":true
},
"ConfirmForgotPasswordRequest":{
"type":"structure",
"required":[
"ClientId",
"Username",
"ConfirmationCode",
"Password"
],
"members":{
"ClientId":{
"shape":"ClientIdType",
"documentation":"The ID of the client associated with the user pool.
"
},
"SecretHash":{
"shape":"SecretHashType",
"documentation":"A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user for whom you want to enter a code to retrieve a forgotten password.
"
},
"ConfirmationCode":{
"shape":"ConfirmationCodeType",
"documentation":"The confirmation code sent by a user's request to retrieve a forgotten password.
"
},
"Password":{
"shape":"PasswordType",
"documentation":"The password sent by sent by a user's request to retrieve a forgotten password.
"
}
},
"documentation":"The request representing the confirmation for a password reset.
"
},
"ConfirmForgotPasswordResponse":{
"type":"structure",
"members":{
},
"documentation":"The response from the server that results from a user's request to retrieve a forgotten password.
"
},
"ConfirmSignUpRequest":{
"type":"structure",
"required":[
"ClientId",
"Username",
"ConfirmationCode"
],
"members":{
"ClientId":{
"shape":"ClientIdType",
"documentation":"The ID of the client associated with the user pool.
"
},
"SecretHash":{
"shape":"SecretHashType",
"documentation":"A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user whose registration you wish to confirm.
"
},
"ConfirmationCode":{
"shape":"ConfirmationCodeType",
"documentation":"The confirmation code sent by a user's request to confirm registration.
"
},
"ForceAliasCreation":{
"shape":"ForceAliasCreation",
"documentation":"Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
"
}
},
"documentation":"Represents the request to confirm registration of a user.
"
},
"ConfirmSignUpResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response from the server for the registration confirmation.
"
},
"ConfirmationCodeType":{
"type":"string",
"max":2048,
"min":1,
"pattern":"[\\S]+"
},
"CreateUserPoolClientRequest":{
"type":"structure",
"required":[
"UserPoolId",
"ClientName"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to create a user pool client.
"
},
"ClientName":{
"shape":"ClientNameType",
"documentation":"The client name for the user pool client you would like to create.
"
},
"GenerateSecret":{
"shape":"GenerateSecret",
"documentation":" Boolean to specify whether you want to generate a secret for the user pool client being created.
"
}
},
"documentation":"Represents the request to create a user pool client.
"
},
"CreateUserPoolClientResponse":{
"type":"structure",
"members":{
"UserPoolClient":{
"shape":"UserPoolClientType",
"documentation":"The user pool client that was just created.
"
}
},
"documentation":"Represents the response from the server to create a user pool client.
"
},
"CreateUserPoolRequest":{
"type":"structure",
"required":["PoolName"],
"members":{
"PoolName":{
"shape":"UserPoolNameType",
"documentation":"A string used to name the user pool.
"
},
"Policies":{
"shape":"UserPoolPolicyType",
"documentation":"The policies associated with the new user pool.
"
},
"LambdaConfig":{
"shape":"LambdaConfigType",
"documentation":"The Lambda trigger configuration information for the new user pool.
"
},
"AutoVerifiedAttributes":{
"shape":"VerifiedAttributesListType",
"documentation":"The attributes to be auto-verified. Possible values: email, phone_number.
"
},
"AliasAttributes":{
"shape":"AliasAttributesListType",
"documentation":"Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
"
},
"SmsVerificationMessage":{
"shape":"SmsVerificationMessageType",
"documentation":"A string representing the SMS verification message.
"
},
"EmailVerificationMessage":{
"shape":"EmailVerificationMessageType",
"documentation":"A string representing the email verification message.
"
},
"EmailVerificationSubject":{
"shape":"EmailVerificationSubjectType",
"documentation":"A string representing the email verification subject.
"
},
"SmsAuthenticationMessage":{
"shape":"SmsVerificationMessageType",
"documentation":"A string representing the SMS authentication message.
"
},
"MfaConfiguration":{
"shape":"UserPoolMfaType",
"documentation":"Specifies MFA configuration details.
"
}
},
"documentation":"Represents the request to create a user pool.
"
},
"CreateUserPoolResponse":{
"type":"structure",
"members":{
"UserPool":{
"shape":"UserPoolType",
"documentation":"A container for the user pool details.
"
}
},
"documentation":"Represents the response from the server for the request to create a user pool.
"
},
"CustomAttributeNameType":{
"type":"string",
"max":20,
"min":1,
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
},
"CustomAttributesListType":{
"type":"list",
"member":{"shape":"SchemaAttributeType"},
"max":25,
"min":1
},
"DateType":{"type":"timestamp"},
"DeleteUserAttributesRequest":{
"type":"structure",
"required":["UserAttributeNames"],
"members":{
"UserAttributeNames":{
"shape":"AttributeNameListType",
"documentation":"An array of strings representing the user attribute names you wish to delete.
"
},
"AccessToken":{
"shape":"TokenModelType",
"documentation":"The access token used in the request to delete user attributes.
"
}
},
"documentation":"Represents the request to delete user attributes.
"
},
"DeleteUserAttributesResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response from the server to delete user attributes.
"
},
"DeleteUserPoolClientRequest":{
"type":"structure",
"required":[
"UserPoolId",
"ClientId"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to delete the client.
"
},
"ClientId":{
"shape":"ClientIdType",
"documentation":"The ID of the client associated with the user pool.
"
}
},
"documentation":"Represents the request to delete a user pool client.
"
},
"DeleteUserPoolRequest":{
"type":"structure",
"required":["UserPoolId"],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool you want to delete.
"
}
},
"documentation":"Represents the request to delete a user pool.
"
},
"DeleteUserRequest":{
"type":"structure",
"members":{
"AccessToken":{
"shape":"TokenModelType",
"documentation":"The access token from a request to delete a user.
"
}
},
"documentation":"Represents the request to delete a user.
"
},
"DeliveryMediumType":{
"type":"string",
"enum":[
"SMS",
"EMAIL"
]
},
"DescribeUserPoolClientRequest":{
"type":"structure",
"required":[
"UserPoolId",
"ClientId"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool you want to describe.
"
},
"ClientId":{
"shape":"ClientIdType",
"documentation":"The ID of the client associated with the user pool.
"
}
},
"documentation":"Represents the request to describe a user pool client.
"
},
"DescribeUserPoolClientResponse":{
"type":"structure",
"members":{
"UserPoolClient":{
"shape":"UserPoolClientType",
"documentation":"The user pool client from a server response to describe the user pool client.
"
}
},
"documentation":"Represents the response from the server from a request to describe the user pool client.
"
},
"DescribeUserPoolRequest":{
"type":"structure",
"required":["UserPoolId"],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool you want to describe.
"
}
},
"documentation":"Represents the request to describe the user pool.
"
},
"DescribeUserPoolResponse":{
"type":"structure",
"members":{
"UserPool":{
"shape":"UserPoolType",
"documentation":"The container of metadata returned by the server to describe the pool.
"
}
},
"documentation":"Represents the response to describe the user pool.
"
},
"EmailVerificationMessageType":{
"type":"string",
"max":2048,
"min":6,
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*"
},
"EmailVerificationSubjectType":{
"type":"string",
"max":140,
"min":1,
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+"
},
"ExpiredCodeException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when the expired code exception is thrown.
"
}
},
"documentation":"This exception is thrown if a code has expired.
",
"exception":true
},
"ForceAliasCreation":{"type":"boolean"},
"ForgotPasswordRequest":{
"type":"structure",
"required":[
"ClientId",
"Username"
],
"members":{
"ClientId":{
"shape":"ClientIdType",
"documentation":"The ID of the client associated with the user pool.
"
},
"SecretHash":{
"shape":"SecretHashType",
"documentation":"A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user for whom you want to enter a code to retrieve a forgotten password.
"
}
},
"documentation":"Represents the request to reset a user's password.
"
},
"ForgotPasswordResponse":{
"type":"structure",
"members":{
"CodeDeliveryDetails":{"shape":"CodeDeliveryDetailsType"}
},
"documentation":"Respresents the response from the server regarding the request to reset a password.
"
},
"GenerateSecret":{"type":"boolean"},
"GetUserAttributeVerificationCodeRequest":{
"type":"structure",
"required":["AttributeName"],
"members":{
"AccessToken":{
"shape":"TokenModelType",
"documentation":"The access token returned by the server response to get the user attribute verification code.
"
},
"AttributeName":{
"shape":"AttributeNameType",
"documentation":"The attribute name returned by the server response to get the user attribute verification code.
"
}
},
"documentation":"Represents the request to get user attribute verification.
"
},
"GetUserAttributeVerificationCodeResponse":{
"type":"structure",
"members":{
"CodeDeliveryDetails":{
"shape":"CodeDeliveryDetailsType",
"documentation":"The code delivery details returned by the server response to get the user attribute verification code.
"
}
},
"documentation":"The verification code response returned by the server response to get the user attribute verification code.
"
},
"GetUserRequest":{
"type":"structure",
"members":{
"AccessToken":{
"shape":"TokenModelType",
"documentation":"The access token returned by the server response to get information about the user.
"
}
},
"documentation":"Represents the request to get information about the user.
"
},
"GetUserResponse":{
"type":"structure",
"required":[
"Username",
"UserAttributes"
],
"members":{
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user you wish to retrieve from the get user request.
"
},
"UserAttributes":{
"shape":"AttributeListType",
"documentation":"An array of name-value pairs representing user attributes.
"
},
"MFAOptions":{
"shape":"MFAOptionListType",
"documentation":"Specifies the options for MFA (e.g., email or phone number).
"
}
},
"documentation":"Represents the response from the server from the request to get information about the user.
"
},
"IntegerType":{"type":"integer"},
"InternalErrorException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when Amazon Cognito throws an internal error exception.
"
}
},
"documentation":"This exception is thrown when Amazon Cognito encounters an internal error.
",
"exception":true,
"fault":true
},
"InvalidLambdaResponseException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when the Amazon Cognito service throws an invalid AWS Lambda response exception.
"
}
},
"documentation":"This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
",
"exception":true
},
"InvalidParameterException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when the Amazon Cognito service throws an invalid parameter exception.
"
}
},
"documentation":"This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
",
"exception":true
},
"InvalidPasswordException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when the Amazon Cognito service throws an invalid user password exception.
"
}
},
"documentation":"This exception is thrown when the Amazon Cognito service encounters an invalid password.
",
"exception":true
},
"LambdaConfigType":{
"type":"structure",
"members":{
"PreSignUp":{
"shape":"ArnType",
"documentation":"A pre-registration AWS Lambda trigger.
"
},
"CustomMessage":{
"shape":"ArnType",
"documentation":"A custom Message AWS Lambda trigger.
"
},
"PostConfirmation":{
"shape":"ArnType",
"documentation":"A post-confirmation AWS Lambda trigger.
"
},
"PreAuthentication":{
"shape":"ArnType",
"documentation":"A pre-authentication AWS Lambda trigger.
"
},
"PostAuthentication":{
"shape":"ArnType",
"documentation":"A post-authentication AWS Lambda trigger.
"
}
},
"documentation":"Specifies the type of configuration for AWS Lambda triggers.
"
},
"LimitExceededException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when Amazon Cognito throws a limit exceeded exception.
"
}
},
"documentation":"This exception is thrown when a user exceeds the limit for a requested AWS resource.
",
"exception":true
},
"ListUserPoolClientsRequest":{
"type":"structure",
"required":["UserPoolId"],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to list user pool clients.
"
},
"MaxResults":{
"shape":"QueryLimit",
"documentation":"The maximum number of results you want the request to return when listing the user pool clients.
"
},
"NextToken":{
"shape":"PaginationKey",
"documentation":"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
"
}
},
"documentation":"Represents the request to list the user pool clients.
"
},
"ListUserPoolClientsResponse":{
"type":"structure",
"members":{
"UserPoolClients":{
"shape":"UserPoolClientListType",
"documentation":"The user pool clients in the response that lists user pool clients.
"
},
"NextToken":{
"shape":"PaginationKey",
"documentation":"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
"
}
},
"documentation":"Represents the response from the server that lists user pool clients.
"
},
"ListUserPoolsRequest":{
"type":"structure",
"required":["MaxResults"],
"members":{
"NextToken":{
"shape":"PaginationKeyType",
"documentation":"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
"
},
"MaxResults":{
"shape":"QueryLimitType",
"documentation":"The maximum number of results you want the request to return when listing the user pools.
"
}
},
"documentation":"Represents the request to list user pools.
"
},
"ListUserPoolsResponse":{
"type":"structure",
"members":{
"UserPools":{
"shape":"UserPoolListType",
"documentation":"The user pools from the response to list users.
"
},
"NextToken":{
"shape":"PaginationKeyType",
"documentation":"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
"
}
},
"documentation":"Represents the response to list user pools.
"
},
"ListUsersRequest":{
"type":"structure",
"required":["UserPoolId"],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for which you want to list users.
"
},
"AttributesToGet":{
"shape":"SearchedAttributeNamesListType",
"documentation":"The attributes to get from the request to list users.
"
},
"Limit":{
"shape":"QueryLimitType",
"documentation":"The limit of the request to list users.
"
},
"PaginationToken":{
"shape":"SearchPaginationTokenType",
"documentation":"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
"
},
"UserStatus":{
"shape":"UserStatusType",
"documentation":"The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
"
}
},
"documentation":"Represents the request to list users.
"
},
"ListUsersResponse":{
"type":"structure",
"members":{
"Users":{
"shape":"UsersListType",
"documentation":"The users returned in the request to list users.
"
},
"PaginationToken":{
"shape":"SearchPaginationTokenType",
"documentation":"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
"
}
},
"documentation":"The response from the request to list users.
"
},
"MFAOptionListType":{
"type":"list",
"member":{"shape":"MFAOptionType"}
},
"MFAOptionType":{
"type":"structure",
"members":{
"DeliveryMedium":{
"shape":"DeliveryMediumType",
"documentation":"The delivery medium (email message or SMS message) to send the MFA code.
"
},
"AttributeName":{
"shape":"AttributeNameType",
"documentation":"The attribute name of the MFA option type.
"
}
},
"documentation":"Specifies the different settings for multi-factor authentication (MFA).
"
},
"MessageType":{"type":"string"},
"NotAuthorizedException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when the Amazon Cognito service returns a not authorized exception.
"
}
},
"documentation":"This exception gets thrown when a user is not authorized.
",
"exception":true
},
"NumberAttributeConstraintsType":{
"type":"structure",
"members":{
"MinValue":{
"shape":"StringType",
"documentation":"The minimum value of an attribute that is of the number data type.
"
},
"MaxValue":{
"shape":"StringType",
"documentation":"The maximum value of an attribute that is of the number data type.
"
}
},
"documentation":"The minimum and maximum value of an attribute that is of the number data type.
"
},
"PaginationKey":{
"type":"string",
"min":1
},
"PaginationKeyType":{
"type":"string",
"min":1,
"pattern":"[\\S]+"
},
"PasswordPolicyMinLengthType":{
"type":"integer",
"max":99,
"min":6
},
"PasswordPolicyType":{
"type":"structure",
"members":{
"MinimumLength":{
"shape":"PasswordPolicyMinLengthType",
"documentation":"The minimum length of the password policy that you have set. Cannot be less than 6.
"
},
"RequireUppercase":{
"shape":"BooleanType",
"documentation":"In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
"
},
"RequireLowercase":{
"shape":"BooleanType",
"documentation":"In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
"
},
"RequireNumbers":{
"shape":"BooleanType",
"documentation":"In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
"
},
"RequireSymbols":{
"shape":"BooleanType",
"documentation":"In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
"
}
},
"documentation":"The password policy type.
"
},
"PasswordType":{
"type":"string",
"max":256,
"min":6,
"pattern":"[\\S]+",
"sensitive":true
},
"QueryLimit":{
"type":"integer",
"max":60,
"min":1
},
"QueryLimitType":{
"type":"integer",
"max":60,
"min":1
},
"ResendConfirmationCodeRequest":{
"type":"structure",
"required":[
"ClientId",
"Username"
],
"members":{
"ClientId":{
"shape":"ClientIdType",
"documentation":"The ID of the client associated with the user pool.
"
},
"SecretHash":{
"shape":"SecretHashType",
"documentation":"A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user to whom you wish to resend a confirmation code.
"
}
},
"documentation":"Represents the request to resend the confirmation code.
"
},
"ResendConfirmationCodeResponse":{
"type":"structure",
"members":{
"CodeDeliveryDetails":{"shape":"CodeDeliveryDetailsType"}
},
"documentation":"The response from the server when the Amazon Cognito service makes the request to resend a confirmation code.
"
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when the Amazon Cognito service returns a resource not found exception.
"
}
},
"documentation":"This exception is thrown when the Amazon Cognito service cannot find the requested resource.
",
"exception":true
},
"SchemaAttributeType":{
"type":"structure",
"members":{
"Name":{
"shape":"CustomAttributeNameType",
"documentation":"A schema attribute of the name type.
"
},
"AttributeDataType":{
"shape":"AttributeDataType",
"documentation":"The attribute data type.
"
},
"DeveloperOnlyAttribute":{
"shape":"BooleanType",
"documentation":"Specifies whether the attribute type is developer only.
"
},
"Mutable":{
"shape":"BooleanType",
"documentation":"Specifies whether the attribute can be changed once it has been created.
"
},
"Required":{
"shape":"BooleanType",
"documentation":"Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.
"
},
"NumberAttributeConstraints":{
"shape":"NumberAttributeConstraintsType",
"documentation":"Specifies the constraints for an attribute of the number type.
"
},
"StringAttributeConstraints":{
"shape":"StringAttributeConstraintsType",
"documentation":"Specifies the constraints for an attribute of the string type.
"
}
},
"documentation":"Contains information about the schema attribute.
"
},
"SchemaAttributesListType":{
"type":"list",
"member":{"shape":"SchemaAttributeType"},
"max":50,
"min":1
},
"SearchPaginationTokenType":{
"type":"string",
"min":1
},
"SearchedAttributeNamesListType":{
"type":"list",
"member":{"shape":"AttributeNameType"}
},
"SecretHashType":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\w+=/]+",
"sensitive":true
},
"SetUserSettingsRequest":{
"type":"structure",
"required":[
"AccessToken",
"MFAOptions"
],
"members":{
"AccessToken":{
"shape":"TokenModelType",
"documentation":"The access token for the set user settings request.
"
},
"MFAOptions":{
"shape":"MFAOptionListType",
"documentation":"Specifies the options for MFA (e.g., email or phone number).
"
}
},
"documentation":"Represents the request to set user settings.
"
},
"SetUserSettingsResponse":{
"type":"structure",
"members":{
},
"documentation":"The response from the server for a set user settings request.
"
},
"SignUpRequest":{
"type":"structure",
"required":[
"ClientId",
"Username",
"Password"
],
"members":{
"ClientId":{
"shape":"ClientIdType",
"documentation":"The ID of the client associated with the user pool.
"
},
"SecretHash":{
"shape":"SecretHashType",
"documentation":"A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
"
},
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user you wish to register.
"
},
"Password":{
"shape":"PasswordType",
"documentation":"The password of the user you wish to register.
"
},
"UserAttributes":{
"shape":"AttributeListType",
"documentation":"An array of name-value pairs representing user attributes.
"
},
"ValidationData":{
"shape":"AttributeListType",
"documentation":"The validation data in the request to register a user.
"
}
},
"documentation":"Represents the request to register a user.
"
},
"SignUpResponse":{
"type":"structure",
"members":{
"UserConfirmed":{
"shape":"BooleanType",
"documentation":"A response from the server indicating that a user registration has been confirmed.
"
},
"CodeDeliveryDetails":{"shape":"CodeDeliveryDetailsType"}
},
"documentation":"The response from the server for a registration request.
"
},
"SmsVerificationMessageType":{
"type":"string",
"max":140,
"min":6,
"pattern":".*\\{####\\}.*"
},
"StatusType":{
"type":"string",
"enum":[
"Enabled",
"Disabled"
]
},
"StringAttributeConstraintsType":{
"type":"structure",
"members":{
"MinLength":{
"shape":"StringType",
"documentation":"The minimum length of an attribute value of the string type.
"
},
"MaxLength":{
"shape":"StringType",
"documentation":"The maximum length of an attribute value of the string type.
"
}
},
"documentation":"The type of constraints associated with an attribute of the string type.
"
},
"StringType":{"type":"string"},
"TokenModelType":{
"type":"string",
"sensitive":true
},
"TooManyFailedAttemptsException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when the Amazon Cognito service returns a too many failed attempts exception.
"
}
},
"documentation":"This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).
",
"exception":true
},
"TooManyRequestsException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when the Amazon Cognito service returns a too many requests exception.
"
}
},
"documentation":"This exception gets thrown when the user has made too many requests for a given operation.
",
"exception":true
},
"UnexpectedLambdaException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when the Amazon Cognito service returns an unexpected AWS Lambda exception.
"
}
},
"documentation":"This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
",
"exception":true
},
"UpdateUserAttributesRequest":{
"type":"structure",
"required":["UserAttributes"],
"members":{
"UserAttributes":{
"shape":"AttributeListType",
"documentation":"An array of name-value pairs representing user attributes.
"
},
"AccessToken":{
"shape":"TokenModelType",
"documentation":"The access token for the request to update user attributes.
"
}
},
"documentation":"Represents the request to update user attributes.
"
},
"UpdateUserAttributesResponse":{
"type":"structure",
"members":{
"CodeDeliveryDetailsList":{
"shape":"CodeDeliveryDetailsListType",
"documentation":"The code delivery details list from the server for the request to update user attributes.
"
}
},
"documentation":"Represents the response from the server for the request to update user attributes.
"
},
"UpdateUserPoolClientRequest":{
"type":"structure",
"required":[
"UserPoolId",
"ClientId"
],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to update the user pool client.
"
},
"ClientId":{
"shape":"ClientIdType",
"documentation":"The ID of the client associated with the user pool.
"
},
"ClientName":{
"shape":"ClientNameType",
"documentation":"The client name from the update user pool client request.
"
}
},
"documentation":"Represents the request to update the user pool client.
"
},
"UpdateUserPoolClientResponse":{
"type":"structure",
"members":{
"UserPoolClient":{
"shape":"UserPoolClientType",
"documentation":"The user pool client value from the response from the server when an update user pool client request is made.
"
}
},
"documentation":"Represents the response from the server to the request to update the user pool client.
"
},
"UpdateUserPoolRequest":{
"type":"structure",
"required":["UserPoolId"],
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool you want to update.
"
},
"Policies":{
"shape":"UserPoolPolicyType",
"documentation":"A container with the policies you wish to update in a user pool.
"
},
"LambdaConfig":{
"shape":"LambdaConfigType",
"documentation":"The AWS Lambda configuration information from the request to update the user pool.
"
},
"AutoVerifiedAttributes":{
"shape":"VerifiedAttributesListType",
"documentation":"The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
"
},
"SmsVerificationMessage":{
"shape":"SmsVerificationMessageType",
"documentation":"A container with information about the SMS verification message.
"
},
"EmailVerificationMessage":{
"shape":"EmailVerificationMessageType",
"documentation":"The contents of the email verification message.
"
},
"EmailVerificationSubject":{
"shape":"EmailVerificationSubjectType",
"documentation":"The subject of the email verfication message
"
},
"SmsAuthenticationMessage":{
"shape":"SmsVerificationMessageType",
"documentation":"The contents of the SMS authentication message.
"
},
"MfaConfiguration":{
"shape":"UserPoolMfaType",
"documentation":"Can be one of the following values:
OFF - MFA tokens are not required and cannot be specified during user registration.ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL - Users have the option when registering to create an MFA token.
"
}
},
"documentation":"Represents the request to update the user pool.
"
},
"UpdateUserPoolResponse":{
"type":"structure",
"members":{
},
"documentation":"Represents the response from the server when you make a request to update the user pool.
"
},
"UserLambdaValidationException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when the Amazon Cognito service returns a user validation exception with the AWS Lambda service.
"
}
},
"documentation":"This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
",
"exception":true
},
"UserPoolClientDescription":{
"type":"structure",
"members":{
"ClientId":{
"shape":"ClientIdType",
"documentation":"The ID of the client associated with the user pool.
"
},
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool where you want to describe the user pool client.
"
},
"ClientName":{
"shape":"ClientNameType",
"documentation":"The client name from the user pool client description.
"
}
},
"documentation":"The description of the user poool client.
"
},
"UserPoolClientListType":{
"type":"list",
"member":{"shape":"UserPoolClientDescription"}
},
"UserPoolClientType":{
"type":"structure",
"members":{
"UserPoolId":{
"shape":"UserPoolIdType",
"documentation":"The user pool ID for the user pool client.
"
},
"ClientName":{
"shape":"ClientNameType",
"documentation":"The client name from the user pool request of the client type.
"
},
"ClientId":{
"shape":"ClientIdType",
"documentation":"The ID of the client associated with the user pool.
"
},
"ClientSecret":{
"shape":"ClientSecretType",
"documentation":"The client secret from the user pool request of the client type.
"
},
"LastModifiedDate":{
"shape":"DateType",
"documentation":"The last modified date from the user pool request of the client type.
"
},
"CreationDate":{
"shape":"DateType",
"documentation":"The creation date from the user pool request of the client type.
"
}
},
"documentation":"A user pool of the client type.
"
},
"UserPoolDescriptionType":{
"type":"structure",
"members":{
"Id":{
"shape":"UserPoolIdType",
"documentation":"The ID in a user pool description.
"
},
"Name":{
"shape":"UserPoolNameType",
"documentation":"The name in a user pool description.
"
},
"LambdaConfig":{
"shape":"LambdaConfigType",
"documentation":"The AWS Lambda configuration information in a user pool description.
"
},
"Status":{
"shape":"StatusType",
"documentation":"The user pool status in a user pool description.
"
},
"LastModifiedDate":{
"shape":"DateType",
"documentation":"The last modified date in a user pool description.
"
},
"CreationDate":{
"shape":"DateType",
"documentation":"The creation date in a user pool description.
"
}
},
"documentation":"A user pool description.
"
},
"UserPoolIdType":{
"type":"string",
"max":55,
"min":1,
"pattern":"[\\w-]+.[0-9a-zA-Z-]+"
},
"UserPoolListType":{
"type":"list",
"member":{"shape":"UserPoolDescriptionType"}
},
"UserPoolMfaType":{
"type":"string",
"enum":[
"OFF",
"ON",
"OPTIONAL"
]
},
"UserPoolNameType":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\w\\s+=,.@-]+"
},
"UserPoolPolicyType":{
"type":"structure",
"members":{
"PasswordPolicy":{
"shape":"PasswordPolicyType",
"documentation":"A container with information about the user pool password policy.
"
}
},
"documentation":"The type of policy in a user pool.
"
},
"UserPoolType":{
"type":"structure",
"members":{
"Id":{
"shape":"UserPoolIdType",
"documentation":"The ID of the user pool.
"
},
"Name":{
"shape":"UserPoolNameType",
"documentation":"The name of the user pool.
"
},
"Policies":{
"shape":"UserPoolPolicyType",
"documentation":"A container describing the policies associated with a user pool.
"
},
"LambdaConfig":{
"shape":"LambdaConfigType",
"documentation":"A container describing the AWS Lambda triggers associated with a user pool.
"
},
"Status":{
"shape":"StatusType",
"documentation":"The status of a user pool.
"
},
"LastModifiedDate":{
"shape":"DateType",
"documentation":"The last modified date of a user pool.
"
},
"CreationDate":{
"shape":"DateType",
"documentation":"The creation date of a user pool.
"
},
"SchemaAttributes":{
"shape":"SchemaAttributesListType",
"documentation":"A container with the schema attributes of a user pool.
"
},
"AutoVerifiedAttributes":{
"shape":"VerifiedAttributesListType",
"documentation":"Specifies the attributes that are auto-verified in a user pool.
"
},
"AliasAttributes":{
"shape":"AliasAttributesListType",
"documentation":"Specifies the attributes that are aliased in a user pool.
"
},
"SmsVerificationMessage":{
"shape":"SmsVerificationMessageType",
"documentation":"The contents of the SMS verification message.
"
},
"EmailVerificationMessage":{
"shape":"EmailVerificationMessageType",
"documentation":"The contents of the email verification message.
"
},
"EmailVerificationSubject":{
"shape":"EmailVerificationSubjectType",
"documentation":"The subject of the email verification message.
"
},
"SmsAuthenticationMessage":{
"shape":"SmsVerificationMessageType",
"documentation":"The contents of the SMS authentication message.
"
},
"MfaConfiguration":{
"shape":"UserPoolMfaType",
"documentation":"Can be one of the following values:
OFF - MFA tokens are not required and cannot be specified during user registration.ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL - Users have the option when registering to create an MFA token.
"
},
"EstimatedNumberOfUsers":{
"shape":"IntegerType",
"documentation":"A number estimating the size of the user pool.
"
}
},
"documentation":"A container with information about the user pool type.
"
},
"UserStatusType":{
"type":"string",
"enum":[
"UNCONFIRMED",
"CONFIRMED",
"ARCHIVED",
"COMPROMISED",
"UNKNOWN"
]
},
"UserType":{
"type":"structure",
"members":{
"Username":{
"shape":"UsernameType",
"documentation":"The user name of the user you wish to describe.
"
},
"Attributes":{
"shape":"AttributeListType",
"documentation":"A container with information about the user type attributes.
"
},
"UserCreateDate":{
"shape":"DateType",
"documentation":"The creation date of the user.
"
},
"UserLastModifiedDate":{
"shape":"DateType",
"documentation":"The last modified date of the user.
"
},
"Enabled":{
"shape":"BooleanType",
"documentation":"Specifies whether the user is enabled.
"
},
"UserStatus":{
"shape":"UserStatusType",
"documentation":"The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
"
}
},
"documentation":"The user type.
"
},
"UsernameExistsException":{
"type":"structure",
"members":{
"message":{
"shape":"MessageType",
"documentation":"The message returned when Amazon Cognito throws a user name exists exception.
"
}
},
"documentation":"This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
",
"exception":true
},
"UsernameType":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+",
"sensitive":true
},
"UsersListType":{
"type":"list",
"member":{"shape":"UserType"}
},
"VerifiedAttributeType":{
"type":"string",
"enum":[
"phone_number",
"email"
]
},
"VerifiedAttributesListType":{
"type":"list",
"member":{"shape":"VerifiedAttributeType"}
},
"VerifyUserAttributeRequest":{
"type":"structure",
"required":[
"AttributeName",
"Code"
],
"members":{
"AccessToken":{
"shape":"TokenModelType",
"documentation":"Represents the access token of the request to verify user attributes.
"
},
"AttributeName":{
"shape":"AttributeNameType",
"documentation":"The attribute name in the request to verify user attributes.
"
},
"Code":{
"shape":"ConfirmationCodeType",
"documentation":"The verification code in the request to verify user attributes.
"
}
},
"documentation":"Represents the request to verify user attributes.
"
},
"VerifyUserAttributeResponse":{
"type":"structure",
"members":{
},
"documentation":"A container representing the response from the server from the request to verify user attributes.
"
}
},
"documentation":"You can create a user pool in Amazon Cognito Identity to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito Identity, which is a new capability that is available as a beta.
"
}