AWS License Manager

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates a grant for the specified license. A grant shares the use of license entitlements with a specific Amazon Web Services account, an organization, or an organizational unit (OU). For more information, see Granted licenses in License Manager in the License Manager User Guide.

See also: AWS API Documentation

Request Syntax

client.create_grant(
    ClientToken='string',
    GrantName='string',
    LicenseArn='string',
    Principals=[
        'string',
    ],
    HomeRegion='string',
    AllowedOperations=[
        'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

type GrantName:

string

param GrantName:

[REQUIRED]

Grant name.

type LicenseArn:

string

param LicenseArn:

[REQUIRED]

Amazon Resource Name (ARN) of the license.

type Principals:

list

param Principals:

[REQUIRED]

The grant principals. You can specify one of the following as an Amazon Resource Name (ARN):

• An Amazon Web Services account, which includes only the account specified.

• An organizational unit (OU), which includes all accounts in the OU.

• An organization, which will include all accounts across your organization.

• (string) --

type HomeRegion:

string

param HomeRegion:

[REQUIRED]

Home Region of the grant.

type AllowedOperations:

list

param AllowedOperations:

[REQUIRED]

Allowed operations for the grant.

• (string) --

type Tags:

list

param Tags:

Tags to add to the grant. For more information about tagging support in License Manager, see the TagResource operation.

• (dict) --

  Details about the tags for a resource. For more information about tagging support in License Manager, see the TagResource operation.

  • Key (string) --

    The tag key.

  • Value (string) --

    The tag value.

rtype:

dict

returns:

Response Syntax

{
    'GrantArn': 'string',
    'Status': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED',
    'Version': 'string'
}

Response Structure

• (dict) --

  • GrantArn (string) --

    Grant ARN.

  • Status (string) --

    Grant status.

  • Version (string) --

    Grant version.

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates a license.

See also: AWS API Documentation

Request Syntax

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',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type LicenseName:

string

param LicenseName:

[REQUIRED]

License name.

type ProductName:

string

param ProductName:

[REQUIRED]

Product name.

type ProductSKU:

string

param ProductSKU:

[REQUIRED]

Product SKU.

type Issuer:

dict

param Issuer:

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

type HomeRegion:

string

param HomeRegion:

[REQUIRED]

Home Region for the license.

type Validity:

dict

param Validity:

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

type Entitlements:

list

param Entitlements:

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

type Beneficiary:

string

param Beneficiary:

[REQUIRED]

License beneficiary.

type ConsumptionConfiguration:

dict

param ConsumptionConfiguration:

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

type LicenseMetadata:

list

param LicenseMetadata:

Information about the license.

• (dict) --

  Describes key/value pairs.

  • Name (string) --

    The key name.

  • Value (string) --

    The value.

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

type Tags:

list

param Tags:

Tags to add to the license. For more information about tagging support in License Manager, see the TagResource operation.

• (dict) --

  Details about the tags for a resource. For more information about tagging support in License Manager, see the TagResource operation.

  • Key (string) --

    The tag key.

  • Value (string) --

    The tag value.

rtype:

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.