Class: Aws::CognitoIdentityProvider::Client

#add_custom_attributes(params = {}) ⇒ `Struct`

Adds additional user attributes to the user pool schema.

Examples:

Request syntax with placeholder values


resp = client.add_custom_attributes({
  user_pool_id: "UserPoolIdType", # required
  custom_attributes: [ # required
    {
      name: "CustomAttributeNameType",
      attribute_data_type: "String", # accepts String, Number, DateTime, Boolean
      developer_only_attribute: false,
      mutable: false,
      required: false,
      number_attribute_constraints: {
        min_value: "StringType",
        max_value: "StringType",
      },
      string_attribute_constraints: {
        min_length: "StringType",
        max_length: "StringType",
      },
    },
  ],
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to add custom attributes.
:custom_attributes (required, Array<Types::SchemaAttributeType>) —

An array of custom attributes, such as Mutable and Name.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 424

def add_custom_attributes(params = {}, options = {})
  req = build_request(:add_custom_attributes, params)
  req.send_request(options)
end

#admin_add_user_to_group(params = {}) ⇒ `Struct`

Adds the specified user to the specified group.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_add_user_to_group({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  group_name: "GroupNameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:username (required, String) —

The username for the user.
:group_name (required, String) —

The group name.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 456

def admin_add_user_to_group(params = {}, options = {})
  req = build_request(:admin_add_user_to_group, params)
  req.send_request(options)
end

#admin_confirm_sign_up(params = {}) ⇒ `Struct`

Confirms user registration as an admin without using a confirmation code. Works on any user.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_confirm_sign_up({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  client_metadata: {
    "StringType" => "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for which you want to confirm user registration.
:username (required, String) —

The user name for which you want to confirm user registration.
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the *post confirmation* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the ‘clientMetadata` attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp 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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 524

def admin_confirm_sign_up(params = {}, options = {})
  req = build_request(:admin_confirm_sign_up, params)
  req.send_request(options)
end

#admin_create_user(params = {}) ⇒ `Types::AdminCreateUserResponse`

Creates a new user in the specified user pool.

If ‘MessageAction` isn’t set, the default is to send a welcome message via email or phone (SMS).

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Alternatively, you can call ‘AdminCreateUser` with `SUPPRESS` for the `MessageAction` parameter, and Amazon Cognito won’t send any email.

In either case, the user will be in the ‘FORCE_CHANGE_PASSWORD` state until they sign in and change their password.

‘AdminCreateUser` requires developer credentials.

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.admin_create_user({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  user_attributes: [
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  validation_data: [
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  temporary_password: "PasswordType",
  force_alias_creation: false,
  message_action: "RESEND", # accepts RESEND, SUPPRESS
  desired_delivery_mediums: ["SMS"], # accepts SMS, EMAIL
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.user.username #=> String
resp.user.attributes #=> Array
resp.user.attributes[0].name #=> String
resp.user.attributes[0].value #=> String
resp.user.user_create_date #=> Time
resp.user.user_last_modified_date #=> Time
resp.user.enabled #=> Boolean
resp.user.user_status #=> String, one of "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", "FORCE_CHANGE_PASSWORD"
resp.user.mfa_options #=> Array
resp.user.mfa_options[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.user.mfa_options[0].attribute_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where the user will be created.
:username (required, String) —

The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can’t be changed.
:user_attributes (Array<Types::AttributeType>) —
An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than ‘Username`. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to `AdminCreateUser`) or the user should supply (when they sign up in response to your welcome message).

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

To send a message inviting the user to sign up, you must specify the user’s email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

In your call to ‘AdminCreateUser`, you can set the `email_verified` attribute to `True`, and you can set the `phone_number_verified` attribute to `True`. You can also do this by calling [AdminUpdateUserAttributes].
- email: The email address of the user to whom the message that contains the code and username will be sent. Required if the ‘email_verified` attribute is set to `True`, or if `“EMAIL”` is specified in the `DesiredDeliveryMediums` parameter.
- phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the ‘phone_number_verified` attribute is set to `True`, or if `“SMS”` is specified in the `DesiredDeliveryMediums` parameter.
[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html
:validation_data (Array<Types::AttributeType>) —

The user’s validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user’s domain.

To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.

The user’s validation data isn’t persisted.
:temporary_password (String) —

The user’s temporary password. This password must conform to the password policy that you specified when you created the user pool.

The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.

This parameter isn’t required. If you don’t specify a value, Amazon Cognito generates one for you.

The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call ‘AdminCreateUser` again, specifying `“RESEND”` for the `MessageAction` parameter.
:force_alias_creation (Boolean) —

This parameter is used only if the ‘phone_number_verified` or `email_verified` attribute is set to `True`. Otherwise, it is ignored.

If this parameter is set to ‘True` and the phone number or email address specified in the UserAttributes parameter 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. The previous user will no longer be able to log in using that alias.

If this parameter is set to ‘False`, the API throws an `AliasExistsException` error if the alias already exists. The default value is `False`.
:message_action (String) —

Set to ‘RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user’s account. Set to ‘SUPPRESS` to suppress sending the message. You can specify only one value.
:desired_delivery_mediums (Array<String>) —

Specify ‘“EMAIL”` if email will be used to send the welcome message. Specify `“SMS”` if the phone number will be used. The default value is `“SMS”`. You can specify more than one value.
:client_metadata (Hash<String,String>) —
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 AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* 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 AdminCreateUser 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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::AdminCreateUserResponse) —
Returns a response object which responds to the following methods:
- #user => Types::UserType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 758

def admin_create_user(params = {}, options = {})
  req = build_request(:admin_create_user, params)
  req.send_request(options)
end

#admin_delete_user(params = {}) ⇒ `Struct`

Deletes a user as an administrator. Works on any user.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_delete_user({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to delete the user.
:username (required, String) —

The user name of the user you want to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 786

def admin_delete_user(params = {}, options = {})
  req = build_request(:admin_delete_user, params)
  req.send_request(options)
end

#admin_delete_user_attributes(params = {}) ⇒ `Struct`

Deletes the user attributes in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_delete_user_attributes({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  user_attribute_names: ["AttributeNameType"], # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to delete user attributes.
:username (required, String) —

The user name of the user from which you would like to delete attributes.
:user_attribute_names (required, Array<String>) —

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

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

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 825

def admin_delete_user_attributes(params = {}, options = {})
  req = build_request(:admin_delete_user_attributes, params)
  req.send_request(options)
end

#admin_disable_provider_for_user(params = {}) ⇒ `Struct`

Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can’t use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked ‘DestinationUser`, the user must create a new user account. See [AdminLinkProviderForUser].

This action is enabled only for admin access and requires developer credentials.

The ‘ProviderName` must match the value specified when creating an IdP for the pool.

To deactivate a native username + password user, the ‘ProviderName` value must be `Cognito` and the `ProviderAttributeName` must be `Cognito_Subject`. The `ProviderAttributeValue` must be the name that is used in the user pool for the user.

The ‘ProviderAttributeName` must always be `Cognito_Subject` for social IdPs. The `ProviderAttributeValue` must always be the exact subject that was used when the user was originally linked as a source user.

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ‘ProviderAttributeName` and `ProviderAttributeValue` must be the same values that were used for the `SourceUser` when the identities were originally linked using ` AdminLinkProviderForUser` call. (If the linking was done with `ProviderAttributeName` set to `Cognito_Subject`, the same applies here). However, if the user has already signed in, the `ProviderAttributeName` must be `Cognito_Subject` and `ProviderAttributeValue` must be the subject of the SAML assertion.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html

Examples:

Request syntax with placeholder values


resp = client.admin_disable_provider_for_user({
  user_pool_id: "StringType", # required
  user: { # required
    provider_name: "ProviderNameType",
    provider_attribute_name: "StringType",
    provider_attribute_value: "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:user (required, Types::ProviderUserIdentifierType) —

The user to be disabled.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 893

def admin_disable_provider_for_user(params = {}, options = {})
  req = build_request(:admin_disable_provider_for_user, params)
  req.send_request(options)
end

#admin_disable_user(params = {}) ⇒ `Struct`

Deactivates a user and revokes all access tokens for the user. A deactivated user can’t sign in, but still appears in the responses to ‘GetUser` and `ListUsers` API requests.

You must make this API request with Amazon Web Services credentials that have ‘cognito-idp:AdminDisableUser` permissions.

Examples:

Request syntax with placeholder values


resp = client.admin_disable_user({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to disable the user.
:username (required, String) —

The user name of the user you want to disable.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 924

def admin_disable_user(params = {}, options = {})
  req = build_request(:admin_disable_user, params)
  req.send_request(options)
end

#admin_enable_user(params = {}) ⇒ `Struct`

Enables the specified user as an administrator. Works on any user.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_enable_user({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to enable the user.
:username (required, String) —

The user name of the user you want to enable.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 952

def admin_enable_user(params = {}, options = {})
  req = build_request(:admin_enable_user, params)
  req.send_request(options)
end

#admin_forget_device(params = {}) ⇒ `Struct`

Forgets the device, as an administrator.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_forget_device({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  device_key: "DeviceKeyType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:username (required, String) —

The user name.
:device_key (required, String) —

The device key.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 984

def admin_forget_device(params = {}, options = {})
  req = build_request(:admin_forget_device, params)
  req.send_request(options)
end

#admin_get_device(params = {}) ⇒ `Types::AdminGetDeviceResponse`

Gets the device, as an administrator.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_get_device({
  device_key: "DeviceKeyType", # required
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Response structure


resp.device.device_key #=> String
resp.device.device_attributes #=> Array
resp.device.device_attributes[0].name #=> String
resp.device.device_attributes[0].value #=> String
resp.device.device_create_date #=> Time
resp.device.device_last_modified_date #=> Time
resp.device.device_last_authenticated_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:device_key (required, String) —

The device key.
:user_pool_id (required, String) —

The user pool ID.
:username (required, String) —

The user name.

Returns:

(Types::AdminGetDeviceResponse) —
Returns a response object which responds to the following methods:
- #device => Types::DeviceType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1028

def admin_get_device(params = {}, options = {})
  req = build_request(:admin_get_device, params)
  req.send_request(options)
end

#admin_get_user(params = {}) ⇒ `Types::AdminGetUserResponse`

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_get_user({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Response structure


resp.username #=> String
resp.user_attributes #=> Array
resp.user_attributes[0].name #=> String
resp.user_attributes[0].value #=> String
resp.user_create_date #=> Time
resp.user_last_modified_date #=> Time
resp.enabled #=> Boolean
resp.user_status #=> String, one of "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", "FORCE_CHANGE_PASSWORD"
resp.mfa_options #=> Array
resp.mfa_options[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.mfa_options[0].attribute_name #=> String
resp.preferred_mfa_setting #=> String
resp.user_mfa_setting_list #=> Array
resp.user_mfa_setting_list[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to get information about the user.
:username (required, String) —

The user name of the user you want to retrieve.

Returns:

(Types::AdminGetUserResponse) —
Returns a response object which responds to the following methods:
- #username => String
- #user_attributes => Array<Types::AttributeType>
- #user_create_date => Time
- #user_last_modified_date => Time
- #enabled => Boolean
- #user_status => String
- #mfa_options => Array<Types::MFAOptionType>
- #preferred_mfa_setting => String
- #user_mfa_setting_list => Array<String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1085

def admin_get_user(params = {}, options = {})
  req = build_request(:admin_get_user, params)
  req.send_request(options)
end

#admin_initiate_auth(params = {}) ⇒ `Types::AdminInitiateAuthResponse`

Initiates the authentication flow, as an administrator.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

Calling this action requires developer credentials.

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.admin_initiate_auth({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
  auth_parameters: {
    "StringType" => "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  context_data: {
    ip_address: "StringType", # required
    server_name: "StringType", # required
    server_path: "StringType", # required
    http_headers: [ # required
      {
        header_name: "StringType",
        header_value: "StringType",
      },
    ],
    encoded_data: "StringType",
  },
})

Response structure


resp.challenge_name #=> String, one of "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"
resp.session #=> String
resp.challenge_parameters #=> Hash
resp.challenge_parameters["StringType"] #=> String
resp.authentication_result.access_token #=> String
resp.authentication_result.expires_in #=> Integer
resp.authentication_result.token_type #=> String
resp.authentication_result.refresh_token #=> String
resp.authentication_result.id_token #=> String
resp.authentication_result.new_device_metadata.device_key #=> String
resp.authentication_result.new_device_metadata.device_group_key #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the Amazon Cognito user pool.
:client_id (required, String) —

The app client ID.
:auth_flow (required, String) —
The authentication flow for this call to run. The API action will depend on this value. For example:
- ‘REFRESH_TOKEN_AUTH` will take in a valid refresh token and return new tokens.
- ‘USER_SRP_AUTH` will take in `USERNAME` and `SRP_A` and return the Secure Remote Password (SRP) protocol variables to be used for next challenge execution.
- ‘ADMIN_USER_PASSWORD_AUTH` will take in `USERNAME` and `PASSWORD` and return 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.
- ‘ADMIN_NO_SRP_AUTH`: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
- ‘ADMIN_USER_PASSWORD_AUTH`: Admin-based user password authentication. This replaces the `ADMIN_NO_SRP_AUTH` authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.
:auth_parameters (Hash<String,String>) —
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 ‘REFRESH_TOKEN_AUTH/REFRESH_TOKEN`: `REFRESH_TOKEN` (required), `SECRET_HASH` (required if the app client is configured with a client secret), `DEVICE_KEY`.
- For ‘ADMIN_NO_SRP_AUTH`: `USERNAME` (required), `SECRET_HASH` (if app client is configured with client secret), `PASSWORD` (required), `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)`.
:client_metadata (Hash<String,String>) —
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 AdminInitiateAuth 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 AdminInitiateAuth 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 AdminInitiateAuth 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
- Verify auth challenge
For more information, see [ Customizing user pool Workflows with Lambda Triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html
:analytics_metadata (Types::AnalyticsMetadataType) —

The analytics metadata for collecting Amazon Pinpoint metrics for ‘AdminInitiateAuth` calls.
:context_data (Types::ContextDataType) —

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.

Returns:

(Types::AdminInitiateAuthResponse) —
Returns a response object which responds to the following methods:
- #challenge_name => String
- #session => String
- #challenge_parameters => Hash<String,String>
- #authentication_result => Types::AuthenticationResultType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1309

def admin_initiate_auth(params = {}, options = {})
  req = build_request(:admin_initiate_auth, params)
  req.send_request(options)
end

#admin_link_provider_for_user(params = {}) ⇒ `Struct`

Links an existing user account in a user pool (‘DestinationUser`) to an identity from an external IdP (`SourceUser`) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account.

For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account.

<note markdown=“1”> The maximum number of federated identities linked to a user is five.

</note>

Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner.

This action is administrative and requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_link_provider_for_user({
  user_pool_id: "StringType", # required
  destination_user: { # required
    provider_name: "ProviderNameType",
    provider_attribute_name: "StringType",
    provider_attribute_value: "StringType",
  },
  source_user: { # required
    provider_name: "ProviderNameType",
    provider_attribute_name: "StringType",
    provider_attribute_value: "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:destination_user (required, Types::ProviderUserIdentifierType) —

The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn’t exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.

For a native username + password user, the ‘ProviderAttributeValue` for the `DestinationUser` should be the username in the user pool. For a federated user, it should be the provider-specific `user_id`.

The ‘ProviderAttributeName` of the `DestinationUser` is ignored.

The ‘ProviderName` should be set to `Cognito` for users in Cognito user pools.

All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won’t succeed.
:source_user (required, Types::ProviderUserIdentifierType) —

An external IdP account for a user who doesn’t exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.

If the ‘SourceUser` is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the `ProviderAttributeName` to `Cognito_Subject`. For social IdPs, the `ProviderName` will be `Facebook`, `Google`, or `LoginWithAmazon`, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for `id`, `sub`, and `user_id`, respectively. The `ProviderAttributeValue` for the user must be the same value as the `id`, `sub`, or `user_id` value found in the social IdP token.

For SAML, the ‘ProviderAttributeName` can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the `ProviderAttributeName`. If you set `ProviderAttributeName` to `Cognito_Subject`, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1407

def admin_link_provider_for_user(params = {}, options = {})
  req = build_request(:admin_link_provider_for_user, params)
  req.send_request(options)
end

#admin_list_devices(params = {}) ⇒ `Types::AdminListDevicesResponse`

Lists devices, as an administrator.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_list_devices({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  limit: 1,
  pagination_token: "SearchPaginationTokenType",
})

Response structure


resp.devices #=> Array
resp.devices[0].device_key #=> String
resp.devices[0].device_attributes #=> Array
resp.devices[0].device_attributes[0].name #=> String
resp.devices[0].device_attributes[0].value #=> String
resp.devices[0].device_create_date #=> Time
resp.devices[0].device_last_modified_date #=> Time
resp.devices[0].device_last_authenticated_date #=> Time
resp.pagination_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:username (required, String) —

The user name.
:limit (Integer) —

The limit of the devices request.
:pagination_token (String) —

The pagination token.

Returns:

(Types::AdminListDevicesResponse) —
Returns a response object which responds to the following methods:
- #devices => Array<Types::DeviceType>
- #pagination_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1458

def admin_list_devices(params = {}, options = {})
  req = build_request(:admin_list_devices, params)
  req.send_request(options)
end

#admin_list_groups_for_user(params = {}) ⇒ `Types::AdminListGroupsForUserResponse`

Lists the groups that the user belongs to.

Calling this action requires developer credentials.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.admin_list_groups_for_user({
  username: "UsernameType", # required
  user_pool_id: "UserPoolIdType", # required
  limit: 1,
  next_token: "PaginationKey",
})

Response structure


resp.groups #=> Array
resp.groups[0].group_name #=> String
resp.groups[0].user_pool_id #=> String
resp.groups[0].description #=> String
resp.groups[0].role_arn #=> String
resp.groups[0].precedence #=> Integer
resp.groups[0].last_modified_date #=> Time
resp.groups[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:username (required, String) —

The username for the user.
:user_pool_id (required, String) —

The user pool ID for the user pool.
:limit (Integer) —

The limit of the request to list groups.
:next_token (String) —

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.

Returns:

(Types::AdminListGroupsForUserResponse) —
Returns a response object which responds to the following methods:
- #groups => Array<Types::GroupType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1513

def admin_list_groups_for_user(params = {}, options = {})
  req = build_request(:admin_list_groups_for_user, params)
  req.send_request(options)
end

#admin_list_user_auth_events(params = {}) ⇒ `Types::AdminListUserAuthEventsResponse`

A history of user activity and any risks detected as part of Amazon Cognito advanced security.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.admin_list_user_auth_events({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  max_results: 1,
  next_token: "PaginationKey",
})

Response structure


resp.auth_events #=> Array
resp.auth_events[0].event_id #=> String
resp.auth_events[0].event_type #=> String, one of "SignIn", "SignUp", "ForgotPassword", "PasswordChange", "ResendCode"
resp.auth_events[0].creation_date #=> Time
resp.auth_events[0].event_response #=> String, one of "Pass", "Fail", "InProgress"
resp.auth_events[0].event_risk.risk_decision #=> String, one of "NoRisk", "AccountTakeover", "Block"
resp.auth_events[0].event_risk.risk_level #=> String, one of "Low", "Medium", "High"
resp.auth_events[0].event_risk.compromised_credentials_detected #=> Boolean
resp.auth_events[0].challenge_responses #=> Array
resp.auth_events[0].challenge_responses[0].challenge_name #=> String, one of "Password", "Mfa"
resp.auth_events[0].challenge_responses[0].challenge_response #=> String, one of "Success", "Failure"
resp.auth_events[0].event_context_data.ip_address #=> String
resp.auth_events[0].event_context_data.device_name #=> String
resp.auth_events[0].event_context_data.timezone #=> String
resp.auth_events[0].event_context_data.city #=> String
resp.auth_events[0].event_context_data.country #=> String
resp.auth_events[0].event_feedback.feedback_value #=> String, one of "Valid", "Invalid"
resp.auth_events[0].event_feedback.provider #=> String
resp.auth_events[0].event_feedback.feedback_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:username (required, String) —

The user pool username or an alias.
:max_results (Integer) —

The maximum number of authentication events to return. Returns 60 events if you set ‘MaxResults` to 0, or if you don’t include a ‘MaxResults` parameter.
:next_token (String) —

A pagination token.

Returns:

(Types::AdminListUserAuthEventsResponse) —
Returns a response object which responds to the following methods:
- #auth_events => Array<Types::AuthEventType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1578

def admin_list_user_auth_events(params = {}, options = {})
  req = build_request(:admin_list_user_auth_events, params)
  req.send_request(options)
end

#admin_remove_user_from_group(params = {}) ⇒ `Struct`

Removes the specified user from the specified group.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_remove_user_from_group({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  group_name: "GroupNameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:username (required, String) —

The username for the user.
:group_name (required, String) —

The group name.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1610

def admin_remove_user_from_group(params = {}, options = {})
  req = build_request(:admin_remove_user_from_group, params)
  req.send_request(options)
end

#admin_reset_user_password(params = {}) ⇒ `Struct`

Resets the specified user’s password in a user pool as an administrator. Works on any user.

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

Calling this action requires developer credentials.

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.admin_reset_user_password({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  client_metadata: {
    "StringType" => "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to reset the user’s password.
:username (required, String) —

The user name of the user whose password you want to reset.
:client_metadata (Hash<String,String>) —
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 AdminResetUserPassword 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 AdminResetUserPassword 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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1717

def admin_reset_user_password(params = {}, options = {})
  req = build_request(:admin_reset_user_password, params)
  req.send_request(options)
end

#admin_respond_to_auth_challenge(params = {}) ⇒ `Types::AdminRespondToAuthChallengeResponse`

Responds to an authentication challenge, as an administrator.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

Calling this action requires developer credentials.

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.admin_respond_to_auth_challenge({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  challenge_name: "SMS_MFA", # required, accepts 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
  challenge_responses: {
    "StringType" => "StringType",
  },
  session: "SessionType",
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  context_data: {
    ip_address: "StringType", # required
    server_name: "StringType", # required
    server_path: "StringType", # required
    http_headers: [ # required
      {
        header_name: "StringType",
        header_value: "StringType",
      },
    ],
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.challenge_name #=> String, one of "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"
resp.session #=> String
resp.challenge_parameters #=> Hash
resp.challenge_parameters["StringType"] #=> String
resp.authentication_result.access_token #=> String
resp.authentication_result.expires_in #=> Integer
resp.authentication_result.token_type #=> String
resp.authentication_result.refresh_token #=> String
resp.authentication_result.id_token #=> String
resp.authentication_result.new_device_metadata.device_key #=> String
resp.authentication_result.new_device_metadata.device_group_key #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the Amazon Cognito user pool.
:client_id (required, String) —

The app client ID.
:challenge_name (required, String) —

The challenge name. For more information, see [AdminInitiateAuth].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html
:challenge_responses (Hash<String,String>) —
The challenge responses. These are inputs corresponding to the value of ‘ChallengeName`, for example:
- ‘SMS_MFA`: `SMS_MFA_CODE`, `USERNAME`, `SECRET_HASH` (if app client is configured with client secret).
- ‘PASSWORD_VERIFIER`: `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, `TIMESTAMP`, `USERNAME`, `SECRET_HASH` (if app client is configured with client secret).
  
  <note markdown=“1”> ‘PASSWORD_VERIFIER` requires `DEVICE_KEY` when signing in with a remembered device.
```
</note>
```
- ‘ADMIN_NO_SRP_AUTH`: `PASSWORD`, `USERNAME`, `SECRET_HASH` (if app client is configured with client secret).
- ‘NEW_PASSWORD_REQUIRED`: `NEW_PASSWORD`, `USERNAME`, `SECRET_HASH` (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as `requiredAttributes` in the `AdminInitiateAuth` response, add a `userAttributes.attributename ` parameter. This parameter can also set values for writable attributes that aren’t required by your user pool.
  
  <note markdown=“1”> In a ‘NEW_PASSWORD_REQUIRED` challenge response, you can’t modify a required attribute that already has a value. In ‘AdminRespondToAuthChallenge`, set a value for any keys that Amazon Cognito returned in the `requiredAttributes` parameter, then use the `AdminUpdateUserAttributes` API operation to modify the value of any additional attributes.
```
</note>
```
- ‘MFA_SETUP` requires `USERNAME`, plus you must use the session value returned by `VerifySoftwareToken` in the `Session` parameter.
The value of the ‘USERNAME` attribute must be the user’s actual username, not an alias (such as an email address or phone number). To make this simpler, the ‘AdminInitiateAuth` response includes the actual username value in the `USERNAMEUSER_ID_FOR_SRP` attribute. This happens even if you specified an alias in your call to `AdminInitiateAuth`.
:session (String) —

The session that should be passed both ways in challenge-response calls to the service. If an ‘InitiateAuth` or `RespondToAuthChallenge` API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next `RespondToAuthChallenge` API call.
:analytics_metadata (Types::AnalyticsMetadataType) —

The analytics metadata for collecting Amazon Pinpoint metrics for ‘AdminRespondToAuthChallenge` calls.
:context_data (Types::ContextDataType) —

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.
:client_metadata (Hash<String,String>) —
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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
- pre sign-up
- custom message
- post authentication
- user migration
- pre token generation
- define auth challenge
- create auth challenge
- verify auth challenge response
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 that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge 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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::AdminRespondToAuthChallengeResponse) —
Returns a response object which responds to the following methods:
- #challenge_name => String
- #session => String
- #challenge_parameters => Hash<String,String>
- #authentication_result => Types::AuthenticationResultType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1939

def admin_respond_to_auth_challenge(params = {}, options = {})
  req = build_request(:admin_respond_to_auth_challenge, params)
  req.send_request(options)
end

#admin_set_user_mfa_preference(params = {}) ⇒ `Struct`

The user’s multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.

Examples:

Request syntax with placeholder values


resp = client.admin_set_user_mfa_preference({
  sms_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  software_token_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  username: "UsernameType", # required
  user_pool_id: "UserPoolIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:sms_mfa_settings (Types::SMSMfaSettingsType) —

The SMS text message MFA settings.
:software_token_mfa_settings (Types::SoftwareTokenMfaSettingsType) —

The time-based one-time password software token MFA settings.
:username (required, String) —

The user pool username or alias.
:user_pool_id (required, String) —

The user pool ID.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1984

def admin_set_user_mfa_preference(params = {}, options = {})
  req = build_request(:admin_set_user_mfa_preference, params)
  req.send_request(options)
end

#admin_set_user_password(params = {}) ⇒ `Struct`

Sets the specified user’s password in a user pool as an administrator. Works on any user.

The password can be temporary or permanent. If it is temporary, the user status enters the ‘FORCE_CHANGE_PASSWORD` state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the `NEW_PASSWORD_REQUIRED` challenge. If the user doesn’t sign in before it expires, the user won’t be able to sign in, and an administrator must reset their password.

Once the user has set a new password, or the password is permanent, the user status is set to ‘Confirmed`.

Examples:

Request syntax with placeholder values


resp = client.admin_set_user_password({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  password: "PasswordType", # required
  permanent: false,
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to set the user’s password.
:username (required, String) —

The user name of the user whose password you want to set.
:password (required, String) —

The password for the user.
:permanent (Boolean) —

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

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2030

def admin_set_user_password(params = {}, options = {})
  req = build_request(:admin_set_user_password, params)
  req.send_request(options)
end

#admin_set_user_settings(params = {}) ⇒ `Struct`

*This action is no longer supported.* You can use it to configure only SMS MFA. You can’t use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use

AdminSetUserMFAPreference][1: instead.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html

Examples:

Request syntax with placeholder values


resp = client.admin_set_user_settings({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  mfa_options: [ # required
    {
      delivery_medium: "SMS", # accepts SMS, EMAIL
      attribute_name: "AttributeNameType",
    },
  ],
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that contains the user whose options you’re setting.
:username (required, String) —

The user name of the user whose options you’re setting.
:mfa_options (required, Array<Types::MFAOptionType>) —

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

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2074

def admin_set_user_settings(params = {}, options = {})
  req = build_request(:admin_set_user_settings, params)
  req.send_request(options)
end

#admin_update_auth_event_feedback(params = {}) ⇒ `Struct`

Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

Examples:

Request syntax with placeholder values


resp = client.admin_update_auth_event_feedback({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  event_id: "EventIdType", # required
  feedback_value: "Valid", # required, accepts Valid, Invalid
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:username (required, String) —

The user pool username.
:event_id (required, String) —

The authentication event ID.
:feedback_value (required, String) —

The authentication event feedback value.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2111

def admin_update_auth_event_feedback(params = {}, options = {})
  req = build_request(:admin_update_auth_event_feedback, params)
  req.send_request(options)
end

#admin_update_device_status(params = {}) ⇒ `Struct`

Updates the device status as an administrator.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_update_device_status({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  device_key: "DeviceKeyType", # required
  device_remembered_status: "remembered", # accepts remembered, not_remembered
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:username (required, String) —

The user name.
:device_key (required, String) —

The device key.
:device_remembered_status (String) —

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

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2147

def admin_update_device_status(params = {}, options = {})
  req = build_request(:admin_update_device_status, params)
  req.send_request(options)
end

#admin_update_user_attributes(params = {}) ⇒ `Struct`

Updates the specified user’s attributes, including developer attributes, as an administrator. Works on any user.

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

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

Calling this action requires developer credentials.

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.admin_update_user_attributes({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  user_attributes: [ # required
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  client_metadata: {
    "StringType" => "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to update user attributes.
:username (required, String) —

The user name of the user for whom you want to update user attributes.
:user_attributes (required, Array<Types::AttributeType>) —

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.
:client_metadata (Hash<String,String>) —
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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2276

def admin_update_user_attributes(params = {}, options = {})
  req = build_request(:admin_update_user_attributes, params)
  req.send_request(options)
end

#admin_user_global_sign_out(params = {}) ⇒ `Struct`

Signs out a user from all devices. You must sign ‘AdminUserGlobalSignOut` requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user’s current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they’re issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.admin_user_global_sign_out({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:username (required, String) —

The user name.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2311

def admin_user_global_sign_out(params = {}, options = {})
  req = build_request(:admin_user_global_sign_out, params)
  req.send_request(options)
end

#associate_software_token(params = {}) ⇒ `Types::AssociateSoftwareTokenResponse`

Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an ‘AssociateSoftwareToken` request with either the user’s access token, or a session string from a challenge response that you received from Amazon Cognito.

<note markdown=“1”> Amazon Cognito disassociates an existing software token when you verify the new token in a [ VerifySoftwareToken] API request. If you don’t verify the software token and your user pool doesn’t require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an ‘MFA_SETUP` or `SOFTWARE_TOKEN_SETUP` challenge each time your user signs. Complete setup with `AssociateSoftwareToken` and `VerifySoftwareToken`.

After you set up software token MFA for your user, Amazon Cognito

generates a ‘SOFTWARE_TOKEN_MFA` challenge when they authenticate. Respond to this challenge with your user’s TOTP.

</note>

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html

Examples:

Request syntax with placeholder values


resp = client.associate_software_token({
  access_token: "TokenModelType",
  session: "SessionType",
})

Response structure


resp.secret_code #=> String
resp.session #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (String) —

A valid access token that Amazon Cognito issued to the user whose software token you want to generate.
:session (String) —

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.

Returns:

(Types::AssociateSoftwareTokenResponse) —
Returns a response object which responds to the following methods:
- #secret_code => String
- #session => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2372

def associate_software_token(params = {}, options = {})
  req = build_request(:associate_software_token, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7986

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
  context[:gem_version] = '1.76.0'
  Seahorse::Client::Request.new(handlers, context)
end

#change_password(params = {}) ⇒ `Struct`

Changes the password for a specified user in a user pool.

Examples:

Request syntax with placeholder values


resp = client.change_password({
  previous_password: "PasswordType", # required
  proposed_password: "PasswordType", # required
  access_token: "TokenModelType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:previous_password (required, String) —

The old password.
:proposed_password (required, String) —

The new password.
:access_token (required, String) —

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

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2403

def change_password(params = {}, options = {})
  req = build_request(:change_password, params)
  req.send_request(options)
end

#confirm_device(params = {}) ⇒ `Types::ConfirmDeviceResponse`

Confirms tracking of the device. This API call is the call that begins device tracking.

Examples:

Request syntax with placeholder values


resp = client.confirm_device({
  access_token: "TokenModelType", # required
  device_key: "DeviceKeyType", # required
  device_secret_verifier_config: {
    password_verifier: "StringType",
    salt: "StringType",
  },
  device_name: "DeviceNameType",
})

Response structure


resp.user_confirmation_necessary #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
:device_key (required, String) —

The device key.
:device_secret_verifier_config (Types::DeviceSecretVerifierConfigType) —

The configuration of the device secret verifier.
:device_name (String) —

The device name.

Returns:

(Types::ConfirmDeviceResponse) —
Returns a response object which responds to the following methods:
- #user_confirmation_necessary => Boolean

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2448

def confirm_device(params = {}, options = {})
  req = build_request(:confirm_device, params)
  req.send_request(options)
end

#confirm_forgot_password(params = {}) ⇒ `Struct`

Allows a user to enter a confirmation code to reset a forgotten password.

Examples:

Request syntax with placeholder values


resp = client.confirm_forgot_password({
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
  confirmation_code: "ConfirmationCodeType", # required
  password: "PasswordType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The app client ID of the app associated with the user pool.
:secret_hash (String) —

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 (required, String) —

The user name of the user for whom you want to enter a code to retrieve a forgotten password.
:confirmation_code (required, String) —

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

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html
:password (required, String) —

The new password that your user wants to set.
:analytics_metadata (Types::AnalyticsMetadataType) —

The Amazon Pinpoint analytics metadata for collecting metrics for ‘ConfirmForgotPassword` calls.
:user_context_data (Types::UserContextDataType) —

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.
:client_metadata (Hash<String,String>) —
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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2553

def confirm_forgot_password(params = {}, options = {})
  req = build_request(:confirm_forgot_password, params)
  req.send_request(options)
end

#confirm_sign_up(params = {}) ⇒ `Struct`

Confirms registration of a new user.

Examples:

Request syntax with placeholder values


resp = client.confirm_sign_up({
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
  confirmation_code: "ConfirmationCodeType", # required
  force_alias_creation: false,
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The ID of the app client associated with the user pool.
:secret_hash (String) —

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 (required, String) —

The user name of the user whose registration you want to confirm.
:confirmation_code (required, String) —

The confirmation code sent by a user’s request to confirm registration.
:force_alias_creation (Boolean) —

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.
:analytics_metadata (Types::AnalyticsMetadataType) —

The Amazon Pinpoint analytics metadata for collecting metrics for ‘ConfirmSignUp` calls.
:user_context_data (Types::UserContextDataType) —

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.
:client_metadata (Hash<String,String>) —
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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2657

def confirm_sign_up(params = {}, options = {})
  req = build_request(:confirm_sign_up, params)
  req.send_request(options)
end

#create_group(params = {}) ⇒ `Types::CreateGroupResponse`

Creates a new group in the specified user pool.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.create_group({
  group_name: "GroupNameType", # required
  user_pool_id: "UserPoolIdType", # required
  description: "DescriptionType",
  role_arn: "ArnType",
  precedence: 1,
})

Response structure


resp.group.group_name #=> String
resp.group.user_pool_id #=> String
resp.group.description #=> String
resp.group.role_arn #=> String
resp.group.precedence #=> Integer
resp.group.last_modified_date #=> Time
resp.group.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (required, String) —

The name of the group. Must be unique.
:user_pool_id (required, String) —

The user pool ID for the user pool.
:description (String) —

A string containing the description of the group.
:role_arn (String) —

The role Amazon Resource Name (ARN) for the group.
:precedence (Integer) —

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`.

Returns:

(Types::CreateGroupResponse) —
Returns a response object which responds to the following methods:
- #group => Types::GroupType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2726

def create_group(params = {}, options = {})
  req = build_request(:create_group, params)
  req.send_request(options)
end

#create_identity_provider(params = {}) ⇒ `Types::CreateIdentityProviderResponse`

Creates an IdP for a user pool.

Examples:

Request syntax with placeholder values


resp = client.create_identity_provider({
  user_pool_id: "UserPoolIdType", # required
  provider_name: "ProviderNameTypeV1", # required
  provider_type: "SAML", # required, accepts SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
  provider_details: { # required
    "StringType" => "StringType",
  },
  attribute_mapping: {
    "AttributeMappingKeyType" => "StringType",
  },
  idp_identifiers: ["IdpIdentifierType"],
})

Response structure


resp.identity_provider.user_pool_id #=> String
resp.identity_provider.provider_name #=> String
resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.identity_provider.provider_details #=> Hash
resp.identity_provider.provider_details["StringType"] #=> String
resp.identity_provider.attribute_mapping #=> Hash
resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
resp.identity_provider.idp_identifiers #=> Array
resp.identity_provider.idp_identifiers[0] #=> String
resp.identity_provider.last_modified_date #=> Time
resp.identity_provider.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:provider_name (required, String) —

The IdP name.
:provider_type (required, String) —

The IdP type.
:provider_details (required, Hash<String,String>) —
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
:attribute_mapping (Hash<String,String>) —

A mapping of IdP attributes to standard and custom user pool attributes.
:idp_identifiers (Array<String>) —

A list of IdP identifiers.

Returns:

(Types::CreateIdentityProviderResponse) —
Returns a response object which responds to the following methods:
- #identity_provider => Types::IdentityProviderType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2856

def create_identity_provider(params = {}, options = {})
  req = build_request(:create_identity_provider, params)
  req.send_request(options)
end

#create_resource_server(params = {}) ⇒ `Types::CreateResourceServerResponse`

Creates a new OAuth2.0 resource server and defines custom scopes within it.

Examples:

Request syntax with placeholder values


resp = client.create_resource_server({
  user_pool_id: "UserPoolIdType", # required
  identifier: "ResourceServerIdentifierType", # required
  name: "ResourceServerNameType", # required
  scopes: [
    {
      scope_name: "ResourceServerScopeNameType", # required
      scope_description: "ResourceServerScopeDescriptionType", # required
    },
  ],
})

Response structure


resp.resource_server.user_pool_id #=> String
resp.resource_server.identifier #=> String
resp.resource_server.name #=> String
resp.resource_server.scopes #=> Array
resp.resource_server.scopes[0].scope_name #=> String
resp.resource_server.scopes[0].scope_description #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:identifier (required, String) —

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as ‘my-weather-api.example.com`.
:name (required, String) —

A friendly name for the resource server.
:scopes (Array<Types::ResourceServerScopeType>) —

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

Returns:

(Types::CreateResourceServerResponse) —
Returns a response object which responds to the following methods:
- #resource_server => Types::ResourceServerType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2910

def create_resource_server(params = {}, options = {})
  req = build_request(:create_resource_server, params)
  req.send_request(options)
end

#create_user_import_job(params = {}) ⇒ `Types::CreateUserImportJobResponse`

Creates the user import job.

Examples:

Request syntax with placeholder values


resp = client.create_user_import_job({
  job_name: "UserImportJobNameType", # required
  user_pool_id: "UserPoolIdType", # required
  cloud_watch_logs_role_arn: "ArnType", # required
})

Response structure


resp.user_import_job.job_name #=> String
resp.user_import_job.job_id #=> String
resp.user_import_job.user_pool_id #=> String
resp.user_import_job.pre_signed_url #=> String
resp.user_import_job.creation_date #=> Time
resp.user_import_job.start_date #=> Time
resp.user_import_job.completion_date #=> Time
resp.user_import_job.status #=> String, one of "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded"
resp.user_import_job.cloud_watch_logs_role_arn #=> String
resp.user_import_job.imported_users #=> Integer
resp.user_import_job.skipped_users #=> Integer
resp.user_import_job.failed_users #=> Integer
resp.user_import_job.completion_message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:job_name (required, String) —

The job name for the user import job.
:user_pool_id (required, String) —

The user pool ID for the user pool that the users are being imported into.
:cloud_watch_logs_role_arn (required, String) —

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

Returns:

(Types::CreateUserImportJobResponse) —
Returns a response object which responds to the following methods:
- #user_import_job => Types::UserImportJobType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2960

def create_user_import_job(params = {}, options = {})
  req = build_request(:create_user_import_job, params)
  req.send_request(options)
end

#create_user_pool(params = {}) ⇒ `Types::CreateUserPoolResponse`

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.create_user_pool({
  pool_name: "UserPoolNameType", # required
  policies: {
    password_policy: {
      minimum_length: 1,
      require_uppercase: false,
      require_lowercase: false,
      require_numbers: false,
      require_symbols: false,
      temporary_password_validity_days: 1,
    },
  },
  deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
  lambda_config: {
    pre_sign_up: "ArnType",
    custom_message: "ArnType",
    post_confirmation: "ArnType",
    pre_authentication: "ArnType",
    post_authentication: "ArnType",
    define_auth_challenge: "ArnType",
    create_auth_challenge: "ArnType",
    verify_auth_challenge_response: "ArnType",
    pre_token_generation: "ArnType",
    user_migration: "ArnType",
    custom_sms_sender: {
      lambda_version: "V1_0", # required, accepts V1_0
      lambda_arn: "ArnType", # required
    },
    custom_email_sender: {
      lambda_version: "V1_0", # required, accepts V1_0
      lambda_arn: "ArnType", # required
    },
    kms_key_id: "ArnType",
  },
  auto_verified_attributes: ["phone_number"], # accepts phone_number, email
  alias_attributes: ["phone_number"], # accepts phone_number, email, preferred_username
  username_attributes: ["phone_number"], # accepts phone_number, email
  sms_verification_message: "SmsVerificationMessageType",
  email_verification_message: "EmailVerificationMessageType",
  email_verification_subject: "EmailVerificationSubjectType",
  verification_message_template: {
    sms_message: "SmsVerificationMessageType",
    email_message: "EmailVerificationMessageType",
    email_subject: "EmailVerificationSubjectType",
    email_message_by_link: "EmailVerificationMessageByLinkType",
    email_subject_by_link: "EmailVerificationSubjectByLinkType",
    default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
  },
  sms_authentication_message: "SmsVerificationMessageType",
  mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
  user_attribute_update_settings: {
    attributes_require_verification_before_update: ["phone_number"], # accepts phone_number, email
  },
  device_configuration: {
    challenge_required_on_new_device: false,
    device_only_remembered_on_user_prompt: false,
  },
  email_configuration: {
    source_arn: "ArnType",
    reply_to_email_address: "EmailAddressType",
    email_sending_account: "COGNITO_DEFAULT", # accepts COGNITO_DEFAULT, DEVELOPER
    from: "StringType",
    configuration_set: "SESConfigurationSet",
  },
  sms_configuration: {
    sns_caller_arn: "ArnType", # required
    external_id: "StringType",
    sns_region: "RegionCodeType",
  },
  user_pool_tags: {
    "TagKeysType" => "TagValueType",
  },
  admin_create_user_config: {
    allow_admin_create_user_only: false,
    unused_account_validity_days: 1,
    invite_message_template: {
      sms_message: "SmsVerificationMessageType",
      email_message: "EmailVerificationMessageType",
      email_subject: "EmailVerificationSubjectType",
    },
  },
  schema: [
    {
      name: "CustomAttributeNameType",
      attribute_data_type: "String", # accepts String, Number, DateTime, Boolean
      developer_only_attribute: false,
      mutable: false,
      required: false,
      number_attribute_constraints: {
        min_value: "StringType",
        max_value: "StringType",
      },
      string_attribute_constraints: {
        min_length: "StringType",
        max_length: "StringType",
      },
    },
  ],
  user_pool_add_ons: {
    advanced_security_mode: "OFF", # required, accepts OFF, AUDIT, ENFORCED
  },
  username_configuration: {
    case_sensitive: false, # required
  },
  account_recovery_setting: {
    recovery_mechanisms: [
      {
        priority: 1, # required
        name: "verified_email", # required, accepts verified_email, verified_phone_number, admin_only
      },
    ],
  },
})

Response structure


resp.user_pool.id #=> String
resp.user_pool.name #=> String
resp.user_pool.policies.password_policy.minimum_length #=> Integer
resp.user_pool.policies.password_policy.require_uppercase #=> Boolean
resp.user_pool.policies.password_policy.require_lowercase #=> Boolean
resp.user_pool.policies.password_policy.require_numbers #=> Boolean
resp.user_pool.policies.password_policy.require_symbols #=> Boolean
resp.user_pool.policies.password_policy.temporary_password_validity_days #=> Integer
resp.user_pool.deletion_protection #=> String, one of "ACTIVE", "INACTIVE"
resp.user_pool.lambda_config.pre_sign_up #=> String
resp.user_pool.lambda_config.custom_message #=> String
resp.user_pool.lambda_config.post_confirmation #=> String
resp.user_pool.lambda_config.pre_authentication #=> String
resp.user_pool.lambda_config.post_authentication #=> String
resp.user_pool.lambda_config.define_auth_challenge #=> String
resp.user_pool.lambda_config.create_auth_challenge #=> String
resp.user_pool.lambda_config.verify_auth_challenge_response #=> String
resp.user_pool.lambda_config.pre_token_generation #=> String
resp.user_pool.lambda_config.user_migration #=> String
resp.user_pool.lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
resp.user_pool.lambda_config.custom_sms_sender.lambda_arn #=> String
resp.user_pool.lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
resp.user_pool.lambda_config.custom_email_sender.lambda_arn #=> String
resp.user_pool.lambda_config.kms_key_id #=> String
resp.user_pool.status #=> String, one of "Enabled", "Disabled"
resp.user_pool.last_modified_date #=> Time
resp.user_pool.creation_date #=> Time
resp.user_pool.schema_attributes #=> Array
resp.user_pool.schema_attributes[0].name #=> String
resp.user_pool.schema_attributes[0].attribute_data_type #=> String, one of "String", "Number", "DateTime", "Boolean"
resp.user_pool.schema_attributes[0].developer_only_attribute #=> Boolean
resp.user_pool.schema_attributes[0].mutable #=> Boolean
resp.user_pool.schema_attributes[0].required #=> Boolean
resp.user_pool.schema_attributes[0].number_attribute_constraints.min_value #=> String
resp.user_pool.schema_attributes[0].number_attribute_constraints.max_value #=> String
resp.user_pool.schema_attributes[0].string_attribute_constraints.min_length #=> String
resp.user_pool.schema_attributes[0].string_attribute_constraints.max_length #=> String
resp.user_pool.auto_verified_attributes #=> Array
resp.user_pool.auto_verified_attributes[0] #=> String, one of "phone_number", "email"
resp.user_pool.alias_attributes #=> Array
resp.user_pool.alias_attributes[0] #=> String, one of "phone_number", "email", "preferred_username"
resp.user_pool.username_attributes #=> Array
resp.user_pool.username_attributes[0] #=> String, one of "phone_number", "email"
resp.user_pool.sms_verification_message #=> String
resp.user_pool.email_verification_message #=> String
resp.user_pool.email_verification_subject #=> String
resp.user_pool.verification_message_template.sms_message #=> String
resp.user_pool.verification_message_template.email_message #=> String
resp.user_pool.verification_message_template.email_subject #=> String
resp.user_pool.verification_message_template.email_message_by_link #=> String
resp.user_pool.verification_message_template.email_subject_by_link #=> String
resp.user_pool.verification_message_template.default_email_option #=> String, one of "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE"
resp.user_pool.sms_authentication_message #=> String
resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update #=> Array
resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update[0] #=> String, one of "phone_number", "email"
resp.user_pool.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
resp.user_pool.device_configuration.challenge_required_on_new_device #=> Boolean
resp.user_pool.device_configuration.device_only_remembered_on_user_prompt #=> Boolean
resp.user_pool.estimated_number_of_users #=> Integer
resp.user_pool.email_configuration.source_arn #=> String
resp.user_pool.email_configuration.reply_to_email_address #=> String
resp.user_pool.email_configuration.email_sending_account #=> String, one of "COGNITO_DEFAULT", "DEVELOPER"
resp.user_pool.email_configuration.from #=> String
resp.user_pool.email_configuration.configuration_set #=> String
resp.user_pool.sms_configuration.sns_caller_arn #=> String
resp.user_pool.sms_configuration.external_id #=> String
resp.user_pool.sms_configuration.sns_region #=> String
resp.user_pool.user_pool_tags #=> Hash
resp.user_pool.user_pool_tags["TagKeysType"] #=> String
resp.user_pool.sms_configuration_failure #=> String
resp.user_pool.email_configuration_failure #=> String
resp.user_pool.domain #=> String
resp.user_pool.custom_domain #=> String
resp.user_pool.admin_create_user_config.allow_admin_create_user_only #=> Boolean
resp.user_pool.admin_create_user_config.unused_account_validity_days #=> Integer
resp.user_pool.admin_create_user_config.invite_message_template.sms_message #=> String
resp.user_pool.admin_create_user_config.invite_message_template.email_message #=> String
resp.user_pool.admin_create_user_config.invite_message_template.email_subject #=> String
resp.user_pool.user_pool_add_ons.advanced_security_mode #=> String, one of "OFF", "AUDIT", "ENFORCED"
resp.user_pool.username_configuration.case_sensitive #=> Boolean
resp.user_pool.arn #=> String
resp.user_pool.account_recovery_setting.recovery_mechanisms #=> Array
resp.user_pool.account_recovery_setting.recovery_mechanisms[0].priority #=> Integer
resp.user_pool.account_recovery_setting.recovery_mechanisms[0].name #=> String, one of "verified_email", "verified_phone_number", "admin_only"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:pool_name (required, String) —

A string used to name the user pool.
:policies (Types::UserPoolPolicyType) —

The policies associated with the new user pool.
:deletion_protection (String) —

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.
:lambda_config (Types::LambdaConfigType) —
The Lambda trigger configuration information for the new user pool.

<note markdown=“1”> 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 ][1].
```
For adding permission using the CLI, see[ add-permission ][2].

</note>
```
[1]: docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html [2]: docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html
:auto_verified_attributes (Array<String>) —

The attributes to be auto-verified. Possible values: email, phone_number.
:alias_attributes (Array<String>) —

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
:username_attributes (Array<String>) —

Specifies whether a user can use an email address or phone number as a username when they sign up.
:sms_verification_message (String) —

This parameter is no longer used. See [VerificationMessageTemplateType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
:email_verification_message (String) —

This parameter is no longer used. See [VerificationMessageTemplateType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
:email_verification_subject (String) —

This parameter is no longer used. See [VerificationMessageTemplateType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
:verification_message_template (Types::VerificationMessageTemplateType) —

The template for the verification message that the user sees when the app requests permission to access the user’s information.
:sms_authentication_message (String) —

A string representing the SMS authentication message.
:mfa_configuration (String) —

Specifies MFA configuration details.
:user_attribute_update_settings (Types::UserAttributeUpdateSettingsType) —

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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
:device_configuration (Types::DeviceConfigurationType) —
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

<note markdown=“1”> When you provide a value for any ‘DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature.
```
</note>
```
:email_configuration (Types::EmailConfigurationType) —

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.
:sms_configuration (Types::SmsConfigurationType) —

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.
:user_pool_tags (Hash<String,String>) —

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.
:admin_create_user_config (Types::AdminCreateUserConfigType) —

The configuration for ‘AdminCreateUser` requests.
:schema (Array<Types::SchemaAttributeType>) —

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
:user_pool_add_ons (Types::UserPoolAddOnsType) —

Enables advanced security risk detection. Set the key ‘AdvancedSecurityMode` to the value “AUDIT”.
:username_configuration (Types::UsernameConfigurationType) —

Case sensitivity on 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].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html
:account_recovery_setting (Types::AccountRecoverySettingType) —

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.

Returns:

(Types::CreateUserPoolResponse) —
Returns a response object which responds to the following methods:
- #user_pool => Types::UserPoolType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3362

def create_user_pool(params = {}, options = {})
  req = build_request(:create_user_pool, params)
  req.send_request(options)
end

#create_user_pool_client(params = {}) ⇒ `Types::CreateUserPoolClientResponse`

Creates the user pool client.

When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see [RevokeToken].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html

Examples:

Request syntax with placeholder values


resp = client.create_user_pool_client({
  user_pool_id: "UserPoolIdType", # required
  client_name: "ClientNameType", # required
  generate_secret: false,
  refresh_token_validity: 1,
  access_token_validity: 1,
  id_token_validity: 1,
  token_validity_units: {
    access_token: "seconds", # accepts seconds, minutes, hours, days
    id_token: "seconds", # accepts seconds, minutes, hours, days
    refresh_token: "seconds", # accepts seconds, minutes, hours, days
  },
  read_attributes: ["ClientPermissionType"],
  write_attributes: ["ClientPermissionType"],
  explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts 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
  supported_identity_providers: ["ProviderNameType"],
  callback_urls: ["RedirectUrlType"],
  logout_urls: ["RedirectUrlType"],
  default_redirect_uri: "RedirectUrlType",
  allowed_o_auth_flows: ["code"], # accepts code, implicit, client_credentials
  allowed_o_auth_scopes: ["ScopeType"],
  allowed_o_auth_flows_user_pool_client: false,
  analytics_configuration: {
    application_id: "HexStringType",
    application_arn: "ArnType",
    role_arn: "ArnType",
    external_id: "StringType",
    user_data_shared: false,
  },
  prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
  enable_token_revocation: false,
  enable_propagate_additional_user_context_data: false,
  auth_session_validity: 1,
})

Response structure


resp.user_pool_client.user_pool_id #=> String
resp.user_pool_client.client_name #=> String
resp.user_pool_client.client_id #=> String
resp.user_pool_client.client_secret #=> String
resp.user_pool_client.last_modified_date #=> Time
resp.user_pool_client.creation_date #=> Time
resp.user_pool_client.refresh_token_validity #=> Integer
resp.user_pool_client.access_token_validity #=> Integer
resp.user_pool_client.id_token_validity #=> Integer
resp.user_pool_client.token_validity_units.access_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.id_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.refresh_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.read_attributes #=> Array
resp.user_pool_client.read_attributes[0] #=> String
resp.user_pool_client.write_attributes #=> Array
resp.user_pool_client.write_attributes[0] #=> String
resp.user_pool_client.explicit_auth_flows #=> Array
resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "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"
resp.user_pool_client.supported_identity_providers #=> Array
resp.user_pool_client.supported_identity_providers[0] #=> String
resp.user_pool_client.callback_urls #=> Array
resp.user_pool_client.callback_urls[0] #=> String
resp.user_pool_client.logout_urls #=> Array
resp.user_pool_client.logout_urls[0] #=> String
resp.user_pool_client.default_redirect_uri #=> String
resp.user_pool_client.allowed_o_auth_flows #=> Array
resp.user_pool_client.allowed_o_auth_flows[0] #=> String, one of "code", "implicit", "client_credentials"
resp.user_pool_client.allowed_o_auth_scopes #=> Array
resp.user_pool_client.allowed_o_auth_scopes[0] #=> String
resp.user_pool_client.allowed_o_auth_flows_user_pool_client #=> Boolean
resp.user_pool_client.analytics_configuration.application_id #=> String
resp.user_pool_client.analytics_configuration.application_arn #=> String
resp.user_pool_client.analytics_configuration.role_arn #=> String
resp.user_pool_client.analytics_configuration.external_id #=> String
resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
resp.user_pool_client.enable_token_revocation #=> Boolean
resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
resp.user_pool_client.auth_session_validity #=> Integer

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to create a user pool client.
:client_name (required, String) —

The client name for the user pool client you would like to create.
:generate_secret (Boolean) —

Boolean to specify whether you want to generate a secret for the user pool client being created.
:refresh_token_validity (Integer) —

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.
:access_token_validity (Integer) —

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.
:id_token_validity (Integer) —

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 ‘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 ID tokens are valid for one hour.
:token_validity_units (Types::TokenValidityUnitsType) —

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.
:read_attributes (Array<String>) —

The read attributes.
:write_attributes (Array<String>) —

The user pool attributes that the app client can write to.

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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html
:explicit_auth_flows (Array<String>) —
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.

<note markdown=“1”> 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`.
```
</note>
```
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`.
:supported_identity_providers (Array<String>) —

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`.
:callback_urls (Array<String>) —
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 localhost for testing purposes only.

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

[1]: tools.ietf.org/html/rfc6749#section-3.1.2
:logout_urls (Array<String>) —

A list of allowed logout URLs for the IdPs.
:default_redirect_uri (String) —
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 localhost for testing purposes only.

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

[1]: tools.ietf.org/html/rfc6749#section-3.1.2
:allowed_o_auth_flows (Array<String>) —
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.
```
:allowed_o_auth_scopes (Array<String>) —

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.
:allowed_o_auth_flows_user_pool_client (Boolean) —

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
:analytics_configuration (Types::AnalyticsConfigurationType) —
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

<note markdown=“1”> 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.
```
</note>
```
:prevent_user_existence_errors (String) —
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.
:enable_token_revocation (Boolean) —

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.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html
:enable_propagate_additional_user_context_data (Boolean) —

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.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
:auth_session_validity (Integer) —

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.

Returns:

(Types::CreateUserPoolClientResponse) —
Returns a response object which responds to the following methods:
- #user_pool_client => Types::UserPoolClientType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3731

def create_user_pool_client(params = {}, options = {})
  req = build_request(:create_user_pool_client, params)
  req.send_request(options)
end

#create_user_pool_domain(params = {}) ⇒ `Types::CreateUserPoolDomainResponse`

Creates a new domain for a user pool.

Examples:

Request syntax with placeholder values


resp = client.create_user_pool_domain({
  domain: "DomainType", # required
  user_pool_id: "UserPoolIdType", # required
  custom_domain_config: {
    certificate_arn: "ArnType", # required
  },
})

Response structure


resp.cloud_front_domain #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:domain (required, String) —

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`.
:user_pool_id (required, String) —

The user pool ID.
:custom_domain_config (Types::CustomDomainConfigType) —

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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html

Returns:

(Types::CreateUserPoolDomainResponse) —
Returns a response object which responds to the following methods:
- #cloud_front_domain => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3783

def create_user_pool_domain(params = {}, options = {})
  req = build_request(:create_user_pool_domain, params)
  req.send_request(options)
end

#delete_group(params = {}) ⇒ `Struct`

Deletes a group.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.delete_group({
  group_name: "GroupNameType", # required
  user_pool_id: "UserPoolIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (required, String) —

The name of the group.
:user_pool_id (required, String) —

The user pool ID for the user pool.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3811

def delete_group(params = {}, options = {})
  req = build_request(:delete_group, params)
  req.send_request(options)
end

#delete_identity_provider(params = {}) ⇒ `Struct`

Deletes an IdP for a user pool.

Examples:

Request syntax with placeholder values


resp = client.delete_identity_provider({
  user_pool_id: "UserPoolIdType", # required
  provider_name: "ProviderNameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:provider_name (required, String) —

The IdP name.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3837

def delete_identity_provider(params = {}, options = {})
  req = build_request(:delete_identity_provider, params)
  req.send_request(options)
end

#delete_resource_server(params = {}) ⇒ `Struct`

Deletes a resource server.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_server({
  user_pool_id: "UserPoolIdType", # required
  identifier: "ResourceServerIdentifierType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool that hosts the resource server.
:identifier (required, String) —

The identifier for the resource server.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3863

def delete_resource_server(params = {}, options = {})
  req = build_request(:delete_resource_server, params)
  req.send_request(options)
end

#delete_user(params = {}) ⇒ `Struct`

Allows a user to delete himself or herself.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  access_token: "TokenModelType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

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

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3886

def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
end

#delete_user_attributes(params = {}) ⇒ `Struct`

Deletes the attributes for a user.

Examples:

Request syntax with placeholder values


resp = client.delete_user_attributes({
  user_attribute_names: ["AttributeNameType"], # required
  access_token: "TokenModelType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_attribute_names (required, Array<String>) —

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.
:access_token (required, String) —

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

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3917

def delete_user_attributes(params = {}, options = {})
  req = build_request(:delete_user_attributes, params)
  req.send_request(options)
end

#delete_user_pool(params = {}) ⇒ `Struct`

Deletes the specified Amazon Cognito user pool.

Examples:

Request syntax with placeholder values


resp = client.delete_user_pool({
  user_pool_id: "UserPoolIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool you want to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3939

def delete_user_pool(params = {}, options = {})
  req = build_request(:delete_user_pool, params)
  req.send_request(options)
end

#delete_user_pool_client(params = {}) ⇒ `Struct`

Allows the developer to delete the user pool client.

Examples:

Request syntax with placeholder values


resp = client.delete_user_pool_client({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to delete the client.
:client_id (required, String) —

The app client ID of the app associated with the user pool.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3966

def delete_user_pool_client(params = {}, options = {})
  req = build_request(:delete_user_pool_client, params)
  req.send_request(options)
end

#delete_user_pool_domain(params = {}) ⇒ `Struct`

Deletes a domain for a user pool.

Examples:

Request syntax with placeholder values


resp = client.delete_user_pool_domain({
  domain: "DomainType", # required
  user_pool_id: "UserPoolIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:domain (required, String) —

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`.
:user_pool_id (required, String) —

The user pool ID.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3994

def delete_user_pool_domain(params = {}, options = {})
  req = build_request(:delete_user_pool_domain, params)
  req.send_request(options)
end

#describe_identity_provider(params = {}) ⇒ `Types::DescribeIdentityProviderResponse`

Gets information about a specific IdP.

Examples:

Request syntax with placeholder values


resp = client.describe_identity_provider({
  user_pool_id: "UserPoolIdType", # required
  provider_name: "ProviderNameType", # required
})

Response structure


resp.identity_provider.user_pool_id #=> String
resp.identity_provider.provider_name #=> String
resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.identity_provider.provider_details #=> Hash
resp.identity_provider.provider_details["StringType"] #=> String
resp.identity_provider.attribute_mapping #=> Hash
resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
resp.identity_provider.idp_identifiers #=> Array
resp.identity_provider.idp_identifiers[0] #=> String
resp.identity_provider.last_modified_date #=> Time
resp.identity_provider.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:provider_name (required, String) —

The IdP name.

Returns:

(Types::DescribeIdentityProviderResponse) —
Returns a response object which responds to the following methods:
- #identity_provider => Types::IdentityProviderType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4036

def describe_identity_provider(params = {}, options = {})
  req = build_request(:describe_identity_provider, params)
  req.send_request(options)
end

#describe_resource_server(params = {}) ⇒ `Types::DescribeResourceServerResponse`

Describes a resource server.

Examples:

Request syntax with placeholder values


resp = client.describe_resource_server({
  user_pool_id: "UserPoolIdType", # required
  identifier: "ResourceServerIdentifierType", # required
})

Response structure


resp.resource_server.user_pool_id #=> String
resp.resource_server.identifier #=> String
resp.resource_server.name #=> String
resp.resource_server.scopes #=> Array
resp.resource_server.scopes[0].scope_name #=> String
resp.resource_server.scopes[0].scope_description #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool that hosts the resource server.
:identifier (required, String) —

The identifier for the resource server

Returns:

(Types::DescribeResourceServerResponse) —
Returns a response object which responds to the following methods:
- #resource_server => Types::ResourceServerType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4073

def describe_resource_server(params = {}, options = {})
  req = build_request(:describe_resource_server, params)
  req.send_request(options)
end

#describe_risk_configuration(params = {}) ⇒ `Types::DescribeRiskConfigurationResponse`

Describes the risk configuration.

Examples:

Request syntax with placeholder values


resp = client.describe_risk_configuration({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType",
})

Response structure


resp.risk_configuration.user_pool_id #=> String
resp.risk_configuration.client_id #=> String
resp.risk_configuration.compromised_credentials_risk_configuration.event_filter #=> Array
resp.risk_configuration.compromised_credentials_risk_configuration.event_filter[0] #=> String, one of "SIGN_IN", "PASSWORD_CHANGE", "SIGN_UP"
resp.risk_configuration.compromised_credentials_risk_configuration.actions.event_action #=> String, one of "BLOCK", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.from #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.reply_to #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.source_arn #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.actions.low_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.low_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.actions.medium_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.medium_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.actions.high_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.high_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.risk_exception_configuration.blocked_ip_range_list #=> Array
resp.risk_configuration.risk_exception_configuration.blocked_ip_range_list[0] #=> String
resp.risk_configuration.risk_exception_configuration.skipped_ip_range_list #=> Array
resp.risk_configuration.risk_exception_configuration.skipped_ip_range_list[0] #=> String
resp.risk_configuration.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:client_id (String) —

The app client ID.

Returns:

(Types::DescribeRiskConfigurationResponse) —
Returns a response object which responds to the following methods:
- #risk_configuration => Types::RiskConfigurationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4132

def describe_risk_configuration(params = {}, options = {})
  req = build_request(:describe_risk_configuration, params)
  req.send_request(options)
end

#describe_user_import_job(params = {}) ⇒ `Types::DescribeUserImportJobResponse`

Describes the user import job.

Examples:

Request syntax with placeholder values


resp = client.describe_user_import_job({
  user_pool_id: "UserPoolIdType", # required
  job_id: "UserImportJobIdType", # required
})

Response structure


resp.user_import_job.job_name #=> String
resp.user_import_job.job_id #=> String
resp.user_import_job.user_pool_id #=> String
resp.user_import_job.pre_signed_url #=> String
resp.user_import_job.creation_date #=> Time
resp.user_import_job.start_date #=> Time
resp.user_import_job.completion_date #=> Time
resp.user_import_job.status #=> String, one of "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded"
resp.user_import_job.cloud_watch_logs_role_arn #=> String
resp.user_import_job.imported_users #=> Integer
resp.user_import_job.skipped_users #=> Integer
resp.user_import_job.failed_users #=> Integer
resp.user_import_job.completion_message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool that the users are being imported into.
:job_id (required, String) —

The job ID for the user import job.

Returns:

(Types::DescribeUserImportJobResponse) —
Returns a response object which responds to the following methods:
- #user_import_job => Types::UserImportJobType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4177

def describe_user_import_job(params = {}, options = {})
  req = build_request(:describe_user_import_job, params)
  req.send_request(options)
end

#describe_user_pool(params = {}) ⇒ `Types::DescribeUserPoolResponse`

Returns the configuration information and metadata of the specified user pool.

Examples:

Request syntax with placeholder values


resp = client.describe_user_pool({
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.user_pool.id #=> String
resp.user_pool.name #=> String
resp.user_pool.policies.password_policy.minimum_length #=> Integer
resp.user_pool.policies.password_policy.require_uppercase #=> Boolean
resp.user_pool.policies.password_policy.require_lowercase #=> Boolean
resp.user_pool.policies.password_policy.require_numbers #=> Boolean
resp.user_pool.policies.password_policy.require_symbols #=> Boolean
resp.user_pool.policies.password_policy.temporary_password_validity_days #=> Integer
resp.user_pool.deletion_protection #=> String, one of "ACTIVE", "INACTIVE"
resp.user_pool.lambda_config.pre_sign_up #=> String
resp.user_pool.lambda_config.custom_message #=> String
resp.user_pool.lambda_config.post_confirmation #=> String
resp.user_pool.lambda_config.pre_authentication #=> String
resp.user_pool.lambda_config.post_authentication #=> String
resp.user_pool.lambda_config.define_auth_challenge #=> String
resp.user_pool.lambda_config.create_auth_challenge #=> String
resp.user_pool.lambda_config.verify_auth_challenge_response #=> String
resp.user_pool.lambda_config.pre_token_generation #=> String
resp.user_pool.lambda_config.user_migration #=> String
resp.user_pool.lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
resp.user_pool.lambda_config.custom_sms_sender.lambda_arn #=> String
resp.user_pool.lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
resp.user_pool.lambda_config.custom_email_sender.lambda_arn #=> String
resp.user_pool.lambda_config.kms_key_id #=> String
resp.user_pool.status #=> String, one of "Enabled", "Disabled"
resp.user_pool.last_modified_date #=> Time
resp.user_pool.creation_date #=> Time
resp.user_pool.schema_attributes #=> Array
resp.user_pool.schema_attributes[0].name #=> String
resp.user_pool.schema_attributes[0].attribute_data_type #=> String, one of "String", "Number", "DateTime", "Boolean"
resp.user_pool.schema_attributes[0].developer_only_attribute #=> Boolean
resp.user_pool.schema_attributes[0].mutable #=> Boolean
resp.user_pool.schema_attributes[0].required #=> Boolean
resp.user_pool.schema_attributes[0].number_attribute_constraints.min_value #=> String
resp.user_pool.schema_attributes[0].number_attribute_constraints.max_value #=> String
resp.user_pool.schema_attributes[0].string_attribute_constraints.min_length #=> String
resp.user_pool.schema_attributes[0].string_attribute_constraints.max_length #=> String
resp.user_pool.auto_verified_attributes #=> Array
resp.user_pool.auto_verified_attributes[0] #=> String, one of "phone_number", "email"
resp.user_pool.alias_attributes #=> Array
resp.user_pool.alias_attributes[0] #=> String, one of "phone_number", "email", "preferred_username"
resp.user_pool.username_attributes #=> Array
resp.user_pool.username_attributes[0] #=> String, one of "phone_number", "email"
resp.user_pool.sms_verification_message #=> String
resp.user_pool.email_verification_message #=> String
resp.user_pool.email_verification_subject #=> String
resp.user_pool.verification_message_template.sms_message #=> String
resp.user_pool.verification_message_template.email_message #=> String
resp.user_pool.verification_message_template.email_subject #=> String
resp.user_pool.verification_message_template.email_message_by_link #=> String
resp.user_pool.verification_message_template.email_subject_by_link #=> String
resp.user_pool.verification_message_template.default_email_option #=> String, one of "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE"
resp.user_pool.sms_authentication_message #=> String
resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update #=> Array
resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update[0] #=> String, one of "phone_number", "email"
resp.user_pool.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
resp.user_pool.device_configuration.challenge_required_on_new_device #=> Boolean
resp.user_pool.device_configuration.device_only_remembered_on_user_prompt #=> Boolean
resp.user_pool.estimated_number_of_users #=> Integer
resp.user_pool.email_configuration.source_arn #=> String
resp.user_pool.email_configuration.reply_to_email_address #=> String
resp.user_pool.email_configuration.email_sending_account #=> String, one of "COGNITO_DEFAULT", "DEVELOPER"
resp.user_pool.email_configuration.from #=> String
resp.user_pool.email_configuration.configuration_set #=> String
resp.user_pool.sms_configuration.sns_caller_arn #=> String
resp.user_pool.sms_configuration.external_id #=> String
resp.user_pool.sms_configuration.sns_region #=> String
resp.user_pool.user_pool_tags #=> Hash
resp.user_pool.user_pool_tags["TagKeysType"] #=> String
resp.user_pool.sms_configuration_failure #=> String
resp.user_pool.email_configuration_failure #=> String
resp.user_pool.domain #=> String
resp.user_pool.custom_domain #=> String
resp.user_pool.admin_create_user_config.allow_admin_create_user_only #=> Boolean
resp.user_pool.admin_create_user_config.unused_account_validity_days #=> Integer
resp.user_pool.admin_create_user_config.invite_message_template.sms_message #=> String
resp.user_pool.admin_create_user_config.invite_message_template.email_message #=> String
resp.user_pool.admin_create_user_config.invite_message_template.email_subject #=> String
resp.user_pool.user_pool_add_ons.advanced_security_mode #=> String, one of "OFF", "AUDIT", "ENFORCED"
resp.user_pool.username_configuration.case_sensitive #=> Boolean
resp.user_pool.arn #=> String
resp.user_pool.account_recovery_setting.recovery_mechanisms #=> Array
resp.user_pool.account_recovery_setting.recovery_mechanisms[0].priority #=> Integer
resp.user_pool.account_recovery_setting.recovery_mechanisms[0].name #=> String, one of "verified_email", "verified_phone_number", "admin_only"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool you want to describe.

Returns:

(Types::DescribeUserPoolResponse) —
Returns a response object which responds to the following methods:
- #user_pool => Types::UserPoolType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4289

def describe_user_pool(params = {}, options = {})
  req = build_request(:describe_user_pool, params)
  req.send_request(options)
end

#describe_user_pool_client(params = {}) ⇒ `Types::DescribeUserPoolClientResponse`

Client method for returning the configuration information and metadata of the specified user pool app client.

Examples:

Request syntax with placeholder values


resp = client.describe_user_pool_client({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
})

Response structure


resp.user_pool_client.user_pool_id #=> String
resp.user_pool_client.client_name #=> String
resp.user_pool_client.client_id #=> String
resp.user_pool_client.client_secret #=> String
resp.user_pool_client.last_modified_date #=> Time
resp.user_pool_client.creation_date #=> Time
resp.user_pool_client.refresh_token_validity #=> Integer
resp.user_pool_client.access_token_validity #=> Integer
resp.user_pool_client.id_token_validity #=> Integer
resp.user_pool_client.token_validity_units.access_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.id_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.refresh_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.read_attributes #=> Array
resp.user_pool_client.read_attributes[0] #=> String
resp.user_pool_client.write_attributes #=> Array
resp.user_pool_client.write_attributes[0] #=> String
resp.user_pool_client.explicit_auth_flows #=> Array
resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "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"
resp.user_pool_client.supported_identity_providers #=> Array
resp.user_pool_client.supported_identity_providers[0] #=> String
resp.user_pool_client.callback_urls #=> Array
resp.user_pool_client.callback_urls[0] #=> String
resp.user_pool_client.logout_urls #=> Array
resp.user_pool_client.logout_urls[0] #=> String
resp.user_pool_client.default_redirect_uri #=> String
resp.user_pool_client.allowed_o_auth_flows #=> Array
resp.user_pool_client.allowed_o_auth_flows[0] #=> String, one of "code", "implicit", "client_credentials"
resp.user_pool_client.allowed_o_auth_scopes #=> Array
resp.user_pool_client.allowed_o_auth_scopes[0] #=> String
resp.user_pool_client.allowed_o_auth_flows_user_pool_client #=> Boolean
resp.user_pool_client.analytics_configuration.application_id #=> String
resp.user_pool_client.analytics_configuration.application_arn #=> String
resp.user_pool_client.analytics_configuration.role_arn #=> String
resp.user_pool_client.analytics_configuration.external_id #=> String
resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
resp.user_pool_client.enable_token_revocation #=> Boolean
resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
resp.user_pool_client.auth_session_validity #=> Integer

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool you want to describe.
:client_id (required, String) —

The app client ID of the app associated with the user pool.

Returns:

(Types::DescribeUserPoolClientResponse) —
Returns a response object which responds to the following methods:
- #user_pool_client => Types::UserPoolClientType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4360

def describe_user_pool_client(params = {}, options = {})
  req = build_request(:describe_user_pool_client, params)
  req.send_request(options)
end

#describe_user_pool_domain(params = {}) ⇒ `Types::DescribeUserPoolDomainResponse`

Gets information about a domain.

Examples:

Request syntax with placeholder values


resp = client.describe_user_pool_domain({
  domain: "DomainType", # required
})

Response structure


resp.domain_description.user_pool_id #=> String
resp.domain_description.aws_account_id #=> String
resp.domain_description.domain #=> String
resp.domain_description.s3_bucket #=> String
resp.domain_description.cloud_front_distribution #=> String
resp.domain_description.version #=> String
resp.domain_description.status #=> String, one of "CREATING", "DELETING", "UPDATING", "ACTIVE", "FAILED"
resp.domain_description.custom_domain_config.certificate_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:domain (required, String) —

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`.

Returns:

(Types::DescribeUserPoolDomainResponse) —
Returns a response object which responds to the following methods:
- #domain_description => Types::DomainDescriptionType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4397

def describe_user_pool_domain(params = {}, options = {})
  req = build_request(:describe_user_pool_domain, params)
  req.send_request(options)
end

#forget_device(params = {}) ⇒ `Struct`

Forgets the specified device.

Examples:

Request syntax with placeholder values


resp = client.forget_device({
  access_token: "TokenModelType",
  device_key: "DeviceKeyType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (String) —

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.
:device_key (required, String) —

The device key.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4424

def forget_device(params = {}, options = {})
  req = build_request(:forget_device, params)
  req.send_request(options)
end

#forgot_password(params = {}) ⇒ `Types::ForgotPasswordResponse`

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user’s password. For the ‘Username` parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see

Recovering User Accounts][1: in the *Amazon Cognito Developer Guide*.

If neither a verified phone number nor a verified email exists, an ‘InvalidParameterException` is thrown. To use the confirmation code for resetting the password, call [ConfirmForgotPassword].

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html [3]: console.aws.amazon.com/pinpoint/home/ [4]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.forgot_password({
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  username: "UsernameType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.code_delivery_details.destination #=> String
resp.code_delivery_details.delivery_medium #=> String, one of "SMS", "EMAIL"
resp.code_delivery_details.attribute_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The ID of the client associated with the user pool.
:secret_hash (String) —

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.
:user_context_data (Types::UserContextDataType) —

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 (required, String) —

The user name of the user for whom you want to enter a code to reset a forgotten password.
:analytics_metadata (Types::AnalyticsMetadataType) —

The Amazon Pinpoint analytics metadata that contributes to your metrics for ‘ForgotPassword` calls.
:client_metadata (Hash<String,String>) —
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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::ForgotPasswordResponse) —
Returns a response object which responds to the following methods:
- #code_delivery_details => Types::CodeDeliveryDetailsType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4559

def forgot_password(params = {}, options = {})
  req = build_request(:forgot_password, params)
  req.send_request(options)
end

#get_csv_header(params = {}) ⇒ `Types::GetCSVHeaderResponse`

Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.

Examples:

Request syntax with placeholder values


resp = client.get_csv_header({
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.user_pool_id #=> String
resp.csv_header #=> Array
resp.csv_header[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

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

Returns:

(Types::GetCSVHeaderResponse) —
Returns a response object which responds to the following methods:
- #user_pool_id => String
- #csv_header => Array<String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4592

def get_csv_header(params = {}, options = {})
  req = build_request(:get_csv_header, params)
  req.send_request(options)
end

#get_device(params = {}) ⇒ `Types::GetDeviceResponse`

Gets the device.

Examples:

Request syntax with placeholder values


resp = client.get_device({
  device_key: "DeviceKeyType", # required
  access_token: "TokenModelType",
})

Response structure


resp.device.device_key #=> String
resp.device.device_attributes #=> Array
resp.device.device_attributes[0].name #=> String
resp.device.device_attributes[0].value #=> String
resp.device.device_create_date #=> Time
resp.device.device_last_modified_date #=> Time
resp.device.device_last_authenticated_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:device_key (required, String) —

The device key.
:access_token (String) —

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

Returns:

(Types::GetDeviceResponse) —
Returns a response object which responds to the following methods:
- #device => Types::DeviceType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4631

def get_device(params = {}, options = {})
  req = build_request(:get_device, params)
  req.send_request(options)
end

#get_group(params = {}) ⇒ `Types::GetGroupResponse`

Gets a group.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.get_group({
  group_name: "GroupNameType", # required
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.group.group_name #=> String
resp.group.user_pool_id #=> String
resp.group.description #=> String
resp.group.role_arn #=> String
resp.group.precedence #=> Integer
resp.group.last_modified_date #=> Time
resp.group.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (required, String) —

The name of the group.
:user_pool_id (required, String) —

The user pool ID for the user pool.

Returns:

(Types::GetGroupResponse) —
Returns a response object which responds to the following methods:
- #group => Types::GroupType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4671

def get_group(params = {}, options = {})
  req = build_request(:get_group, params)
  req.send_request(options)
end

#get_identity_provider_by_identifier(params = {}) ⇒ `Types::GetIdentityProviderByIdentifierResponse`

Gets the specified IdP.

Examples:

Request syntax with placeholder values


resp = client.get_identity_provider_by_identifier({
  user_pool_id: "UserPoolIdType", # required
  idp_identifier: "IdpIdentifierType", # required
})

Response structure


resp.identity_provider.user_pool_id #=> String
resp.identity_provider.provider_name #=> String
resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.identity_provider.provider_details #=> Hash
resp.identity_provider.provider_details["StringType"] #=> String
resp.identity_provider.attribute_mapping #=> Hash
resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
resp.identity_provider.idp_identifiers #=> Array
resp.identity_provider.idp_identifiers[0] #=> String
resp.identity_provider.last_modified_date #=> Time
resp.identity_provider.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:idp_identifier (required, String) —

The IdP identifier.

Returns:

(Types::GetIdentityProviderByIdentifierResponse) —
Returns a response object which responds to the following methods:
- #identity_provider => Types::IdentityProviderType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4713

def get_identity_provider_by_identifier(params = {}, options = {})
  req = build_request(:get_identity_provider_by_identifier, params)
  req.send_request(options)
end

#get_signing_certificate(params = {}) ⇒ `Types::GetSigningCertificateResponse`

This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.

Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to ‘GetSigningCertificate`, but doesn’t invalidate the original certificate.

Examples:

Request syntax with placeholder values


resp = client.get_signing_certificate({
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.certificate #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.

Returns:

(Types::GetSigningCertificateResponse) —
Returns a response object which responds to the following methods:
- #certificate => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4747

def get_signing_certificate(params = {}, options = {})
  req = build_request(:get_signing_certificate, params)
  req.send_request(options)
end

#get_ui_customization(params = {}) ⇒ `Types::GetUICustomizationResponse`

Gets the user interface (UI) Customization information for a particular app client’s app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app ‘clientId` is `ALL`), then that information is returned. If nothing is present, then an empty shape is returned.

Examples:

Request syntax with placeholder values


resp = client.get_ui_customization({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType",
})

Response structure


resp.ui_customization.user_pool_id #=> String
resp.ui_customization.client_id #=> String
resp.ui_customization.image_url #=> String
resp.ui_customization.css #=> String
resp.ui_customization.css_version #=> String
resp.ui_customization.last_modified_date #=> Time
resp.ui_customization.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:client_id (String) —

The client ID for the client app.

Returns:

(Types::GetUICustomizationResponse) —
Returns a response object which responds to the following methods:
- #ui_customization => Types::UICustomizationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4790

def get_ui_customization(params = {}, options = {})
  req = build_request(:get_ui_customization, params)
  req.send_request(options)
end

#get_user(params = {}) ⇒ `Types::GetUserResponse`

Gets the user attributes and metadata for a user.

Examples:

Request syntax with placeholder values


resp = client.get_user({
  access_token: "TokenModelType", # required
})

Response structure


resp.username #=> String
resp.user_attributes #=> Array
resp.user_attributes[0].name #=> String
resp.user_attributes[0].value #=> String
resp.mfa_options #=> Array
resp.mfa_options[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.mfa_options[0].attribute_name #=> String
resp.preferred_mfa_setting #=> String
resp.user_mfa_setting_list #=> Array
resp.user_mfa_setting_list[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

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

Returns:

(Types::GetUserResponse) —
Returns a response object which responds to the following methods:
- #username => String
- #user_attributes => Array<Types::AttributeType>
- #mfa_options => Array<Types::MFAOptionType>
- #preferred_mfa_setting => String
- #user_mfa_setting_list => Array<String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4832

def get_user(params = {}, options = {})
  req = build_request(:get_user, params)
  req.send_request(options)
end

#get_user_attribute_verification_code(params = {}) ⇒ `Types::GetUserAttributeVerificationCodeResponse`

Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.get_user_attribute_verification_code({
  access_token: "TokenModelType", # required
  attribute_name: "AttributeNameType", # required
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.code_delivery_details.destination #=> String
resp.code_delivery_details.delivery_medium #=> String, one of "SMS", "EMAIL"
resp.code_delivery_details.attribute_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A non-expired access token for the user whose attribute verification code you want to generate.
:attribute_name (required, String) —

The attribute name returned by the server response to get the user attribute verification code.
:client_metadata (Hash<String,String>) —
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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::GetUserAttributeVerificationCodeResponse) —
Returns a response object which responds to the following methods:
- #code_delivery_details => Types::CodeDeliveryDetailsType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4936

def get_user_attribute_verification_code(params = {}, options = {})
  req = build_request(:get_user_attribute_verification_code, params)
  req.send_request(options)
end

#get_user_pool_mfa_config(params = {}) ⇒ `Types::GetUserPoolMfaConfigResponse`

Gets the user pool multi-factor authentication (MFA) configuration.

Examples:

Request syntax with placeholder values


resp = client.get_user_pool_mfa_config({
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.sms_mfa_configuration.sms_authentication_message #=> String
resp.sms_mfa_configuration.sms_configuration.sns_caller_arn #=> String
resp.sms_mfa_configuration.sms_configuration.external_id #=> String
resp.sms_mfa_configuration.sms_configuration.sns_region #=> String
resp.software_token_mfa_configuration.enabled #=> Boolean
resp.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.

Returns:

(Types::GetUserPoolMfaConfigResponse) —
Returns a response object which responds to the following methods:
- #sms_mfa_configuration => Types::SmsMfaConfigType
- #software_token_mfa_configuration => Types::SoftwareTokenMfaConfigType
- #mfa_configuration => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4971

def get_user_pool_mfa_config(params = {}, options = {})
  req = build_request(:get_user_pool_mfa_config, params)
  req.send_request(options)
end

#global_sign_out(params = {}) ⇒ `Struct`

Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.

Examples:

Request syntax with placeholder values


resp = client.global_sign_out({
  access_token: "TokenModelType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

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

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4997

def global_sign_out(params = {}, options = {})
  req = build_request(:global_sign_out, params)
  req.send_request(options)
end

#initiate_auth(params = {}) ⇒ `Types::InitiateAuthResponse`

Initiates sign-in for a user in the Amazon Cognito user directory. You can’t sign in a user with a federated IdP with ‘InitiateAuth`. For more information, see [ Adding user pool sign-in through a third party].

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html [2]: console.aws.amazon.com/pinpoint/home/ [3]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.initiate_auth({
  auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH
  auth_parameters: {
    "StringType" => "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
  client_id: "ClientIdType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
})

Response structure


resp.challenge_name #=> String, one of "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"
resp.session #=> String
resp.challenge_parameters #=> Hash
resp.challenge_parameters["StringType"] #=> String
resp.authentication_result.access_token #=> String
resp.authentication_result.expires_in #=> Integer
resp.authentication_result.token_type #=> String
resp.authentication_result.refresh_token #=> String
resp.authentication_result.id_token #=> String
resp.authentication_result.new_device_metadata.device_key #=> String
resp.authentication_result.new_device_metadata.device_group_key #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:auth_flow (required, String) —
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.
:auth_parameters (Hash<String,String>) —
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 ‘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)`.
:client_metadata (Hash<String,String>) —
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
- Verify auth challenge
For more information, see [ Customizing user pool Workflows with Lambda Triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html
:client_id (required, String) —

The app client ID.
:analytics_metadata (Types::AnalyticsMetadataType) —

The Amazon Pinpoint analytics metadata that contributes to your metrics for ‘InitiateAuth` calls.
:user_context_data (Types::UserContextDataType) —

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.

Returns:

(Types::InitiateAuthResponse) —
Returns a response object which responds to the following methods:
- #challenge_name => String
- #session => String
- #challenge_parameters => Hash<String,String>
- #authentication_result => Types::AuthenticationResultType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5204

def initiate_auth(params = {}, options = {})
  req = build_request(:initiate_auth, params)
  req.send_request(options)
end

#list_devices(params = {}) ⇒ `Types::ListDevicesResponse`

Lists the sign-in devices that Amazon Cognito has registered to the current user.

Examples:

Request syntax with placeholder values


resp = client.list_devices({
  access_token: "TokenModelType", # required
  limit: 1,
  pagination_token: "SearchPaginationTokenType",
})

Response structure


resp.devices #=> Array
resp.devices[0].device_key #=> String
resp.devices[0].device_attributes #=> Array
resp.devices[0].device_attributes[0].name #=> String
resp.devices[0].device_attributes[0].value #=> String
resp.devices[0].device_create_date #=> Time
resp.devices[0].device_last_modified_date #=> Time
resp.devices[0].device_last_authenticated_date #=> Time
resp.pagination_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
:limit (Integer) —

The limit of the device request.
:pagination_token (String) —

The pagination token for the list request.

Returns:

(Types::ListDevicesResponse) —
Returns a response object which responds to the following methods:
- #devices => Array<Types::DeviceType>
- #pagination_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5251

def list_devices(params = {}, options = {})
  req = build_request(:list_devices, params)
  req.send_request(options)
end

#list_groups(params = {}) ⇒ `Types::ListGroupsResponse`

Lists the groups associated with a user pool.

Calling this action requires developer credentials.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_groups({
  user_pool_id: "UserPoolIdType", # required
  limit: 1,
  next_token: "PaginationKey",
})

Response structure


resp.groups #=> Array
resp.groups[0].group_name #=> String
resp.groups[0].user_pool_id #=> String
resp.groups[0].description #=> String
resp.groups[0].role_arn #=> String
resp.groups[0].precedence #=> Integer
resp.groups[0].last_modified_date #=> Time
resp.groups[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:limit (Integer) —

The limit of the request to list groups.
:next_token (String) —

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.

Returns:

(Types::ListGroupsResponse) —
Returns a response object which responds to the following methods:
- #groups => Array<Types::GroupType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5302

def list_groups(params = {}, options = {})
  req = build_request(:list_groups, params)
  req.send_request(options)
end

#list_identity_providers(params = {}) ⇒ `Types::ListIdentityProvidersResponse`

Lists information about all IdPs for a user pool.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_identity_providers({
  user_pool_id: "UserPoolIdType", # required
  max_results: 1,
  next_token: "PaginationKeyType",
})

Response structure


resp.providers #=> Array
resp.providers[0].provider_name #=> String
resp.providers[0].provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.providers[0].last_modified_date #=> Time
resp.providers[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:max_results (Integer) —

The maximum number of IdPs to return.
:next_token (String) —

A pagination token.

Returns:

(Types::ListIdentityProvidersResponse) —
Returns a response object which responds to the following methods:
- #providers => Array<Types::ProviderDescription>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5346

def list_identity_providers(params = {}, options = {})
  req = build_request(:list_identity_providers, params)
  req.send_request(options)
end

#list_resource_servers(params = {}) ⇒ `Types::ListResourceServersResponse`

Lists the resource servers for a user pool.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resource_servers({
  user_pool_id: "UserPoolIdType", # required
  max_results: 1,
  next_token: "PaginationKeyType",
})

Response structure


resp.resource_servers #=> Array
resp.resource_servers[0].user_pool_id #=> String
resp.resource_servers[0].identifier #=> String
resp.resource_servers[0].name #=> String
resp.resource_servers[0].scopes #=> Array
resp.resource_servers[0].scopes[0].scope_name #=> String
resp.resource_servers[0].scopes[0].scope_description #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:max_results (Integer) —

The maximum number of resource servers to return.
:next_token (String) —

A pagination token.

Returns:

(Types::ListResourceServersResponse) —
Returns a response object which responds to the following methods:
- #resource_servers => Array<Types::ResourceServerType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5392

def list_resource_servers(params = {}, options = {})
  req = build_request(:list_resource_servers, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceResponse`

Lists the tags that are assigned to an Amazon Cognito 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.

You can use this action up to 10 times per second, per account.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ArnType", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKeysType"] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

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

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #tags => Hash<String,String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5428

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_user_import_jobs(params = {}) ⇒ `Types::ListUserImportJobsResponse`

Lists the user import jobs.

Examples:

Request syntax with placeholder values


resp = client.list_user_import_jobs({
  user_pool_id: "UserPoolIdType", # required
  max_results: 1, # required
  pagination_token: "PaginationKeyType",
})

Response structure


resp.user_import_jobs #=> Array
resp.user_import_jobs[0].job_name #=> String
resp.user_import_jobs[0].job_id #=> String
resp.user_import_jobs[0].user_pool_id #=> String
resp.user_import_jobs[0].pre_signed_url #=> String
resp.user_import_jobs[0].creation_date #=> Time
resp.user_import_jobs[0].start_date #=> Time
resp.user_import_jobs[0].completion_date #=> Time
resp.user_import_jobs[0].status #=> String, one of "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded"
resp.user_import_jobs[0].cloud_watch_logs_role_arn #=> String
resp.user_import_jobs[0].imported_users #=> Integer
resp.user_import_jobs[0].skipped_users #=> Integer
resp.user_import_jobs[0].failed_users #=> Integer
resp.user_import_jobs[0].completion_message #=> String
resp.pagination_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool that the users are being imported into.
:max_results (required, Integer) —

The maximum number of import jobs you want the request to return.
:pagination_token (String) —

An identifier that was returned from the previous call to ‘ListUserImportJobs`, which can be used to return the next set of import jobs in the list.

Returns:

(Types::ListUserImportJobsResponse) —
Returns a response object which responds to the following methods:
- #user_import_jobs => Array<Types::UserImportJobType>
- #pagination_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5482

def list_user_import_jobs(params = {}, options = {})
  req = build_request(:list_user_import_jobs, params)
  req.send_request(options)
end

#list_user_pool_clients(params = {}) ⇒ `Types::ListUserPoolClientsResponse`

Lists the clients that have been created for the specified user pool.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_user_pool_clients({
  user_pool_id: "UserPoolIdType", # required
  max_results: 1,
  next_token: "PaginationKey",
})

Response structure


resp.user_pool_clients #=> Array
resp.user_pool_clients[0].client_id #=> String
resp.user_pool_clients[0].user_pool_id #=> String
resp.user_pool_clients[0].client_name #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to list user pool clients.
:max_results (Integer) —

The maximum number of results you want the request to return when listing the user pool clients.
:next_token (String) —

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.

Returns:

(Types::ListUserPoolClientsResponse) —
Returns a response object which responds to the following methods:
- #user_pool_clients => Array<Types::UserPoolClientDescription>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5529

def list_user_pool_clients(params = {}, options = {})
  req = build_request(:list_user_pool_clients, params)
  req.send_request(options)
end

#list_user_pools(params = {}) ⇒ `Types::ListUserPoolsResponse`

Lists the user pools associated with an Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_user_pools({
  next_token: "PaginationKeyType",
  max_results: 1, # required
})

Response structure


resp.user_pools #=> Array
resp.user_pools[0].id #=> String
resp.user_pools[0].name #=> String
resp.user_pools[0].lambda_config.pre_sign_up #=> String
resp.user_pools[0].lambda_config.custom_message #=> String
resp.user_pools[0].lambda_config.post_confirmation #=> String
resp.user_pools[0].lambda_config.pre_authentication #=> String
resp.user_pools[0].lambda_config.post_authentication #=> String
resp.user_pools[0].lambda_config.define_auth_challenge #=> String
resp.user_pools[0].lambda_config.create_auth_challenge #=> String
resp.user_pools[0].lambda_config.verify_auth_challenge_response #=> String
resp.user_pools[0].lambda_config.pre_token_generation #=> String
resp.user_pools[0].lambda_config.user_migration #=> String
resp.user_pools[0].lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
resp.user_pools[0].lambda_config.custom_sms_sender.lambda_arn #=> String
resp.user_pools[0].lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
resp.user_pools[0].lambda_config.custom_email_sender.lambda_arn #=> String
resp.user_pools[0].lambda_config.kms_key_id #=> String
resp.user_pools[0].status #=> String, one of "Enabled", "Disabled"
resp.user_pools[0].last_modified_date #=> Time
resp.user_pools[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:next_token (String) —

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.
:max_results (required, Integer) —

The maximum number of results you want the request to return when listing the user pools.

Returns:

(Types::ListUserPoolsResponse) —
Returns a response object which responds to the following methods:
- #user_pools => Array<Types::UserPoolDescriptionType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5588

def list_user_pools(params = {}, options = {})
  req = build_request(:list_user_pools, params)
  req.send_request(options)
end

#list_users(params = {}) ⇒ `Types::ListUsersResponse`

Lists the users in the Amazon Cognito user pool.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_users({
  user_pool_id: "UserPoolIdType", # required
  attributes_to_get: ["AttributeNameType"],
  limit: 1,
  pagination_token: "SearchPaginationTokenType",
  filter: "UserFilterType",
})

Response structure


resp.users #=> Array
resp.users[0].username #=> String
resp.users[0].attributes #=> Array
resp.users[0].attributes[0].name #=> String
resp.users[0].attributes[0].value #=> String
resp.users[0].user_create_date #=> Time
resp.users[0].user_last_modified_date #=> Time
resp.users[0].enabled #=> Boolean
resp.users[0].user_status #=> String, one of "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", "FORCE_CHANGE_PASSWORD"
resp.users[0].mfa_options #=> Array
resp.users[0].mfa_options[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.users[0].mfa_options[0].attribute_name #=> String
resp.pagination_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool on which the search should be performed.
:attributes_to_get (Array<String>) —

An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
:limit (Integer) —

Maximum number of users to be returned.
:pagination_token (String) —

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.
:filter (String) —
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.

<note markdown=“1”> 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][1

in the [Command Line Interface User

Guide].
```
</note>
```
For more information, see [Searching for Users Using the ListUsers API] and [Examples of Using the ListUsers API] in the *Amazon Cognito Developer Guide*.

[1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api [3]: docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples

Returns:

(Types::ListUsersResponse) —
Returns a response object which responds to the following methods:
- #users => Array<Types::UserType>
- #pagination_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5718

def list_users(params = {}, options = {})
  req = build_request(:list_users, params)
  req.send_request(options)
end

#list_users_in_group(params = {}) ⇒ `Types::ListUsersInGroupResponse`

Lists the users in the specified group.

Calling this action requires developer credentials.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_users_in_group({
  user_pool_id: "UserPoolIdType", # required
  group_name: "GroupNameType", # required
  limit: 1,
  next_token: "PaginationKey",
})

Response structure


resp.users #=> Array
resp.users[0].username #=> String
resp.users[0].attributes #=> Array
resp.users[0].attributes[0].name #=> String
resp.users[0].attributes[0].value #=> String
resp.users[0].user_create_date #=> Time
resp.users[0].user_last_modified_date #=> Time
resp.users[0].enabled #=> Boolean
resp.users[0].user_status #=> String, one of "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", "FORCE_CHANGE_PASSWORD"
resp.users[0].mfa_options #=> Array
resp.users[0].mfa_options[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.users[0].mfa_options[0].attribute_name #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:group_name (required, String) —

The name of the group.
:limit (Integer) —

The limit of the request to list users.
:next_token (String) —

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.

Returns:

(Types::ListUsersInGroupResponse) —
Returns a response object which responds to the following methods:
- #users => Array<Types::UserType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5777

def list_users_in_group(params = {}, options = {})
  req = build_request(:list_users_in_group, params)
  req.send_request(options)
end

#resend_confirmation_code(params = {}) ⇒ `Types::ResendConfirmationCodeResponse`

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.resend_confirmation_code({
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  username: "UsernameType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.code_delivery_details.destination #=> String
resp.code_delivery_details.delivery_medium #=> String, one of "SMS", "EMAIL"
resp.code_delivery_details.attribute_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The ID of the client associated with the user pool.
:secret_hash (String) —

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.
:user_context_data (Types::UserContextDataType) —

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 (required, String) —

The ‘username` attribute of the user to whom you want to resend a confirmation code.
:analytics_metadata (Types::AnalyticsMetadataType) —

The Amazon Pinpoint analytics metadata that contributes to your metrics for ‘ResendConfirmationCode` calls.
:client_metadata (Hash<String,String>) —
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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::ResendConfirmationCodeResponse) —
Returns a response object which responds to the following methods:
- #code_delivery_details => Types::CodeDeliveryDetailsType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5903

def resend_confirmation_code(params = {}, options = {})
  req = build_request(:resend_confirmation_code, params)
  req.send_request(options)
end

#respond_to_auth_challenge(params = {}) ⇒ `Types::RespondToAuthChallengeResponse`

Responds to the authentication challenge.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.respond_to_auth_challenge({
  client_id: "ClientIdType", # required
  challenge_name: "SMS_MFA", # required, accepts 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
  session: "SessionType",
  challenge_responses: {
    "StringType" => "StringType",
  },
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.challenge_name #=> String, one of "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"
resp.session #=> String
resp.challenge_parameters #=> Hash
resp.challenge_parameters["StringType"] #=> String
resp.authentication_result.access_token #=> String
resp.authentication_result.expires_in #=> Integer
resp.authentication_result.token_type #=> String
resp.authentication_result.refresh_token #=> String
resp.authentication_result.id_token #=> String
resp.authentication_result.new_device_metadata.device_key #=> String
resp.authentication_result.new_device_metadata.device_group_key #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The app client ID.
:challenge_name (required, String) —

The challenge name. For more information, see [InitiateAuth].

‘ADMIN_NO_SRP_AUTH` isn’t a valid value.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html
:session (String) —

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.
:challenge_responses (Hash<String,String>) —
The challenge responses. These are inputs corresponding to the value of ‘ChallengeName`, for example:

<note markdown=“1”> ‘SECRET_HASH` (if app client is configured with client secret) applies to all of the inputs that follow (including `SOFTWARE_TOKEN_MFA`).
```
</note>
```
- ‘SMS_MFA`: `SMS_MFA_CODE`, `USERNAME`.
- ‘PASSWORD_VERIFIER`: `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, `TIMESTAMP`, `USERNAME`.
  
  <note markdown=“1”> ‘PASSWORD_VERIFIER` requires `DEVICE_KEY` when you sign in with a remembered device.
```
</note>
```
- ‘NEW_PASSWORD_REQUIRED`: `NEW_PASSWORD`, `USERNAME`, `SECRET_HASH` (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as `requiredAttributes` in the `InitiateAuth` response, add a `userAttributes.attributename ` parameter. This parameter can also set values for writable attributes that aren’t required by your user pool.
  
  <note markdown=“1”> 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.
```
</note>
```
- ‘SOFTWARE_TOKEN_MFA`: `USERNAME` and `SOFTWARE_TOKEN_MFA_CODE` are required attributes.
- ‘DEVICE_SRP_AUTH` requires `USERNAME`, `DEVICE_KEY`, `SRP_A` (and `SECRET_HASH`).
- ‘DEVICE_PASSWORD_VERIFIER` requires everything that `PASSWORD_VERIFIER` requires, plus `DEVICE_KEY`.
- ‘MFA_SETUP` requires `USERNAME`, plus you must use the session value returned by `VerifySoftwareToken` in the `Session` parameter.
:analytics_metadata (Types::AnalyticsMetadataType) —

The Amazon Pinpoint analytics metadata that contributes to your metrics for ‘RespondToAuthChallenge` calls.
:user_context_data (Types::UserContextDataType) —

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.
:client_metadata (Hash<String,String>) —
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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::RespondToAuthChallengeResponse) —
Returns a response object which responds to the following methods:
- #challenge_name => String
- #session => String
- #challenge_parameters => Hash<String,String>
- #authentication_result => Types::AuthenticationResultType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6099

def respond_to_auth_challenge(params = {}, options = {})
  req = build_request(:respond_to_auth_challenge, params)
  req.send_request(options)
end

#revoke_token(params = {}) ⇒ `Struct`

Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can’t use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.

Examples:

Request syntax with placeholder values


resp = client.revoke_token({
  token: "TokenModelType", # required
  client_id: "ClientIdType", # required
  client_secret: "ClientSecretType",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:token (required, String) —

The refresh token that you want to revoke.
:client_id (required, String) —

The client ID for the token that you want to revoke.
:client_secret (String) —

The secret for the client ID. This is required only if the client ID has a secret.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6133

def revoke_token(params = {}, options = {})
  req = build_request(:revoke_token, params)
  req.send_request(options)
end

#set_risk_configuration(params = {}) ⇒ `Types::SetRiskConfigurationResponse`

Configures actions on detected risks. To delete the risk configuration for ‘UserPoolId` or `ClientId`, pass null values for all four configuration types.

To activate Amazon Cognito advanced security features, update the user pool to include the ‘UserPoolAddOns` key`AdvancedSecurityMode`.

Examples:

Request syntax with placeholder values


resp = client.set_risk_configuration({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType",
  compromised_credentials_risk_configuration: {
    event_filter: ["SIGN_IN"], # accepts SIGN_IN, PASSWORD_CHANGE, SIGN_UP
    actions: { # required
      event_action: "BLOCK", # required, accepts BLOCK, NO_ACTION
    },
  },
  account_takeover_risk_configuration: {
    notify_configuration: {
      from: "StringType",
      reply_to: "StringType",
      source_arn: "ArnType", # required
      block_email: {
        subject: "EmailNotificationSubjectType", # required
        html_body: "EmailNotificationBodyType",
        text_body: "EmailNotificationBodyType",
      },
      no_action_email: {
        subject: "EmailNotificationSubjectType", # required
        html_body: "EmailNotificationBodyType",
        text_body: "EmailNotificationBodyType",
      },
      mfa_email: {
        subject: "EmailNotificationSubjectType", # required
        html_body: "EmailNotificationBodyType",
        text_body: "EmailNotificationBodyType",
      },
    },
    actions: { # required
      low_action: {
        notify: false, # required
        event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
      },
      medium_action: {
        notify: false, # required
        event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
      },
      high_action: {
        notify: false, # required
        event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
      },
    },
  },
  risk_exception_configuration: {
    blocked_ip_range_list: ["StringType"],
    skipped_ip_range_list: ["StringType"],
  },
})

Response structure


resp.risk_configuration.user_pool_id #=> String
resp.risk_configuration.client_id #=> String
resp.risk_configuration.compromised_credentials_risk_configuration.event_filter #=> Array
resp.risk_configuration.compromised_credentials_risk_configuration.event_filter[0] #=> String, one of "SIGN_IN", "PASSWORD_CHANGE", "SIGN_UP"
resp.risk_configuration.compromised_credentials_risk_configuration.actions.event_action #=> String, one of "BLOCK", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.from #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.reply_to #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.source_arn #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.actions.low_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.low_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.actions.medium_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.medium_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.actions.high_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.high_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.risk_exception_configuration.blocked_ip_range_list #=> Array
resp.risk_configuration.risk_exception_configuration.blocked_ip_range_list[0] #=> String
resp.risk_configuration.risk_exception_configuration.skipped_ip_range_list #=> Array
resp.risk_configuration.risk_exception_configuration.skipped_ip_range_list[0] #=> String
resp.risk_configuration.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:client_id (String) —

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.
:compromised_credentials_risk_configuration (Types::CompromisedCredentialsRiskConfigurationType) —

The compromised credentials risk configuration.
:account_takeover_risk_configuration (Types::AccountTakeoverRiskConfigurationType) —

The account takeover risk configuration.
:risk_exception_configuration (Types::RiskExceptionConfigurationType) —

The configuration to override the risk decision.

Returns:

(Types::SetRiskConfigurationResponse) —
Returns a response object which responds to the following methods:
- #risk_configuration => Types::RiskConfigurationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6258

def set_risk_configuration(params = {}, options = {})
  req = build_request(:set_risk_configuration, params)
  req.send_request(options)
end

#set_ui_customization(params = {}) ⇒ `Types::SetUICustomizationResponse`

Sets the user interface (UI) customization information for a user pool’s built-in app UI.

You can specify app UI customization settings for a single client (with a specific ‘clientId`) or for all clients (by setting the `clientId` to `ALL`). If you specify `ALL`, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the `ALL` configuration.

<note markdown=“1”> To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app’s pages, and the service will throw an error.

</note>

Examples:

Request syntax with placeholder values


resp = client.set_ui_customization({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType",
  css: "CSSType",
  image_file: "data",
})

Response structure


resp.ui_customization.user_pool_id #=> String
resp.ui_customization.client_id #=> String
resp.ui_customization.image_url #=> String
resp.ui_customization.css #=> String
resp.ui_customization.css_version #=> String
resp.ui_customization.last_modified_date #=> Time
resp.ui_customization.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:client_id (String) —

The client ID for the client app.
:css (String) —

The CSS values in the UI customization.
:image_file (String, StringIO, File) —

The uploaded logo image for the UI customization.

Returns:

(Types::SetUICustomizationResponse) —
Returns a response object which responds to the following methods:
- #ui_customization => Types::UICustomizationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6318

def set_ui_customization(params = {}, options = {})
  req = build_request(:set_ui_customization, params)
  req.send_request(options)
end

#set_user_mfa_preference(params = {}) ⇒ `Struct`

Set the user’s multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. 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.

Examples:

Request syntax with placeholder values


resp = client.set_user_mfa_preference({
  sms_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  software_token_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  access_token: "TokenModelType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:sms_mfa_settings (Types::SMSMfaSettingsType) —

The SMS text message multi-factor authentication (MFA) settings.
:software_token_mfa_settings (Types::SoftwareTokenMfaSettingsType) —

The time-based one-time password (TOTP) software token MFA settings.
:access_token (required, String) —

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6365

def set_user_mfa_preference(params = {}, options = {})
  req = build_request(:set_user_mfa_preference, params)
  req.send_request(options)
end

#set_user_pool_mfa_config(params = {}) ⇒ `Types::SetUserPoolMfaConfigResponse`

Sets the user pool multi-factor authentication (MFA) configuration.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.set_user_pool_mfa_config({
  user_pool_id: "UserPoolIdType", # required
  sms_mfa_configuration: {
    sms_authentication_message: "SmsVerificationMessageType",
    sms_configuration: {
      sns_caller_arn: "ArnType", # required
      external_id: "StringType",
      sns_region: "RegionCodeType",
    },
  },
  software_token_mfa_configuration: {
    enabled: false,
  },
  mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
})

Response structure


resp.sms_mfa_configuration.sms_authentication_message #=> String
resp.sms_mfa_configuration.sms_configuration.sns_caller_arn #=> String
resp.sms_mfa_configuration.sms_configuration.external_id #=> String
resp.sms_mfa_configuration.sms_configuration.sns_region #=> String
resp.software_token_mfa_configuration.enabled #=> Boolean
resp.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:sms_mfa_configuration (Types::SmsMfaConfigType) —

The SMS text message MFA configuration.
:software_token_mfa_configuration (Types::SoftwareTokenMfaConfigType) —

The software token MFA configuration.
:mfa_configuration (String) —
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.
[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html

Returns:

(Types::SetUserPoolMfaConfigResponse) —
Returns a response object which responds to the following methods:
- #sms_mfa_configuration => Types::SmsMfaConfigType
- #software_token_mfa_configuration => Types::SoftwareTokenMfaConfigType
- #mfa_configuration => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6461

def set_user_pool_mfa_config(params = {}, options = {})
  req = build_request(:set_user_pool_mfa_config, params)
  req.send_request(options)
end

#set_user_settings(params = {}) ⇒ `Struct`

*This action is no longer supported.* You can use it to configure only SMS MFA. You can’t use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use

SetUserMFAPreference][1: instead.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html

Examples:

Request syntax with placeholder values


resp = client.set_user_settings({
  access_token: "TokenModelType", # required
  mfa_options: [ # required
    {
      delivery_medium: "SMS", # accepts SMS, EMAIL
      attribute_name: "AttributeNameType",
    },
  ],
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
:mfa_options (required, Array<Types::MFAOptionType>) —

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

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6501

def set_user_settings(params = {}, options = {})
  req = build_request(:set_user_settings, params)
  req.send_request(options)
end

#sign_up(params = {}) ⇒ `Types::SignUpResponse`

Registers the user in the specified user pool and creates a user name, password, and user attributes.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.sign_up({
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
  password: "PasswordType", # required
  user_attributes: [
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  validation_data: [
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.user_confirmed #=> Boolean
resp.code_delivery_details.destination #=> String
resp.code_delivery_details.delivery_medium #=> String, one of "SMS", "EMAIL"
resp.code_delivery_details.attribute_name #=> String
resp.user_sub #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The ID of the client associated with the user pool.
:secret_hash (String) —

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 (required, String) —

The user name of the user you want to register.
:password (required, String) —

The password of the user you want to register.
:user_attributes (Array<Types::AttributeType>) —

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the ‘custom:` prefix to the attribute name.
:validation_data (Array<Types::AttributeType>) —

The validation data in the request to register a user.
:analytics_metadata (Types::AnalyticsMetadataType) —

The Amazon Pinpoint analytics metadata that contributes to your metrics for ‘SignUp` calls.
:user_context_data (Types::UserContextDataType) —

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.
:client_metadata (Hash<String,String>) —
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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::SignUpResponse) —
Returns a response object which responds to the following methods:
- #user_confirmed => Boolean
- #code_delivery_details => Types::CodeDeliveryDetailsType
- #user_sub => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6655

def sign_up(params = {}, options = {})
  req = build_request(:sign_up, params)
  req.send_request(options)
end

#start_user_import_job(params = {}) ⇒ `Types::StartUserImportJobResponse`

Starts the user import.

Examples:

Request syntax with placeholder values


resp = client.start_user_import_job({
  user_pool_id: "UserPoolIdType", # required
  job_id: "UserImportJobIdType", # required
})

Response structure


resp.user_import_job.job_name #=> String
resp.user_import_job.job_id #=> String
resp.user_import_job.user_pool_id #=> String
resp.user_import_job.pre_signed_url #=> String
resp.user_import_job.creation_date #=> Time
resp.user_import_job.start_date #=> Time
resp.user_import_job.completion_date #=> Time
resp.user_import_job.status #=> String, one of "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded"
resp.user_import_job.cloud_watch_logs_role_arn #=> String
resp.user_import_job.imported_users #=> Integer
resp.user_import_job.skipped_users #=> Integer
resp.user_import_job.failed_users #=> Integer
resp.user_import_job.completion_message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool that the users are being imported into.
:job_id (required, String) —

The job ID for the user import job.

Returns:

(Types::StartUserImportJobResponse) —
Returns a response object which responds to the following methods:
- #user_import_job => Types::UserImportJobType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6700

def start_user_import_job(params = {}, options = {})
  req = build_request(:start_user_import_job, params)
  req.send_request(options)
end

#stop_user_import_job(params = {}) ⇒ `Types::StopUserImportJobResponse`

Stops the user import job.

Examples:

Request syntax with placeholder values


resp = client.stop_user_import_job({
  user_pool_id: "UserPoolIdType", # required
  job_id: "UserImportJobIdType", # required
})

Response structure


resp.user_import_job.job_name #=> String
resp.user_import_job.job_id #=> String
resp.user_import_job.user_pool_id #=> String
resp.user_import_job.pre_signed_url #=> String
resp.user_import_job.creation_date #=> Time
resp.user_import_job.start_date #=> Time
resp.user_import_job.completion_date #=> Time
resp.user_import_job.status #=> String, one of "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded"
resp.user_import_job.cloud_watch_logs_role_arn #=> String
resp.user_import_job.imported_users #=> Integer
resp.user_import_job.skipped_users #=> Integer
resp.user_import_job.failed_users #=> Integer
resp.user_import_job.completion_message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool that the users are being imported into.
:job_id (required, String) —

The job ID for the user import job.

Returns:

(Types::StopUserImportJobResponse) —
Returns a response object which responds to the following methods:
- #user_import_job => Types::UserImportJobType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6745

def stop_user_import_job(params = {}, options = {})
  req = build_request(:stop_user_import_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ `Struct`

Assigns a set of tags to an Amazon Cognito 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.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an ‘Environment` tag key to both user pools. The value of this key might be `Test` for one user pool, and `Production` for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ArnType", # required
  tags: { # required
    "TagKeysType" => "TagValueType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the user pool to assign the tags to.
:tags (required, Hash<String,String>) —

The tags to assign to the user pool.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6791

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ `Struct`

Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ArnType", # required
  tag_keys: ["TagKeysType"], # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
:tag_keys (required, Array<String>) —

The keys of the tags to remove from the user pool.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6819

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_auth_event_feedback(params = {}) ⇒ `Struct`

Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

Examples:

Request syntax with placeholder values


resp = client.update_auth_event_feedback({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  event_id: "EventIdType", # required
  feedback_token: "TokenModelType", # required
  feedback_value: "Valid", # required, accepts Valid, Invalid
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:username (required, String) —

The user pool username.
:event_id (required, String) —

The event ID.
:feedback_token (required, String) —

The feedback token.
:feedback_value (required, String) —

The authentication event feedback value.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6860

def update_auth_event_feedback(params = {}, options = {})
  req = build_request(:update_auth_event_feedback, params)
  req.send_request(options)
end

#update_device_status(params = {}) ⇒ `Struct`

Updates the device status.

Examples:

Request syntax with placeholder values


resp = client.update_device_status({
  access_token: "TokenModelType", # required
  device_key: "DeviceKeyType", # required
  device_remembered_status: "remembered", # accepts remembered, not_remembered
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the user whose device status you want to update.
:device_key (required, String) —

The device key.
:device_remembered_status (String) —

The status of whether a device is remembered.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6891

def update_device_status(params = {}, options = {})
  req = build_request(:update_device_status, params)
  req.send_request(options)
end

#update_group(params = {}) ⇒ `Types::UpdateGroupResponse`

Updates the specified group with the specified attributes.

Calling this action requires developer credentials.

Examples:

Request syntax with placeholder values


resp = client.update_group({
  group_name: "GroupNameType", # required
  user_pool_id: "UserPoolIdType", # required
  description: "DescriptionType",
  role_arn: "ArnType",
  precedence: 1,
})

Response structure


resp.group.group_name #=> String
resp.group.user_pool_id #=> String
resp.group.description #=> String
resp.group.role_arn #=> String
resp.group.precedence #=> Integer
resp.group.last_modified_date #=> Time
resp.group.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (required, String) —

The name of the group.
:user_pool_id (required, String) —

The user pool ID for the user pool.
:description (String) —

A string containing the new description of the group.
:role_arn (String) —

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 (Integer) —

The new precedence value for the group. For more information about this parameter, see [CreateGroup].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html

Returns:

(Types::UpdateGroupResponse) —
Returns a response object which responds to the following methods:
- #group => Types::GroupType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6950

def update_group(params = {}, options = {})
  req = build_request(:update_group, params)
  req.send_request(options)
end

#update_identity_provider(params = {}) ⇒ `Types::UpdateIdentityProviderResponse`

Updates IdP information for a user pool.

Examples:

Request syntax with placeholder values


resp = client.update_identity_provider({
  user_pool_id: "UserPoolIdType", # required
  provider_name: "ProviderNameType", # required
  provider_details: {
    "StringType" => "StringType",
  },
  attribute_mapping: {
    "AttributeMappingKeyType" => "StringType",
  },
  idp_identifiers: ["IdpIdentifierType"],
})

Response structure


resp.identity_provider.user_pool_id #=> String
resp.identity_provider.provider_name #=> String
resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.identity_provider.provider_details #=> Hash
resp.identity_provider.provider_details["StringType"] #=> String
resp.identity_provider.attribute_mapping #=> Hash
resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
resp.identity_provider.idp_identifiers #=> Array
resp.identity_provider.idp_identifiers[0] #=> String
resp.identity_provider.last_modified_date #=> Time
resp.identity_provider.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:provider_name (required, String) —

The IdP name.
:provider_details (Hash<String,String>) —

The IdP details to be updated, such as ‘MetadataURL` and `MetadataFile`.
:attribute_mapping (Hash<String,String>) —

The IdP attribute mapping to be changed.
:idp_identifiers (Array<String>) —

A list of IdP identifiers.

Returns:

(Types::UpdateIdentityProviderResponse) —
Returns a response object which responds to the following methods:
- #identity_provider => Types::IdentityProviderType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7009

def update_identity_provider(params = {}, options = {})
  req = build_request(:update_identity_provider, params)
  req.send_request(options)
end

#update_resource_server(params = {}) ⇒ `Types::UpdateResourceServerResponse`

Updates the name and scopes of resource server. All other fields are read-only.

If you don’t provide a value for an attribute, it is set to the default value.

Examples:

Request syntax with placeholder values


resp = client.update_resource_server({
  user_pool_id: "UserPoolIdType", # required
  identifier: "ResourceServerIdentifierType", # required
  name: "ResourceServerNameType", # required
  scopes: [
    {
      scope_name: "ResourceServerScopeNameType", # required
      scope_description: "ResourceServerScopeDescriptionType", # required
    },
  ],
})

Response structure


resp.resource_server.user_pool_id #=> String
resp.resource_server.identifier #=> String
resp.resource_server.name #=> String
resp.resource_server.scopes #=> Array
resp.resource_server.scopes[0].scope_name #=> String
resp.resource_server.scopes[0].scope_description #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool.
:identifier (required, String) —

The identifier for the resource server.
:name (required, String) —

The name of the resource server.
:scopes (Array<Types::ResourceServerScopeType>) —

The scope values to be set for the resource server.

Returns:

(Types::UpdateResourceServerResponse) —
Returns a response object which responds to the following methods:
- #resource_server => Types::ResourceServerType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7063

def update_resource_server(params = {}, options = {})
  req = build_request(:update_resource_server, params)
  req.send_request(options)
end

#update_user_attributes(params = {}) ⇒ `Types::UpdateUserAttributesResponse`

Allows a user to update a specific attribute (one at a time).

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.update_user_attributes({
  user_attributes: [ # required
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  access_token: "TokenModelType", # required
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.code_delivery_details_list #=> Array
resp.code_delivery_details_list[0].destination #=> String
resp.code_delivery_details_list[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.code_delivery_details_list[0].attribute_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_attributes (required, Array<Types::AttributeType>) —

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.
:access_token (required, String) —

A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.
:client_metadata (Hash<String,String>) —
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*.

<note markdown=“1”> 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.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::UpdateUserAttributesResponse) —
Returns a response object which responds to the following methods:
- #code_delivery_details_list => Array<Types::CodeDeliveryDetailsType>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7179

def update_user_attributes(params = {}, options = {})
  req = build_request(:update_user_attributes, params)
  req.send_request(options)
end

#update_user_pool(params = {}) ⇒ `Struct`

Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using [DescribeUserPool]. If you don’t provide a value for an attribute, it will be set to the default value.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any

other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools] in the *Amazon Cognito Developer Guide*.

</note>

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html [2]: console.aws.amazon.com/pinpoint/home/ [3]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html

Examples:

Request syntax with placeholder values


resp = client.update_user_pool({
  user_pool_id: "UserPoolIdType", # required
  policies: {
    password_policy: {
      minimum_length: 1,
      require_uppercase: false,
      require_lowercase: false,
      require_numbers: false,
      require_symbols: false,
      temporary_password_validity_days: 1,
    },
  },
  deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
  lambda_config: {
    pre_sign_up: "ArnType",
    custom_message: "ArnType",
    post_confirmation: "ArnType",
    pre_authentication: "ArnType",
    post_authentication: "ArnType",
    define_auth_challenge: "ArnType",
    create_auth_challenge: "ArnType",
    verify_auth_challenge_response: "ArnType",
    pre_token_generation: "ArnType",
    user_migration: "ArnType",
    custom_sms_sender: {
      lambda_version: "V1_0", # required, accepts V1_0
      lambda_arn: "ArnType", # required
    },
    custom_email_sender: {
      lambda_version: "V1_0", # required, accepts V1_0
      lambda_arn: "ArnType", # required
    },
    kms_key_id: "ArnType",
  },
  auto_verified_attributes: ["phone_number"], # accepts phone_number, email
  sms_verification_message: "SmsVerificationMessageType",
  email_verification_message: "EmailVerificationMessageType",
  email_verification_subject: "EmailVerificationSubjectType",
  verification_message_template: {
    sms_message: "SmsVerificationMessageType",
    email_message: "EmailVerificationMessageType",
    email_subject: "EmailVerificationSubjectType",
    email_message_by_link: "EmailVerificationMessageByLinkType",
    email_subject_by_link: "EmailVerificationSubjectByLinkType",
    default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
  },
  sms_authentication_message: "SmsVerificationMessageType",
  user_attribute_update_settings: {
    attributes_require_verification_before_update: ["phone_number"], # accepts phone_number, email
  },
  mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
  device_configuration: {
    challenge_required_on_new_device: false,
    device_only_remembered_on_user_prompt: false,
  },
  email_configuration: {
    source_arn: "ArnType",
    reply_to_email_address: "EmailAddressType",
    email_sending_account: "COGNITO_DEFAULT", # accepts COGNITO_DEFAULT, DEVELOPER
    from: "StringType",
    configuration_set: "SESConfigurationSet",
  },
  sms_configuration: {
    sns_caller_arn: "ArnType", # required
    external_id: "StringType",
    sns_region: "RegionCodeType",
  },
  user_pool_tags: {
    "TagKeysType" => "TagValueType",
  },
  admin_create_user_config: {
    allow_admin_create_user_only: false,
    unused_account_validity_days: 1,
    invite_message_template: {
      sms_message: "SmsVerificationMessageType",
      email_message: "EmailVerificationMessageType",
      email_subject: "EmailVerificationSubjectType",
    },
  },
  user_pool_add_ons: {
    advanced_security_mode: "OFF", # required, accepts OFF, AUDIT, ENFORCED
  },
  account_recovery_setting: {
    recovery_mechanisms: [
      {
        priority: 1, # required
        name: "verified_email", # required, accepts verified_email, verified_phone_number, admin_only
      },
    ],
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool you want to update.
:policies (Types::UserPoolPolicyType) —

A container with the policies you want to update in a user pool.
:deletion_protection (String) —

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.
:lambda_config (Types::LambdaConfigType) —

The Lambda configuration information from the request to update the user pool.
:auto_verified_attributes (Array<String>) —

The attributes that are automatically verified when Amazon Cognito requests to update user pools.
:sms_verification_message (String) —

This parameter is no longer used. See [VerificationMessageTemplateType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
:email_verification_message (String) —

This parameter is no longer used. See [VerificationMessageTemplateType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
:email_verification_subject (String) —

This parameter is no longer used. See [VerificationMessageTemplateType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html
:verification_message_template (Types::VerificationMessageTemplateType) —

The template for verification messages.
:sms_authentication_message (String) —

The contents of the SMS authentication message.
:user_attribute_update_settings (Types::UserAttributeUpdateSettingsType) —

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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
:mfa_configuration (String) —
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.
[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html
:device_configuration (Types::DeviceConfigurationType) —
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

<note markdown=“1”> When you provide a value for any ‘DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature.
```
</note>
```
:email_configuration (Types::EmailConfigurationType) —

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.
:sms_configuration (Types::SmsConfigurationType) —

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.
:user_pool_tags (Hash<String,String>) —

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.
:admin_create_user_config (Types::AdminCreateUserConfigType) —

The configuration for ‘AdminCreateUser` requests.
:user_pool_add_ons (Types::UserPoolAddOnsType) —

Enables advanced security risk detection. Set the key ‘AdvancedSecurityMode` to the value “AUDIT”.
:account_recovery_setting (Types::AccountRecoverySettingType) —

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.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7447

def update_user_pool(params = {}, options = {})
  req = build_request(:update_user_pool, params)
  req.send_request(options)
end

#update_user_pool_client(params = {}) ⇒ `Types::UpdateUserPoolClientResponse`

Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using [DescribeUserPoolClient].

If you don’t provide a value for an attribute, it will be set to the default value.

You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see [RevokeToken].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html

Examples:

Request syntax with placeholder values


resp = client.update_user_pool_client({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  client_name: "ClientNameType",
  refresh_token_validity: 1,
  access_token_validity: 1,
  id_token_validity: 1,
  token_validity_units: {
    access_token: "seconds", # accepts seconds, minutes, hours, days
    id_token: "seconds", # accepts seconds, minutes, hours, days
    refresh_token: "seconds", # accepts seconds, minutes, hours, days
  },
  read_attributes: ["ClientPermissionType"],
  write_attributes: ["ClientPermissionType"],
  explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts 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
  supported_identity_providers: ["ProviderNameType"],
  callback_urls: ["RedirectUrlType"],
  logout_urls: ["RedirectUrlType"],
  default_redirect_uri: "RedirectUrlType",
  allowed_o_auth_flows: ["code"], # accepts code, implicit, client_credentials
  allowed_o_auth_scopes: ["ScopeType"],
  allowed_o_auth_flows_user_pool_client: false,
  analytics_configuration: {
    application_id: "HexStringType",
    application_arn: "ArnType",
    role_arn: "ArnType",
    external_id: "StringType",
    user_data_shared: false,
  },
  prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
  enable_token_revocation: false,
  enable_propagate_additional_user_context_data: false,
  auth_session_validity: 1,
})

Response structure


resp.user_pool_client.user_pool_id #=> String
resp.user_pool_client.client_name #=> String
resp.user_pool_client.client_id #=> String
resp.user_pool_client.client_secret #=> String
resp.user_pool_client.last_modified_date #=> Time
resp.user_pool_client.creation_date #=> Time
resp.user_pool_client.refresh_token_validity #=> Integer
resp.user_pool_client.access_token_validity #=> Integer
resp.user_pool_client.id_token_validity #=> Integer
resp.user_pool_client.token_validity_units.access_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.id_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.refresh_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.read_attributes #=> Array
resp.user_pool_client.read_attributes[0] #=> String
resp.user_pool_client.write_attributes #=> Array
resp.user_pool_client.write_attributes[0] #=> String
resp.user_pool_client.explicit_auth_flows #=> Array
resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "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"
resp.user_pool_client.supported_identity_providers #=> Array
resp.user_pool_client.supported_identity_providers[0] #=> String
resp.user_pool_client.callback_urls #=> Array
resp.user_pool_client.callback_urls[0] #=> String
resp.user_pool_client.logout_urls #=> Array
resp.user_pool_client.logout_urls[0] #=> String
resp.user_pool_client.default_redirect_uri #=> String
resp.user_pool_client.allowed_o_auth_flows #=> Array
resp.user_pool_client.allowed_o_auth_flows[0] #=> String, one of "code", "implicit", "client_credentials"
resp.user_pool_client.allowed_o_auth_scopes #=> Array
resp.user_pool_client.allowed_o_auth_scopes[0] #=> String
resp.user_pool_client.allowed_o_auth_flows_user_pool_client #=> Boolean
resp.user_pool_client.analytics_configuration.application_id #=> String
resp.user_pool_client.analytics_configuration.application_arn #=> String
resp.user_pool_client.analytics_configuration.role_arn #=> String
resp.user_pool_client.analytics_configuration.external_id #=> String
resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
resp.user_pool_client.enable_token_revocation #=> Boolean
resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
resp.user_pool_client.auth_session_validity #=> Integer

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID for the user pool where you want to update the user pool client.
:client_id (required, String) —

The ID of the client associated with the user pool.
:client_name (String) —

The client name from the update user pool client request.
:refresh_token_validity (Integer) —

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.
:access_token_validity (Integer) —

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.
:id_token_validity (Integer) —

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 ‘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 ID tokens are valid for one hour.
:token_validity_units (Types::TokenValidityUnitsType) —

The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
:read_attributes (Array<String>) —

The read-only attributes of the user pool.
:write_attributes (Array<String>) —

The writeable attributes of the user pool.
:explicit_auth_flows (Array<String>) —
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.

<note markdown=“1”> 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`.
```
</note>
```
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`.
:supported_identity_providers (Array<String>) —

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.
:callback_urls (Array<String>) —
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 localhost for testing purposes only.

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

[1]: tools.ietf.org/html/rfc6749#section-3.1.2
:logout_urls (Array<String>) —

A list of allowed logout URLs for the IdPs.
:default_redirect_uri (String) —
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 ‘localhost` for testing purposes only.

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

[1]: tools.ietf.org/html/rfc6749#section-3.1.2
:allowed_o_auth_flows (Array<String>) —
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.
```
:allowed_o_auth_scopes (Array<String>) —

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.
:allowed_o_auth_flows_user_pool_client (Boolean) —

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
:analytics_configuration (Types::AnalyticsConfigurationType) —
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.

<note markdown=“1”> 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.
```
</note>
```
:prevent_user_existence_errors (String) —
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.
:enable_token_revocation (Boolean) —

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

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html
:enable_propagate_additional_user_context_data (Boolean) —

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.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
:auth_session_validity (Integer) —

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.

Returns:

(Types::UpdateUserPoolClientResponse) —
Returns a response object which responds to the following methods:
- #user_pool_client => Types::UserPoolClientType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7805

def update_user_pool_client(params = {}, options = {})
  req = build_request(:update_user_pool_client, params)
  req.send_request(options)
end

#update_user_pool_domain(params = {}) ⇒ `Types::UpdateUserPoolDomainResponse`

Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.

You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can’t use it to change the domain for a user pool.

A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.

Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.

However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.

When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.

After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.

For more information about adding a custom domain to your user pool, see [Using Your Own Domain for the Hosted UI].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html

Examples:

Request syntax with placeholder values


resp = client.update_user_pool_domain({
  domain: "DomainType", # required
  user_pool_id: "UserPoolIdType", # required
  custom_domain_config: { # required
    certificate_arn: "ArnType", # required
  },
})

Response structure


resp.cloud_front_domain #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:domain (required, String) —

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.
:user_pool_id (required, String) —

The ID of the user pool that is associated with the custom domain whose certificate you’re updating.
:custom_domain_config (required, Types::CustomDomainConfigType) —

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.

Returns:

(Types::UpdateUserPoolDomainResponse) —
Returns a response object which responds to the following methods:
- #cloud_front_domain => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7885

def update_user_pool_domain(params = {}, options = {})
  req = build_request(:update_user_pool_domain, params)
  req.send_request(options)
end

#verify_software_token(params = {}) ⇒ `Types::VerifySoftwareTokenResponse`

Use this API to register a user’s entered time-based one-time password (TOTP) code and mark the user’s software token MFA status as “verified” if successful. The request takes an access token or a session string, but not both.

Examples:

Request syntax with placeholder values


resp = client.verify_software_token({
  access_token: "TokenModelType",
  session: "SessionType",
  user_code: "SoftwareTokenMFAUserCodeType", # required
  friendly_device_name: "StringType",
})

Response structure


resp.status #=> String, one of "SUCCESS", "ERROR"
resp.session #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (String) —

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.
:session (String) —

The session that should be passed both ways in challenge-response calls to the service.
:user_code (required, String) —

The one- time password computed using the secret code returned by [AssociateSoftwareToken].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html
:friendly_device_name (String) —

The friendly device name.

Returns:

(Types::VerifySoftwareTokenResponse) —
Returns a response object which responds to the following methods:
- #status => String
- #session => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7937

def verify_software_token(params = {}, options = {})
  req = build_request(:verify_software_token, params)
  req.send_request(options)
end

#verify_user_attribute(params = {}) ⇒ `Struct`

Verifies the specified user attributes in the user pool.

If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see [ UserAttributeUpdateSettingsType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html

Examples:

Request syntax with placeholder values


resp = client.verify_user_attribute({
  access_token: "TokenModelType", # required
  attribute_name: "AttributeNameType", # required
  code: "ConfirmationCodeType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
:attribute_name (required, String) —

The attribute name in the request to verify user attributes.
:code (required, String) —

The verification code in the request to verify user attributes.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7977

def verify_user_attribute(params = {}, options = {})
  req = build_request(:verify_user_attribute, params)
  req.send_request(options)
end

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



8001
8002
8003

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8001

def waiter_names
  []
end

Overview

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#add_custom_attributes(params = {}) ⇒ Struct

#admin_add_user_to_group(params = {}) ⇒ Struct

#admin_confirm_sign_up(params = {}) ⇒ Struct

#admin_create_user(params = {}) ⇒ Types::AdminCreateUserResponse

#admin_delete_user(params = {}) ⇒ Struct

#admin_delete_user_attributes(params = {}) ⇒ Struct

#admin_disable_provider_for_user(params = {}) ⇒ Struct

#admin_disable_user(params = {}) ⇒ Struct

#admin_enable_user(params = {}) ⇒ Struct

#admin_forget_device(params = {}) ⇒ Struct

#admin_get_device(params = {}) ⇒ Types::AdminGetDeviceResponse

#admin_get_user(params = {}) ⇒ Types::AdminGetUserResponse

#admin_initiate_auth(params = {}) ⇒ Types::AdminInitiateAuthResponse

#admin_link_provider_for_user(params = {}) ⇒ Struct

#admin_list_devices(params = {}) ⇒ Types::AdminListDevicesResponse

#admin_list_groups_for_user(params = {}) ⇒ Types::AdminListGroupsForUserResponse

#admin_list_user_auth_events(params = {}) ⇒ Types::AdminListUserAuthEventsResponse

#admin_remove_user_from_group(params = {}) ⇒ Struct

#admin_reset_user_password(params = {}) ⇒ Struct

#admin_respond_to_auth_challenge(params = {}) ⇒ Types::AdminRespondToAuthChallengeResponse

#admin_set_user_mfa_preference(params = {}) ⇒ Struct

#admin_set_user_password(params = {}) ⇒ Struct

#admin_set_user_settings(params = {}) ⇒ Struct

#admin_update_auth_event_feedback(params = {}) ⇒ Struct

#admin_update_device_status(params = {}) ⇒ Struct

#admin_update_user_attributes(params = {}) ⇒ Struct

#admin_user_global_sign_out(params = {}) ⇒ Struct

#associate_software_token(params = {}) ⇒ Types::AssociateSoftwareTokenResponse

#build_request(operation_name, params = {}) ⇒ Object

#change_password(params = {}) ⇒ Struct

#confirm_device(params = {}) ⇒ Types::ConfirmDeviceResponse

#confirm_forgot_password(params = {}) ⇒ Struct

#confirm_sign_up(params = {}) ⇒ Struct

#create_group(params = {}) ⇒ Types::CreateGroupResponse

#create_identity_provider(params = {}) ⇒ Types::CreateIdentityProviderResponse

#create_resource_server(params = {}) ⇒ Types::CreateResourceServerResponse

#create_user_import_job(params = {}) ⇒ Types::CreateUserImportJobResponse

#create_user_pool(params = {}) ⇒ Types::CreateUserPoolResponse

#create_user_pool_client(params = {}) ⇒ Types::CreateUserPoolClientResponse

#create_user_pool_domain(params = {}) ⇒ Types::CreateUserPoolDomainResponse

#delete_group(params = {}) ⇒ Struct

#delete_identity_provider(params = {}) ⇒ Struct

#delete_resource_server(params = {}) ⇒ Struct

#delete_user(params = {}) ⇒ Struct

#delete_user_attributes(params = {}) ⇒ Struct

#delete_user_pool(params = {}) ⇒ Struct

#delete_user_pool_client(params = {}) ⇒ Struct

#delete_user_pool_domain(params = {}) ⇒ Struct

#describe_identity_provider(params = {}) ⇒ Types::DescribeIdentityProviderResponse

#describe_resource_server(params = {}) ⇒ Types::DescribeResourceServerResponse

#describe_risk_configuration(params = {}) ⇒ Types::DescribeRiskConfigurationResponse

#describe_user_import_job(params = {}) ⇒ Types::DescribeUserImportJobResponse

#describe_user_pool(params = {}) ⇒ Types::DescribeUserPoolResponse

#describe_user_pool_client(params = {}) ⇒ Types::DescribeUserPoolClientResponse

#describe_user_pool_domain(params = {}) ⇒ Types::DescribeUserPoolDomainResponse

#forget_device(params = {}) ⇒ Struct

#forgot_password(params = {}) ⇒ Types::ForgotPasswordResponse

#get_csv_header(params = {}) ⇒ Types::GetCSVHeaderResponse

#get_device(params = {}) ⇒ Types::GetDeviceResponse

#get_group(params = {}) ⇒ Types::GetGroupResponse

#get_identity_provider_by_identifier(params = {}) ⇒ Types::GetIdentityProviderByIdentifierResponse

#get_signing_certificate(params = {}) ⇒ Types::GetSigningCertificateResponse

#get_ui_customization(params = {}) ⇒ Types::GetUICustomizationResponse

#get_user(params = {}) ⇒ Types::GetUserResponse

#get_user_attribute_verification_code(params = {}) ⇒ Types::GetUserAttributeVerificationCodeResponse

#get_user_pool_mfa_config(params = {}) ⇒ Types::GetUserPoolMfaConfigResponse

#global_sign_out(params = {}) ⇒ Struct

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#add_custom_attributes(params = {}) ⇒ `Struct`

#admin_add_user_to_group(params = {}) ⇒ `Struct`

#admin_confirm_sign_up(params = {}) ⇒ `Struct`

#admin_create_user(params = {}) ⇒ `Types::AdminCreateUserResponse`

#admin_delete_user(params = {}) ⇒ `Struct`

#admin_delete_user_attributes(params = {}) ⇒ `Struct`

#admin_disable_provider_for_user(params = {}) ⇒ `Struct`

#admin_disable_user(params = {}) ⇒ `Struct`

#admin_enable_user(params = {}) ⇒ `Struct`

#admin_forget_device(params = {}) ⇒ `Struct`

#admin_get_device(params = {}) ⇒ `Types::AdminGetDeviceResponse`

#admin_get_user(params = {}) ⇒ `Types::AdminGetUserResponse`

#admin_initiate_auth(params = {}) ⇒ `Types::AdminInitiateAuthResponse`

#admin_link_provider_for_user(params = {}) ⇒ `Struct`

#admin_list_devices(params = {}) ⇒ `Types::AdminListDevicesResponse`

#admin_list_groups_for_user(params = {}) ⇒ `Types::AdminListGroupsForUserResponse`

#admin_list_user_auth_events(params = {}) ⇒ `Types::AdminListUserAuthEventsResponse`

#admin_remove_user_from_group(params = {}) ⇒ `Struct`

#admin_reset_user_password(params = {}) ⇒ `Struct`

#admin_respond_to_auth_challenge(params = {}) ⇒ `Types::AdminRespondToAuthChallengeResponse`

#admin_set_user_mfa_preference(params = {}) ⇒ `Struct`

#admin_set_user_password(params = {}) ⇒ `Struct`

#admin_set_user_settings(params = {}) ⇒ `Struct`

#admin_update_auth_event_feedback(params = {}) ⇒ `Struct`

#admin_update_device_status(params = {}) ⇒ `Struct`

#admin_update_user_attributes(params = {}) ⇒ `Struct`

#admin_user_global_sign_out(params = {}) ⇒ `Struct`

#associate_software_token(params = {}) ⇒ `Types::AssociateSoftwareTokenResponse`

#build_request(operation_name, params = {}) ⇒ `Object`

#change_password(params = {}) ⇒ `Struct`

#confirm_device(params = {}) ⇒ `Types::ConfirmDeviceResponse`

#confirm_forgot_password(params = {}) ⇒ `Struct`

#confirm_sign_up(params = {}) ⇒ `Struct`

#create_group(params = {}) ⇒ `Types::CreateGroupResponse`

#create_identity_provider(params = {}) ⇒ `Types::CreateIdentityProviderResponse`

#create_resource_server(params = {}) ⇒ `Types::CreateResourceServerResponse`

#create_user_import_job(params = {}) ⇒ `Types::CreateUserImportJobResponse`

#create_user_pool(params = {}) ⇒ `Types::CreateUserPoolResponse`

#create_user_pool_client(params = {}) ⇒ `Types::CreateUserPoolClientResponse`

#create_user_pool_domain(params = {}) ⇒ `Types::CreateUserPoolDomainResponse`

#delete_group(params = {}) ⇒ `Struct`

#delete_identity_provider(params = {}) ⇒ `Struct`

#delete_resource_server(params = {}) ⇒ `Struct`

#delete_user(params = {}) ⇒ `Struct`

#delete_user_attributes(params = {}) ⇒ `Struct`

#delete_user_pool(params = {}) ⇒ `Struct`

#delete_user_pool_client(params = {}) ⇒ `Struct`

#delete_user_pool_domain(params = {}) ⇒ `Struct`

#describe_identity_provider(params = {}) ⇒ `Types::DescribeIdentityProviderResponse`

#describe_resource_server(params = {}) ⇒ `Types::DescribeResourceServerResponse`

#describe_risk_configuration(params = {}) ⇒ `Types::DescribeRiskConfigurationResponse`

#describe_user_import_job(params = {}) ⇒ `Types::DescribeUserImportJobResponse`

#describe_user_pool(params = {}) ⇒ `Types::DescribeUserPoolResponse`

#describe_user_pool_client(params = {}) ⇒ `Types::DescribeUserPoolClientResponse`

#describe_user_pool_domain(params = {}) ⇒ `Types::DescribeUserPoolDomainResponse`

#forget_device(params = {}) ⇒ `Struct`

#forgot_password(params = {}) ⇒ `Types::ForgotPasswordResponse`

#get_csv_header(params = {}) ⇒ `Types::GetCSVHeaderResponse`

#get_device(params = {}) ⇒ `Types::GetDeviceResponse`

#get_group(params = {}) ⇒ `Types::GetGroupResponse`

#get_identity_provider_by_identifier(params = {}) ⇒ `Types::GetIdentityProviderByIdentifierResponse`

#get_signing_certificate(params = {}) ⇒ `Types::GetSigningCertificateResponse`

#get_ui_customization(params = {}) ⇒ `Types::GetUICustomizationResponse`

#get_user(params = {}) ⇒ `Types::GetUserResponse`

#get_user_attribute_verification_code(params = {}) ⇒ `Types::GetUserAttributeVerificationCodeResponse`

#get_user_pool_mfa_config(params = {}) ⇒ `Types::GetUserPoolMfaConfigResponse`

#global_sign_out(params = {}) ⇒ `Struct`

#initiate_auth(params = {}) ⇒ `Types::InitiateAuthResponse`

#list_devices(params = {}) ⇒ `Types::ListDevicesResponse`

#list_groups(params = {}) ⇒ `Types::ListGroupsResponse`

#list_identity_providers(params = {}) ⇒ `Types::ListIdentityProvidersResponse`

#list_resource_servers(params = {}) ⇒ `Types::ListResourceServersResponse`

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceResponse`

#list_user_import_jobs(params = {}) ⇒ `Types::ListUserImportJobsResponse`

#list_user_pool_clients(params = {}) ⇒ `Types::ListUserPoolClientsResponse`

#list_user_pools(params = {}) ⇒ `Types::ListUserPoolsResponse`

#list_users(params = {}) ⇒ `Types::ListUsersResponse`