llengeResponse":{ "type":"structure", "members":{ "ChallengeName":{ "shape":"ChallengeNameType", "documentation":"

The name of the challenge. For more information, see AdminInitiateAuth.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next `RespondToAuthChallenge` API call.

" }, "ChallengeParameters":{ "shape":"ChallengeParametersType", "documentation":"

The challenge parameters. For more information, see AdminInitiateAuth.

" }, "AuthenticationResult":{ "shape":"AuthenticationResultType", "documentation":"

The result returned by the server in response to the authentication request.

" } }, "documentation":"

Responds to the authentication challenge, as an administrator.

" }, "AdminSetUserMFAPreferenceRequest":{ "type":"structure", "required":[ "Username", "UserPoolId" ], "members":{ "SMSMfaSettings":{ "shape":"SMSMfaSettingsType", "documentation":"

The SMS text message MFA settings.

" }, "SoftwareTokenMfaSettings":{ "shape":"SoftwareTokenMfaSettingsType", "documentation":"

The time-based one-time password software token MFA settings.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" } } }, "AdminSetUserMFAPreferenceResponse":{ "type":"structure", "members":{ } }, "AdminSetUserPasswordRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "Password" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to set the user's password.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "Password":{ "shape":"PasswordType", "documentation":"

The password for the user.

" }, "Permanent":{ "shape":"BooleanType", "documentation":"

`True` if the password is permanent, `False` if it is temporary.

" } } }, "AdminSetUserPasswordResponse":{ "type":"structure", "members":{ } }, "AdminSetUserSettingsRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "MFAOptions" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The ID of the user pool that contains the user whose options you're setting.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "MFAOptions":{ "shape":"MFAOptionListType", "documentation":"

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

" } }, "documentation":"

You can use this parameter to set an MFA configuration that uses the SMS delivery medium.

" }, "AdminSetUserSettingsResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response from the server to set user settings as an administrator.

