LicenseManager / Client / list_distributed_grants

list_distributed_grants

LicenseManager.Client.list_distributed_grants(**kwargs)

Lists the grants distributed for the specified license.

See also: AWS API Documentation

Request Syntax

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

  • GrantArns (list) –

    Amazon Resource Names (ARNs) of the grants.

    • (string) –

  • Filters (list) –

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

        The value of the filter, which is case-sensitive. You can only specify one value for the filter.

        • (string) –

  • NextToken (string) – Token for the next set of results.

  • MaxResults (integer) – Maximum number of results to return in a single call.

Return type:

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',
            ],
            'Options': {
                'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY'|'ALL_GRANTS_PERMITTED_BY_ISSUER'
            }
        },
    ],
    '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) –

        • Options (dict) –

          The options specified for the grant.

          • ActivationOverrideBehavior (string) –

            An activation option for your grant that determines the behavior of activating a grant. Activation options can only be used with granted licenses sourced from the Amazon Web Services Marketplace. Additionally, the operation must specify the value of ACTIVE for the Status parameter.

            • As a license administrator, you can optionally specify an ActivationOverrideBehavior when activating a grant.

            • As a grantor, you can optionally specify an ActivationOverrideBehavior when you activate a grant for a grantee account in your organization.

            • As a grantee, if the grantor creating the distributed grant doesn’t specify an ActivationOverrideBehavior, you can optionally specify one when you are activating the grant.

              DISTRIBUTED_GRANTS_ONLY

            Use this value to activate a grant without replacing any member account’s active grants for the same product.

            ALL_GRANTS_PERMITTED_BY_ISSUER

            Use this value to activate a grant and disable other active grants in any member accounts for the same product. This action will also replace their previously activated grants with this activated grant.

    • NextToken (string) –

      Token for the next set of results.

Exceptions