AWS API Changes

2020/12/03 - AWS License Manager - 24 new api methods

Changes AWS License Manager enables managed entitlements for AWS customers and Software Vendors (ISV). You can track and distribute license entitlements from AWS Marketplace and supported ISVs.

CheckoutLicense (new)

Link ¶

Checks out the specified license.

See also: AWS API Documentation

Request Syntax

client.checkout_license(
    ProductSKU='string',
    CheckoutType='PROVISIONAL',
    KeyFingerprint='string',
    Entitlements=[
        {
            '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'
        },
    ],
    ClientToken='string',
    Beneficiary='string',
    NodeId='string'
)

type ProductSKU

string

param ProductSKU

[REQUIRED]

Product SKU.

type CheckoutType

string

param CheckoutType

[REQUIRED]

Checkout type.

type KeyFingerprint

string

param KeyFingerprint

[REQUIRED]

Key fingerprint identifying the license.

type Entitlements

list

param Entitlements

[REQUIRED]

License entitlements.

(dict) --

Data associated with an entitlement resource.
- Name (string) -- [REQUIRED]
  
  Entitlement data name.
- Value (string) --
  
  Entitlement data value.
- Unit (string) -- [REQUIRED]
  
  Entitlement data unit.

type ClientToken

string

param ClientToken

[REQUIRED]

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

type Beneficiary

string

param Beneficiary

License beneficiary.

type NodeId

string

param NodeId

Node ID.

rtype

dict

returns

Response Syntax

{
    'CheckoutType': 'PROVISIONAL',
    'LicenseConsumptionToken': 'string',
    'EntitlementsAllowed': [
        {
            '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'
        },
    ],
    'SignedToken': 'string',
    'NodeId': 'string',
    'IssuedAt': 'string',
    'Expiration': 'string'
}

Response Structure

(dict) --
- CheckoutType (string) --
  
  Checkout type.
- LicenseConsumptionToken (string) --
  
  License consumption token.
- EntitlementsAllowed (list) --
  
  Allowed license entitlements.
  - (dict) --
    
    Data associated with an entitlement resource.
    - Name (string) --
      
      Entitlement data name.
    - Value (string) --
      
      Entitlement data value.
    - Unit (string) --
      
      Entitlement data unit.
- SignedToken (string) --
  
  Signed token.
- NodeId (string) --
  
  Node ID.
- IssuedAt (string) --
  
  Date and time at which the license checkout is issued.
- Expiration (string) --
  
  Date and time at which the license checkout expires.

ListLicenseVersions (new)

Link ¶

Lists all versions of the specified license.

See also: AWS API Documentation

Request Syntax

client.list_license_versions(
    LicenseArn='string',
    NextToken='string',
    MaxResults=123
)

type LicenseArn

string

param LicenseArn

[REQUIRED]

Amazon Resource Name (ARN) of the license.

type NextToken

string

param NextToken

Token for the next set of results.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

rtype

dict

returns

Response Syntax

