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.

ConfirmSignUpInput

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

type ConfirmSignUpInput struct { AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` ClientId *string `min:"1" type:"string" required:"true" sensitive:"true"` ConfirmationCode *string `min:"1" type:"string" required:"true"` ForceAliasCreation *bool `type:"boolean"` 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 confirm registration of a user.

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

ClientId is a required field

ConfirmationCode

Type: *string

The confirmation code sent by a user's request to confirm registration.

ConfirmationCode is a required field

ForceAliasCreation

Type: *bool

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

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 whose registration you wish to confirm.

Username is a required field

Method

GoString

func (s ConfirmSignUpInput) GoString() string

GoString returns the string representation

SetAnalyticsMetadata

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

SetAnalyticsMetadata sets the AnalyticsMetadata field's value.

SetClientId

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

SetClientId sets the ClientId field's value.

SetConfirmationCode

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

SetConfirmationCode sets the ConfirmationCode field's value.

SetForceAliasCreation

func (s *ConfirmSignUpInput) SetForceAliasCreation(v bool) *ConfirmSignUpInput

SetForceAliasCreation sets the ForceAliasCreation field's value.

SetSecretHash

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

SetSecretHash sets the SecretHash field's value.

SetUserContextData

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

SetUserContextData sets the UserContextData field's value.

SetUsername

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

SetUsername sets the Username field's value.

String

func (s ConfirmSignUpInput) String() string

String returns the string representation

Validate

func (s *ConfirmSignUpInput) Validate() error

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

On this page: