LicenseManager / Client / get_grant

get_grant#

LicenseManager.Client.get_grant(**kwargs)#

Gets detailed information about the specified grant.

Request Syntax

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

Parameters:

GrantArn (string) –
[REQUIRED]

Amazon Resource Name (ARN) of the grant.
Version (string) – Grant version.

Return type:

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

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

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