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.

ForgotPasswordInput

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

type ForgotPasswordInput struct { AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` ClientId *string `min:"1" 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"` }

Represents the request to reset a user's password.

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 ID of the client associated with the user pool.

ClientId 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 reset a forgotten password.

Username is a required field

Method

GoString

func (s ForgotPasswordInput) GoString() string

GoString returns the string representation

SetAnalyticsMetadata

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

SetAnalyticsMetadata sets the AnalyticsMetadata field's value.

SetClientId

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

SetClientId sets the ClientId field's value.

SetSecretHash

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

SetSecretHash sets the SecretHash field's value.

SetUserContextData

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

SetUserContextData sets the UserContextData field's value.

SetUsername

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

SetUsername sets the Username field's value.

String

func (s ForgotPasswordInput) String() string

String returns the string representation

Validate

func (s *ForgotPasswordInput) Validate() error

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

On this page: