« blib/lib/Paws/CognitoIdp/VerificationMessageTemplateType.pm
↑ Summary
blib/lib/Paws/CognitoIdp/VerifySoftwareTokenResponse.pm »
| 1 | |||
| 2 | package Paws::CognitoIdp::VerifySoftwareToken; | ||
| 3 | use Moose; | ||
| 4 | has AccessToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has FriendlyDeviceName => (is => 'ro', isa => 'Str'); | ||
| 6 | has Session => (is => 'ro', isa => 'Str'); | ||
| 7 | has UserCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'VerifySoftwareToken'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::VerifySoftwareTokenResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CognitoIdp::VerifySoftwareToken - Arguments for method VerifySoftwareToken on L<Paws::CognitoIdp> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method VerifySoftwareToken on the | ||
| 25 | L<Amazon Cognito Identity Provider|Paws::CognitoIdp> service. Use the attributes of this class | ||
| 26 | as arguments to method VerifySoftwareToken. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to VerifySoftwareToken. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $cognito-idp = Paws->service('CognitoIdp'); | ||
| 33 | my $VerifySoftwareTokenResponse = $cognito -idp->VerifySoftwareToken( | ||
| 34 | UserCode => 'MySoftwareTokenMFAUserCodeType', | ||
| 35 | AccessToken => 'MyTokenModelType', # OPTIONAL | ||
| 36 | FriendlyDeviceName => 'MyStringType', # OPTIONAL | ||
| 37 | Session => 'MySessionType', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $Session = $VerifySoftwareTokenResponse->Session; | ||
| 42 | my $Status = $VerifySoftwareTokenResponse->Status; | ||
| 43 | |||
| 44 | # Returns a L<Paws::CognitoIdp::VerifySoftwareTokenResponse> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/VerifySoftwareToken> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 AccessToken => Str | ||
| 53 | |||
| 54 | The access token. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 FriendlyDeviceName => Str | ||
| 59 | |||
| 60 | The friendly device name. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 Session => Str | ||
| 65 | |||
| 66 | The session which should be passed both ways in challenge-response | ||
| 67 | calls to the service. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> UserCode => Str | ||
| 72 | |||
| 73 | The one time password computed using the secret code returned by | ||
| 74 | AssociateSoftwareToken" | ||
| 75 | (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html). | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method VerifySoftwareToken in L<Paws::CognitoIdp> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |