LicenseManager / Client / checkout_borrow_license

checkout_borrow_license#

LicenseManager.Client.checkout_borrow_license(**kwargs)#

Checks out the specified license for offline use.

Request Syntax

response = client.checkout_borrow_license(
    LicenseArn='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'
        },
    ],
    DigitalSignatureMethod='JWT_PS384',
    NodeId='string',
    CheckoutMetadata=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

Parameters:

LicenseArn (string) –
[REQUIRED]

Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.
Entitlements (list) –
[REQUIRED]

License entitlements. Partial checkouts are not supported.
- (dict) –
  
  Data associated with an entitlement resource.
  - Name (string) – [REQUIRED]
    
    Entitlement data name.
  - Value (string) –
    
    Entitlement data value.
  - Unit (string) – [REQUIRED]
    
    Entitlement data unit.
DigitalSignatureMethod (string) –
[REQUIRED]

Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.
NodeId (string) – Node ID.
CheckoutMetadata (list) –
Information about constraints.
- (dict) –
  
  Describes key/value pairs.
  - Name (string) –
    
    The key name.
  - Value (string) –
    
    The value.
ClientToken (string) –
[REQUIRED]

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Return type:

dict

Returns:

Response Syntax

{
    'LicenseArn': 'string',
    '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'
        },
    ],
    'NodeId': 'string',
    'SignedToken': 'string',
    'IssuedAt': 'string',
    'Expiration': 'string',
    'CheckoutMetadata': [
        {
            'Name': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) –
- LicenseArn (string) –
  
  Amazon Resource Name (ARN) of the license.
- 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.
- NodeId (string) –
  
  Node ID.
- SignedToken (string) –
  
  Signed token.
- IssuedAt (string) –
  
  Date and time at which the license checkout is issued.
- Expiration (string) –
  
  Date and time at which the license checkout expires.
- CheckoutMetadata (list) –
  
  Information about constraints.
  - (dict) –
    
    Describes key/value pairs.
    - Name (string) –
      
      The key name.
    - Value (string) –
      
      The value.

Exceptions

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