LicenseManager / Client / checkout_license

checkout_license#

LicenseManager.Client.checkout_license(**kwargs)#

Checks out the specified license.

Note

If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.

Request Syntax

response = client.checkout_license(
    ProductSKU='string',
    CheckoutType='PROVISIONAL'|'PERPETUAL',
    KeyFingerprint='string',
    Entitlements=[
        {
            'Name': 'string',
            'Value': 'string',
            'Unit': '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'
        },
    ],
    ClientToken='string',
    Beneficiary='string',
    NodeId='string'
)

Parameters:

ProductSKU (string) –
[REQUIRED]

Product SKU.
CheckoutType (string) –
[REQUIRED]

Checkout type.
KeyFingerprint (string) –
[REQUIRED]

Key fingerprint identifying the license.
Entitlements (list) –
[REQUIRED]

License entitlements.
- (dict) –
  
  Data associated with an entitlement resource.
  - Name (string) – [REQUIRED]
    
    Entitlement data name.
  - Value (string) –
    
    Entitlement data value.
  - Unit (string) – [REQUIRED]
    
    Entitlement data unit.
ClientToken (string) –
[REQUIRED]

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Beneficiary (string) – License beneficiary.
NodeId (string) – Node ID.

Return type:

dict

Returns:

Response Syntax

{
    'CheckoutType': 'PROVISIONAL'|'PERPETUAL',
    'LicenseConsumptionToken': 'string',
    'EntitlementsAllowed': [
        {
            'Name': 'string',
            'Value': 'string',
            'Unit': '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'
        },
    ],
    'SignedToken': 'string',
    'NodeId': 'string',
    'IssuedAt': 'string',
    'Expiration': 'string',
    'LicenseArn': 'string'
}

Response Structure

(dict) –
- CheckoutType (string) –
  
  Checkout type.
- LicenseConsumptionToken (string) –
  
  License consumption token.
- EntitlementsAllowed (list) –
  
  Allowed license entitlements.
  - (dict) –
    
    Data associated with an entitlement resource.
    - Name (string) –
      
      Entitlement data name.
    - Value (string) –
      
      Entitlement data value.
    - Unit (string) –
      
      Entitlement data unit.
- SignedToken (string) –
  
  Signed token.
- NodeId (string) –
  
  Node ID.
- IssuedAt (string) –
  
  Date and time at which the license checkout is issued.
- Expiration (string) –
  
  Date and time at which the license checkout expires.
- LicenseArn (string) –
  
  Amazon Resource Name (ARN) of the checkout license.

Exceptions

LicenseManager.Client.exceptions.ValidationException
LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ResourceNotFoundException
LicenseManager.Client.exceptions.NoEntitlementsAllowedException
LicenseManager.Client.exceptions.UnsupportedDigitalSignatureMethodException
LicenseManager.Client.exceptions.RedirectException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException
LicenseManager.Client.exceptions.ServerInternalException