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.

RespondToAuthChallengeInput

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

type RespondToAuthChallengeInput struct { AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` ChallengeName *string `type:"string" required:"true" enum:"ChallengeNameType"` ChallengeResponses map[string]*string `type:"map"` ClientId *string `min:"1" type:"string" required:"true" sensitive:"true"` Session *string `min:"20" type:"string"` UserContextData *UserContextDataType `type:"structure"` }

The request to respond to an authentication challenge.

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.

ChallengeName

Type: *string

The challenge name. For more information, see .

ADMIN_NO_SRP_AUTH is not a valid value.

ChallengeName is a required field

ChallengeResponses

Type: map[string]*string

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

  • SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).

ClientId

Type: *string

The app client ID.

ClientId is a required field

Session

Type: *string

The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

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.

Method

GoString

func (s RespondToAuthChallengeInput) GoString() string

GoString returns the string representation

SetAnalyticsMetadata

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

SetAnalyticsMetadata sets the AnalyticsMetadata field's value.

SetChallengeName

func (s *RespondToAuthChallengeInput) SetChallengeName(v string) *RespondToAuthChallengeInput

SetChallengeName sets the ChallengeName field's value.

SetChallengeResponses

func (s *RespondToAuthChallengeInput) SetChallengeResponses(v map[string]*string) *RespondToAuthChallengeInput

SetChallengeResponses sets the ChallengeResponses field's value.

SetClientId

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

SetClientId sets the ClientId field's value.

SetSession

func (s *RespondToAuthChallengeInput) SetSession(v string) *RespondToAuthChallengeInput

SetSession sets the Session field's value.

SetUserContextData

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

SetUserContextData sets the UserContextData field's value.

String

func (s RespondToAuthChallengeInput) String() string

String returns the string representation

Validate

func (s *RespondToAuthChallengeInput) Validate() error

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

On this page: