LicenseManager / Client / list_distributed_grants

list_distributed_grants#

LicenseManager.Client.list_distributed_grants(**kwargs)#

Lists the grants distributed for the specified license.

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) –
    
    Filter values. Filter values are case-sensitive.
    - (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',
            ]
        },
    ],
    '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.

Exceptions

LicenseManager.Client.exceptions.ValidationException
LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ResourceLimitExceededException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException