« blib/lib/Paws/LicenseManager/CheckInLicenseResponse.pm
↑ Summary
blib/lib/Paws/LicenseManager/CheckoutBorrowLicenseResponse.pm »
| 1 | |||
| 2 | package Paws::LicenseManager::CheckoutBorrowLicense; | ||
| 3 | use Moose; | ||
| 4 | has CheckoutMetadata => (is => 'ro', isa => 'ArrayRef[Paws::LicenseManager::Metadata]'); | ||
| 5 | has ClientToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DigitalSignatureMethod => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Entitlements => (is => 'ro', isa => 'ArrayRef[Paws::LicenseManager::EntitlementData]', required => 1); | ||
| 8 | has LicenseArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has NodeId => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CheckoutBorrowLicense'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LicenseManager::CheckoutBorrowLicenseResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::LicenseManager::CheckoutBorrowLicense - Arguments for method CheckoutBorrowLicense on L<Paws::LicenseManager> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CheckoutBorrowLicense on the | ||
| 27 | L<AWS License Manager|Paws::LicenseManager> service. Use the attributes of this class | ||
| 28 | as arguments to method CheckoutBorrowLicense. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CheckoutBorrowLicense. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $license-manager = Paws->service('LicenseManager'); | ||
| 35 | my $CheckoutBorrowLicenseResponse = | ||
| 36 | $license -manager->CheckoutBorrowLicense( | ||
| 37 | ClientToken => 'MyClientToken', | ||
| 38 | DigitalSignatureMethod => 'JWT_PS384', | ||
| 39 | Entitlements => [ | ||
| 40 | { | ||
| 41 | Name => 'MyString', | ||
| 42 | Unit => 'Count' | ||
| 43 | , # values: Count, None, Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second | ||
| 44 | Value => 'MyString', | ||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], | ||
| 48 | LicenseArn => 'MyArn', | ||
| 49 | CheckoutMetadata => [ | ||
| 50 | { | ||
| 51 | Name => 'MyString', | ||
| 52 | Value => 'MyString', | ||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # OPTIONAL | ||
| 56 | NodeId => 'MyString', # OPTIONAL | ||
| 57 | ); | ||
| 58 | |||
| 59 | # Results: | ||
| 60 | my $CheckoutMetadata = $CheckoutBorrowLicenseResponse->CheckoutMetadata; | ||
| 61 | my $EntitlementsAllowed = | ||
| 62 | $CheckoutBorrowLicenseResponse->EntitlementsAllowed; | ||
| 63 | my $Expiration = $CheckoutBorrowLicenseResponse->Expiration; | ||
| 64 | my $IssuedAt = $CheckoutBorrowLicenseResponse->IssuedAt; | ||
| 65 | my $LicenseArn = $CheckoutBorrowLicenseResponse->LicenseArn; | ||
| 66 | my $LicenseConsumptionToken = | ||
| 67 | $CheckoutBorrowLicenseResponse->LicenseConsumptionToken; | ||
| 68 | my $NodeId = $CheckoutBorrowLicenseResponse->NodeId; | ||
| 69 | my $SignedToken = $CheckoutBorrowLicenseResponse->SignedToken; | ||
| 70 | |||
| 71 | # Returns a L<Paws::LicenseManager::CheckoutBorrowLicenseResponse> object. | ||
| 72 | |||
| 73 | 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. | ||
| 74 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/license-manager/CheckoutBorrowLicense> | ||
| 75 | |||
| 76 | =head1 ATTRIBUTES | ||
| 77 | |||
| 78 | |||
| 79 | =head2 CheckoutMetadata => ArrayRef[L<Paws::LicenseManager::Metadata>] | ||
| 80 | |||
| 81 | Information about constraints. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> ClientToken => Str | ||
| 86 | |||
| 87 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 88 | idempotency of the request. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> DigitalSignatureMethod => Str | ||
| 93 | |||
| 94 | Digital signature method. The possible value is JSON Web Signature | ||
| 95 | (JWS) algorithm PS384. For more information, see RFC 7518 Digital | ||
| 96 | Signature with RSASSA-PSS | ||
| 97 | (https://tools.ietf.org/html/rfc7518#section-3.5). | ||
| 98 | |||
| 99 | Valid values are: C<"JWT_PS384"> | ||
| 100 | |||
| 101 | =head2 B<REQUIRED> Entitlements => ArrayRef[L<Paws::LicenseManager::EntitlementData>] | ||
| 102 | |||
| 103 | License entitlements. Partial checkouts are not supported. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> LicenseArn => Str | ||
| 108 | |||
| 109 | Amazon Resource Name (ARN) of the license. The license must use the | ||
| 110 | borrow consumption configuration. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 NodeId => Str | ||
| 115 | |||
| 116 | Node ID. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, documenting arguments for method CheckoutBorrowLicense in L<Paws::LicenseManager> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 |