[ aws . license-manager ]

list-received-licenses

Description

Lists received licenses.

See also: AWS API Documentation

Synopsis

  list-received-licenses
[--license-arns <value>]
[--filters <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--license-arns (list)

Amazon Resource Names (ARNs) of the licenses.

(string)

Syntax:

"string" "string" ...

--filters (list)

Filters to scope the results. The following filters are supported:

  • ProductSKU

  • Status

  • Fingerprint

  • IssuerName

  • Beneficiary

(structure)

A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

Name -> (string)

Name of the filter. Filter names are case-sensitive.

Values -> (list)

Filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

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

--next-token (string)

Token for the next set of results.

--max-results (integer)

Maximum number of results to return in a single call.

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

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

  • yaml

  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64

  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Licenses -> (list)

Received license details.

(structure)

Describes a license that is granted to a grantee.

LicenseArn -> (string)

Amazon Resource Name (ARN) of the license.

LicenseName -> (string)

License name.

ProductName -> (string)

Product name.

ProductSKU -> (string)

Product SKU.

Issuer -> (structure)

Granted license issuer.

Name -> (string)

Issuer name.

SignKey -> (string)

Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

KeyFingerprint -> (string)

Issuer key fingerprint.

HomeRegion -> (string)

Home Region of the granted license.

Status -> (string)

Granted license status.

Validity -> (structure)

Date and time range during which the granted license is valid, in ISO8601-UTC format.

Begin -> (string)

Start of the time range.

End -> (string)

End of the time range.

Beneficiary -> (string)

Granted license beneficiary.

Entitlements -> (list)

License entitlements.

(structure)

Describes a resource entitled for use with a license.

Name -> (string)

Entitlement name.

Value -> (string)

Entitlement resource. Use only if the unit is None.

MaxCount -> (long)

Maximum entitlement count. Use if the unit is not None.

Overage -> (boolean)

Indicates whether overages are allowed.

Unit -> (string)

Entitlement unit.

AllowCheckIn -> (boolean)

Indicates whether check-ins are allowed.

ConsumptionConfiguration -> (structure)

Configuration for consumption of the license.

RenewType -> (string)

Renewal frequency.

ProvisionalConfiguration -> (structure)

Details about a provisional configuration.

MaxTimeToLiveInMinutes -> (integer)

Maximum time for the provisional configuration, in minutes.

BorrowConfiguration -> (structure)

Details about a borrow configuration.

AllowEarlyCheckIn -> (boolean)

Indicates whether early check-ins are allowed.

MaxTimeToLiveInMinutes -> (integer)

Maximum time for the borrow configuration, in minutes.

LicenseMetadata -> (list)

Granted license metadata.

(structure)

Describes key/value pairs.

Name -> (string)

The key name.

Value -> (string)

The value.

CreateTime -> (string)

Creation time of the granted license.

Version -> (string)

Version of the granted license.

ReceivedMetadata -> (structure)

Granted license received metadata.

ReceivedStatus -> (string)

Received status.

ReceivedStatusReason -> (string)

Received status reason.

AllowedOperations -> (list)

Allowed operations.

(string)

NextToken -> (string)

Token for the next set of results.