You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::SetUserSettingsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SetUserSettingsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  access_token: "TokenModelType", # required
  mfa_options: [ # required
    {
      delivery_medium: "SMS", # accepts SMS, EMAIL
      attribute_name: "AttributeNameType",
    },
  ],
}

Represents the request to set user settings.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

The access token for the set user settings request.

Returns:

  • (String) —

    The access token for the set user settings request.

#mfa_options ⇒ Array<Types::MFAOptionType>

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

Returns:

  • (Array<Types::MFAOptionType>) —

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