AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ConfirmForgotPasswordInput

import "github.com/aws/aws-sdk-go/service/cognitoidentityprovider"

type ConfirmForgotPasswordInput struct { AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` ClientId *string `min:"1" type:"string" required:"true" sensitive:"true"` ConfirmationCode *string `min:"1" type:"string" required:"true"` Password *string `min:"6" type:"string" required:"true" sensitive:"true"` SecretHash *string `min:"1" type:"string" sensitive:"true"` UserContextData *UserContextDataType `type:"structure"` Username *string `min:"1" type:"string" required:"true" sensitive:"true"` }

The request representing the confirmation for a password reset.

AnalyticsMetadata

An Amazon Pinpoint analytics endpoint.

An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.

ClientId

Type: *string

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

ClientId is a required field

ConfirmationCode

Type: *string

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

ConfirmationCode is a required field

Password

Type: *string

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

Password is a required field

SecretHash

Type: *string

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.

UserContextData

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.

Username

Type: *string

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

Username is a required field

Method

GoString

func (s ConfirmForgotPasswordInput) GoString() string

GoString returns the string representation

SetAnalyticsMetadata

func (s *ConfirmForgotPasswordInput) SetAnalyticsMetadata(v *AnalyticsMetadataType) *ConfirmForgotPasswordInput

SetAnalyticsMetadata sets the AnalyticsMetadata field's value.

SetClientId

func (s *ConfirmForgotPasswordInput) SetClientId(v string) *ConfirmForgotPasswordInput

SetClientId sets the ClientId field's value.

SetConfirmationCode

func (s *ConfirmForgotPasswordInput) SetConfirmationCode(v string) *ConfirmForgotPasswordInput

SetConfirmationCode sets the ConfirmationCode field's value.

SetPassword

func (s *ConfirmForgotPasswordInput) SetPassword(v string) *ConfirmForgotPasswordInput

SetPassword sets the Password field's value.

SetSecretHash

func (s *ConfirmForgotPasswordInput) SetSecretHash(v string) *ConfirmForgotPasswordInput

SetSecretHash sets the SecretHash field's value.

SetUserContextData

func (s *ConfirmForgotPasswordInput) SetUserContextData(v *UserContextDataType) *ConfirmForgotPasswordInput

SetUserContextData sets the UserContextData field's value.

SetUsername

func (s *ConfirmForgotPasswordInput) SetUsername(v string) *ConfirmForgotPasswordInput

SetUsername sets the Username field's value.

String

func (s ConfirmForgotPasswordInput) String() string

String returns the string representation

Validate

func (s *ConfirmForgotPasswordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: