AWS License Manager

{'Status': {'WORKFLOW_COMPLETED'}}

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'|'WORKFLOW_COMPLETED',
    'Version': 'string'
}

Response Structure

• (dict) --

  • GrantArn (string) --

    Grant ARN.

  • Status (string) --

    Grant status.

  • Version (string) --

    Grant version.

{'Status': {'WORKFLOW_COMPLETED'}}

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'|'WORKFLOW_COMPLETED',
    'Version': 'string'
}

Response Structure

• (dict) --

  • GrantArn (string) --

    Grant ARN.

  • Status (string) --

    Grant status.

  • Version (string) --

    Grant version.

{'Status': {'WORKFLOW_COMPLETED'}, 'StatusReason': 'string'}

{'Status': {'WORKFLOW_COMPLETED'}}

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'|'WORKFLOW_COMPLETED',
    StatusReason='string',
    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 StatusReason

string

param StatusReason

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'|'WORKFLOW_COMPLETED',
    'Version': 'string'
}

Response Structure

• (dict) --

  • GrantArn (string) --

    Grant ARN.

  • Status (string) --

    Grant status.

  • Version (string) --

    New version of the grant.

{'StatusReason': 'string'}

{'Status': {'WORKFLOW_COMPLETED'}}

Deletes the specified grant.

See also: AWS API Documentation

Request Syntax

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

type GrantArn

string

param GrantArn

[REQUIRED]

Amazon Resource Name (ARN) of the grant.

type StatusReason

string

param StatusReason

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'|'WORKFLOW_COMPLETED',
    'Version': 'string'
}

Response Structure

• (dict) --

  • GrantArn (string) --

    Grant ARN.

  • Status (string) --

    Grant status.

  • Version (string) --

    Grant version.

{'Grant': {'GrantStatus': {'WORKFLOW_COMPLETED'}}}

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

{'Grants': {'GrantStatus': {'WORKFLOW_COMPLETED'}}}

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

• GrantStatus

• GranteePrincipalARN

• ProductSKU

• LicenseIssuerName

• (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'|'WORKFLOW_COMPLETED',
            '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.

{'Grants': {'GrantStatus': {'WORKFLOW_COMPLETED'}}}

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:

• ProductSKU

• LicenseIssuerName

• LicenseArn

• GrantStatus

• GranterAccountId

• (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'|'WORKFLOW_COMPLETED',
            '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.

{'Licenses': {'ReceivedMetadata': {'ReceivedStatus': {'WORKFLOW_COMPLETED'},
                                   'ReceivedStatusReason': 'string'}}}

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

• Fingerprint

• IssuerName

• Beneficiary

• (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'|'WORKFLOW_COMPLETED',
                'ReceivedStatusReason': 'string',
                '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.

        • ReceivedStatusReason (string) --

        • AllowedOperations (list) --

          Allowed operations.

          • (string) --

  • NextToken (string) --

    Token for the next set of results.

{'Status': {'WORKFLOW_COMPLETED'}}

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'|'WORKFLOW_COMPLETED',
    'Version': 'string'
}

Response Structure

• (dict) --

  • GrantArn (string) --

    Grant ARN.

  • Status (string) --

    Grant status.

  • Version (string) --

    Grant version.