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

Class: Aws::CognitoIdentityProvider::Types::ConfirmForgotPasswordRequest

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

Overview

Note:

When making an API call, you may pass ConfirmForgotPasswordRequest data as a hash:

{
  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: {
    encoded_data: "StringType",
  },
}

The request representing the confirmation for a password reset.

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadataTypes::AnalyticsMetadataType

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.



2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2168

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#client_idString

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

Returns:

  • (String)


2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2168

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#confirmation_codeString

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

Returns:

  • (String)


2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2168

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#passwordString

The password sent by a user's request to retrieve a forgotten password.

Returns:

  • (String)


2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2168

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#secret_hashString

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.

Returns:

  • (String)


2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2168

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#user_context_dataTypes::UserContextDataType

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.



2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2168

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#usernameString

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Returns:

  • (String)


2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2168

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end