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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::SetUserSettingsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass SetUserSettingsRequest data as a 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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:access_token]

Instance Attribute Summary

• #access_token ⇒ String

  A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

• #mfa_options ⇒ Array<Types::MFAOptionType>

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

Instance Attribute Details

#access_token ⇒ String

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8393

class SetUserSettingsRequest < Struct.new(
  :access_token,
  :mfa_options)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#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>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8393

class SetUserSettingsRequest < Struct.new(
  :access_token,
  :mfa_options)
  SENSITIVE = [:access_token]
  include Aws::Structure
end