[ aws . license-manager ]

checkout-license

Description

Checks out the specified license.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  checkout-license
--product-sku <value>
--checkout-type <value>
--key-fingerprint <value>
--entitlements <value>
--client-token <value>
[--beneficiary <value>]
[--node-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--product-sku (string)

Product SKU.

--checkout-type (string)

Checkout type.

Possible values:

• PROVISIONAL

• PERPETUAL

--key-fingerprint (string)

Key fingerprint identifying the license.

--entitlements (list)

License entitlements.

(structure)

Data associated with an entitlement resource.

Name -> (string)

Entitlement data name.

Value -> (string)

Entitlement data value.

Unit -> (string)

Entitlement data unit.

Shorthand Syntax:

Name=string,Value=string,Unit=string ...

JSON Syntax:

[
  {
    "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"
  }
  ...
]

--client-token (string)

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

--beneficiary (string)

License beneficiary.

--node-id (string)

Node ID.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

CheckoutType -> (string)

Checkout type.

LicenseConsumptionToken -> (string)

License consumption token.

EntitlementsAllowed -> (list)

Allowed license entitlements.

(structure)

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.