AWS License Manager

{'LicenseArn': 'string'}

Checks out the specified license.

See also: AWS API Documentation

Request Syntax

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'
)

type ProductSKU

string

param ProductSKU

[REQUIRED]

Product SKU.

type CheckoutType

string

param CheckoutType

[REQUIRED]

Checkout type.

type KeyFingerprint

string

param KeyFingerprint

[REQUIRED]

Key fingerprint identifying the license.

type Entitlements

list

param Entitlements

[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.

type ClientToken

string

param ClientToken

[REQUIRED]

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

type Beneficiary

string

param Beneficiary

License beneficiary.

type NodeId

string

param NodeId

Node ID.

rtype

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.