{
    'Licenses': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Licenses (list) --
  
  License details.
  - (dict) --
    
    Software license that is managed in AWS License Manager.
    - 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 CMK from AWS Key Management Service. The CMK 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.
- NextToken (string) --
  
  Token for the next set of results.

DeleteToken (new)

Link ¶

Deletes the specified token. Must be called in the license home Region.

See also: AWS API Documentation

Request Syntax

client.delete_token(
    TokenId='string'
)

type TokenId

string

param TokenId

[REQUIRED]

Token ID.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CheckoutBorrowLicense (new)

Link ¶

Checks out the specified license for offline use.

See also: AWS API Documentation

Request Syntax

client.checkout_borrow_license(
    LicenseArn='string',
    Entitlements=[
        {
            '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'
        },
    ],
    DigitalSignatureMethod='JWT_PS384',
    NodeId='string',
    CheckoutMetadata=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

type LicenseArn

string

param LicenseArn

[REQUIRED]

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

type Entitlements

list

param Entitlements

[REQUIRED]

License entitlements. Partial checkouts are not supported.

(dict) --

Data associated with an entitlement resource.
- Name (string) -- [REQUIRED]
  
  Entitlement data name.
- Value (string) --
  
  Entitlement data value.
- Unit (string) -- [REQUIRED]
  
  Entitlement data unit.

type DigitalSignatureMethod

string

param DigitalSignatureMethod

[REQUIRED]

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

type NodeId

string

param NodeId

Node ID.

type CheckoutMetadata

list

param CheckoutMetadata

Information about constraints.

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

rtype

dict

returns

Response Syntax

{
    'LicenseArn': 'string',
    'LicenseConsumptionToken': 'string',
    'EntitlementsAllowed': [
        {
            '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'
        },
    ],
    'NodeId': 'string',
    'SignedToken': 'string',
    'IssuedAt': 'string',
    'Expiration': 'string',
    'CheckoutMetadata': [
        {
            'Name': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- LicenseArn (string) --
  
  Amazon Resource Name (ARN) of the license.
- LicenseConsumptionToken (string) --
  
  License consumption token.
- EntitlementsAllowed (list) --
  
  Allowed license entitlements.
  - (dict) --
    
    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.
  - (dict) --
    
    Describes key/value pairs.
    - Name (string) --
      
      The key name.
    - Value (string) --
      
      The value.

GetGrant (new)

Link ¶

Gets detailed information about the specified grant.

See also: AWS API Documentation

Request Syntax

client.get_grant(
    GrantArn='string',
    Version='string'
)

type GrantArn

string

param GrantArn

[REQUIRED]

Amazon Resource Name (ARN) of the grant.

type Version

string

param Version

Grant version.

rtype

dict

returns

Response Syntax

{
    'Grant': {
        'GrantArn': 'string',
        'GrantName': 'string',
        'ParentArn': 'string',
        'LicenseArn': 'string',
        'GranteePrincipalArn': 'string',
        'HomeRegion': 'string',
        'GrantStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
        'StatusReason': 'string',
        'Version': 'string',
        'GrantedOperations': [
            'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
        ]
    }
}

Response Structure

(dict) --
- Grant (dict) --
  
  Grant details.
  - GrantArn (string) --
    
    Amazon Resource Name (ARN) of the grant.
  - GrantName (string) --
    
    Grant name.
  - ParentArn (string) --
    
    Parent ARN.
  - LicenseArn (string) --
    
    License ARN.
  - GranteePrincipalArn (string) --
    
    The grantee principal ARN.
  - HomeRegion (string) --
    
    Home Region of the grant.
  - GrantStatus (string) --
    
    Grant status.
  - StatusReason (string) --
    
    Grant status reason.
  - Version (string) --
    
    Grant version.
  - GrantedOperations (list) --
    
    Granted operations.
    - (string) --

CheckInLicense (new)

Link ¶

Checks in the specified license. Check in a license when it is no longer in use.

See also: AWS API Documentation

Request Syntax

client.check_in_license(
    LicenseConsumptionToken='string',
    Beneficiary='string'
)

type LicenseConsumptionToken

string

param LicenseConsumptionToken

[REQUIRED]

License consumption token.

type Beneficiary

string

param Beneficiary

License beneficiary.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListLicenses (new)

Link ¶

Lists the licenses for your account.

See also: AWS API Documentation

Request Syntax

client.list_licenses(
    LicenseArns=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

type LicenseArns

list

param LicenseArns

Amazon Resource Names (ARNs) of the licenses.

(string) --

type Filters

list

param Filters

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

Beneficiary
ProductSKU
KeyFingerprint
Status

(dict) --

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

type NextToken

string

param NextToken

Token for the next set of results.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

rtype

dict

returns

Response Syntax

{
    'Licenses': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Licenses (list) --
  
  License details.
  - (dict) --
    
    Software license that is managed in AWS License Manager.
    - 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 CMK from AWS Key Management Service. The CMK 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.
- NextToken (string) --
  
  Token for the next set of results.

ExtendLicenseConsumption (new)

Link ¶

Extends the expiration date for license consumption.

See also: AWS API Documentation

Request Syntax

client.extend_license_consumption(
    LicenseConsumptionToken='string',
    DryRun=True|False
)

type LicenseConsumptionToken

string

param LicenseConsumptionToken

[REQUIRED]

License consumption token.

type DryRun

boolean

param DryRun

Checks whether you have the required permissions for the action, without actually making the request. Provides an error response if you do not have the required permissions.

rtype

dict

returns

Response Syntax

{
    'LicenseConsumptionToken': 'string',
    'Expiration': 'string'
}

Response Structure

(dict) --
- LicenseConsumptionToken (string) --
  
  License consumption token.
- Expiration (string) --
  
  Date and time at which the license consumption expires.

CreateGrantVersion (new)

Link ¶

Creates a new version of the specified grant.

See also: AWS API Documentation

Request Syntax

client.create_grant_version(
    ClientToken='string',
    GrantArn='string',
    GrantName='string',
    AllowedOperations=[
        'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
    ],
    Status='PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
    SourceVersion='string'
)

type ClientToken

string

param ClientToken

[REQUIRED]

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

type GrantArn

string

param GrantArn

[REQUIRED]

Amazon Resource Name (ARN) of the grant.

type GrantName

string

param GrantName

Grant name.

type AllowedOperations

list

param AllowedOperations

Allowed operations for the grant.

(string) --

type Status

string

param Status

Grant status.

type SourceVersion

string

param SourceVersion

Current version of the grant.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- GrantArn (string) --
  
  Grant ARN.
- Status (string) --
  
  Grant status.
- Version (string) --
  
  New version of the grant.

CreateLicenseVersion (new)

Link ¶

Creates a new version of the specified license.

See also: AWS API Documentation

Request Syntax

client.create_license_version(
    LicenseArn='string',
    LicenseName='string',
    ProductName='string',
    Issuer={
        'Name': 'string',
        'SignKey': 'string'
    },
    HomeRegion='string',
    Validity={
        'Begin': 'string',
        'End': 'string'
    },
    LicenseMetadata=[
        {
            'Name': 'string',
            'Value': '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
        }
    },
    Status='AVAILABLE'|'PENDING_AVAILABLE'|'DEACTIVATED'|'SUSPENDED'|'EXPIRED'|'PENDING_DELETE'|'DELETED',
    ClientToken='string',
    SourceVersion='string'
)

type LicenseArn

string

param LicenseArn

[REQUIRED]

Amazon Resource Name (ARN) of the license.

type LicenseName

string

param LicenseName

[REQUIRED]

License name.

type ProductName

string

param ProductName

[REQUIRED]

Product name.

type Issuer

dict

param Issuer

[REQUIRED]

License issuer.

Name (string) -- [REQUIRED]

Issuer name.
SignKey (string) --

Asymmetric CMK from AWS Key Management Service. The CMK 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 of 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 LicenseMetadata

list

param LicenseMetadata

Information about the license.

(dict) --

Describes key/value pairs.
- Name (string) --
  
  The key name.
- Value (string) --
  
  The value.

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

string

param Status

[REQUIRED]

License status.

type ClientToken

string

param ClientToken

[REQUIRED]

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

type SourceVersion

string

param SourceVersion

Current version of the license.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- LicenseArn (string) --
  
  License ARN.
- Version (string) --
  
  New version of the license.
- Status (string) --
  
  License status.

AcceptGrant (new)

Link ¶

Accepts the specified grant.

See also: AWS API Documentation

Request Syntax

client.accept_grant(
    GrantArn='string'
)

type GrantArn

string

param GrantArn

[REQUIRED]

Amazon Resource Name (ARN) of the grant.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- GrantArn (string) --
  
  Grant ARN.
- Status (string) --
  
  Grant status.
- Version (string) --
  
  Grant version.

ListReceivedGrants (new)

Link ¶

Lists grants that are received but not accepted.

See also: AWS API Documentation

Request Syntax

client.list_received_grants(
    GrantArns=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

type GrantArns

list

param GrantArns

Amazon Resource Names (ARNs) of the grants.

(string) --

type Filters

list

param Filters

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

LicenseARN
Status

(dict) --

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

type NextToken

string

param NextToken

Token for the next set of results.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

rtype

dict

returns

Response Syntax

{
    'Grants': [
        {
            'GrantArn': 'string',
            'GrantName': 'string',
            'ParentArn': 'string',
            'LicenseArn': 'string',
            'GranteePrincipalArn': 'string',
            'HomeRegion': 'string',
            'GrantStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
            'StatusReason': 'string',
            'Version': 'string',
            'GrantedOperations': [
                'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Grants (list) --
  
  Received grant details.
  - (dict) --
    
    Describes a grant.
    - GrantArn (string) --
      
      Amazon Resource Name (ARN) of the grant.
    - GrantName (string) --
      
      Grant name.
    - ParentArn (string) --
      
      Parent ARN.
    - LicenseArn (string) --
      
      License ARN.
    - GranteePrincipalArn (string) --
      
      The grantee principal ARN.
    - HomeRegion (string) --
      
      Home Region of the grant.
    - GrantStatus (string) --
      
      Grant status.
    - StatusReason (string) --
      
      Grant status reason.
    - Version (string) --
      
      Grant version.
    - GrantedOperations (list) --
      
      Granted operations.
      - (string) --
- NextToken (string) --
  
  Token for the next set of results.

DeleteGrant (new)

Link ¶

Deletes the specified grant.

See also: AWS API Documentation

Request Syntax

client.delete_grant(
    GrantArn='string',
    Version='string'
)

type GrantArn

string

param GrantArn

[REQUIRED]

Amazon Resource Name (ARN) of the grant.

type Version

string

param Version

[REQUIRED]

Current version of the grant.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- GrantArn (string) --
  
  Grant ARN.
- Status (string) --
  
  Grant status.
- Version (string) --
  
  Grant version.

GetAccessToken (new)

Link ¶

Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.

See also: AWS API Documentation

Request Syntax

client.get_access_token(
    Token='string',
    TokenProperties=[
        'string',
    ]
)

type Token

string

param Token

[REQUIRED]

Refresh token, encoded as a JWT token.

type TokenProperties

list

param TokenProperties

Token properties to validate against those present in the JWT token.

(string) --

rtype

dict

returns

Response Syntax

{
    'AccessToken': 'string'
}

Response Structure

(dict) --
- AccessToken (string) --
  
  Temporary access token.

GetLicense (new)

Link ¶

Gets detailed information about the specified license.

See also: AWS API Documentation

Request Syntax

client.get_license(
    LicenseArn='string',
    Version='string'
)

type LicenseArn

string

param LicenseArn

[REQUIRED]

Amazon Resource Name (ARN) of the license.

type Version

string

param Version

License version.

rtype

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 CMK from AWS Key Management Service. The CMK 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.

RejectGrant (new)

Link ¶

Rejects the specified grant.

See also: AWS API Documentation

Request Syntax

client.reject_grant(
    GrantArn='string'
)

type GrantArn

string

param GrantArn

[REQUIRED]

Amazon Resource Name (ARN) of the grant.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- GrantArn (string) --
  
  Grant ARN.
- Status (string) --
  
  Grant status.
- Version (string) --
  
  Grant version.

CreateLicense (new)

Link ¶

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

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 CMK from AWS Key Management Service. The CMK 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.

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.

CreateToken (new)

Link ¶

Creates a long-lived token.

A refresh token is a JWT token used to get an access token. With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that you can use to call License Manager to manage the specified license.

See also: AWS API Documentation

Request Syntax

client.create_token(
    LicenseArn='string',
    RoleArns=[
        'string',
    ],
    ExpirationInDays=123,
    TokenProperties=[
        'string',
    ],
    ClientToken='string'
)

type LicenseArn

string

param LicenseArn

[REQUIRED]

Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

type RoleArns

list

param RoleArns

Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.

(string) --

type ExpirationInDays

integer

param ExpirationInDays

Token expiration, in days, counted from token creation. The default is 365 days.

type TokenProperties

list

param TokenProperties

Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

(string) --

type ClientToken

string

param ClientToken

[REQUIRED]

Idempotency token, valid for 10 minutes.

rtype

dict

returns

Response Syntax

{
    'TokenId': 'string',
    'TokenType': 'REFRESH_TOKEN',
    'Token': 'string'
}

Response Structure

(dict) --
- TokenId (string) --
  
  Token ID.
- TokenType (string) --
  
  Token type.
- Token (string) --
  
  Refresh token, encoded as a JWT token.

ListDistributedGrants (new)

Link ¶

Lists the grants distributed for the specified license.

See also: AWS API Documentation

Request Syntax

client.list_distributed_grants(
    GrantArns=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

type GrantArns

list

param GrantArns

Amazon Resource Names (ARNs) of the grants.

(string) --

type Filters

list

param Filters

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

LicenseARN
Status
PrincipalARN
ParentARN

(dict) --

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

type NextToken

string

param NextToken

Token for the next set of results.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

rtype

dict

returns

Response Syntax

{
    'Grants': [
        {
            'GrantArn': 'string',
            'GrantName': 'string',
            'ParentArn': 'string',
            'LicenseArn': 'string',
            'GranteePrincipalArn': 'string',
            'HomeRegion': 'string',
            'GrantStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED',
            'StatusReason': 'string',
            'Version': 'string',
            'GrantedOperations': [
                'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Grants (list) --
  
  Distributed grant details.
  - (dict) --
    
    Describes a grant.
    - GrantArn (string) --
      
      Amazon Resource Name (ARN) of the grant.
    - GrantName (string) --
      
      Grant name.
    - ParentArn (string) --
      
      Parent ARN.
    - LicenseArn (string) --
      
      License ARN.
    - GranteePrincipalArn (string) --
      
      The grantee principal ARN.
    - HomeRegion (string) --
      
      Home Region of the grant.
    - GrantStatus (string) --
      
      Grant status.
    - StatusReason (string) --
      
      Grant status reason.
    - Version (string) --
      
      Grant version.
    - GrantedOperations (list) --
      
      Granted operations.
      - (string) --
- NextToken (string) --
  
  Token for the next set of results.

DeleteLicense (new)

Link ¶

Deletes the specified license.

See also: AWS API Documentation

Request Syntax

client.delete_license(
    LicenseArn='string',
    SourceVersion='string'
)

type LicenseArn

string

param LicenseArn

[REQUIRED]

Amazon Resource Name (ARN) of the license.

type SourceVersion

string

param SourceVersion

[REQUIRED]

Current version of the license.

rtype

dict

returns

Response Syntax

{
    'Status': 'PENDING_DELETE'|'DELETED',
    'DeletionDate': 'string'
}

Response Structure

(dict) --
- Status (string) --
  
  License status.
- DeletionDate (string) --
  
  Date on which the license is deleted.

ListTokens (new)

Link ¶

Lists your tokens.

See also: AWS API Documentation

Request Syntax

client.list_tokens(
    TokenIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

type TokenIds

list

param TokenIds

Token IDs.

(string) --

type Filters

list

param Filters

Filters to scope the results. The following filter is supported:

licenseArns

(dict) --

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

type NextToken

string

param NextToken

Token for the next set of results.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

rtype

dict

returns

Response Syntax

{
    'Tokens': [
        {
            'TokenId': 'string',
            'TokenType': 'string',
            'LicenseArn': 'string',
            'ExpirationTime': 'string',
            'TokenProperties': [
                'string',
            ],
            'RoleArns': [
                'string',
            ],
            'Status': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Tokens (list) --
  
  Received token details.
  - (dict) --
    
    Describes a token.
    - TokenId (string) --
      
      Token ID.
    - TokenType (string) --
      
      Type of token generated. The supported value is REFRESH_TOKEN .
    - LicenseArn (string) --
      
      Amazon Resource Name (ARN) of the license.
    - ExpirationTime (string) --
      
      Token expiration time, in ISO8601-UTC format.
    - TokenProperties (list) --
      
      Data specified by the caller.
      - (string) --
    - RoleArns (list) --
      
      Amazon Resource Names (ARN) of the roles included in the token.
      - (string) --
    - Status (string) --
      
      Token status. The possible values are AVAILABLE and DELETED .
- NextToken (string) --
  
  Token for the next set of results.

CreateGrant (new)

Link ¶

Creates a grant for the specified license. A grant shares the use of license entitlements with specific AWS accounts.

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',
    ]
)

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.

(string) --

type HomeRegion

string

param HomeRegion

[REQUIRED]

Home Region of the grant.

type AllowedOperations

list

param AllowedOperations

[REQUIRED]

Allowed operations for the grant.

(string) --

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- GrantArn (string) --
  
  Grant ARN.
- Status (string) --
  
  Grant status.
- Version (string) --
  
  Grant version.

GetLicenseUsage (new)

Link ¶

Gets detailed information about the usage of the specified license.

See also: AWS API Documentation

Request Syntax

client.get_license_usage(
    LicenseArn='string'
)

type LicenseArn

string

param LicenseArn

[REQUIRED]

Amazon Resource Name (ARN) of the license.

rtype

dict

returns

Response Syntax

{
    'LicenseUsage': {
        'EntitlementUsages': [
            {
                'Name': 'string',
                'ConsumedValue': 'string',
                'MaxCount': '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'
            },
        ]
    }
}

Response Structure

(dict) --
- LicenseUsage (dict) --
  
  License usage details.
  - EntitlementUsages (list) --
    
    License entitlement usages.
    - (dict) --
      
      Usage associated with an entitlement resource.
      - Name (string) --
        
        Entitlement usage name.
      - ConsumedValue (string) --
        
        Resource usage consumed.
      - MaxCount (string) --
        
        Maximum entitlement usage count.
      - Unit (string) --
        
        Entitlement usage unit.

ListReceivedLicenses (new)

Link ¶

Lists received licenses.

See also: AWS API Documentation

Request Syntax

client.list_received_licenses(
    LicenseArns=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

type LicenseArns

list

param LicenseArns

Amazon Resource Names (ARNs) of the licenses.

(string) --

type Filters

list

param Filters

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

ProductSKU
Status
KeyFingerprint
Issuer

(dict) --

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

type NextToken

string

param NextToken

Token for the next set of results.

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

rtype

dict

returns

Response Syntax

{
    'Licenses': [
        {
            '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',
            'ReceivedMetadata': {
                'ReceivedStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'DISABLED',
                'AllowedOperations': [
                    'CreateGrant'|'CheckoutLicense'|'CheckoutBorrowLicense'|'CheckInLicense'|'ExtendConsumptionLicense'|'ListPurchasedLicenses'|'CreateToken',
                ]
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Licenses (list) --
  
  Received license details.
  - (dict) --
    
    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 (dict) --
      
      Granted license issuer.
      - Name (string) --
        
        Issuer name.
      - SignKey (string) --
        
        Asymmetric CMK from AWS Key Management Service. The CMK 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 (dict) --
      
      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.
      - (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) --
      
      Granted license metadata.
      - (dict) --
        
        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 (dict) --
      
      Granted license received metadata.
      - ReceivedStatus (string) --
        
        Received status.
      - AllowedOperations (list) --
        
        Allowed operations.
        
        (string) --
- NextToken (string) --
  
  Token for the next set of results.