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.

AdminRespondToAuthChallengeInput

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

type AdminRespondToAuthChallengeInput 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"` ContextData *ContextDataType `type:"structure"` Session *string `min:"20" type:"string"` UserPoolId *string `min:"1" type:"string" required:"true"` }

The request to respond to the authentication challenge, as an administrator.

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 .

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).

  • ADMIN_NO_SRP_AUTH: PASSWORD, 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).

The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.

ClientId

Type: *string

The app client ID.

ClientId is a required field

ContextData

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

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.

UserPoolId

Type: *string

The ID of the Amazon Cognito user pool.

UserPoolId is a required field

Method

GoString

func (s AdminRespondToAuthChallengeInput) GoString() string

GoString returns the string representation

SetAnalyticsMetadata

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

SetAnalyticsMetadata sets the AnalyticsMetadata field's value.

SetChallengeName

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

SetChallengeName sets the ChallengeName field's value.

SetChallengeResponses

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

SetChallengeResponses sets the ChallengeResponses field's value.

SetClientId

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

SetClientId sets the ClientId field's value.

SetContextData

func (s *AdminRespondToAuthChallengeInput) SetContextData(v *ContextDataType) *AdminRespondToAuthChallengeInput

SetContextData sets the ContextData field's value.

SetSession

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

SetSession sets the Session field's value.

SetUserPoolId

func (s *AdminRespondToAuthChallengeInput) SetUserPoolId(v string) *AdminRespondToAuthChallengeInput

SetUserPoolId sets the UserPoolId field's value.

String

func (s AdminRespondToAuthChallengeInput) String() string

String returns the string representation

Validate

func (s *AdminRespondToAuthChallengeInput) Validate() error

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

On this page: