Class: Aws::CognitoIdentityProvider::Types::VerifyUserAttributeRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the request to verify user attributes.

Constant Summary collapse

SENSITIVE =
[:access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Returns:

  • (String)


13319
13320
13321
13322
13323
13324
13325
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 13319

class VerifyUserAttributeRequest < Struct.new(
  :access_token,
  :attribute_name,
  :code)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#attribute_nameString

The name of the attribute that you want to verify.

Returns:

  • (String)


13319
13320
13321
13322
13323
13324
13325
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 13319

class VerifyUserAttributeRequest < Struct.new(
  :access_token,
  :attribute_name,
  :code)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#codeString

The verification code that your user pool sent to the added or changed attribute, for example the user's email address.

Returns:

  • (String)


13319
13320
13321
13322
13323
13324
13325
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 13319

class VerifyUserAttributeRequest < Struct.new(
  :access_token,
  :attribute_name,
  :code)
  SENSITIVE = [:access_token]
  include Aws::Structure
end