LicenseManager / Client / create_license

create_license

LicenseManager.Client.create_license(**kwargs)

Creates a license.

See also: AWS API Documentation

Request Syntax

response = client.create_license(
    LicenseName='string',
    ProductName='string',
    ProductSKU='string',
    Issuer={
        'Name': 'string',
        'SignKey': 'string'
    },
    HomeRegion='string',
    Validity={
        'Begin': 'string',
        'End': '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
        },
    ],
    Beneficiary='string',
    ConsumptionConfiguration={
        'RenewType': 'None'|'Weekly'|'Monthly',
        'ProvisionalConfiguration': {
            'MaxTimeToLiveInMinutes': 123
        },
        'BorrowConfiguration': {
            'AllowEarlyCheckIn': True|False,
            'MaxTimeToLiveInMinutes': 123
        }
    },
    LicenseMetadata=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

Parameters:

• LicenseName (string) –

  [REQUIRED]

  License name.

• ProductName (string) –

  [REQUIRED]

  Product name.

• ProductSKU (string) –

  [REQUIRED]

  Product SKU.

• Issuer (dict) –

  [REQUIRED]

  License issuer.

  • Name (string) – [REQUIRED]

    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.

• HomeRegion (string) –

  [REQUIRED]

  Home Region for the license.

• Validity (dict) –

  [REQUIRED]

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

  • Begin (string) – [REQUIRED]

    Start of the time range.

  • End (string) –

    End of the time range.

• Entitlements (list) –

  [REQUIRED]

  License entitlements.

  • (dict) –

    Describes a resource entitled for use with a license.

    • Name (string) – [REQUIRED]

      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) – [REQUIRED]

      Entitlement unit.

    • AllowCheckIn (boolean) –

      Indicates whether check-ins are allowed.

• Beneficiary (string) –

  [REQUIRED]

  License beneficiary.

• ConsumptionConfiguration (dict) –

  [REQUIRED]

  Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

  • RenewType (string) –

    Renewal frequency.

  • ProvisionalConfiguration (dict) –

    Details about a provisional configuration.

    • MaxTimeToLiveInMinutes (integer) – [REQUIRED]

      Maximum time for the provisional configuration, in minutes.

  • BorrowConfiguration (dict) –

    Details about a borrow configuration.

    • AllowEarlyCheckIn (boolean) – [REQUIRED]

      Indicates whether early check-ins are allowed.

    • MaxTimeToLiveInMinutes (integer) – [REQUIRED]

      Maximum time for the borrow configuration, in minutes.

• LicenseMetadata (list) –

  Information about the license.

  • (dict) –

    Describes key/value pairs.

    • Name (string) –

      The key name.

    • Value (string) –

      The value.

• ClientToken (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'LicenseArn': 'string',
    'Status': 'AVAILABLE'|'PENDING_AVAILABLE'|'DEACTIVATED'|'SUSPENDED'|'EXPIRED'|'PENDING_DELETE'|'DELETED',
    'Version': 'string'
}

Response Structure

• (dict) –

  • LicenseArn (string) –

    Amazon Resource Name (ARN) of the license.

  • Status (string) –

    License status.

  • Version (string) –

    License version.

Exceptions

• LicenseManager.Client.exceptions.ValidationException

• LicenseManager.Client.exceptions.InvalidParameterValueException

• LicenseManager.Client.exceptions.RedirectException

• LicenseManager.Client.exceptions.AuthorizationException

• LicenseManager.Client.exceptions.AccessDeniedException

• LicenseManager.Client.exceptions.RateLimitExceededException

• LicenseManager.Client.exceptions.ServerInternalException