Class: Aws::CognitoIdentityProvider::Types::CodeDeliveryDetailsType

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

Overview

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

This data type is a response parameter of operations that send a code for user profile confirmation, verification, or management, for example [ForgotPassword] and [SignUp].

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_name ⇒ String

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

Returns:

  • (String) 


2995
2996
2997
2998
2999
3000
3001
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2995

class CodeDeliveryDetailsType < Struct.new(
  :destination,
  :delivery_medium,
  :attribute_name)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_medium ⇒ String

The method that Amazon Cognito used to send the code.

Returns:

  • (String) 


2995
2996
2997
2998
2999
3000
3001
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2995

class CodeDeliveryDetailsType < Struct.new(
  :destination,
  :delivery_medium,
  :attribute_name)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ String

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

Returns:

  • (String) 


2995
2996
2997
2998
2999
3000
3001
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2995

class CodeDeliveryDetailsType < Struct.new(
  :destination,
  :delivery_medium,
  :attribute_name)
  SENSITIVE = []
  include Aws::Structure
end