LicenseManager / Client / get_license

get_license#

LicenseManager.Client.get_license(**kwargs)#

Gets detailed information about the specified license.

See also: AWS API Documentation

Request Syntax

response = client.get_license(
    LicenseArn='string',
    Version='string'
)
Parameters:

  • LicenseArn (string) –

    [REQUIRED]

    Amazon Resource Name (ARN) of the license.

  • Version (string) – License version.

Return type:

dict

Returns:

Response Syntax

{
    'License': {
        'LicenseArn': 'string',
        'LicenseName': 'string',
        'ProductName': 'string',
        'ProductSKU': 'string',
        'Issuer': {
            'Name': 'string',
            'SignKey': 'string',
            'KeyFingerprint': 'string'
        },
        'HomeRegion': 'string',
        'Status': 'AVAILABLE'|'PENDING_AVAILABLE'|'DEACTIVATED'|'SUSPENDED'|'EXPIRED'|'PENDING_DELETE'|'DELETED',
        'Validity': {
            'Begin': 'string',
            'End': 'string'
        },
        'Beneficiary': 'string',
        'Entitlements': [
            {
                'Name': 'string',
                'Value': 'string',
                'MaxCount': 123,
                'Overage': True|False,
                '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',
                'AllowCheckIn': True|False
            },
        ],
        'ConsumptionConfiguration': {
            'RenewType': 'None'|'Weekly'|'Monthly',
            'ProvisionalConfiguration': {
                'MaxTimeToLiveInMinutes': 123
            },
            'BorrowConfiguration': {
                'AllowEarlyCheckIn': True|False,
                'MaxTimeToLiveInMinutes': 123
            }
        },
        'LicenseMetadata': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'CreateTime': 'string',
        'Version': 'string'
    }
}

Response Structure

  • (dict) –

    • License (dict) –

      License details.

      • LicenseArn (string) –

        Amazon Resource Name (ARN) of the license.

      • LicenseName (string) –

        License name.

      • ProductName (string) –

        Product name.

      • ProductSKU (string) –

        Product SKU.

      • Issuer (dict) –

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

      • Status (string) –

        License status.

      • Validity (dict) –

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

        • Begin (string) –

          Start of the time range.

        • End (string) –

          End of the time range.

      • Beneficiary (string) –

        License beneficiary.

      • Entitlements (list) –

        License entitlements.

        • (dict) –

          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 (integer) –

            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 (dict) –

        Configuration for consumption of the license.

        • RenewType (string) –

          Renewal frequency.

        • ProvisionalConfiguration (dict) –

          Details about a provisional configuration.

          • MaxTimeToLiveInMinutes (integer) –

            Maximum time for the provisional configuration, in minutes.

        • BorrowConfiguration (dict) –

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

        License metadata.

        • (dict) –

          Describes key/value pairs.

          • Name (string) –

            The key name.

          • Value (string) –

            The value.

      • CreateTime (string) –

        License creation time.

      • Version (string) –

        License version.

Exceptions