" }, "AdminUpdateAuthEventFeedbackRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "EventId", "FeedbackValue" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "EventId":{ "shape":"EventIdType", "documentation":"

The authentication event ID.

" }, "FeedbackValue":{ "shape":"FeedbackValueType", "documentation":"

The authentication event feedback value. When you provide a `FeedbackValue` value of `valid`, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a `FeedbackValue` value of `invalid`, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.

" } } }, "AdminUpdateAuthEventFeedbackResponse":{ "type":"structure", "members":{ } }, "AdminUpdateDeviceStatusRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "DeviceKey" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "DeviceRememberedStatus":{ "shape":"DeviceRememberedStatusType", "documentation":"

The status indicating whether a device has been remembered or not.

" } }, "documentation":"

The request to update the device status, as an administrator.

" }, "AdminUpdateDeviceStatusResponse":{ "type":"structure", "members":{ }, "documentation":"

The status response to the request to update the device, 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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "UserAttributes":{ "shape":"AttributeListType", "documentation":"

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the `custom:` prefix to the attribute name.

If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

To update the value of an attribute that requires verification in the same API request, include the `email_verified` or `phone_number_verified` attribute, with a value of `true`. If you set the `email_verified` or `phone_number_verified` value for an `email` or `phone_number` attribute that requires verification to `true`, Amazon Cognito doesn’t send a verification message to your user.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

- Validate the ClientMetadata value.

- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

" } }, "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.

" }, "AdminUserGlobalSignOutRequest":{ "type":"structure", "required":[ "UserPoolId", "Username" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" } }, "documentation":"

The request to sign out of all devices, as an administrator.

" }, "AdminUserGlobalSignOutResponse":{ "type":"structure", "members":{ }, "documentation":"

The global sign-out response, as an administrator.

" }, "AdvancedSecurityModeType":{ "type":"string", "enum":[ "OFF", "AUDIT", "ENFORCED" ] }, "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 that Amazon Cognito sends to the user when the value of an alias attribute is already linked to another user profile.

" } }, "documentation":"

This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.

", "exception":true }, "AnalyticsConfigurationType":{ "type":"structure", "members":{ "ApplicationId":{ "shape":"HexStringType", "documentation":"

The application ID for an Amazon Pinpoint application.

" }, "ApplicationArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.

" }, "RoleArn":{ "shape":"ArnType", "documentation":"

The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

" }, "ExternalId":{ "shape":"StringType", "documentation":"

The external ID.

" }, "UserDataShared":{ "shape":"BooleanType", "documentation":"

If `UserDataShared` is `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

" } }, "documentation":"

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.

In Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

" }, "AnalyticsMetadataType":{ "type":"structure", "members":{ "AnalyticsEndpointId":{ "shape":"StringType", "documentation":"

The endpoint ID.

" } }, "documentation":"

An Amazon Pinpoint analytics endpoint.

An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.

" }, "ArnType":{ "type":"string", "max":2048, "min":20, "pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?" }, "AssociateSoftwareTokenRequest":{ "type":"structure", "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose software token you want to generate.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

" } } }, "AssociateSoftwareTokenResponse":{ "type":"structure", "members":{ "SecretCode":{ "shape":"SecretCodeType", "documentation":"

A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

" } } }, "AttributeDataType":{ "type":"string", "enum":[ "String", "Number", "DateTime", "Boolean" ] }, "AttributeListType":{ "type":"list", "member":{"shape":"AttributeType"} }, "AttributeMappingKeyType":{ "type":"string", "max":32, "min":1 }, "AttributeMappingType":{ "type":"map", "key":{"shape":"AttributeMappingKeyType"}, "value":{"shape":"StringType"} }, "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":2048, "sensitive":true }, "AttributesRequireVerificationBeforeUpdateType":{ "type":"list", "member":{"shape":"VerifiedAttributeType"} }, "AuthEventType":{ "type":"structure", "members":{ "EventId":{ "shape":"StringType", "documentation":"

The event ID.

" }, "EventType":{ "shape":"EventType", "documentation":"

The event type.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was created.

" }, "EventResponse":{ "shape":"EventResponseType", "documentation":"

The event response.

" }, "EventRisk":{ "shape":"EventRiskType", "documentation":"

The event risk.

" }, "ChallengeResponses":{ "shape":"ChallengeResponseListType", "documentation":"

The challenge responses.

" }, "EventContextData":{ "shape":"EventContextDataType", "documentation":"

The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.

" }, "EventFeedback":{ "shape":"EventFeedbackType", "documentation":"

A flag specifying the user feedback captured at the time of an event request is good or bad.

" } }, "documentation":"

The authentication event type.

" }, "AuthEventsType":{ "type":"list", "member":{"shape":"AuthEventType"} }, "AuthFlowType":{ "type":"string", "enum":[ "USER_SRP_AUTH", "REFRESH_TOKEN_AUTH", "REFRESH_TOKEN", "CUSTOM_AUTH", "ADMIN_NO_SRP_AUTH", "USER_PASSWORD_AUTH", "ADMIN_USER_PASSWORD_AUTH" ] }, "AuthParametersType":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"}, "sensitive":true }, "AuthSessionValidityType":{ "type":"integer", "max":15, "min":3 }, "AuthenticationResultType":{ "type":"structure", "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user who you want to authenticate.

" }, "ExpiresIn":{ "shape":"IntegerType", "documentation":"

The expiration period of the authentication result in seconds.

" }, "TokenType":{ "shape":"StringType", "documentation":"

The token type.

" }, "RefreshToken":{ "shape":"TokenModelType", "documentation":"

The refresh token.

" }, "IdToken":{ "shape":"TokenModelType", "documentation":"

The ID token.

" }, "NewDeviceMetadata":{ "shape":"NewDeviceMetadataType", "documentation":"

The new device metadata from an authentication result.

" } }, "documentation":"

The authentication result.

" }, "BlockedIPRangeListType":{ "type":"list", "member":{"shape":"StringType"}, "max":200 }, "BooleanType":{"type":"boolean"}, "CSSType":{ "type":"string", "max":131072, "min":0 }, "CSSVersionType":{"type":"string"}, "CallbackURLsListType":{ "type":"list", "member":{"shape":"RedirectUrlType"}, "max":100, "min":0 }, "ChallengeName":{ "type":"string", "enum":[ "Password", "Mfa" ] }, "ChallengeNameType":{ "type":"string", "enum":[ "SMS_MFA", "SOFTWARE_TOKEN_MFA", "SELECT_MFA_TYPE", "MFA_SETUP", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED" ] }, "ChallengeParametersType":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"} }, "ChallengeResponse":{ "type":"string", "enum":[ "Success", "Failure" ] }, "ChallengeResponseListType":{ "type":"list", "member":{"shape":"ChallengeResponseType"} }, "ChallengeResponseType":{ "type":"structure", "members":{ "ChallengeName":{ "shape":"ChallengeName", "documentation":"

The challenge name.

" }, "ChallengeResponse":{ "shape":"ChallengeResponse", "documentation":"

The challenge response.

" } }, "documentation":"

The challenge response type.

" }, "ChallengeResponsesType":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"}, "sensitive":true }, "ChangePasswordRequest":{ "type":"structure", "required":[ "PreviousPassword", "ProposedPassword", "AccessToken" ], "members":{ "PreviousPassword":{ "shape":"PasswordType", "documentation":"

The old password.

" }, "ProposedPassword":{ "shape":"PasswordType", "documentation":"

The new password.

" }, "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose password you want to change.

" } }, "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 }, "ClientMetadataType":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"} }, "ClientNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w\\s+=,.@-]+" }, "ClientPermissionListType":{ "type":"list", "member":{"shape":"ClientPermissionType"} }, "ClientPermissionType":{ "type":"string", "max":2048, "min":1 }, "ClientSecretType":{ "type":"string", "max":64, "min":1, "pattern":"[\\w+]+", "sensitive":true }, "CloudWatchLogsConfigurationType":{ "type":"structure", "members":{ "LogGroupArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs. The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account as your user pool.

To send logs to log groups with a resource policy of a size greater than 5120 characters, configure a log group with a path that starts with `/aws/vendedlogs`. For more information, see Enabling logging from certain Amazon Web Services services.

" } }, "documentation":"

The CloudWatch logging destination of a user pool detailed activity logging configuration.

" }, "CodeDeliveryDetailsListType":{ "type":"list", "member":{"shape":"CodeDeliveryDetailsType"} }, "CodeDeliveryDetailsType":{ "type":"structure", "members":{ "Destination":{ "shape":"StringType", "documentation":"

The email address or phone number destination where Amazon Cognito sent the code.

" }, "DeliveryMedium":{ "shape":"DeliveryMediumType", "documentation":"

The method that Amazon Cognito used to send the code.

" }, "AttributeName":{ "shape":"AttributeNameType", "documentation":"

The name of the attribute that Amazon Cognito verifies with the code.

" } }, "documentation":"

The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.

" }, "CodeDeliveryFailureException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message sent when a verification code fails to deliver successfully.

" } }, "documentation":"

This exception is thrown when a verification code fails to deliver successfully.

", "exception":true }, "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 doesn't match what the server was expecting.

", "exception":true }, "CompletionMessageType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w]+" }, "CompromisedCredentialsActionsType":{ "type":"structure", "required":["EventAction"], "members":{ "EventAction":{ "shape":"CompromisedCredentialsEventActionType", "documentation":"

The event action.

" } }, "documentation":"

The compromised credentials actions type.

" }, "CompromisedCredentialsEventActionType":{ "type":"string", "enum":[ "BLOCK", "NO_ACTION" ] }, "CompromisedCredentialsRiskConfigurationType":{ "type":"structure", "required":["Actions"], "members":{ "EventFilter":{ "shape":"EventFiltersType", "documentation":"

Perform the action for these events. The default is to perform all events if no event filter is specified.

" }, "Actions":{ "shape":"CompromisedCredentialsActionsType", "documentation":"

The compromised credentials risk configuration actions.

" } }, "documentation":"

The compromised credentials risk configuration type.

" }, "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 }, "ConfirmDeviceRequest":{ "type":"structure", "required":[ "AccessToken", "DeviceKey" ], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose device you want to confirm.

" }, "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "DeviceSecretVerifierConfig":{ "shape":"DeviceSecretVerifierConfigType", "documentation":"

The configuration of the device secret verifier.

" }, "DeviceName":{ "shape":"DeviceNameType", "documentation":"

The device name.

" } }, "documentation":"

Confirms the device request.

" }, "ConfirmDeviceResponse":{ "type":"structure", "members":{ "UserConfirmationNecessary":{ "shape":"BooleanType", "documentation":"

Indicates whether the user confirmation must confirm the device response.

" } }, "documentation":"

Confirms the device response.

" }, "ConfirmForgotPasswordRequest":{ "type":"structure", "required":[ "ClientId", "Username", "ConfirmationCode", "Password" ], "members":{ "ClientId":{ "shape":"ClientIdType", "documentation":"

The app client ID of the app 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. For more information about `SecretHash`, see Computing secret hash values.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "ConfirmationCode":{ "shape":"ConfirmationCodeType", "documentation":"

The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.

" }, "Password":{ "shape":"PasswordType", "documentation":"

The new password that your user wants to set.

" }, "AnalyticsMetadata":{ "shape":"AnalyticsMetadataType", "documentation":"

The Amazon Pinpoint analytics metadata for collecting metrics for `ConfirmForgotPassword` calls.

" }, "UserContextData":{ "shape":"UserContextDataType", "documentation":"

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

- Validate the ClientMetadata value.

- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

" } }, "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 app 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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "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.

" }, "AnalyticsMetadata":{ "shape":"AnalyticsMetadataType", "documentation":"

The Amazon Pinpoint analytics metadata for collecting metrics for `ConfirmSignUp` calls.

" }, "UserContextData":{ "shape":"UserContextDataType", "documentation":"

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

- Validate the ClientMetadata value.

- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

" } }, "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]+" }, "ContextDataType":{ "type":"structure", "required":[ "IpAddress", "ServerName", "ServerPath", "HttpHeaders" ], "members":{ "IpAddress":{ "shape":"StringType", "documentation":"

The source IP address of your user's device.

" }, "ServerName":{ "shape":"StringType", "documentation":"

Your server endpoint where this API is invoked.

" }, "ServerPath":{ "shape":"StringType", "documentation":"

Your server path where this API is invoked.

" }, "HttpHeaders":{ "shape":"HttpHeaderList", "documentation":"

HttpHeaders received on your server in same order.

" }, "EncodedData":{ "shape":"StringType", "documentation":"

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

" } }, "documentation":"

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" }, "CreateGroupRequest":{ "type":"structure", "required":[ "GroupName", "UserPoolId" ], "members":{ "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group. Must be unique.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Description":{ "shape":"DescriptionType", "documentation":"

A string containing the description of the group.

" }, "RoleArn":{ "shape":"ArnType", "documentation":"

The role Amazon Resource Name (ARN) for the group.

" }, "Precedence":{ "shape":"PrecedenceType", "documentation":"

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims.

Two groups can have the same `Precedence` value. If this happens, neither group takes precedence over the other. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn't set in users' tokens.

The default `Precedence` value is null. The maximum `Precedence` value is `2^31-1`.

" } } }, "CreateGroupResponse":{ "type":"structure", "members":{ "Group":{ "shape":"GroupType", "documentation":"

The group object for the group.

" } } }, "CreateIdentityProviderRequest":{ "type":"structure", "required":[ "UserPoolId", "ProviderName", "ProviderType", "ProviderDetails" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "ProviderName":{ "shape":"ProviderNameTypeV2", "documentation":"

The IdP name.

" }, "ProviderType":{ "shape":"IdentityProviderTypeType", "documentation":"

The IdP type.

" }, "ProviderDetails":{ "shape":"ProviderDetailsType", "documentation":"

The IdP details. The following list describes the provider detail keys for each IdP type.

- For Google and Login with Amazon:

  - client_id

  - client_secret

  - authorize_scopes

- For Facebook:

  - client_id

  - client_secret

  - authorize_scopes

  - api_version

- For Sign in with Apple:

  - client_id

  - team_id

  - key_id

  - private_key

  - authorize_scopes

- For OpenID Connect (OIDC) providers:

  - client_id

  - client_secret

  - attributes_request_method

  - oidc_issuer

  - authorize_scopes

  - The following keys are only present if Amazon Cognito didn't discover them at the `oidc_issuer` URL.

    - authorize_url

    - token_url

    - attributes_url

    - jwks_uri

  - Amazon Cognito sets the value of the following keys automatically. They are read-only.

    - attributes_url_add_attributes

- For SAML providers:

  - MetadataFile or MetadataURL

  - IDPSignout optional

" }, "AttributeMapping":{ "shape":"AttributeMappingType", "documentation":"

A mapping of IdP attributes to standard and custom user pool attributes.

" }, "IdpIdentifiers":{ "shape":"IdpIdentifiersListType", "documentation":"

A list of IdP identifiers.

" } } }, "CreateIdentityProviderResponse":{ "type":"structure", "required":["IdentityProvider"], "members":{ "IdentityProvider":{ "shape":"IdentityProviderType", "documentation":"

The newly created IdP object.

" } } }, "CreateResourceServerRequest":{ "type":"structure", "required":[ "UserPoolId", "Identifier", "Name" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Identifier":{ "shape":"ResourceServerIdentifierType", "documentation":"

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as `https://my-weather-api.example.com`.

" }, "Name":{ "shape":"ResourceServerNameType", "documentation":"

A friendly name for the resource server.

" }, "Scopes":{ "shape":"ResourceServerScopeListType", "documentation":"

A list of scopes. Each scope is a key-value map with the keys `name` and `description`.

" } } }, "CreateResourceServerResponse":{ "type":"structure", "required":["ResourceServer"], "members":{ "ResourceServer":{ "shape":"ResourceServerType", "documentation":"

The newly created resource server.

" } } }, "CreateUserImportJobRequest":{ "type":"structure", "required":[ "JobName", "UserPoolId", "CloudWatchLogsRoleArn" ], "members":{ "JobName":{ "shape":"UserImportJobNameType", "documentation":"

The job name for the user import job.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "CloudWatchLogsRoleArn":{ "shape":"ArnType", "documentation":"

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

" } }, "documentation":"

Represents the request to create the user import job.

" }, "CreateUserImportJobResponse":{ "type":"structure", "members":{ "UserImportJob":{ "shape":"UserImportJobType", "documentation":"

The job object that represents the user import job.

" } }, "documentation":"

Represents the response from the server to the request to create the user import job.

" }, "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.

" }, "RefreshTokenValidity":{ "shape":"RefreshTokenValidityType", "documentation":"

The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set `RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days`, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for `RefreshTokenValidity` in an API request is days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

" }, "AccessTokenValidity":{ "shape":"AccessTokenValidityType", "documentation":"

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours`, your user can authorize access with their access token for 10 hours.

The default time unit for `AccessTokenValidity` in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

" }, "IdTokenValidity":{ "shape":"IdTokenValidityType", "documentation":"

The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours`, your user can authenticate their session with their ID token for 10 hours.

The default time unit for `IdTokenValidity` in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

" }, "TokenValidityUnits":{ "shape":"TokenValidityUnitsType", "documentation":"

The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.

" }, "ReadAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.

When you don't specify the `ReadAttributes` for your app client, your app can read the values of `email_verified`, `phone_number_verified`, and the Standard attributes of your user pool. When your user pool has read access to these default attributes, `ReadAttributes` doesn't return any information. Amazon Cognito only populates `ReadAttributes` in the API response if you have specified your own custom set of read attributes.

" }, "WriteAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets `family_name` to the new value.

When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes.

If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.

" }, "ExplicitAuthFlows":{ "shape":"ExplicitAuthFlowsListType", "documentation":"

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for `ExplicitAuthFlows`, your user client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and `ALLOW_CUSTOM_AUTH`.

Valid values include:

- `ALLOW_ADMIN_USER_PASSWORD_AUTH`: Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.

- `ALLOW_CUSTOM_AUTH`: Enable Lambda trigger based authentication.

- `ALLOW_USER_PASSWORD_AUTH`: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

- `ALLOW_USER_SRP_AUTH`: Enable SRP-based authentication.

- `ALLOW_REFRESH_TOKEN_AUTH`: Enable authflow to refresh tokens.

In some environments, you will see the values `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_`, like `ALLOW_USER_SRP_AUTH`.

" }, "SupportedIdentityProviders":{ "shape":"SupportedIdentityProvidersListType", "documentation":"

A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO`, `Facebook`, `Google`, `SignInWithApple`, and `LoginWithAmazon`. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP`.

" }, "CallbackURLs":{ "shape":"CallbackURLsListType", "documentation":"

A list of allowed redirect (callback) URLs for the IdPs.

A redirect URI must:

- Be an absolute URI.

- Be registered with the authorization server.

- Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

" }, "LogoutURLs":{ "shape":"LogoutURLsListType", "documentation":"

A list of allowed logout URLs for the IdPs.

" }, "DefaultRedirectURI":{ "shape":"RedirectUrlType", "documentation":"

The default redirect URI. Must be in the `CallbackURLs` list.

A redirect URI must:

- Be an absolute URI.

- Be registered with the authorization server.

- Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

" }, "AllowedOAuthFlows":{ "shape":"OAuthFlowsType", "documentation":"

The allowed OAuth flows.

code

  Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the `/oauth2/token` endpoint.

implicit

  Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

  Issue the access token from the `/oauth2/token` endpoint directly to a non-person user using a combination of the client ID and client secret.

" }, "AllowedOAuthScopes":{ "shape":"ScopeListType", "documentation":"

The allowed OAuth scopes. Possible values provided by OAuth are `phone`, `email`, `openid`, and `profile`. Possible values provided by Amazon Web Services are `aws.cognito.signin.user.admin`. Custom scopes created in Resource Servers are also supported.

" }, "AllowedOAuthFlowsUserPoolClient":{ "shape":"BooleanType", "documentation":"

Set to `true` to use OAuth 2.0 features in your user pool app client.

`AllowedOAuthFlowsUserPoolClient` must be `true` before you can configure the following features in your app client.

- `CallBackURLs`: Callback URLs.

- `LogoutURLs`: Sign-out redirect URLs.

- `AllowedOAuthScopes`: OAuth 2.0 scopes.

- `AllowedOAuthFlows`: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the CLI or SDKs, it defaults to `false`.

" }, "AnalyticsConfiguration":{ "shape":"AnalyticsConfigurationType", "documentation":"

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

" }, "PreventUserExistenceErrors":{ "shape":"PreventUserExistenceErrorTypes", "documentation":"

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to `ENABLED` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY`, those APIs return a `UserNotFoundException` exception if the user doesn't exist in the user pool.

Valid values include:

- `ENABLED` - This prevents user existence-related errors.

- `LEGACY` - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.

" }, "EnableTokenRevocation":{ "shape":"WrappedBooleanType", "documentation":"

Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.

If you don't include this parameter, token revocation is automatically activated for the new user pool client.

" }, "EnablePropagateAdditionalUserContextData":{ "shape":"WrappedBooleanType", "documentation":"

Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret.

" }, "AuthSessionValidity":{ "shape":"AuthSessionValidityType", "documentation":"

Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

" } }, "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.

" }, "CreateUserPoolDomainRequest":{ "type":"structure", "required":[ "Domain", "UserPoolId" ], "members":{ "Domain":{ "shape":"DomainType", "documentation":"

The domain string. For custom domains, this is the fully-qualified domain name, such as `auth.example.com`. For Amazon Cognito prefix domains, this is the prefix alone, such as `auth`.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "CustomDomainConfig":{ "shape":"CustomDomainConfigType", "documentation":"

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

" } } }, "CreateUserPoolDomainResponse":{ "type":"structure", "members":{ "CloudFrontDomain":{ "shape":"DomainType", "documentation":"

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

" } } }, "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.

" }, "DeletionProtection":{ "shape":"DeletionProtectionType", "documentation":"

When active, `DeletionProtection` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a `DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request.

" }, "LambdaConfig":{ "shape":"LambdaConfigType", "documentation":"

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the CLI, see add-permission .

" }, "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.

" }, "UsernameAttributes":{ "shape":"UsernameAttributesListType", "documentation":"

Specifies whether a user can use an email address or phone number as a username when they sign up.

" }, "SmsVerificationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

This parameter is no longer used. See VerificationMessageTemplateType.

" }, "EmailVerificationMessage":{ "shape":"EmailVerificationMessageType", "documentation":"

This parameter is no longer used. See VerificationMessageTemplateType.

" }, "EmailVerificationSubject":{ "shape":"EmailVerificationSubjectType", "documentation":"

This parameter is no longer used. See VerificationMessageTemplateType.

" }, "VerificationMessageTemplate":{ "shape":"VerificationMessageTemplateType", "documentation":"

The template for the verification message that the user sees when the app requests permission to access the user's information.

" }, "SmsAuthenticationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

A string representing the SMS authentication message.

" }, "MfaConfiguration":{ "shape":"UserPoolMfaType", "documentation":"

Specifies MFA configuration details.

" }, "UserAttributeUpdateSettings":{ "shape":"UserAttributeUpdateSettingsType", "documentation":"

The settings for updates to user attributes. These settings include the property `AttributesRequireVerificationBeforeUpdate`, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

" }, "DeviceConfiguration":{ "shape":"DeviceConfigurationType", "documentation":"

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature.

" }, "EmailConfiguration":{ "shape":"EmailConfigurationType", "documentation":"

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

" }, "SmsConfiguration":{ "shape":"SmsConfigurationType", "documentation":"

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

" }, "UserPoolTags":{ "shape":"UserPoolTagsType", "documentation":"

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

" }, "AdminCreateUserConfig":{ "shape":"AdminCreateUserConfigType", "documentation":"

The configuration for `AdminCreateUser` requests.

" }, "Schema":{ "shape":"SchemaAttributesListType", "documentation":"

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

" }, "UserPoolAddOns":{ "shape":"UserPoolAddOnsType", "documentation":"

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to `AUDIT`. To configure automatic security responses to risky traffic to your user pool, set to `ENFORCED`.

For more information, see Adding advanced security to a user pool.

" }, "UsernameConfiguration":{ "shape":"UsernameConfigurationType", "documentation":"

Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username`, `USERNAME`, or `UserName`, or for email, `email@example.com` or `EMaiL@eXamplE.Com`. For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

" }, "AccountRecoverySetting":{ "shape":"AccountRecoverySettingType", "documentation":"

The available verified method a user can use to recover their password when they call `ForgotPassword`. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

" } }, "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 }, "CustomDomainConfigType":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

" } }, "documentation":"

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

" }, "CustomEmailLambdaVersionConfigType":{ "type":"structure", "required":[ "LambdaVersion", "LambdaArn" ], "members":{ "LambdaVersion":{ "shape":"CustomEmailSenderLambdaVersionType", "documentation":"

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a `LambdaVersion` of `V1_0` with a custom sender function.

" }, "LambdaArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

" } }, "documentation":"

The properties of a custom email sender Lambda trigger.

" }, "CustomEmailSenderLambdaVersionType":{ "type":"string", "enum":["V1_0"] }, "CustomSMSLambdaVersionConfigType":{ "type":"structure", "required":[ "LambdaVersion", "LambdaArn" ], "members":{ "LambdaVersion":{ "shape":"CustomSMSSenderLambdaVersionType", "documentation":"

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

You must use a `LambdaVersion` of `V1_0` with a custom sender function.

" }, "LambdaArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

" } }, "documentation":"

The properties of a custom SMS sender Lambda trigger.

" }, "CustomSMSSenderLambdaVersionType":{ "type":"string", "enum":["V1_0"] }, "DateType":{"type":"timestamp"}, "DefaultEmailOptionType":{ "type":"string", "enum":[ "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE" ] }, "DeleteGroupRequest":{ "type":"structure", "required":[ "GroupName", "UserPoolId" ], "members":{ "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" } } }, "DeleteIdentityProviderRequest":{ "type":"structure", "required":[ "UserPoolId", "ProviderName" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "ProviderName":{ "shape":"ProviderNameType", "documentation":"

The IdP name.

" } } }, "DeleteResourceServerRequest":{ "type":"structure", "required":[ "UserPoolId", "Identifier" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that hosts the resource server.

" }, "Identifier":{ "shape":"ResourceServerIdentifierType", "documentation":"

The identifier for the resource server.

" } } }, "DeleteUserAttributesRequest":{ "type":"structure", "required":[ "UserAttributeNames", "AccessToken" ], "members":{ "UserAttributeNames":{ "shape":"AttributeNameListType", "documentation":"

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prependattach the `custom:` prefix to the front of the attribute name.

" }, "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

" } }, "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 app client ID of the app associated with the user pool.

" } }, "documentation":"

Represents the request to delete a user pool client.

" }, "DeleteUserPoolDomainRequest":{ "type":"structure", "required":[ "Domain", "UserPoolId" ], "members":{ "Domain":{ "shape":"DomainType", "documentation":"

The domain string. For custom domains, this is the fully-qualified domain name, such as `auth.example.com`. For Amazon Cognito prefix domains, this is the prefix alone, such as `auth`.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" } } }, "DeleteUserPoolDomainResponse":{ "type":"structure", "members":{ } }, "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", "required":["AccessToken"], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.

" } }, "documentation":"

Represents the request to delete a user.

" }, "DeletionProtectionType":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "DeliveryMediumListType":{ "type":"list", "member":{"shape":"DeliveryMediumType"} }, "DeliveryMediumType":{ "type":"string", "enum":[ "SMS", "EMAIL" ] }, "DescribeIdentityProviderRequest":{ "type":"structure", "required":[ "UserPoolId", "ProviderName" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "ProviderName":{ "shape":"ProviderNameType", "documentation":"

The IdP name.

" } } }, "DescribeIdentityProviderResponse":{ "type":"structure", "required":["IdentityProvider"], "members":{ "IdentityProvider":{ "shape":"IdentityProviderType", "documentation":"

The identity provider details.

" } } }, "DescribeResourceServerRequest":{ "type":"structure", "required":[ "UserPoolId", "Identifier" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that hosts the resource server.

" }, "Identifier":{ "shape":"ResourceServerIdentifierType", "documentation":"

The identifier for the resource server

" } } }, "DescribeResourceServerResponse":{ "type":"structure", "required":["ResourceServer"], "members":{ "ResourceServer":{ "shape":"ResourceServerType", "documentation":"

The resource server.

" } } }, "DescribeRiskConfigurationRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The app client ID.

" } } }, "DescribeRiskConfigurationResponse":{ "type":"structure", "required":["RiskConfiguration"], "members":{ "RiskConfiguration":{ "shape":"RiskConfigurationType", "documentation":"

The risk configuration.

" } } }, "DescribeUserImportJobRequest":{ "type":"structure", "required":[ "UserPoolId", "JobId" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "JobId":{ "shape":"UserImportJobIdType", "documentation":"

The job ID for the user import job.

" } }, "documentation":"

Represents the request to describe the user import job.

" }, "DescribeUserImportJobResponse":{ "type":"structure", "members":{ "UserImportJob":{ "shape":"UserImportJobType", "documentation":"

The job object that represents the user import job.

" } }, "documentation":"

Represents the response from the server to the request to describe the user import job.

" }, "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 app client ID of the app 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.

" }, "DescribeUserPoolDomainRequest":{ "type":"structure", "required":["Domain"], "members":{ "Domain":{ "shape":"DomainType", "documentation":"

The domain string. For custom domains, this is the fully-qualified domain name, such as `auth.example.com`. For Amazon Cognito prefix domains, this is the prefix alone, such as `auth`.

" } } }, "DescribeUserPoolDomainResponse":{ "type":"structure", "members":{ "DomainDescription":{ "shape":"DomainDescriptionType", "documentation":"

A domain description object containing information about the domain.

" } } }, "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.

" }, "DescriptionType":{ "type":"string", "max":2048 }, "DeviceConfigurationType":{ "type":"structure", "members":{ "ChallengeRequiredOnNewDevice":{ "shape":"BooleanType", "documentation":"

When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

Whether or not `ChallengeRequiredOnNewDevice` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.

" }, "DeviceOnlyRememberedOnUserPrompt":{ "shape":"BooleanType", "documentation":"

When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.

When `DeviceOnlyRememberedOnUserPrompt` is `false`, Amazon Cognito immediately remembers devices that you register in a `ConfirmDevice` API request.

" } }, "documentation":"

The device-remembering configuration for a user pool. A DescribeUserPool request returns a null value for this object when the user pool isn't configured to remember devices. When device remembering is active, you can remember a user's device with a ConfirmDevice API request. Additionally. when the property `DeviceOnlyRememberedOnUserPrompt` is `true`, you must follow `ConfirmDevice` with an UpdateDeviceStatus API request that sets the user's device to `remembered` or `not_remembered`.

To sign in with a remembered device, include `DEVICE_KEY` in the authentication parameters in your user's InitiateAuth request. If your app doesn't include a `DEVICE_KEY` parameter, the response from Amazon Cognito includes newly-generated `DEVICE_KEY` and `DEVICE_GROUP_KEY` values under `NewDeviceMetadata`. Store these values to use in future device-authentication requests.

When you provide a value for any property of `DeviceConfiguration`, you activate the device remembering for the user pool.

" }, "DeviceKeyType":{ "type":"string", "max":55, "min":1, "pattern":"[\\w-]+_[0-9a-f-]+" }, "DeviceListType":{ "type":"list", "member":{"shape":"DeviceType"} }, "DeviceNameType":{ "type":"string", "max":1024, "min":1 }, "DeviceRememberedStatusType":{ "type":"string", "enum":[ "remembered", "not_remembered" ] }, "DeviceSecretVerifierConfigType":{ "type":"structure", "members":{ "PasswordVerifier":{ "shape":"StringType", "documentation":"

The password verifier.

" }, "Salt":{ "shape":"StringType", "documentation":"

The salt

" } }, "documentation":"

The device verifier against which it is authenticated.

" }, "DeviceType":{ "type":"structure", "members":{ "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "DeviceAttributes":{ "shape":"AttributeListType", "documentation":"

The device attributes.

" }, "DeviceCreateDate":{ "shape":"DateType", "documentation":"

The creation date of the device.

" }, "DeviceLastModifiedDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was modified.

" }, "DeviceLastAuthenticatedDate":{ "shape":"DateType", "documentation":"

The date when the device was last authenticated.

" } }, "documentation":"

The device type.

" }, "DomainDescriptionType":{ "type":"structure", "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "AWSAccountId":{ "shape":"AWSAccountIdType", "documentation":"

The Amazon Web Services ID for the user pool owner.

" }, "Domain":{ "shape":"DomainType", "documentation":"

The domain string. For custom domains, this is the fully-qualified domain name, such as `auth.example.com`. For Amazon Cognito prefix domains, this is the prefix alone, such as `auth`.

" }, "S3Bucket":{ "shape":"S3BucketType", "documentation":"

The Amazon S3 bucket where the static files for this domain are stored.

" }, "CloudFrontDistribution":{ "shape":"StringType", "documentation":"

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

" }, "Version":{ "shape":"DomainVersionType", "documentation":"

The app version.

" }, "Status":{ "shape":"DomainStatusType", "documentation":"

The domain status.

" }, "CustomDomainConfig":{ "shape":"CustomDomainConfigType", "documentation":"

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

" } }, "documentation":"

A container for information about a domain.

" }, "DomainStatusType":{ "type":"string", "enum":[ "CREATING", "DELETING", "UPDATING", "ACTIVE", "FAILED" ] }, "DomainType":{ "type":"string", "max":63, "min":1, "pattern":"^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$" }, "DomainVersionType":{ "type":"string", "max":20, "min":1 }, "DuplicateProviderException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception is thrown when the provider is already supported by the user pool.

", "exception":true }, "EmailAddressType":{ "type":"string", "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+@[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" }, "EmailConfigurationType":{ "type":"structure", "members":{ "SourceArn":{ "shape":"ArnType", "documentation":"

The ARN of a verified email address or an address from a verified domain in Amazon SES. You can set a `SourceArn` email from a verified domain only with an API request. You can set a verified email address, but not an address in a verified domain, in the Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following ways, depending on the value that you specify for the `EmailSendingAccount` parameter:

- If you specify `COGNITO_DEFAULT`, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.

- If you specify `DEVELOPER`, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

The Region value of the `SourceArn` parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the `SourceArn` and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.

" }, "ReplyToEmailAddress":{ "shape":"EmailAddressType", "documentation":"

The destination to which the receiver of the email should reply.

" }, "EmailSendingAccount":{ "shape":"EmailSendingAccountType", "documentation":"

Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

COGNITO_DEFAULT

  When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

  To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide.

  The default FROM address is `no-reply@verificationemail.com`. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the `SourceArn` parameter.

DEVELOPER

  When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.

  If you use this option, provide the ARN of an Amazon SES verified email address for the `SourceArn` parameter.

  Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role in your Amazon Web Services account. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.

" }, "From":{ "shape":"StringType", "documentation":"

Either the sender’s email address or the sender’s name with their email address. For example, `testuser@example.com` or `Test User <testuser@example.com>`. This address appears before the body of the email.

" }, "ConfigurationSet":{ "shape":"SESConfigurationSet", "documentation":"

The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:

Event publishing

  Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch

IP pool management

  When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

" } }, "documentation":"

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you created your user pool, and in alternate Regions in some cases. For more information on the supported Regions, see Email settings for Amazon Cognito user pools.

" }, "EmailNotificationBodyType":{ "type":"string", "max":20000, "min":6, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]+" }, "EmailNotificationSubjectType":{ "type":"string", "max":140, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+" }, "EmailSendingAccountType":{ "type":"string", "enum":[ "COGNITO_DEFAULT", "DEVELOPER" ] }, "EmailVerificationMessageByLinkType":{ "type":"string", "max":20000, "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*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*" }, "EmailVerificationMessageType":{ "type":"string", "max":20000, "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*]*" }, "EmailVerificationSubjectByLinkType":{ "type":"string", "max":140, "min":1, "pattern":"[\\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]+" }, "EnableSoftwareTokenMFAException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).

", "exception":true }, "EventContextDataType":{ "type":"structure", "members":{ "IpAddress":{ "shape":"StringType", "documentation":"

The source IP address of your user's device.

" }, "DeviceName":{ "shape":"StringType", "documentation":"

The user's device name.

" }, "Timezone":{ "shape":"StringType", "documentation":"

The user's time zone.

" }, "City":{ "shape":"StringType", "documentation":"

The user's city.

" }, "Country":{ "shape":"StringType", "documentation":"

The user's country.

" } }, "documentation":"

Specifies the user context data captured at the time of an event request.

" }, "EventFeedbackType":{ "type":"structure", "required":[ "FeedbackValue", "Provider" ], "members":{ "FeedbackValue":{ "shape":"FeedbackValueType", "documentation":"

The authentication event feedback value. When you provide a `FeedbackValue` value of `valid`, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a `FeedbackValue` value of `invalid`, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.

" }, "Provider":{ "shape":"StringType", "documentation":"

The provider.

" }, "FeedbackDate":{ "shape":"DateType", "documentation":"

The event feedback date.

" } }, "documentation":"

Specifies the event feedback type.

" }, "EventFilterType":{ "type":"string", "enum":[ "SIGN_IN", "PASSWORD_CHANGE", "SIGN_UP" ] }, "EventFiltersType":{ "type":"list", "member":{"shape":"EventFilterType"} }, "EventIdType":{ "type":"string", "max":50, "min":1, "pattern":"[\\w+-]+" }, "EventResponseType":{ "type":"string", "enum":[ "Pass", "Fail", "InProgress" ] }, "EventRiskType":{ "type":"structure", "members":{ "RiskDecision":{ "shape":"RiskDecisionType", "documentation":"

The risk decision.

" }, "RiskLevel":{ "shape":"RiskLevelType", "documentation":"

The risk level.

" }, "CompromisedCredentialsDetected":{ "shape":"WrappedBooleanType", "documentation":"

Indicates whether compromised credentials were detected during an authentication event.

" } }, "documentation":"

The event risk type.

" }, "EventSourceName":{ "type":"string", "enum":["userNotification"] }, "EventType":{ "type":"string", "enum":[ "SignIn", "SignUp", "ForgotPassword", "PasswordChange", "ResendCode" ] }, "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 }, "ExplicitAuthFlowsListType":{ "type":"list", "member":{"shape":"ExplicitAuthFlowsType"} }, "ExplicitAuthFlowsType":{ "type":"string", "enum":[ "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH" ] }, "FeedbackValueType":{ "type":"string", "enum":[ "Valid", "Invalid" ] }, "ForbiddenException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

" } }, "documentation":"

This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

", "exception":true }, "ForceAliasCreation":{"type":"boolean"}, "ForgetDeviceRequest":{ "type":"structure", "required":["DeviceKey"], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

" }, "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" } }, "documentation":"

Represents the request to forget the device.

" }, "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.

" }, "UserContextData":{ "shape":"UserContextDataType", "documentation":"

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "AnalyticsMetadata":{ "shape":"AnalyticsMetadataType", "documentation":"

The Amazon Pinpoint analytics metadata that contributes to your metrics for `ForgotPassword` calls.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

- Validate the ClientMetadata value.

- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

" } }, "documentation":"

Represents the request to reset a user's password.

" }, "ForgotPasswordResponse":{ "type":"structure", "members":{ "CodeDeliveryDetails":{ "shape":"CodeDeliveryDetailsType", "documentation":"

The code delivery details returned by the server in response to the request to reset a password.

" } }, "documentation":"

The response from Amazon Cognito to a request to reset a password.

" }, "GenerateSecret":{"type":"boolean"}, "GetCSVHeaderRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are to be imported into.

" } }, "documentation":"

Represents the request to get the header information of the CSV file for the user import job.

" }, "GetCSVHeaderResponse":{ "type":"structure", "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are to be imported into.

" }, "CSVHeader":{ "shape":"ListOfStringTypes", "documentation":"

The header information of the CSV file for the user import job.

" } }, "documentation":"

Represents the response from the server to the request to get the header information of the CSV file for the user import job.

" }, "GetDeviceRequest":{ "type":"structure", "required":["DeviceKey"], "members":{ "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose device information you want to request.

" } }, "documentation":"

Represents the request to get the device.

" }, "GetDeviceResponse":{ "type":"structure", "required":["Device"], "members":{ "Device":{ "shape":"DeviceType", "documentation":"

The device.

" } }, "documentation":"

Gets the device response.

" }, "GetGroupRequest":{ "type":"structure", "required":[ "GroupName", "UserPoolId" ], "members":{ "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" } } }, "GetGroupResponse":{ "type":"structure", "members":{ "Group":{ "shape":"GroupType", "documentation":"

The group object for the group.

" } } }, "GetIdentityProviderByIdentifierRequest":{ "type":"structure", "required":[ "UserPoolId", "IdpIdentifier" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "IdpIdentifier":{ "shape":"IdpIdentifierType", "documentation":"

The IdP identifier.

" } } }, "GetIdentityProviderByIdentifierResponse":{ "type":"structure", "required":["IdentityProvider"], "members":{ "IdentityProvider":{ "shape":"IdentityProviderType", "documentation":"

The identity provider details.

" } } }, "GetLogDeliveryConfigurationRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The ID of the user pool where you want to view detailed activity logging configuration.

" } } }, "GetLogDeliveryConfigurationResponse":{ "type":"structure", "members":{ "LogDeliveryConfiguration":{ "shape":"LogDeliveryConfigurationType", "documentation":"

The detailed activity logging configuration of the requested user pool.

" } } }, "GetSigningCertificateRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" } }, "documentation":"

Request to get a signing certificate from Amazon Cognito.

" }, "GetSigningCertificateResponse":{ "type":"structure", "members":{ "Certificate":{ "shape":"StringType", "documentation":"

The signing certificate.

" } }, "documentation":"

Response from Amazon Cognito for a signing certificate request.

" }, "GetUICustomizationRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The client ID for the client app.

" } } }, "GetUICustomizationResponse":{ "type":"structure", "required":["UICustomization"], "members":{ "UICustomization":{ "shape":"UICustomizationType", "documentation":"

The UI customization information.

" } } }, "GetUserAttributeVerificationCodeRequest":{ "type":"structure", "required":[ "AccessToken", "AttributeName" ], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A non-expired access token for the user whose attribute verification code you want to generate.

" }, "AttributeName":{ "shape":"AttributeNameType", "documentation":"

The attribute name returned by the server response to get the user attribute verification code.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

- Validate the ClientMetadata value.

- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

" } }, "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 in response to the request to get the user attribute verification code.

" } }, "documentation":"

The verification code response returned by the server response to get the user attribute verification code.

" }, "GetUserPoolMfaConfigRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" } } }, "GetUserPoolMfaConfigResponse":{ "type":"structure", "members":{ "SmsMfaConfiguration":{ "shape":"SmsMfaConfigType", "documentation":"

The SMS text message multi-factor authentication (MFA) configuration.

" }, "SoftwareTokenMfaConfiguration":{ "shape":"SoftwareTokenMfaConfigType", "documentation":"

The software token multi-factor authentication (MFA) configuration.

" }, "MfaConfiguration":{ "shape":"UserPoolMfaType", "documentation":"

The multi-factor authentication (MFA) configuration. Valid values include:

- `OFF` MFA won't be used for any users.

- `ON` MFA is required for all users to sign in.

- `OPTIONAL` MFA will be required only for individual users who have an MFA factor activated.

" } } }, "GetUserRequest":{ "type":"structure", "required":["AccessToken"], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A non-expired access token for the user whose information you want to query.

" } }, "documentation":"

Represents the request to get information about the user.

" }, "GetUserResponse":{ "type":"structure", "required":[ "Username", "UserAttributes" ], "members":{ "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you requested.

" }, "UserAttributes":{ "shape":"AttributeListType", "documentation":"

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the `custom:` prefix to the attribute name.

" }, "MFAOptions":{ "shape":"MFAOptionListType", "documentation":"

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

" }, "PreferredMfaSetting":{ "shape":"StringType", "documentation":"

The user's preferred MFA setting.

" }, "UserMFASettingList":{ "shape":"UserMFASettingListType", "documentation":"

The MFA options that are activated for the user. The possible values in this list are `SMS_MFA` and `SOFTWARE_TOKEN_MFA`.

" } }, "documentation":"

Represents the response from the server from the request to get information about the user.

" }, "GlobalSignOutRequest":{ "type":"structure", "required":["AccessToken"], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user who you want to sign out.

" } }, "documentation":"

Represents the request to sign out all devices.

" }, "GlobalSignOutResponse":{ "type":"structure", "members":{ }, "documentation":"

The response to the request to sign out all devices.

" }, "GroupExistsException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.

", "exception":true }, "GroupListType":{ "type":"list", "member":{"shape":"GroupType"} }, "GroupNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" }, "GroupType":{ "type":"structure", "members":{ "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Description":{ "shape":"DescriptionType", "documentation":"

A string containing the description of the group.

" }, "RoleArn":{ "shape":"ArnType", "documentation":"

The role Amazon Resource Name (ARN) for the group.

" }, "Precedence":{ "shape":"PrecedenceType", "documentation":"

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower `Precedence` values take precedence over groups with higher ornull `Precedence` values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims.

Two groups can have the same `Precedence` value. If this happens, neither group takes precedence over the other. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn't set in users' tokens.

The default `Precedence` value is null.

" }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was modified.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was created.

" } }, "documentation":"

The group type.

" }, "HexStringType":{ "type":"string", "pattern":"^[0-9a-fA-F]+$" }, "HttpHeader":{ "type":"structure", "members":{ "headerName":{ "shape":"StringType", "documentation":"

The header name.

" }, "headerValue":{ "shape":"StringType", "documentation":"

The header value.

" } }, "documentation":"

The HTTP header.

" }, "HttpHeaderList":{ "type":"list", "member":{"shape":"HttpHeader"} }, "IdTokenValidityType":{ "type":"integer", "max":86400, "min":1 }, "IdentityProviderType":{ "type":"structure", "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "ProviderName":{ "shape":"ProviderNameType", "documentation":"

The IdP name.

" }, "ProviderType":{ "shape":"IdentityProviderTypeType", "documentation":"

The IdP type.

" }, "ProviderDetails":{ "shape":"ProviderDetailsType", "documentation":"

The IdP details. The following list describes the provider detail keys for each IdP type.

- For Google and Login with Amazon:

  - client_id

  - client_secret

  - authorize_scopes

- For Facebook:

  - client_id

  - client_secret

  - authorize_scopes

  - api_version

- For Sign in with Apple:

  - client_id

  - team_id

  - key_id

  - private_key

    You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.

  - authorize_scopes

- For OIDC providers:

  - client_id

  - client_secret

  - attributes_request_method

  - oidc_issuer

  - authorize_scopes

  - The following keys are only present if Amazon Cognito didn't discover them at the `oidc_issuer` URL.

    - authorize_url

    - token_url

    - attributes_url

    - jwks_uri

  - Amazon Cognito sets the value of the following keys automatically. They are read-only.

    - attributes_url_add_attributes

- For SAML providers:

  - MetadataFile or MetadataURL

  - IDPSignout optional

" }, "AttributeMapping":{ "shape":"AttributeMappingType", "documentation":"

A mapping of IdP attributes to standard and custom user pool attributes.

" }, "IdpIdentifiers":{ "shape":"IdpIdentifiersListType", "documentation":"

A list of IdP identifiers.

" }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was modified.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was created.

" } }, "documentation":"

A container for information about an IdP.

" }, "IdentityProviderTypeType":{ "type":"string", "enum":[ "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC" ] }, "IdpIdentifierType":{ "type":"string", "max":40, "min":1, "pattern":"[\\w\\s+=.@-]+" }, "IdpIdentifiersListType":{ "type":"list", "member":{"shape":"IdpIdentifierType"}, "max":50, "min":0 }, "ImageFileType":{ "type":"blob", "max":131072, "min":0 }, "ImageUrlType":{"type":"string"}, "InitiateAuthRequest":{ "type":"structure", "required":[ "AuthFlow", "ClientId" ], "members":{ "AuthFlow":{ "shape":"AuthFlowType", "documentation":"

The authentication flow for this call to run. The API action will depend on this value. For example:

- `REFRESH_TOKEN_AUTH` takes in a valid refresh token and returns new tokens.

- `USER_SRP_AUTH` takes in `USERNAME` and `SRP_A` and returns the SRP variables to be used for next challenge execution.

- `USER_PASSWORD_AUTH` takes in `USERNAME` and `PASSWORD` and returns the next challenge or tokens.

Valid values include:

- `USER_SRP_AUTH`: Authentication flow for the Secure Remote Password (SRP) protocol.

- `REFRESH_TOKEN_AUTH`/`REFRESH_TOKEN`: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

- `CUSTOM_AUTH`: Custom authentication flow.

- `USER_PASSWORD_AUTH`: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

`ADMIN_NO_SRP_AUTH` isn't a valid value.

" }, "AuthParameters":{ "shape":"AuthParametersType", "documentation":"

The authentication parameters. These are inputs corresponding to the `AuthFlow` that you're invoking. The required values depend on the value of `AuthFlow`:

- For `USER_SRP_AUTH`: `USERNAME` (required), `SRP_A` (required), `SECRET_HASH` (required if the app client is configured with a client secret), `DEVICE_KEY`.

- For `USER_PASSWORD_AUTH`: `USERNAME` (required), `PASSWORD` (required), `SECRET_HASH` (required if the app client is configured with a client secret), `DEVICE_KEY`.

- For `REFRESH_TOKEN_AUTH/REFRESH_TOKEN`: `REFRESH_TOKEN` (required), `SECRET_HASH` (required if the app client is configured with a client secret), `DEVICE_KEY`.

- For `CUSTOM_AUTH`: `USERNAME` (required), `SECRET_HASH` (if app client is configured with client secret), `DEVICE_KEY`. To start the authentication flow with password verification, include `ChallengeName: SRP_A` and `SRP_A: (The SRP_A Value)`.

For more information about `SECRET_HASH`, see Computing secret hash values. For information about `DEVICE_KEY`, see Working with user devices in your user pool.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

- Pre signup

- Pre authentication

- User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a `validationData` attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the `validationData` value to enhance your workflow for your specific needs.

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

- Post authentication

- Custom message

- Pre token generation

- Create auth challenge

- Define auth challenge

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

- Validate the ClientMetadata value.

- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The app client ID.

" }, "AnalyticsMetadata":{ "shape":"AnalyticsMetadataType", "documentation":"

The Amazon Pinpoint analytics metadata that contributes to your metrics for `InitiateAuth` calls.

" }, "UserContextData":{ "shape":"UserContextDataType", "documentation":"

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

" } }, "documentation":"

Initiates the authentication request.

" }, "InitiateAuthResponse":{ "type":"structure", "members":{ "ChallengeName":{ "shape":"ChallengeNameType", "documentation":"

The name of the challenge that you're responding to with this call. This name is returned in the `InitiateAuth` response if you must pass another challenge.

Valid values include the following:

All of the following challenges require `USERNAME` and `SECRET_HASH` (if applicable) in the parameters.

- `SMS_MFA`: Next challenge is to supply an `SMS_MFA_CODE`, delivered via SMS.

- `PASSWORD_VERIFIER`: Next challenge is to supply `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and `TIMESTAMP` after the client-side SRP calculations.

- `CUSTOM_CHALLENGE`: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

- `DEVICE_SRP_AUTH`: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

- `DEVICE_PASSWORD_VERIFIER`: Similar to `PASSWORD_VERIFIER`, but for devices only.

- `NEW_PASSWORD_REQUIRED`: For users who are required to change their passwords after successful first login.

  Respond to this challenge with `NEW_PASSWORD` and any required attributes that Amazon Cognito returned in the `requiredAttributes` parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see RespondToAuthChallenge.

  In a `NEW_PASSWORD_REQUIRED` challenge response, you can't modify a required attribute that already has a value. In `RespondToAuthChallenge`, set a value for any keys that Amazon Cognito returned in the `requiredAttributes` parameter, then use the `UpdateUserAttributes` API operation to modify the value of any additional attributes.

- `MFA_SETUP`: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters `MFAS_CAN_SETUP` value.

  To set up software token MFA, use the session returned here from `InitiateAuth` as an input to `AssociateSoftwareToken`. Use the session returned by `VerifySoftwareToken` as an input to `RespondToAuthChallenge` with challenge name `MFA_SETUP` to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call `InitiateAuth` again to restart sign-in.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next `RespondToAuthChallenge` API call.

" }, "ChallengeParameters":{ "shape":"ChallengeParametersType", "documentation":"

The challenge parameters. These are returned in the `InitiateAuth` response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (`RespondToAuthChallenge`).

All challenges require `USERNAME` and `SECRET_HASH` (if applicable).

" }, "AuthenticationResult":{ "shape":"AuthenticationResultType", "documentation":"

The result of the authentication response. This result is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, `ChallengeName`, `ChallengeParameters`, and `Session` are returned.

" } }, "documentation":"

Initiates the authentication response.

" }, "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 }, "InvalidEmailRoleAccessPolicyException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when you have an unverified email address or the identity policy isn't set on an email address that Amazon Cognito can access.

" } }, "documentation":"

This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.

", "exception":true }, "InvalidLambdaResponseException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when Amazon Cognito throws an invalid Lambda response exception.

" } }, "documentation":"

This exception is thrown when Amazon Cognito encounters an invalid Lambda response.

", "exception":true }, "InvalidOAuthFlowException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception is thrown when the specified OAuth flow is not valid.

", "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 Amazon Cognito throws an invalid user password exception.

" } }, "documentation":"

This exception is thrown when Amazon Cognito encounters an invalid password.

", "exception":true }, "InvalidSmsRoleAccessPolicyException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the invalid SMS role access policy exception is thrown.

" } }, "documentation":"

This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.

", "exception":true }, "InvalidSmsRoleTrustRelationshipException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the role trust relationship for the SMS message is not valid.

" } }, "documentation":"

This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust `cognito-idp.amazonaws.com` or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.

", "exception":true }, "InvalidUserPoolConfigurationException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the user pool configuration is not valid.

" } }, "documentation":"

This exception is thrown when the user pool configuration is not valid.

", "exception":true }, "LambdaConfigType":{ "type":"structure", "members":{ "PreSignUp":{ "shape":"ArnType", "documentation":"

A pre-registration Lambda trigger.

" }, "CustomMessage":{ "shape":"ArnType", "documentation":"

A custom Message Lambda trigger.

" }, "PostConfirmation":{ "shape":"ArnType", "documentation":"

A post-confirmation Lambda trigger.

" }, "PreAuthentication":{ "shape":"ArnType", "documentation":"

A pre-authentication Lambda trigger.

" }, "PostAuthentication":{ "shape":"ArnType", "documentation":"

A post-authentication Lambda trigger.

" }, "DefineAuthChallenge":{ "shape":"ArnType", "documentation":"

Defines the authentication challenge.

" }, "CreateAuthChallenge":{ "shape":"ArnType", "documentation":"

Creates an authentication challenge.

" }, "VerifyAuthChallengeResponse":{ "shape":"ArnType", "documentation":"

Verifies the authentication challenge response.

" }, "PreTokenGeneration":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

Set this parameter for legacy purposes. If you also set an ARN in `PreTokenGenerationConfig`, its value must be identical to `PreTokenGeneration`. For new instances of pre token generation triggers, set the `LambdaArn` of `PreTokenGenerationConfig`.

You can set ``

" }, "PreTokenGenerationConfig":{ "shape":"PreTokenGenerationVersionConfigType", "documentation":"

The detailed configuration of a pre token generation trigger. If you also set an ARN in `PreTokenGeneration`, its value must be identical to `PreTokenGenerationConfig`.

" }, "UserMigration":{ "shape":"ArnType", "documentation":"

The user migration Lambda config type.

" }, "CustomSMSSender":{ "shape":"CustomSMSLambdaVersionConfigType", "documentation":"

A custom SMS sender Lambda trigger.

" }, "CustomEmailSender":{ "shape":"CustomEmailLambdaVersionConfigType", "documentation":"

A custom email sender Lambda trigger.

" }, "KMSKeyID":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to `CustomEmailSender` and `CustomSMSSender`.

" } }, "documentation":"

Specifies the configuration for 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 Amazon Web Services resource.

", "exception":true }, "ListDevicesRequest":{ "type":"structure", "required":["AccessToken"], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.

" }, "Limit":{ "shape":"QueryLimitType", "documentation":"

The limit of the device request.

" }, "PaginationToken":{ "shape":"SearchPaginationTokenType", "documentation":"

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

" } }, "documentation":"

Represents the request to list the devices.

" }, "ListDevicesResponse":{ "type":"structure", "members":{ "Devices":{ "shape":"DeviceListType", "documentation":"

The devices returned in the list devices response.

" }, "PaginationToken":{ "shape":"SearchPaginationTokenType", "documentation":"

The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

" } }, "documentation":"

Represents the response to list devices.

" }, "ListGroupsRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Limit":{ "shape":"QueryLimitType", "documentation":"

The limit of the request to list groups.

" }, "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.

" } } }, "ListGroupsResponse":{ "type":"structure", "members":{ "Groups":{ "shape":"GroupListType", "documentation":"

The group objects for the groups.

" }, "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.

" } } }, "ListIdentityProvidersRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "MaxResults":{ "shape":"ListProvidersLimitType", "documentation":"

The maximum number of IdPs to return.

" }, "NextToken":{ "shape":"PaginationKeyType", "documentation":"

A pagination token.

" } } }, "ListIdentityProvidersResponse":{ "type":"structure", "required":["Providers"], "members":{ "Providers":{ "shape":"ProvidersListType", "documentation":"

A list of IdP objects.

" }, "NextToken":{ "shape":"PaginationKeyType", "documentation":"

A pagination token.

" } } }, "ListOfStringTypes":{ "type":"list", "member":{"shape":"StringType"} }, "ListProvidersLimitType":{ "type":"integer", "max":60, "min":0 }, "ListResourceServersLimitType":{ "type":"integer", "max":50, "min":1 }, "ListResourceServersRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "MaxResults":{ "shape":"ListResourceServersLimitType", "documentation":"

The maximum number of resource servers to return.

" }, "NextToken":{ "shape":"PaginationKeyType", "documentation":"

A pagination token.

" } } }, "ListResourceServersResponse":{ "type":"structure", "required":["ResourceServers"], "members":{ "ResourceServers":{ "shape":"ResourceServersListType", "documentation":"

The resource servers.

" }, "NextToken":{ "shape":"PaginationKeyType", "documentation":"

A pagination token.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"UserPoolTagsType", "documentation":"

The tags that are assigned to the user pool.

" } } }, "ListUserImportJobsRequest":{ "type":"structure", "required":[ "UserPoolId", "MaxResults" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "MaxResults":{ "shape":"PoolQueryLimitType", "documentation":"

The maximum number of import jobs you want the request to return.

" }, "PaginationToken":{ "shape":"PaginationKeyType", "documentation":"

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

" } }, "documentation":"

Represents the request to list the user import jobs.

" }, "ListUserImportJobsResponse":{ "type":"structure", "members":{ "UserImportJobs":{ "shape":"UserImportJobsListType", "documentation":"

The user import jobs.

" }, "PaginationToken":{ "shape":"PaginationKeyType", "documentation":"

The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

" } }, "documentation":"

Represents the response from the server to the request to list the user import jobs.

" }, "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":"PoolQueryLimitType", "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.

" }, "ListUsersInGroupRequest":{ "type":"structure", "required":[ "UserPoolId", "GroupName" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group.

" }, "Limit":{ "shape":"QueryLimitType", "documentation":"

The maximum number of users that you want to retrieve before pagination.

" }, "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.

" } } }, "ListUsersInGroupResponse":{ "type":"structure", "members":{ "Users":{ "shape":"UsersListType", "documentation":"

A list of users in the group, and their attributes.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

An identifier that you can use in a later request to return the next set of items in the list.

" } } }, "ListUsersRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool on which the search should be performed.

" }, "AttributesToGet":{ "shape":"SearchedAttributeNamesListType", "documentation":"

A JSON array of user attribute names, for example `given_name`, that you want Amazon Cognito to include in the response for each user. When you don't provide an `AttributesToGet` parameter, Amazon Cognito returns all attributes for each user.

Use `AttributesToGet` with required attributes in your user pool, or in conjunction with `Filter`. Amazon Cognito returns an error if not all users in the results have set a value for the attribute you request. Attributes that you can't filter on, including custom attributes, must have a value set in every user profile before an `AttributesToGet` parameter returns results.

" }, "Limit":{ "shape":"QueryLimitType", "documentation":"

Maximum number of users to be returned.

" }, "PaginationToken":{ "shape":"SearchPaginationTokenType", "documentation":"

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

" }, "Filter":{ "shape":"UserFilterType", "documentation":"

A filter string of the form \"AttributeName Filter-Type \"AttributeValue\"\". Quotation marks within the filter string must be escaped using the backslash (\\) character. For example, \"`family_name` = \\\"Reddy\\\"\".

- AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.

- Filter-Type: For an exact match, use =, for example, \"`given_name` = \\\"Jon\\\"\". For a prefix (\"starts with\") match, use ^=, for example, \"`given_name` ^= \\\"Jon\\\"\".

- AttributeValue: The attribute value that must be matched for each user.

If the filter string is empty, `ListUsers` returns all users in the user pool.

You can only search for the following standard attributes:

- `username` (case-sensitive)

- `email`

- `phone_number`

- `name`

- `given_name`

- `family_name`

- `preferred_username`

- `cognito:user_status` (called Status in the Console) (case-insensitive)

- `status (called Enabled in the Console) (case-sensitive)`

- `sub`

Custom attributes aren't searchable.

You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the `--query` parameter of the `list-users` action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

" } }, "documentation":"

Represents the request to list users.

" }, "ListUsersResponse":{ "type":"structure", "members":{ "Users":{ "shape":"UsersListType", "documentation":"

A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of `ListUsers` displays both the IdP user and the native user that you linked. You can identify IdP users in the `Users` object of this API response by the IdP prefix that Amazon Cognito appends to `Username`.

" }, "PaginationToken":{ "shape":"SearchPaginationTokenType", "documentation":"

The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

" } }, "documentation":"

The response from the request to list users.

" }, "LogConfigurationListType":{ "type":"list", "member":{"shape":"LogConfigurationType"}, "max":1, "min":0 }, "LogConfigurationType":{ "type":"structure", "required":[ "LogLevel", "EventSource" ], "members":{ "LogLevel":{ "shape":"LogLevel", "documentation":"

The `errorlevel` selection of logs that a user pool sends for detailed activity logging.

" }, "EventSource":{ "shape":"EventSourceName", "documentation":"

The source of events that your user pool sends for detailed activity logging.

" }, "CloudWatchLogsConfiguration":{ "shape":"CloudWatchLogsConfigurationType", "documentation":"

The CloudWatch logging destination of a user pool.

" } }, "documentation":"

The logging parameters of a user pool.

" }, "LogDeliveryConfigurationType":{ "type":"structure", "required":[ "UserPoolId", "LogConfigurations" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The ID of the user pool where you configured detailed activity logging.

" }, "LogConfigurations":{ "shape":"LogConfigurationListType", "documentation":"

The detailed activity logging destination of a user pool.

" } }, "documentation":"

The logging parameters of a user pool.

" }, "LogLevel":{ "type":"string", "enum":["ERROR"] }, "LogoutURLsListType":{ "type":"list", "member":{"shape":"RedirectUrlType"}, "max":100, "min":0 }, "LongType":{"type":"long"}, "MFAMethodNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when Amazon Cognito throws an MFA method not found exception.

" } }, "documentation":"

This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.

", "exception":true }, "MFAOptionListType":{ "type":"list", "member":{"shape":"MFAOptionType"} }, "MFAOptionType":{ "type":"structure", "members":{ "DeliveryMedium":{ "shape":"DeliveryMediumType", "documentation":"

The delivery medium to send the MFA code. You can use this parameter to set only the `SMS` delivery medium value.

" }, "AttributeName":{ "shape":"AttributeNameType", "documentation":"

The attribute name of the MFA option type. The only valid value is `phone_number`.

" } }, "documentation":"

This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.

" }, "MessageActionType":{ "type":"string", "enum":[ "RESEND", "SUPPRESS" ] }, "MessageTemplateType":{ "type":"structure", "members":{ "SMSMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

The message template for SMS messages.

" }, "EmailMessage":{ "shape":"EmailVerificationMessageType", "documentation":"

The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

" }, "EmailSubject":{ "shape":"EmailVerificationSubjectType", "documentation":"

The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

" } }, "documentation":"

The message template structure.

" }, "MessageType":{"type":"string"}, "NewDeviceMetadataType":{ "type":"structure", "members":{ "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "DeviceGroupKey":{ "shape":"StringType", "documentation":"

The device group key.

" } }, "documentation":"

The new device metadata type.

" }, "NotAuthorizedException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service returns a not authorized exception.

" } }, "documentation":"

This exception is thrown when a user isn't authorized.

", "exception":true }, "NotifyConfigurationType":{ "type":"structure", "required":["SourceArn"], "members":{ "From":{ "shape":"StringType", "documentation":"

The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.

" }, "ReplyTo":{ "shape":"StringType", "documentation":"

The destination to which the receiver of an email should reply to.

" }, "SourceArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the `From` parameter.

" }, "BlockEmail":{ "shape":"NotifyEmailType", "documentation":"

Email template used when a detected risk event is blocked.

" }, "NoActionEmail":{ "shape":"NotifyEmailType", "documentation":"

The email template used when a detected risk event is allowed.

" }, "MfaEmail":{ "shape":"NotifyEmailType", "documentation":"

The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.

" } }, "documentation":"

The notify configuration type.

" }, "NotifyEmailType":{ "type":"structure", "required":["Subject"], "members":{ "Subject":{ "shape":"EmailNotificationSubjectType", "documentation":"

The email subject.

" }, "HtmlBody":{ "shape":"EmailNotificationBodyType", "documentation":"

The email HTML body.

" }, "TextBody":{ "shape":"EmailNotificationBodyType", "documentation":"

The email text body.

" } }, "documentation":"

The notify email type.

" }, "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 values of an attribute that is of the number data type.

" }, "OAuthFlowType":{ "type":"string", "enum":[ "code", "implicit", "client_credentials" ] }, "OAuthFlowsType":{ "type":"list", "member":{"shape":"OAuthFlowType"}, "max":3, "min":0 }, "PaginationKey":{ "type":"string", "max":131072, "min":1, "pattern":"[\\S]+" }, "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 in the policy that you have set. This value can't 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.

" }, "TemporaryPasswordValidityDays":{ "shape":"TemporaryPasswordValidityDaysType", "documentation":"

The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to `7`. If you submit a value of `0`, Amazon Cognito treats it as a null value and sets `TemporaryPasswordValidityDays` to its default value.

When you set `TemporaryPasswordValidityDays` for a user pool, you can no longer set a value for the legacy `UnusedAccountValidityDays` parameter in that user pool.

" } }, "documentation":"

The password policy type.

" }, "PasswordResetRequiredException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when a password reset is required.

" } }, "documentation":"

This exception is thrown when a password reset is required.

", "exception":true }, "PasswordType":{ "type":"string", "max":256, "pattern":"[\\S]+", "sensitive":true }, "PoolQueryLimitType":{ "type":"integer", "max":60, "min":1 }, "PreSignedUrlType":{ "type":"string", "max":2048, "min":0 }, "PreTokenGenerationLambdaVersionType":{ "type":"string", "enum":[ "V1_0", "V2_0" ] }, "PreTokenGenerationVersionConfigType":{ "type":"structure", "required":[ "LambdaVersion", "LambdaArn" ], "members":{ "LambdaVersion":{ "shape":"PreTokenGenerationLambdaVersionType", "documentation":"

The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

" }, "LambdaArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

This parameter and the `PreTokenGeneration` property of `LambdaConfig` have the same value. For new instances of pre token generation triggers, set `LambdaArn`.

" } }, "documentation":"

The properties of a pre token generation Lambda trigger.

" }, "PrecedenceType":{ "type":"integer", "min":0 }, "PreconditionNotMetException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when a precondition is not met.

" } }, "documentation":"

This exception is thrown when a precondition is not met.

", "exception":true }, "PreventUserExistenceErrorTypes":{ "type":"string", "enum":[ "LEGACY", "ENABLED" ] }, "PriorityType":{ "type":"integer", "max":2, "min":1 }, "ProviderDescription":{ "type":"structure", "members":{ "ProviderName":{ "shape":"ProviderNameType", "documentation":"

The IdP name.

" }, "ProviderType":{ "shape":"IdentityProviderTypeType", "documentation":"

The IdP type.

" }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The date the provider was last modified.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was created.

" } }, "documentation":"

A container for IdP details.

" }, "ProviderDetailsType":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"} }, "ProviderNameType":{ "type":"string", "max":32, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\p{Z}]+" }, "ProviderNameTypeV2":{ "type":"string", "max":32, "min":1, "pattern":"[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+" }, "ProviderUserIdentifierType":{ "type":"structure", "members":{ "ProviderName":{ "shape":"ProviderNameType", "documentation":"

The name of the provider, such as Facebook, Google, or Login with Amazon.

" }, "ProviderAttributeName":{ "shape":"StringType", "documentation":"

The name of the provider attribute to link to, such as `NameID`.

" }, "ProviderAttributeValue":{ "shape":"StringType", "documentation":"

The value of the provider attribute to link to, such as `xxxxx_account`.

" } }, "documentation":"

A container for information about an IdP for a user pool.

" }, "ProvidersListType":{ "type":"list", "member":{"shape":"ProviderDescription"}, "max":50, "min":0 }, "QueryLimit":{ "type":"integer", "max":60, "min":1 }, "QueryLimitType":{ "type":"integer", "max":60, "min":0 }, "RecoveryMechanismsType":{ "type":"list", "member":{"shape":"RecoveryOptionType"}, "max":2, "min":1 }, "RecoveryOptionNameType":{ "type":"string", "enum":[ "verified_email", "verified_phone_number", "admin_only" ] }, "RecoveryOptionType":{ "type":"structure", "required":[ "Priority", "Name" ], "members":{ "Priority":{ "shape":"PriorityType", "documentation":"

A positive integer specifying priority of a method with 1 being the highest priority.

" }, "Name":{ "shape":"RecoveryOptionNameType", "documentation":"

The recovery method for a user.

" } }, "documentation":"

A map containing a priority as a key, and recovery method name as a value.

" }, "RedirectUrlType":{ "type":"string", "max":1024, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" }, "RefreshTokenValidityType":{ "type":"integer", "max":315360000, "min":0 }, "RegionCodeType":{ "type":"string", "max":32, "min":5 }, "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.

" }, "UserContextData":{ "shape":"UserContextDataType", "documentation":"

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "AnalyticsMetadata":{ "shape":"AnalyticsMetadataType", "documentation":"

The Amazon Pinpoint analytics metadata that contributes to your metrics for `ResendConfirmationCode` calls.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

- Validate the ClientMetadata value.

- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

" } }, "documentation":"

Represents the request to resend the confirmation code.

" }, "ResendConfirmationCodeResponse":{ "type":"structure", "members":{ "CodeDeliveryDetails":{ "shape":"CodeDeliveryDetailsType", "documentation":"

The code delivery details returned by the server in response to the request to resend the confirmation code.

" } }, "documentation":"

The response from the server when Amazon Cognito 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 can't find the requested resource.

", "exception":true }, "ResourceServerIdentifierType":{ "type":"string", "max":256, "min":1, "pattern":"[\\x21\\x23-\\x5B\\x5D-\\x7E]+" }, "ResourceServerNameType":{ "type":"string", "max":256, "min":1, "pattern":"[\\w\\s+=,.@-]+" }, "ResourceServerScopeDescriptionType":{ "type":"string", "max":256, "min":1 }, "ResourceServerScopeListType":{ "type":"list", "member":{"shape":"ResourceServerScopeType"}, "max":100 }, "ResourceServerScopeNameType":{ "type":"string", "max":256, "min":1, "pattern":"[\\x21\\x23-\\x2E\\x30-\\x5B\\x5D-\\x7E]+" }, "ResourceServerScopeType":{ "type":"structure", "required":[ "ScopeName", "ScopeDescription" ], "members":{ "ScopeName":{ "shape":"ResourceServerScopeNameType", "documentation":"

The name of the scope.

" }, "ScopeDescription":{ "shape":"ResourceServerScopeDescriptionType", "documentation":"

A description of the scope.

" } }, "documentation":"

A resource server scope.

" }, "ResourceServerType":{ "type":"structure", "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that hosts the resource server.

" }, "Identifier":{ "shape":"ResourceServerIdentifierType", "documentation":"

The identifier for the resource server.

" }, "Name":{ "shape":"ResourceServerNameType", "documentation":"

The name of the resource server.

" }, "Scopes":{ "shape":"ResourceServerScopeListType", "documentation":"

A list of scopes that are defined for the resource server.

" } }, "documentation":"

A container for information about a resource server for a user pool.

" }, "ResourceServersListType":{ "type":"list", "member":{"shape":"ResourceServerType"} }, "RespondToAuthChallengeRequest":{ "type":"structure", "required":[ "ClientId", "ChallengeName" ], "members":{ "ClientId":{ "shape":"ClientIdType", "documentation":"

The app client ID.

" }, "ChallengeName":{ "shape":"ChallengeNameType", "documentation":"

The challenge name. For more information, see InitiateAuth.

`ADMIN_NO_SRP_AUTH` isn't a valid value.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session that should be passed both ways in challenge-response calls to the service. If `InitiateAuth` or `RespondToAuthChallenge` API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next `RespondToAuthChallenge` API call.

" }, "ChallengeResponses":{ "shape":"ChallengeResponsesType", "documentation":"

The responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.

You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret.

SMS_MFA

  `\"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\": \"[SMS_code]\", \"USERNAME\": \"[username]\"}`

PASSWORD_VERIFIER

  `\"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\": {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}`

  Add `\"DEVICE_KEY\"` when you sign in with a remembered device.

CUSTOM_CHALLENGE

  `\"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\": {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}`

  Add `\"DEVICE_KEY\"` when you sign in with a remembered device.

NEW_PASSWORD_REQUIRED

  `\"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\": {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\": \"[username]\"}`

  To set any required attributes that `InitiateAuth` returned in an `requiredAttributes` parameter, add `\"userAttributes.[attribute_name]\": \"[attribute_value]\"`. This parameter can also set values for writable attributes that aren't required by your user pool.

  In a `NEW_PASSWORD_REQUIRED` challenge response, you can't modify a required attribute that already has a value. In `RespondToAuthChallenge`, set a value for any keys that Amazon Cognito returned in the `requiredAttributes` parameter, then use the `UpdateUserAttributes` API operation to modify the value of any additional attributes.

SOFTWARE_TOKEN_MFA

  `\"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\": {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\": [authenticator_code]}`

DEVICE_SRP_AUTH

  `\"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\": \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\": \"[srp_a]\"}`

DEVICE_PASSWORD_VERIFIER

  `\"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\": {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}`

MFA_SETUP

  `\"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\": \"[username]\"}, \"SESSION\": \"[Session ID from VerifySoftwareToken]\"`

SELECT_MFA_TYPE

  `\"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\": \"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"}`

For more information about `SECRET_HASH`, see Computing secret hash values. For information about `DEVICE_KEY`, see Working with user devices in your user pool.

" }, "AnalyticsMetadata":{ "shape":"AnalyticsMetadataType", "documentation":"

The Amazon Pinpoint analytics metadata that contributes to your metrics for `RespondToAuthChallenge` calls.

" }, "UserContextData":{ "shape":"UserContextDataType", "documentation":"

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

- Validate the ClientMetadata value.

- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

" } }, "documentation":"

The request to respond to an authentication challenge.

" }, "RespondToAuthChallengeResponse":{ "type":"structure", "members":{ "ChallengeName":{ "shape":"ChallengeNameType", "documentation":"

The challenge name. For more information, see InitiateAuth.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next `RespondToAuthChallenge` API call.

" }, "ChallengeParameters":{ "shape":"ChallengeParametersType", "documentation":"

The challenge parameters. For more information, see InitiateAuth.

" }, "AuthenticationResult":{ "shape":"AuthenticationResultType", "documentation":"

The result returned by the server in response to the request to respond to the authentication challenge.

" } }, "documentation":"

The response to respond to the authentication challenge.

" }, "RevokeTokenRequest":{ "type":"structure", "required":[ "Token", "ClientId" ], "members":{ "Token":{ "shape":"TokenModelType", "documentation":"

The refresh token that you want to revoke.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The client ID for the token that you want to revoke.

" }, "ClientSecret":{ "shape":"ClientSecretType", "documentation":"

The secret for the client ID. This is required only if the client ID has a secret.

" } } }, "RevokeTokenResponse":{ "type":"structure", "members":{ } }, "RiskConfigurationType":{ "type":"structure", "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The app client ID.

" }, "CompromisedCredentialsRiskConfiguration":{ "shape":"CompromisedCredentialsRiskConfigurationType", "documentation":"

The compromised credentials risk configuration object, including the `EventFilter` and the `EventAction`.

" }, "AccountTakeoverRiskConfiguration":{ "shape":"AccountTakeoverRiskConfigurationType", "documentation":"

The account takeover risk configuration object, including the `NotifyConfiguration` object and `Actions` to take if there is an account takeover.

" }, "RiskExceptionConfiguration":{ "shape":"RiskExceptionConfigurationType", "documentation":"

The configuration to override the risk decision.

" }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was modified.

" } }, "documentation":"

The risk configuration type.

" }, "RiskDecisionType":{ "type":"string", "enum":[ "NoRisk", "AccountTakeover", "Block" ] }, "RiskExceptionConfigurationType":{ "type":"structure", "members":{ "BlockedIPRangeList":{ "shape":"BlockedIPRangeListType", "documentation":"

Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation, a compact representation of an IP address and its routing prefix.

" }, "SkippedIPRangeList":{ "shape":"SkippedIPRangeListType", "documentation":"

Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation.

" } }, "documentation":"

The type of the configuration to override the risk decision.

" }, "RiskLevelType":{ "type":"string", "enum":[ "Low", "Medium", "High" ] }, "S3BucketType":{ "type":"string", "max":1024, "min":3, "pattern":"^[0-9A-Za-z\\.\\-_]*(?Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted." }, "PreferredMfa":{ "shape":"BooleanType", "documentation":"

Specifies whether SMS is the preferred MFA method.

" } }, "documentation":"

The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

" }, "SchemaAttributeType":{ "type":"structure", "members":{ "Name":{ "shape":"CustomAttributeNameType", "documentation":"

The name of your user pool attribute. When you create or update a user pool, adding a schema attribute creates a custom or developer-only attribute. When you add an attribute with a `Name` value of `MyAttribute`, Amazon Cognito creates the custom attribute `custom:MyAttribute`. When `DeveloperOnlyAttribute` is `true`, Amazon Cognito creates your attribute as `dev:MyAttribute`. In an operation that describes a user pool, Amazon Cognito returns this value as `value` for standard attributes, `custom:value` for custom attributes, and `dev:value` for developer-only attributes..

" }, "AttributeDataType":{ "shape":"AttributeDataType", "documentation":"

The data format of the values for your attribute. When you choose an `AttributeDataType`, Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example `\"custom:isMember\" : \"true\"` or `\"custom:YearsAsMember\" : \"12\"`.

" }, "DeveloperOnlyAttribute":{ "shape":"BooleanType", "documentation":"

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using `DeveloperOnlyAttribute`.

Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, `DeveloperOnlyAttribute` can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.

", "box":true }, "Mutable":{ "shape":"BooleanType", "documentation":"

Specifies whether the value of the attribute can be changed.

Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of `true`. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

", "box":true }, "Required":{ "shape":"BooleanType", "documentation":"

Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.

", "box":true }, "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":"

A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a `custom:` prefix, and developer attributes with a `dev:` prefix. For more information, see User pool attributes.

Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

" }, "SchemaAttributesListType":{ "type":"list", "member":{"shape":"SchemaAttributeType"}, "max":50, "min":1 }, "ScopeDoesNotExistException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception is thrown when the specified scope doesn't exist.

", "exception":true }, "ScopeListType":{ "type":"list", "member":{"shape":"ScopeType"}, "max":50 }, "ScopeType":{ "type":"string", "max":256, "min":1, "pattern":"[\\x21\\x23-\\x5B\\x5D-\\x7E]+" }, "SearchPaginationTokenType":{ "type":"string", "min":1, "pattern":"[\\S]+" }, "SearchedAttributeNamesListType":{ "type":"list", "member":{"shape":"AttributeNameType"} }, "SecretCodeType":{ "type":"string", "min":16, "pattern":"[A-Za-z0-9]+", "sensitive":true }, "SecretHashType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w+=/]+", "sensitive":true }, "SessionType":{ "type":"string", "max":2048, "min":20, "sensitive":true }, "SetLogDeliveryConfigurationRequest":{ "type":"structure", "required":[ "UserPoolId", "LogConfigurations" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The ID of the user pool where you want to configure detailed activity logging .

" }, "LogConfigurations":{ "shape":"LogConfigurationListType", "documentation":"

A collection of all of the detailed activity logging configurations for a user pool.

" } } }, "SetLogDeliveryConfigurationResponse":{ "type":"structure", "members":{ "LogDeliveryConfiguration":{ "shape":"LogDeliveryConfigurationType", "documentation":"

The detailed activity logging configuration that you applied to the requested user pool.

" } } }, "SetRiskConfigurationRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The app client ID. If `ClientId` is null, then the risk configuration is mapped to `userPoolId`. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.

Otherwise, `ClientId` is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.

" }, "CompromisedCredentialsRiskConfiguration":{ "shape":"CompromisedCredentialsRiskConfigurationType", "documentation":"

The compromised credentials risk configuration.

" }, "AccountTakeoverRiskConfiguration":{ "shape":"AccountTakeoverRiskConfigurationType", "documentation":"

The account takeover risk configuration.

" }, "RiskExceptionConfiguration":{ "shape":"RiskExceptionConfigurationType", "documentation":"

The configuration to override the risk decision.

" } } }, "SetRiskConfigurationResponse":{ "type":"structure", "required":["RiskConfiguration"], "members":{ "RiskConfiguration":{ "shape":"RiskConfigurationType", "documentation":"

The risk configuration.

" } } }, "SetUICustomizationRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The client ID for the client app.

" }, "CSS":{ "shape":"CSSType", "documentation":"

The CSS values in the UI customization.

" }, "ImageFile":{ "shape":"ImageFileType", "documentation":"

The uploaded logo image for the UI customization.

" } } }, "SetUICustomizationResponse":{ "type":"structure", "required":["UICustomization"], "members":{ "UICustomization":{ "shape":"UICustomizationType", "documentation":"

The UI customization information.

" } } }, "SetUserMFAPreferenceRequest":{ "type":"structure", "required":["AccessToken"], "members":{ "SMSMfaSettings":{ "shape":"SMSMfaSettingsType", "documentation":"

The SMS text message multi-factor authentication (MFA) settings.

" }, "SoftwareTokenMfaSettings":{ "shape":"SoftwareTokenMfaSettingsType", "documentation":"

The time-based one-time password (TOTP) software token MFA settings.

" }, "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

" } } }, "SetUserMFAPreferenceResponse":{ "type":"structure", "members":{ } }, "SetUserPoolMfaConfigRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "SmsMfaConfiguration":{ "shape":"SmsMfaConfigType", "documentation":"

The SMS text message MFA configuration.

" }, "SoftwareTokenMfaConfiguration":{ "shape":"SoftwareTokenMfaConfigType", "documentation":"

The software token MFA configuration.

" }, "MfaConfiguration":{ "shape":"UserPoolMfaType", "documentation":"

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:

- `OFF` MFA won't be used for any users.

- `ON` MFA is required for all users to sign in.

- `OPTIONAL` MFA will be required only for individual users who have an MFA factor activated.

" } } }, "SetUserPoolMfaConfigResponse":{ "type":"structure", "members":{ "SmsMfaConfiguration":{ "shape":"SmsMfaConfigType", "documentation":"

The SMS text message MFA configuration.

" }, "SoftwareTokenMfaConfiguration":{ "shape":"SoftwareTokenMfaConfigType", "documentation":"

The software token MFA configuration.

" }, "MfaConfiguration":{ "shape":"UserPoolMfaType", "documentation":"

The MFA configuration. Valid values include:

- `OFF` MFA won't be used for any users.

- `ON` MFA is required for all users to sign in.

- `OPTIONAL` MFA will be required only for individual users who have an MFA factor enabled.

" } } }, "SetUserSettingsRequest":{ "type":"structure", "required":[ "AccessToken", "MFAOptions" ], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

" }, "MFAOptions":{ "shape":"MFAOptionListType", "documentation":"

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

" } }, "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 username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.

" }, "Password":{ "shape":"PasswordType", "documentation":"

The password of the user you want to register.

" }, "UserAttributes":{ "shape":"AttributeListType", "documentation":"

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the `custom:` prefix to the attribute name.

" }, "ValidationData":{ "shape":"AttributeListType", "documentation":"

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.

For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

" }, "AnalyticsMetadata":{ "shape":"AnalyticsMetadataType", "documentation":"

The Amazon Pinpoint analytics metadata that contributes to your metrics for `SignUp` calls.

" }, "UserContextData":{ "shape":"UserContextDataType", "documentation":"

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

- Validate the ClientMetadata value.

- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

" } }, "documentation":"

Represents the request to register a user.

" }, "SignUpResponse":{ "type":"structure", "required":[ "UserConfirmed", "UserSub" ], "members":{ "UserConfirmed":{ "shape":"BooleanType", "documentation":"

A response from the server indicating that a user registration has been confirmed.

" }, "CodeDeliveryDetails":{ "shape":"CodeDeliveryDetailsType", "documentation":"

The code delivery details returned by the server response to the user registration request.

" }, "UserSub":{ "shape":"StringType", "documentation":"

The UUID of the authenticated user. This isn't the same as `username`.

" } }, "documentation":"

The response from the server for a registration request.

" }, "SkippedIPRangeListType":{ "type":"list", "member":{"shape":"StringType"}, "max":200 }, "SmsConfigurationType":{ "type":"structure", "required":["SnsCallerArn"], "members":{ "SnsCallerArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.

" }, "ExternalId":{ "shape":"StringType", "documentation":"

The external ID provides additional security for your IAM role. You can use an `ExternalId` with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an `ExternalId`, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the `ExternalID`. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the `ExternalId`.

For more information about the `ExternalId` of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party

" }, "SnsRegion":{ "shape":"RegionCodeType", "documentation":"

The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.

Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.

" } }, "documentation":"

The SMS configuration type is the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

" }, "SmsMfaConfigType":{ "type":"structure", "members":{ "SmsAuthenticationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.

" }, "SmsConfiguration":{ "shape":"SmsConfigurationType", "documentation":"

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.

" } }, "documentation":"

The SMS text message multi-factor authentication (MFA) configuration type.

" }, "SmsVerificationMessageType":{ "type":"string", "max":140, "min":6, "pattern":".*\\{####\\}.*" }, "SoftwareTokenMFANotFoundException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.

", "exception":true }, "SoftwareTokenMFAUserCodeType":{ "type":"string", "max":6, "min":6, "pattern":"[0-9]+", "sensitive":true }, "SoftwareTokenMfaConfigType":{ "type":"structure", "members":{ "Enabled":{ "shape":"BooleanType", "documentation":"

Specifies whether software token MFA is activated.

" } }, "documentation":"

The type used for enabling software token MFA at the user pool level.

" }, "SoftwareTokenMfaSettingsType":{ "type":"structure", "members":{ "Enabled":{ "shape":"BooleanType", "documentation":"

Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

" }, "PreferredMfa":{ "shape":"BooleanType", "documentation":"

Specifies whether software token MFA is the preferred MFA method.

" } }, "documentation":"

The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

" }, "StartUserImportJobRequest":{ "type":"structure", "required":[ "UserPoolId", "JobId" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "JobId":{ "shape":"UserImportJobIdType", "documentation":"

The job ID for the user import job.

" } }, "documentation":"

Represents the request to start the user import job.

" }, "StartUserImportJobResponse":{ "type":"structure", "members":{ "UserImportJob":{ "shape":"UserImportJobType", "documentation":"

The job object that represents the user import job.

" } }, "documentation":"

Represents the response from the server to the request to start the user import job.

" }, "StatusType":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "StopUserImportJobRequest":{ "type":"structure", "required":[ "UserPoolId", "JobId" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "JobId":{ "shape":"UserImportJobIdType", "documentation":"

The job ID for the user import job.

" } }, "documentation":"

Represents the request to stop the user import job.

" }, "StopUserImportJobResponse":{ "type":"structure", "members":{ "UserImportJob":{ "shape":"UserImportJobType", "documentation":"

The job object that represents the user import job.

" } }, "documentation":"

Represents the response from the server to the request to stop the user import job.

" }, "StringAttributeConstraintsType":{ "type":"structure", "members":{ "MinLength":{ "shape":"StringType", "documentation":"

The minimum length.

" }, "MaxLength":{ "shape":"StringType", "documentation":"

The maximum length.

" } }, "documentation":"

The constraints associated with a string attribute.

" }, "StringType":{ "type":"string", "max":131072, "min":0 }, "SupportedIdentityProvidersListType":{ "type":"list", "member":{"shape":"ProviderNameType"} }, "TagKeysType":{ "type":"string", "max":128, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

" }, "Tags":{ "shape":"UserPoolTagsType", "documentation":"

The tags to assign to the user pool.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValueType":{ "type":"string", "max":256, "min":0 }, "TemporaryPasswordValidityDaysType":{ "type":"integer", "max":365, "min":0 }, "TimeUnitsType":{ "type":"string", "enum":[ "seconds", "minutes", "hours", "days" ] }, "TokenModelType":{ "type":"string", "pattern":"[A-Za-z0-9-_=.]+", "sensitive":true }, "TokenValidityUnitsType":{ "type":"structure", "members":{ "AccessToken":{ "shape":"TimeUnitsType", "documentation":"

A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `AccessTokenValidity` parameter. The default `AccessTokenValidity` time unit is hours. `AccessTokenValidity` duration can range from five minutes to one day.

" }, "IdToken":{ "shape":"TimeUnitsType", "documentation":"

A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `IdTokenValidity` parameter. The default `IdTokenValidity` time unit is hours. `IdTokenValidity` duration can range from five minutes to one day.

" }, "RefreshToken":{ "shape":"TimeUnitsType", "documentation":"

A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `RefreshTokenValidity` parameter. The default `RefreshTokenValidity` time unit is days. `RefreshTokenValidity` duration can range from 60 minutes to 10 years.

" } }, "documentation":"

The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.

" }, "TooManyFailedAttemptsException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when Amazon Cognito returns a `TooManyFailedAttempts` exception.

" } }, "documentation":"

This exception is thrown when the user has made too many failed attempts for a given action, such as 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 is thrown when the user has made too many requests for a given operation.

", "exception":true }, "UICustomizationType":{ "type":"structure", "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The client ID for the client app.

" }, "ImageUrl":{ "shape":"ImageUrlType", "documentation":"

The logo image for the UI customization.

" }, "CSS":{ "shape":"CSSType", "documentation":"

The CSS values in the UI customization.

" }, "CSSVersion":{ "shape":"CSSVersionType", "documentation":"

The CSS version number.

" }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was modified.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was created.

" } }, "documentation":"

A container for the UI customization information for a user pool's built-in app UI.

" }, "UnauthorizedException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

Exception that is thrown when the request isn't authorized. This can happen due to an invalid access token in the request.

", "exception":true }, "UnexpectedLambdaException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when Amazon Cognito returns an unexpected Lambda exception.

" } }, "documentation":"

This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.

", "exception":true }, "UnsupportedIdentityProviderException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception is thrown when the specified identifier isn't supported.

", "exception":true }, "UnsupportedOperationException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

Exception that is thrown when you attempt to perform an operation that isn't enabled for the user pool client.

", "exception":true }, "UnsupportedTokenTypeException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

Exception that is thrown when an unsupported token is passed to an operation.

", "exception":true }, "UnsupportedUserStateException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the user is in an unsupported state.

" } }, "documentation":"

The request failed because the user is in an unsupported state.

", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

" }, "TagKeys":{ "shape":"UserPoolTagsListType", "documentation":"

The keys of the tags to remove from the user pool.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateAuthEventFeedbackRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "EventId", "FeedbackToken", "FeedbackValue" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, you can also use their `sub` in this request.

" }, "EventId":{ "shape":"EventIdType", "documentation":"

The event ID.

" }, "FeedbackToken":{ "shape":"TokenModelType", "documentation":"

The feedback token.

" }, "FeedbackValue":{ "shape":"FeedbackValueType", "documentation":"

The authentication event feedback value. When you provide a `FeedbackValue` value of `valid`, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a `FeedbackValue` value of `invalid`, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.

" } } }, "UpdateAuthEventFeedbackResponse":{ "type":"structure", "members":{ } }, "UpdateDeviceStatusRequest":{ "type":"structure", "required":[ "AccessToken", "DeviceKey" ], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose device status you want to update.

" }, "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "DeviceRememberedStatus":{ "shape":"DeviceRememberedStatusType", "documentation":"

The status of whether a device is remembered.

" } }, "documentation":"

Represents the request to update the device status.

" }, "UpdateDeviceStatusResponse":{ "type":"structure", "members":{ }, "documentation":"

The response to the request to update the device status.

" }, "UpdateGroupRequest":{ "type":"structure", "required":[ "GroupName", "UserPoolId" ], "members":{ "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Description":{ "shape":"DescriptionType", "documentation":"

A string containing the new description of the group.

" }, "RoleArn":{ "shape":"ArnType", "documentation":"

The new role Amazon Resource Name (ARN) for the group. This is used for setting the `cognito:roles` and `cognito:preferred_role` claims in the token.

" }, "Precedence":{ "shape":"PrecedenceType", "documentation":"

The new precedence value for the group. For more information about this parameter, see CreateGroup.

" } } }, "UpdateGroupResponse":{ "type":"structure", "members":{ "Group":{ "shape":"GroupType", "documentation":"

The group object for the group.

" } } }, "UpdateIdentityProviderRequest":{ "type":"structure", "required":[ "UserPoolId", "ProviderName" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "ProviderName":{ "shape":"ProviderNameType", "documentation":"

The IdP name.

" }, "ProviderDetails":{ "shape":"ProviderDetailsType", "documentation":"

The IdP details to be updated, such as `MetadataURL` and `MetadataFile`.

" }, "AttributeMapping":{ "shape":"AttributeMappingType", "documentation":"

The IdP attribute mapping to be changed.

" }, "IdpIdentifiers":{ "shape":"IdpIdentifiersListType", "documentation":"

A list of IdP identifiers.

" } } }, "UpdateIdentityProviderResponse":{ "type":"structure", "required":["IdentityProvider"], "members":{ "IdentityProvider":{ "shape":"IdentityProviderType", "documentation":"

The identity provider details.

" } } }, "UpdateResourceServerRequest":{ "type":"structure", "required":[ "UserPoolId", "Identifier", "Name" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Identifier":{ "shape":"ResourceServerIdentifierType", "documentation":"

The identifier for the resource server.

" }, "Name":{ "shape":"ResourceServerNameType", "documentation":"

The name of the resource server.

" }, "Scopes":{ "shape":"ResourceServerScopeListType", "documentation":"

The scope values to be set for the resource server.

" } } }, "UpdateResourceServerResponse":{ "type":"structure", "required":["ResourceServer"], "members":{ "ResourceServer":{ "shape":"ResourceServerType", "documentation":"

The resource server.

" } } }, "UpdateUserAttributesRequest":{ "type":"structure", "required":[ "UserAttributes", "AccessToken" ], "members":{ "UserAttributes":{ "shape":"AttributeListType", "documentation":"

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the `custom:` prefix to the attribute name.

If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

" }, "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

- Validate the ClientMetadata value.

- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

" } }, "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.

" }, "RefreshTokenValidity":{ "shape":"RefreshTokenValidityType", "documentation":"

The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set `RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days`, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for `RefreshTokenValidity` in an API request is days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

" }, "AccessTokenValidity":{ "shape":"AccessTokenValidityType", "documentation":"

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours`, your user can authorize access with their access token for 10 hours.

The default time unit for `AccessTokenValidity` in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

" }, "IdTokenValidity":{ "shape":"IdTokenValidityType", "documentation":"

The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours`, your user can authenticate their session with their ID token for 10 hours.

The default time unit for `IdTokenValidity` in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

" }, "TokenValidityUnits":{ "shape":"TokenValidityUnitsType", "documentation":"

The time units you use when you set the duration of ID, access, and refresh tokens. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.

" }, "ReadAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.

When you don't specify the `ReadAttributes` for your app client, your app can read the values of `email_verified`, `phone_number_verified`, and the Standard attributes of your user pool. When your user pool has read access to these default attributes, `ReadAttributes` doesn't return any information. Amazon Cognito only populates `ReadAttributes` in the API response if you have specified your own custom set of read attributes.

" }, "WriteAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets `family_name` to the new value.

When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes.

If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.

" }, "ExplicitAuthFlows":{ "shape":"ExplicitAuthFlowsListType", "documentation":"

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for `ExplicitAuthFlows`, your user client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and `ALLOW_CUSTOM_AUTH`.

Valid values include:

- `ALLOW_ADMIN_USER_PASSWORD_AUTH`: Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.

- `ALLOW_CUSTOM_AUTH`: Enable Lambda trigger based authentication.

- `ALLOW_USER_PASSWORD_AUTH`: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

- `ALLOW_USER_SRP_AUTH`: Enable SRP-based authentication.

- `ALLOW_REFRESH_TOKEN_AUTH`: Enable authflow to refresh tokens.

In some environments, you will see the values `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_`, like `ALLOW_USER_SRP_AUTH`.

" }, "SupportedIdentityProviders":{ "shape":"SupportedIdentityProvidersListType", "documentation":"

A list of provider names for the IdPs that this client supports. The following are supported: `COGNITO`, `Facebook`, `Google`, `SignInWithApple`, `LoginWithAmazon`, and the names of your own SAML and OIDC providers.

" }, "CallbackURLs":{ "shape":"CallbackURLsListType", "documentation":"

A list of allowed redirect (callback) URLs for the IdPs.

A redirect URI must:

- Be an absolute URI.

- Be registered with the authorization server.

- Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as `myapp://example` are also supported.

" }, "LogoutURLs":{ "shape":"LogoutURLsListType", "documentation":"

A list of allowed logout URLs for the IdPs.

" }, "DefaultRedirectURI":{ "shape":"RedirectUrlType", "documentation":"

The default redirect URI. Must be in the `CallbackURLs` list.

A redirect URI must:

- Be an absolute URI.

- Be registered with the authorization server.

- Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for `http://localhost` for testing purposes only.

App callback URLs such as `myapp://example` are also supported.

" }, "AllowedOAuthFlows":{ "shape":"OAuthFlowsType", "documentation":"

The allowed OAuth flows.

code

  Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the `/oauth2/token` endpoint.

implicit

  Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

  Issue the access token from the `/oauth2/token` endpoint directly to a non-person user using a combination of the client ID and client secret.

" }, "AllowedOAuthScopes":{ "shape":"ScopeListType", "documentation":"

The allowed OAuth scopes. Possible values provided by OAuth are `phone`, `email`, `openid`, and `profile`. Possible values provided by Amazon Web Services are `aws.cognito.signin.user.admin`. Custom scopes created in Resource Servers are also supported.

" }, "AllowedOAuthFlowsUserPoolClient":{ "shape":"BooleanType", "documentation":"

Set to `true` to use OAuth 2.0 features in your user pool app client.

`AllowedOAuthFlowsUserPoolClient` must be `true` before you can configure the following features in your app client.

- `CallBackURLs`: Callback URLs.

- `LogoutURLs`: Sign-out redirect URLs.

- `AllowedOAuthScopes`: OAuth 2.0 scopes.

- `AllowedOAuthFlows`: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the CLI or SDKs, it defaults to `false`.

" }, "AnalyticsConfiguration":{ "shape":"AnalyticsConfigurationType", "documentation":"

The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.

In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

" }, "PreventUserExistenceErrors":{ "shape":"PreventUserExistenceErrorTypes", "documentation":"

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to `ENABLED` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY`, those APIs return a `UserNotFoundException` exception if the user doesn't exist in the user pool.

Valid values include:

- `ENABLED` - This prevents user existence-related errors.

- `LEGACY` - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.

" }, "EnableTokenRevocation":{ "shape":"WrappedBooleanType", "documentation":"

Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.

" }, "EnablePropagateAdditionalUserContextData":{ "shape":"WrappedBooleanType", "documentation":"

Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret.

" }, "AuthSessionValidity":{ "shape":"AuthSessionValidityType", "documentation":"

Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

" } }, "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 you request to update the user pool client.

" } }, "documentation":"

Represents the response from the server to the request to update the user pool client.

" }, "UpdateUserPoolDomainRequest":{ "type":"structure", "required":[ "Domain", "UserPoolId", "CustomDomainConfig" ], "members":{ "Domain":{ "shape":"DomainType", "documentation":"

The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be `auth.example.com`.

This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The ID of the user pool that is associated with the custom domain whose certificate you're updating.

" }, "CustomDomainConfig":{ "shape":"CustomDomainConfigType", "documentation":"

The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

" } }, "documentation":"

The UpdateUserPoolDomain request input.

" }, "UpdateUserPoolDomainResponse":{ "type":"structure", "members":{ "CloudFrontDomain":{ "shape":"DomainType", "documentation":"

The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.

" } }, "documentation":"

The UpdateUserPoolDomain response output.

" }, "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 want to update in a user pool.

" }, "DeletionProtection":{ "shape":"DeletionProtectionType", "documentation":"

When active, `DeletionProtection` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a `DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request.

" }, "LambdaConfig":{ "shape":"LambdaConfigType", "documentation":"

The Lambda configuration information from the request to update the user pool.

" }, "AutoVerifiedAttributes":{ "shape":"VerifiedAttributesListType", "documentation":"

The attributes that are automatically verified when Amazon Cognito requests to update user pools.

" }, "SmsVerificationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

This parameter is no longer used. See VerificationMessageTemplateType.

" }, "EmailVerificationMessage":{ "shape":"EmailVerificationMessageType", "documentation":"

This parameter is no longer used. See VerificationMessageTemplateType.

" }, "EmailVerificationSubject":{ "shape":"EmailVerificationSubjectType", "documentation":"

This parameter is no longer used. See VerificationMessageTemplateType.

" }, "VerificationMessageTemplate":{ "shape":"VerificationMessageTemplateType", "documentation":"

The template for verification messages.

" }, "SmsAuthenticationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

The contents of the SMS authentication message.

" }, "UserAttributeUpdateSettings":{ "shape":"UserAttributeUpdateSettingsType", "documentation":"

The settings for updates to user attributes. These settings include the property `AttributesRequireVerificationBeforeUpdate`, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

" }, "MfaConfiguration":{ "shape":"UserPoolMfaType", "documentation":"

Possible values include:

- `OFF` - MFA tokens aren't required and can't be specified during user registration.

- `ON` - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA \"ON\" for existing user pools.

- `OPTIONAL` - Users have the option when registering to create an MFA token.

" }, "DeviceConfiguration":{ "shape":"DeviceConfigurationType", "documentation":"

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature.

" }, "EmailConfiguration":{ "shape":"EmailConfigurationType", "documentation":"

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.

" }, "SmsConfiguration":{ "shape":"SmsConfigurationType", "documentation":"

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

" }, "UserPoolTags":{ "shape":"UserPoolTagsType", "documentation":"

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

" }, "AdminCreateUserConfig":{ "shape":"AdminCreateUserConfigType", "documentation":"

The configuration for `AdminCreateUser` requests.

" }, "UserPoolAddOns":{ "shape":"UserPoolAddOnsType", "documentation":"

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to `AUDIT`. To configure automatic security responses to risky traffic to your user pool, set to `ENFORCED`.

For more information, see Adding advanced security to a user pool.

" }, "AccountRecoverySetting":{ "shape":"AccountRecoverySettingType", "documentation":"

The available verified method a user can use to recover their password when they call `ForgotPassword`. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

" } }, "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.

" }, "UserAttributeUpdateSettingsType":{ "type":"structure", "members":{ "AttributesRequireVerificationBeforeUpdate":{ "shape":"AttributesRequireVerificationBeforeUpdateType", "documentation":"

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the AdminUpdateUserAttributes API and set `email_verified` or `phone_number_verified` to true.

When `AttributesRequireVerificationBeforeUpdate` is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where `AttributesRequireVerificationBeforeUpdate` is false, API operations that change attribute values can immediately update a user’s `email` or `phone_number` attribute.

" } }, "documentation":"

The settings for updates to user attributes. These settings include the property `AttributesRequireVerificationBeforeUpdate`, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

" }, "UserContextDataType":{ "type":"structure", "members":{ "IpAddress":{ "shape":"StringType", "documentation":"

The source IP address of your user's device.

" }, "EncodedData":{ "shape":"StringType", "documentation":"

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

" } }, "documentation":"

Contextual data, such as the user's device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

", "sensitive":true }, "UserFilterType":{ "type":"string", "max":256 }, "UserImportInProgressException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the user pool has an import job running.

" } }, "documentation":"

This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.

", "exception":true }, "UserImportJobIdType":{ "type":"string", "max":55, "min":1, "pattern":"import-[0-9a-zA-Z-]+" }, "UserImportJobNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w\\s+=,.@-]+" }, "UserImportJobStatusType":{ "type":"string", "enum":[ "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded" ] }, "UserImportJobType":{ "type":"structure", "members":{ "JobName":{ "shape":"UserImportJobNameType", "documentation":"

The job name for the user import job.

" }, "JobId":{ "shape":"UserImportJobIdType", "documentation":"

The job ID for the user import job.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "PreSignedUrl":{ "shape":"PreSignedUrlType", "documentation":"

The pre-signed URL to be used to upload the `.csv` file.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was created.

" }, "StartDate":{ "shape":"DateType", "documentation":"

The date when the user import job was started.

" }, "CompletionDate":{ "shape":"DateType", "documentation":"

The date when the user import job was completed.

" }, "Status":{ "shape":"UserImportJobStatusType", "documentation":"

The status of the user import job. One of the following:

- `Created` - The job was created but not started.

- `Pending` - A transition state. You have started the job, but it has not begun importing users yet.

- `InProgress` - The job has started, and users are being imported.

- `Stopping` - You have stopped the job, but the job has not stopped importing users yet.

- `Stopped` - You have stopped the job, and the job has stopped importing users.

- `Succeeded` - The job has completed successfully.

- `Failed` - The job has stopped due to an error.

- `Expired` - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.

" }, "CloudWatchLogsRoleArn":{ "shape":"ArnType", "documentation":"

The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see \"Creating the CloudWatch Logs IAM Role\" in the Amazon Cognito Developer Guide.

" }, "ImportedUsers":{ "shape":"LongType", "documentation":"

The number of users that were successfully imported.

" }, "SkippedUsers":{ "shape":"LongType", "documentation":"

The number of users that were skipped.

" }, "FailedUsers":{ "shape":"LongType", "documentation":"

The number of users that couldn't be imported.

" }, "CompletionMessage":{ "shape":"CompletionMessageType", "documentation":"

The message returned when the user import job is completed.

" } }, "documentation":"

The user import job type.

" }, "UserImportJobsListType":{ "type":"list", "member":{"shape":"UserImportJobType"}, "max":50, "min":1 }, "UserLambdaValidationException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service returns a user validation exception with the Lambda service.

" } }, "documentation":"

This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.

", "exception":true }, "UserMFASettingListType":{ "type":"list", "member":{"shape":"StringType"} }, "UserNotConfirmedException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when a user isn't confirmed successfully.

" } }, "documentation":"

This exception is thrown when a user isn't confirmed successfully.

", "exception":true }, "UserNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when a user isn't found.

" } }, "documentation":"

This exception is thrown when a user isn't found.

", "exception":true }, "UserPoolAddOnNotEnabledException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception is thrown when user pool add-ons aren't enabled.

", "exception":true }, "UserPoolAddOnsType":{ "type":"structure", "required":["AdvancedSecurityMode"], "members":{ "AdvancedSecurityMode":{ "shape":"AdvancedSecurityModeType", "documentation":"

The operating mode of advanced security features in your user pool.

" } }, "documentation":"

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to `AUDIT`. To configure automatic security responses to risky traffic to your user pool, set to `ENFORCED`.

For more information, see Adding advanced security to a user pool.

" }, "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 pool 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 date and time, in ISO 8601 format, when the item was modified.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was created.

" }, "RefreshTokenValidity":{ "shape":"RefreshTokenValidityType", "documentation":"

The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set `RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days`, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for `RefreshTokenValidity` in an API request is days. You can't set `RefreshTokenValidity` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

" }, "AccessTokenValidity":{ "shape":"AccessTokenValidityType", "documentation":"

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours`, your user can authorize access with their access token for 10 hours.

The default time unit for `AccessTokenValidity` in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

" }, "IdTokenValidity":{ "shape":"IdTokenValidityType", "documentation":"

The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours`, your user can authenticate their session with their ID token for 10 hours.

The default time unit for `IdTokenValidity` in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

" }, "TokenValidityUnits":{ "shape":"TokenValidityUnitsType", "documentation":"

The time units used to specify the token validity times of each token type: ID, access, and refresh.

" }, "ReadAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.

When you don't specify the `ReadAttributes` for your app client, your app can read the values of `email_verified`, `phone_number_verified`, and the Standard attributes of your user pool. When your user pool has read access to these default attributes, `ReadAttributes` doesn't return any information. Amazon Cognito only populates `ReadAttributes` in the API response if you have specified your own custom set of read attributes.

" }, "WriteAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets `family_name` to the new value.

When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes.

If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.

" }, "ExplicitAuthFlows":{ "shape":"ExplicitAuthFlowsListType", "documentation":"

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for `ExplicitAuthFlows`, your user client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and `ALLOW_CUSTOM_AUTH`.

Valid values include:

- `ALLOW_ADMIN_USER_PASSWORD_AUTH`: Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.

- `ALLOW_CUSTOM_AUTH`: Enable Lambda trigger based authentication.

- `ALLOW_USER_PASSWORD_AUTH`: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

- `ALLOW_USER_SRP_AUTH`: Enable SRP-based authentication.

- `ALLOW_REFRESH_TOKEN_AUTH`: Enable authflow to refresh tokens.

In some environments, you will see the values `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_`, like `ALLOW_USER_SRP_AUTH`.

" }, "SupportedIdentityProviders":{ "shape":"SupportedIdentityProvidersListType", "documentation":"

A list of provider names for the IdPs that this client supports. The following are supported: `COGNITO`, `Facebook`, `Google`, `SignInWithApple`, `LoginWithAmazon`, and the names of your own SAML and OIDC providers.

" }, "CallbackURLs":{ "shape":"CallbackURLsListType", "documentation":"

A list of allowed redirect (callback) URLs for the IdPs.

A redirect URI must:

- Be an absolute URI.

- Be registered with the authorization server.

- Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

" }, "LogoutURLs":{ "shape":"LogoutURLsListType", "documentation":"

A list of allowed logout URLs for the IdPs.

" }, "DefaultRedirectURI":{ "shape":"RedirectUrlType", "documentation":"

The default redirect URI. Must be in the `CallbackURLs` list.

A redirect URI must:

- Be an absolute URI.

- Be registered with the authorization server.

- Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

" }, "AllowedOAuthFlows":{ "shape":"OAuthFlowsType", "documentation":"

The allowed OAuth flows.

code

  Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the `/oauth2/token` endpoint.

implicit

  Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

  Issue the access token from the `/oauth2/token` endpoint directly to a non-person user using a combination of the client ID and client secret.

" }, "AllowedOAuthScopes":{ "shape":"ScopeListType", "documentation":"

The OAuth scopes that your app client supports. Possible values that OAuth provides are `phone`, `email`, `openid`, and `profile`. Possible values that Amazon Web Services provides are `aws.cognito.signin.user.admin`. Amazon Cognito also supports custom scopes that you create in Resource Servers.

" }, "AllowedOAuthFlowsUserPoolClient":{ "shape":"BooleanType", "documentation":"

Set to `true` to use OAuth 2.0 features in your user pool app client.

`AllowedOAuthFlowsUserPoolClient` must be `true` before you can configure the following features in your app client.

- `CallBackURLs`: Callback URLs.

- `LogoutURLs`: Sign-out redirect URLs.

- `AllowedOAuthScopes`: OAuth 2.0 scopes.

- `AllowedOAuthFlows`: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the CLI or SDKs, it defaults to `false`.

", "box":true }, "AnalyticsConfiguration":{ "shape":"AnalyticsConfigurationType", "documentation":"

The Amazon Pinpoint analytics configuration for the user pool client.

Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.

" }, "PreventUserExistenceErrors":{ "shape":"PreventUserExistenceErrorTypes", "documentation":"

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to `ENABLED` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY`, those APIs return a `UserNotFoundException` exception if the user doesn't exist in the user pool.

Valid values include:

- `ENABLED` - This prevents user existence-related errors.

- `LEGACY` - This represents the old behavior of Amazon Cognito where user existence related errors aren't prevented.

" }, "EnableTokenRevocation":{ "shape":"WrappedBooleanType", "documentation":"

Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.

" }, "EnablePropagateAdditionalUserContextData":{ "shape":"WrappedBooleanType", "documentation":"

When `EnablePropagateAdditionalUserContextData` is true, Amazon Cognito accepts an `IpAddress` value that you send in the `UserContextData` parameter. The `UserContextData` parameter sends information to Amazon Cognito advanced security for risk analysis. You can send `UserContextData` when you sign in Amazon Cognito native users with the `InitiateAuth` and `RespondToAuthChallenge` API operations.

When `EnablePropagateAdditionalUserContextData` is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. `EnablePropagateAdditionalUserContextData` doesn't affect whether you can send a source IP address in a `ContextData` parameter with the authenticated API operations `AdminInitiateAuth` and `AdminRespondToAuthChallenge`.

You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.

" }, "AuthSessionValidity":{ "shape":"AuthSessionValidityType", "documentation":"

Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

" } }, "documentation":"

Contains information about a user pool client.

" }, "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 Lambda configuration information in a user pool description.

" }, "Status":{ "shape":"StatusType", "documentation":"

The user pool status in a user pool description.

", "deprecated":true, "deprecatedMessage":"This property is no longer available." }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was modified.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was created.

" } }, "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":"

The password policy.

" } }, "documentation":"

The policy associated with a user pool.

" }, "UserPoolTaggingException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception is thrown when a user pool tag can't be set or updated.

", "exception":true }, "UserPoolTagsListType":{ "type":"list", "member":{"shape":"TagKeysType"} }, "UserPoolTagsType":{ "type":"map", "key":{"shape":"TagKeysType"}, "value":{"shape":"TagValueType"} }, "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":"

The policies associated with the user pool.

" }, "DeletionProtection":{ "shape":"DeletionProtectionType", "documentation":"

When active, `DeletionProtection` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a `DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request.

" }, "LambdaConfig":{ "shape":"LambdaConfigType", "documentation":"

The Lambda triggers associated with the user pool.

" }, "Status":{ "shape":"StatusType", "documentation":"

This parameter is no longer used.

", "deprecated":true, "deprecatedMessage":"This property is no longer available." }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was modified.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time, in ISO 8601 format, when the item was created.

" }, "SchemaAttributes":{ "shape":"SchemaAttributesListType", "documentation":"

A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a `custom:` prefix, and developer attributes with a `dev:` prefix. For more information, see User pool attributes.

Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

" }, "AutoVerifiedAttributes":{ "shape":"VerifiedAttributesListType", "documentation":"

The attributes that are auto-verified in a user pool.

" }, "AliasAttributes":{ "shape":"AliasAttributesListType", "documentation":"

The attributes that are aliased in a user pool.

" }, "UsernameAttributes":{ "shape":"UsernameAttributesListType", "documentation":"

Specifies whether a user can use an email address or phone number as a username when they sign up.

" }, "SmsVerificationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

This parameter is no longer used. See VerificationMessageTemplateType.

" }, "EmailVerificationMessage":{ "shape":"EmailVerificationMessageType", "documentation":"

This parameter is no longer used. See VerificationMessageTemplateType.

" }, "EmailVerificationSubject":{ "shape":"EmailVerificationSubjectType", "documentation":"

This parameter is no longer used. See VerificationMessageTemplateType.

" }, "VerificationMessageTemplate":{ "shape":"VerificationMessageTemplateType", "documentation":"

The template for verification messages.

" }, "SmsAuthenticationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

The contents of the SMS authentication message.

" }, "UserAttributeUpdateSettings":{ "shape":"UserAttributeUpdateSettingsType", "documentation":"

The settings for updates to user attributes. These settings include the property `AttributesRequireVerificationBeforeUpdate`, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

" }, "MfaConfiguration":{ "shape":"UserPoolMfaType", "documentation":"

Can be one of the following values:

- `OFF` - MFA tokens aren't required and can't be specified during user registration.

- `ON` - MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.

- `OPTIONAL` - Users have the option when registering to create an MFA token.

" }, "DeviceConfiguration":{ "shape":"DeviceConfigurationType", "documentation":"

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature.

" }, "EstimatedNumberOfUsers":{ "shape":"IntegerType", "documentation":"

A number estimating the size of the user pool.

" }, "EmailConfiguration":{ "shape":"EmailConfigurationType", "documentation":"

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

" }, "SmsConfiguration":{ "shape":"SmsConfigurationType", "documentation":"

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

" }, "UserPoolTags":{ "shape":"UserPoolTagsType", "documentation":"

The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

" }, "SmsConfigurationFailure":{ "shape":"StringType", "documentation":"

The reason why the SMS configuration can't send the messages to your users.

This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

InvalidSmsRoleAccessPolicyException

  The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.

SNSSandbox

  The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

" }, "EmailConfigurationFailure":{ "shape":"StringType", "documentation":"

Deprecated. Review error codes from API requests with `EventSource:cognito-idp.amazonaws.com` in CloudTrail for information about problems with user pool email configuration.

" }, "Domain":{ "shape":"DomainType", "documentation":"

The domain prefix, if the user pool has a domain associated with it.

" }, "CustomDomain":{ "shape":"DomainType", "documentation":"

A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be `auth.example.com`.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

" }, "AdminCreateUserConfig":{ "shape":"AdminCreateUserConfigType", "documentation":"

The configuration for `AdminCreateUser` requests.

" }, "UserPoolAddOns":{ "shape":"UserPoolAddOnsType", "documentation":"

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to `AUDIT`. To configure automatic security responses to risky traffic to your user pool, set to `ENFORCED`.

For more information, see Adding advanced security to a user pool.

" }, "UsernameConfiguration":{ "shape":"UsernameConfigurationType", "documentation":"

Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to `False`, users can sign in using either \"username\" or \"Username\". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

" }, "Arn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) for the user pool.

" }, "AccountRecoverySetting":{ "shape":"AccountRecoverySettingType", "documentation":"

The available verified method a user can use to recover their password when they call `ForgotPassword`. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

" } }, "documentation":"

A container for information about the user pool.

" }, "UserStatusType":{ "type":"string", "enum":[ "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", "FORCE_CHANGE_PASSWORD" ] }, "UserType":{ "type":"structure", "members":{ "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user you want 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 date and time, in ISO 8601 format, when the item was modified.

" }, "Enabled":{ "shape":"BooleanType", "documentation":"

Specifies whether the user is enabled.

" }, "UserStatus":{ "shape":"UserStatusType", "documentation":"

The user status. This can be one of the following:

- UNCONFIRMED - User has been created but not confirmed.

- CONFIRMED - User has been confirmed.

- EXTERNAL_PROVIDER - User signed in with a third-party IdP.

- UNKNOWN - User status isn't known.

- RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

- FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

" }, "MFAOptions":{ "shape":"MFAOptionListType", "documentation":"

The MFA options for the user.

" } }, "documentation":"

A user profile in a Amazon Cognito user pool.

" }, "UsernameAttributeType":{ "type":"string", "enum":[ "phone_number", "email" ] }, "UsernameAttributesListType":{ "type":"list", "member":{"shape":"UsernameAttributeType"} }, "UsernameConfigurationType":{ "type":"structure", "required":["CaseSensitive"], "members":{ "CaseSensitive":{ "shape":"WrappedBooleanType", "documentation":"

Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.

Valid values include:

True

  Enables case sensitivity for all username input. When this option is set to `True`, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.

False

  Enables case insensitivity for all username input. For example, when this option is set to `False`, users can sign in using `username`, `USERNAME`, or `UserName`. This option also enables both `preferred_username` and `email` alias to be case insensitive, in addition to the `username` attribute.

" } }, "documentation":"

The username configuration 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"} }, "VerificationMessageTemplateType":{ "type":"structure", "members":{ "SmsMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

The template for SMS messages that Amazon Cognito sends to your users.

" }, "EmailMessage":{ "shape":"EmailVerificationMessageType", "documentation":"

The template for email messages that Amazon Cognito sends to your users. You can set an `EmailMessage` template only if the value of EmailSendingAccount is `DEVELOPER`. When your EmailSendingAccount is `DEVELOPER`, your user pool sends email messages with your own Amazon SES configuration.

" }, "EmailSubject":{ "shape":"EmailVerificationSubjectType", "documentation":"

The subject line for the email message template. You can set an `EmailSubject` template only if the value of EmailSendingAccount is `DEVELOPER`. When your EmailSendingAccount is `DEVELOPER`, your user pool sends email messages with your own Amazon SES configuration.

" }, "EmailMessageByLink":{ "shape":"EmailVerificationMessageByLinkType", "documentation":"

The email message template for sending a confirmation link to the user. You can set an `EmailMessageByLink` template only if the value of EmailSendingAccount is `DEVELOPER`. When your EmailSendingAccount is `DEVELOPER`, your user pool sends email messages with your own Amazon SES configuration.

" }, "EmailSubjectByLink":{ "shape":"EmailVerificationSubjectByLinkType", "documentation":"

The subject line for the email message template for sending a confirmation link to the user. You can set an `EmailSubjectByLink` template only if the value of EmailSendingAccount is `DEVELOPER`. When your EmailSendingAccount is `DEVELOPER`, your user pool sends email messages with your own Amazon SES configuration.

" }, "DefaultEmailOption":{ "shape":"DefaultEmailOptionType", "documentation":"

The default email option.

" } }, "documentation":"

The template for verification messages.

" }, "VerifiedAttributeType":{ "type":"string", "enum":[ "phone_number", "email" ] }, "VerifiedAttributesListType":{ "type":"list", "member":{"shape":"VerifiedAttributeType"} }, "VerifySoftwareTokenRequest":{ "type":"structure", "required":["UserCode"], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session that should be passed both ways in challenge-response calls to the service.

" }, "UserCode":{ "shape":"SoftwareTokenMFAUserCodeType", "documentation":"

The one- time password computed using the secret code returned by AssociateSoftwareToken.

" }, "FriendlyDeviceName":{ "shape":"StringType", "documentation":"

The friendly device name.

" } } }, "VerifySoftwareTokenResponse":{ "type":"structure", "members":{ "Status":{ "shape":"VerifySoftwareTokenResponseType", "documentation":"

The status of the verify software token.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session that should be passed both ways in challenge-response calls to the service.

" } } }, "VerifySoftwareTokenResponseType":{ "type":"string", "enum":[ "SUCCESS", "ERROR" ] }, "VerifyUserAttributeRequest":{ "type":"structure", "required":[ "AccessToken", "AttributeName", "Code" ], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.

" }, "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.

" }, "WrappedBooleanType":{"type":"boolean"} }, "documentation":"

With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can link IdP users to native user profiles. Learn more about the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and hosted UI reference.

This API reference provides detailed information about API operations and object types in Amazon Cognito.

Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side authentication of users. You can interact with operations in the Amazon Cognito user pools API as any of the following subjects.

1. An administrator who wants to configure user pools, app clients, users, groups, or other user pool functions.

2. A server-side app, like a web application, that wants to use its Amazon Web Services privileges to manage, authenticate, or authorize a user.

3. A client-side app, like a mobile app, that wants to make unauthenticated requests to manage, authenticate, or authorize a user.

For more information, see Using the Amazon Cognito user pools API and user pool endpoints in the Amazon Cognito Developer Guide.

With your Amazon Web Services SDK, you can build the logic to support operational flows in every use case for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints. The following links can get you started with the `CognitoIdentityProvider` client in other supported Amazon Web Services SDKs.

- Amazon Web Services Command Line Interface

- Amazon Web Services SDK for .NET

- Amazon Web Services SDK for C++

- Amazon Web Services SDK for Go

- Amazon Web Services SDK for Java V2

- Amazon Web Services SDK for JavaScript

- Amazon Web Services SDK for PHP V3

- Amazon Web Services SDK for Python

- Amazon Web Services SDK for Ruby V3

To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs.

" }