package Paws::CognitoIdp::AdminRespondToAuthChallenge; use Moose; has AnalyticsMetadata => (is => 'ro', isa => 'Paws::CognitoIdp::AnalyticsMetadataType'); has ChallengeName => (is => 'ro', isa => 'Str', required => 1); has ChallengeResponses => (is => 'ro', isa => 'Paws::CognitoIdp::ChallengeResponsesType'); has ClientId => (is => 'ro', isa => 'Str', required => 1); has ClientMetadata => (is => 'ro', isa => 'Paws::CognitoIdp::ClientMetadataType'); has ContextData => (is => 'ro', isa => 'Paws::CognitoIdp::ContextDataType'); has Session => (is => 'ro', isa => 'Str'); has UserPoolId => (is => 'ro', isa => 'Str', required => 1); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'AdminRespondToAuthChallenge'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::AdminRespondToAuthChallengeResponse'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::CognitoIdp::AdminRespondToAuthChallenge - Arguments for method AdminRespondToAuthChallenge on L =head1 DESCRIPTION This class represents the parameters used for calling the method AdminRespondToAuthChallenge on the L service. Use the attributes of this class as arguments to method AdminRespondToAuthChallenge. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AdminRespondToAuthChallenge. =head1 SYNOPSIS my $cognito-idp = Paws->service('CognitoIdp'); my $AdminRespondToAuthChallengeResponse = $cognito -idp->AdminRespondToAuthChallenge( ChallengeName => 'SMS_MFA', ClientId => 'MyClientIdType', UserPoolId => 'MyUserPoolIdType', AnalyticsMetadata => { AnalyticsEndpointId => 'MyStringType', # OPTIONAL }, # OPTIONAL ChallengeResponses => { 'MyStringType' => 'MyStringType', # key: OPTIONAL, value: OPTIONAL }, # OPTIONAL ClientMetadata => { 'MyStringType' => 'MyStringType', # key: OPTIONAL, value: OPTIONAL }, # OPTIONAL ContextData => { HttpHeaders => [ { HeaderName => 'MyStringType', # OPTIONAL HeaderValue => 'MyStringType', # OPTIONAL }, ... ], IpAddress => 'MyStringType', # OPTIONAL ServerName => 'MyStringType', # OPTIONAL ServerPath => 'MyStringType', # OPTIONAL EncodedData => 'MyStringType', # OPTIONAL }, # OPTIONAL Session => 'MySessionType', # OPTIONAL ); # Results: my $AuthenticationResult = $AdminRespondToAuthChallengeResponse->AuthenticationResult; my $ChallengeName = $AdminRespondToAuthChallengeResponse->ChallengeName; my $ChallengeParameters = $AdminRespondToAuthChallengeResponse->ChallengeParameters; my $Session = $AdminRespondToAuthChallengeResponse->Session; # Returns a L object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see L =head1 ATTRIBUTES =head2 AnalyticsMetadata => L The analytics metadata for collecting Amazon Pinpoint metrics for C calls. =head2 B ChallengeName => Str The challenge name. For more information, see AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html). Valid values are: C<"SMS_MFA">, C<"SOFTWARE_TOKEN_MFA">, C<"SELECT_MFA_TYPE">, C<"MFA_SETUP">, C<"PASSWORD_VERIFIER">, C<"CUSTOM_CHALLENGE">, C<"DEVICE_SRP_AUTH">, C<"DEVICE_PASSWORD_VERIFIER">, C<"ADMIN_NO_SRP_AUTH">, C<"NEW_PASSWORD_REQUIRED"> =head2 ChallengeResponses => L The challenge responses. These are inputs corresponding to the value of C, for example: =over =item * C: C, C, C (if app client is configured with client secret). =item * C: C, C, C, C, C (if app client is configured with client secret). =item * C: C, C, C (if app client is configured with client secret). =item * C: C, any other required attributes, C, C (if app client is configured with client secret). =item * C requires C, plus you need to use the session value returned by C in the C parameter. =back The value of the C attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the C response includes the actual username value in the C attribute, even if you specified an alias in your call to C. =head2 B ClientId => Str The app client ID. =head2 ClientMetadata => L A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: I

, I, I,
I, I, I,
I, and I. When
Amazon Cognito invokes any of these functions, it passes a JSON
payload, which the function receives as input. This payload contains a
C attribute, which provides the data that you assigned
to the ClientMetadata parameter in your AdminRespondToAuthChallenge
request. In your function code in AWS Lambda, you can process the
C value to enhance your workflow for your specific
needs.

For more information, see Customizing User Pool Workflows with Lambda
Triggers
(https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
in the I.

Take the following limitations into consideration when you use the
ClientMetadata parameter:

=over

=item *

Amazon Cognito does not store the ClientMetadata value. This data is
available only to AWS Lambda triggers that are assigned to a user pool
to support custom workflows. If your user pool configuration does not
include triggers, the ClientMetadata parameter serves no purpose.

=item *

Amazon Cognito does not validate the ClientMetadata value.

=item *

Amazon Cognito does not encrypt the the ClientMetadata value, so don't
use it to provide sensitive information.

=back




=head2 ContextData => L

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.



=head2 Session => Str

The session which should be passed both ways in challenge-response
calls to the service. If C or C
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 C
API call.



=head2 B UserPoolId => Str

The ID of the Amazon Cognito user pool.




=head1 SEE ALSO

This class forms part of L, documenting arguments for method AdminRespondToAuthChallenge in L

=head1 BUGS and CONTRIBUTIONS

The source code is located here: L

Please report bugs to: L

=cut