Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . license-manager ]

checkout-borrow-license

Description

Checks out the specified license for offline use.

See also: AWS API Documentation

Synopsis

  checkout-borrow-license
--license-arn <value>
--entitlements <value>
--digital-signature-method <value>
[--node-id <value>]
[--checkout-metadata <value>]
--client-token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--license-arn (string)

Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

--entitlements (list)

License entitlements. Partial checkouts are not supported.

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

--digital-signature-method (string)

Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS .

Possible values:

  • JWT_PS384

--node-id (string)

Node ID.

--checkout-metadata (list)

Information about constraints.

(structure)

Describes key/value pairs.

Name -> (string)

The key name.

Value -> (string)

The value.

Shorthand Syntax:

Name=string,Value=string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

--client-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

LicenseArn -> (string)

Amazon Resource Name (ARN) of the license.

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.

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.

(structure)

Describes key/value pairs.

Name -> (string)

The key name.

Value -> (string)

The value.