« blib/lib/Paws/LicenseManager/CreateLicenseVersionResponse.pm
↑ Summary
blib/lib/Paws/LicenseManager/CreateTokenResponse.pm »
| 1 | |||
| 2 | package Paws::LicenseManager::CreateToken; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ExpirationInDays => (is => 'ro', isa => 'Int'); | ||
| 6 | has LicenseArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has RoleArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has TokenProperties => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateToken'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LicenseManager::CreateTokenResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::LicenseManager::CreateToken - Arguments for method CreateToken on L<Paws::LicenseManager> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateToken on the | ||
| 26 | L<AWS License Manager|Paws::LicenseManager> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateToken. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateToken. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $license-manager = Paws->service('LicenseManager'); | ||
| 34 | my $CreateTokenResponse = $license -manager->CreateToken( | ||
| 35 | ClientToken => 'MyClientToken', | ||
| 36 | LicenseArn => 'MyArn', | ||
| 37 | ExpirationInDays => 1, # OPTIONAL | ||
| 38 | RoleArns => [ | ||
| 39 | 'MyArn', ... # max: 2048 | ||
| 40 | ], # OPTIONAL | ||
| 41 | TokenProperties => [ 'MyString', ... ], # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $Token = $CreateTokenResponse->Token; | ||
| 46 | my $TokenId = $CreateTokenResponse->TokenId; | ||
| 47 | my $TokenType = $CreateTokenResponse->TokenType; | ||
| 48 | |||
| 49 | # Returns a L<Paws::LicenseManager::CreateTokenResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/license-manager/CreateToken> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ClientToken => Str | ||
| 58 | |||
| 59 | Idempotency token, valid for 10 minutes. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 ExpirationInDays => Int | ||
| 64 | |||
| 65 | Token expiration, in days, counted from token creation. The default is | ||
| 66 | 365 days. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> LicenseArn => Str | ||
| 71 | |||
| 72 | Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud | ||
| 73 | claim of the JWT token. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 RoleArns => ArrayRef[Str|Undef] | ||
| 78 | |||
| 79 | Amazon Resource Name (ARN) of the IAM roles to embed in the token. | ||
| 80 | License Manager does not check whether the roles are in use. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 TokenProperties => ArrayRef[Str|Undef] | ||
| 85 | |||
| 86 | Data specified by the caller to be included in the JWT token. The data | ||
| 87 | is mapped to the amr claim of the JWT token. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, documenting arguments for method CreateToken in L<Paws::LicenseManager> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |