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.

SignUpInput

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

type SignUpInput struct { AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` ClientId *string `min:"1" type:"string" required:"true" sensitive:"true"` Password *string `min:"6" type:"string" required:"true" sensitive:"true"` SecretHash *string `min:"1" type:"string" sensitive:"true"` UserAttributes []*AttributeType `type:"list"` UserContextData *UserContextDataType `type:"structure"` Username *string `min:"1" type:"string" required:"true" sensitive:"true"` ValidationData []*AttributeType `type:"list"` }

Represents the request to register 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 client associated with the user pool.

ClientId is a required field

Password

Type: *string

The password of the user you wish to register.

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.

UserAttributes

Specifies whether the attribute is standard or custom.

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 you wish to register.

Username is a required field

ValidationData

Specifies whether the attribute is standard or custom.

Method

GoString

func (s SignUpInput) GoString() string

GoString returns the string representation

SetAnalyticsMetadata

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

SetAnalyticsMetadata sets the AnalyticsMetadata field's value.

SetClientId

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

SetClientId sets the ClientId field's value.

SetPassword

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

SetPassword sets the Password field's value.

SetSecretHash

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

SetSecretHash sets the SecretHash field's value.

SetUserAttributes

func (s *SignUpInput) SetUserAttributes(v []*AttributeType) *SignUpInput

SetUserAttributes sets the UserAttributes field's value.

SetUserContextData

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

SetUserContextData sets the UserContextData field's value.

SetUsername

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

SetUsername sets the Username field's value.

SetValidationData

func (s *SignUpInput) SetValidationData(v []*AttributeType) *SignUpInput

SetValidationData sets the ValidationData field's value.

String

func (s SignUpInput) String() string

String returns the string representation

Validate

func (s *SignUpInput) Validate() error

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

On this page: