AWS API Changes

2026/10/27 - AWS License Manager - 8 updated api methods

Changes AWS License Manager now supports delegate grants for read-only visibility into license distributions. CreateGrant accepts a new GrantType (BuyerGrant or DelegateGrant) and a desired status at distribution time.

CreateGrant (updated)

Link ¶
Changes (request)

{'AllowedOperations': {'ListReceivedLicenses'},
 'GrantType': 'BuyerGrant | DelegateGrant',
 'Options': {'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY | '
                                           'ALL_GRANTS_PERMITTED_BY_ISSUER',
             'DesiredStatus': 'PENDING_WORKFLOW | PENDING_ACCEPT | REJECTED | '
                              'ACTIVE | FAILED_WORKFLOW | DELETED | '
                              'PENDING_DELETE | DISABLED | WORKFLOW_COMPLETED'}}

Creates a grant for the specified license. A grant shares the use of license entitlements with a specific Amazon Web Services account, an organization, or an organizational unit (OU). For more information, see Granted licenses in License Manager in the License Manager User Guide.

Set the type of grant with the GrantType field:

BuyerGrant - The default grant type, created by the seller when a customer subscribes to a product. The seller creates a license for the subscription and a buyer grant for the customer. With a buyer grant, the customer can use, consume, and distribute the license, according to the permissions the seller sets in the product contract.
DelegateGrant - A delegate grant gives the grantee read-only visibility into the licenses and grants that you have distributed to buyers for a product. The grantee can monitor that activity on your behalf, and can also listen for the related Amazon EventBridge events. A delegate grant conveys no entitlement to use the licenses, and its only allowed operation is ListReceivedLicenses. You must create the delegate grant, and its license, from the same Amazon Web Services account that you used to create those buyer licenses and grants.

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'|'ListReceivedLicenses',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    GrantType='BuyerGrant'|'DelegateGrant',
    Options={
        'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY'|'ALL_GRANTS_PERMITTED_BY_ISSUER',
        'DesiredStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED'
    }
)

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. You can specify one of the following as an Amazon Resource Name (ARN):

An Amazon Web Services account, which includes only the account specified.
An organizational unit (OU), which includes all accounts in the OU.
An organization, which will include all accounts across your organization.

(string) --

type HomeRegion:

string

param HomeRegion:

[REQUIRED]

Home Region of the grant.

type AllowedOperations:

list

param AllowedOperations:

[REQUIRED]

Allowed operations for the grant.

(string) --

type Tags:

list

param Tags:

Tags to add to the grant. For more information about tagging support in License Manager, see the TagResource operation.

(dict) --

Details about the tags for a resource. For more information about tagging support in License Manager, see the TagResource operation.
- Key (string) --
  
  The tag key.
- Value (string) --
  
  The tag value.

type GrantType:

string

param GrantType:

The type of grant to create. For more information about each type, see the preceding description of this operation. Valid values:

BuyerGrant - The default grant type if you don't specify a value. Conveys the entitlement to use the license.
DelegateGrant - Gives the grantee read-only visibility into the licenses and grants that you have distributed to buyers, with no entitlement to use them.

type Options:

dict

param Options:

The options for the grant: the status to set after creation, and how activating the grant affects other active grants for the same product.

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 activate the grant. For the CreateGrantVersion operation, specify ACTIVE for the Status parameter. For the CreateGrant operation, specify ACTIVE for the DesiredStatus option.
- 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.
DesiredStatus (string) --

The status of the grant after License Manager creates it. The only supported value is ACTIVE. Specify ACTIVE to create and activate the grant in one request.

You can specify this option only for the CreateGrant operation, and only when the grant principal is an organization or an organizational unit (OU). To change the status of an existing grant, use the Status parameter of the CreateGrantVersion operation.

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.

CreateGrantVersion (updated)

Link ¶
Changes (request)

{'AllowedOperations': {'ListReceivedLicenses'},
 'Options': {'DesiredStatus': 'PENDING_WORKFLOW | PENDING_ACCEPT | REJECTED | '
                              'ACTIVE | FAILED_WORKFLOW | DELETED | '
                              'PENDING_DELETE | DISABLED | WORKFLOW_COMPLETED'}}

Creates a new version of the specified grant. For more information, see Granted licenses in License Manager in the License Manager User Guide.

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'|'ListReceivedLicenses',
    ],
    Status='PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED',
    StatusReason='string',
    SourceVersion='string',
    Options={
        'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY'|'ALL_GRANTS_PERMITTED_BY_ISSUER',
        'DesiredStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED'
    }
)

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:

Grant status reason.

type SourceVersion:

string

param SourceVersion:

Current version of the grant.

type Options:

dict

param Options:

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 activate the grant. For the CreateGrantVersion operation, specify ACTIVE for the Status parameter. For the CreateGrant operation, specify ACTIVE for the DesiredStatus option.
- 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.
DesiredStatus (string) --

The status of the grant after License Manager creates it. The only supported value is ACTIVE. Specify ACTIVE to create and activate the grant in one request.

You can specify this option only for the CreateGrant operation, and only when the grant principal is an organization or an organizational unit (OU). To change the status of an existing grant, use the Status parameter of the CreateGrantVersion operation.

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.

GetGrant (updated)

Link ¶
Changes (response)

{'Grant': {'GrantType': 'BuyerGrant | DelegateGrant',
           'GrantedOperations': {'ListReceivedLicenses'},
           'Options': {'DesiredStatus': 'PENDING_WORKFLOW | PENDING_ACCEPT | '
                                        'REJECTED | ACTIVE | FAILED_WORKFLOW | '
                                        'DELETED | PENDING_DELETE | DISABLED | '
                                        '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'|'ListReceivedLicenses',
        ],
        'Options': {
            'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY'|'ALL_GRANTS_PERMITTED_BY_ISSUER',
            'DesiredStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED'
        },
        'GrantType': 'BuyerGrant'|'DelegateGrant'
    }
}

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 activate the grant. For the CreateGrantVersion operation, specify ACTIVE for the Status parameter. For the CreateGrant operation, specify ACTIVE for the DesiredStatus option.
      - 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.
    - DesiredStatus (string) --
      
      The status of the grant after License Manager creates it. The only supported value is ACTIVE. Specify ACTIVE to create and activate the grant in one request.
      
      You can specify this option only for the CreateGrant operation, and only when the grant principal is an organization or an organizational unit (OU). To change the status of an existing grant, use the Status parameter of the CreateGrantVersion operation.
  - GrantType (string) --
    
    The type of the grant. Valid values:
    - BuyerGrant - Grants the entitlement to use the license.
    - DelegateGrant - Gives the grantee read-only visibility into the licenses and grants distributed to buyers, with no entitlement to use them.

ListDistributedGrants (updated)

Link ¶
Changes (response)

{'Grants': {'GrantType': 'BuyerGrant | DelegateGrant',
            'GrantedOperations': {'ListReceivedLicenses'},
            'Options': {'DesiredStatus': 'PENDING_WORKFLOW | PENDING_ACCEPT | '
                                         'REJECTED | ACTIVE | FAILED_WORKFLOW '
                                         '| DELETED | PENDING_DELETE | '
                                         'DISABLED | 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) --
  
  The value of the filter, which is case-sensitive. You can only specify one value for the filter.
  - (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'|'ListReceivedLicenses',
            ],
            'Options': {
                'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY'|'ALL_GRANTS_PERMITTED_BY_ISSUER',
                'DesiredStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED'
            },
            'GrantType': 'BuyerGrant'|'DelegateGrant'
        },
    ],
    '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 activate the grant. For the CreateGrantVersion operation, specify ACTIVE for the Status parameter. For the CreateGrant operation, specify ACTIVE for the DesiredStatus option.
        
        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.
      - DesiredStatus (string) --
        
        The status of the grant after License Manager creates it. The only supported value is ACTIVE. Specify ACTIVE to create and activate the grant in one request.
        
        You can specify this option only for the CreateGrant operation, and only when the grant principal is an organization or an organizational unit (OU). To change the status of an existing grant, use the Status parameter of the CreateGrantVersion operation.
    - GrantType (string) --
      
      The type of the grant. Valid values:
      - BuyerGrant - Grants the entitlement to use the license.
      - DelegateGrant - Gives the grantee read-only visibility into the licenses and grants distributed to buyers, with no entitlement to use them.
- NextToken (string) --
  
  Token for the next set of results.

ListReceivedGrants (updated)

Link ¶
Changes (response)

{'Grants': {'GrantType': 'BuyerGrant | DelegateGrant',
            'GrantedOperations': {'ListReceivedLicenses'},
            'Options': {'DesiredStatus': 'PENDING_WORKFLOW | PENDING_ACCEPT | '
                                         'REJECTED | ACTIVE | FAILED_WORKFLOW '
                                         '| DELETED | PENDING_DELETE | '
                                         'DISABLED | WORKFLOW_COMPLETED'}}}

Lists grants that are received. Received grants are grants created while specifying the recipient as this Amazon Web Services account, your organization, or an organizational unit (OU) to which this member account belongs.

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) --
  
  The value of the filter, which is case-sensitive. You can only specify one value for the filter.
  - (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'|'ListReceivedLicenses',
            ],
            'Options': {
                'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY'|'ALL_GRANTS_PERMITTED_BY_ISSUER',
                'DesiredStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED'
            },
            'GrantType': 'BuyerGrant'|'DelegateGrant'
        },
    ],
    '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) --
    - 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 activate the grant. For the CreateGrantVersion operation, specify ACTIVE for the Status parameter. For the CreateGrant operation, specify ACTIVE for the DesiredStatus option.
        
        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.
      - DesiredStatus (string) --
        
        The status of the grant after License Manager creates it. The only supported value is ACTIVE. Specify ACTIVE to create and activate the grant in one request.
        
        You can specify this option only for the CreateGrant operation, and only when the grant principal is an organization or an organizational unit (OU). To change the status of an existing grant, use the Status parameter of the CreateGrantVersion operation.
    - GrantType (string) --
      
      The type of the grant. Valid values:
      - BuyerGrant - Grants the entitlement to use the license.
      - DelegateGrant - Gives the grantee read-only visibility into the licenses and grants distributed to buyers, with no entitlement to use them.
- NextToken (string) --
  
  Token for the next set of results.

ListReceivedGrantsForOrganization (updated)

Link ¶
Changes (response)

{'Grants': {'GrantType': 'BuyerGrant | DelegateGrant',
            'GrantedOperations': {'ListReceivedLicenses'},
            'Options': {'DesiredStatus': 'PENDING_WORKFLOW | PENDING_ACCEPT | '
                                         'REJECTED | ACTIVE | FAILED_WORKFLOW '
                                         '| DELETED | PENDING_DELETE | '
                                         'DISABLED | WORKFLOW_COMPLETED'}}}

Lists the grants received for all accounts in the organization.

See also: AWS API Documentation

Request Syntax

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

type LicenseArn:

string

param LicenseArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the received license.

type Filters:

list

param Filters:

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

ParentArn
GranteePrincipalArn

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

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'|'ListReceivedLicenses',
            ],
            'Options': {
                'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY'|'ALL_GRANTS_PERMITTED_BY_ISSUER',
                'DesiredStatus': 'PENDING_WORKFLOW'|'PENDING_ACCEPT'|'REJECTED'|'ACTIVE'|'FAILED_WORKFLOW'|'DELETED'|'PENDING_DELETE'|'DISABLED'|'WORKFLOW_COMPLETED'
            },
            'GrantType': 'BuyerGrant'|'DelegateGrant'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Grants (list) --
  
  Lists the grants the organization has received.
  - (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 activate the grant. For the CreateGrantVersion operation, specify ACTIVE for the Status parameter. For the CreateGrant operation, specify ACTIVE for the DesiredStatus option.
        
        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.
      - DesiredStatus (string) --
        
        The status of the grant after License Manager creates it. The only supported value is ACTIVE. Specify ACTIVE to create and activate the grant in one request.
        
        You can specify this option only for the CreateGrant operation, and only when the grant principal is an organization or an organizational unit (OU). To change the status of an existing grant, use the Status parameter of the CreateGrantVersion operation.
    - GrantType (string) --
      
      The type of the grant. Valid values:
      - BuyerGrant - Grants the entitlement to use the license.
      - DelegateGrant - Gives the grantee read-only visibility into the licenses and grants distributed to buyers, with no entitlement to use them.
- NextToken (string) --
  
  Token for the next set of results.

ListReceivedLicenses (updated)

Link ¶
Changes (response)

{'Licenses': {'ReceivedMetadata': {'AllowedOperations': {'ListReceivedLicenses'},
                                   'GrantType': 'BuyerGrant | DelegateGrant'}}}

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) --
  
  The value of the filter, which is case-sensitive. You can only specify one value for the filter.
  - (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'|'ListReceivedLicenses',
                ],
                'GrantType': 'BuyerGrant'|'DelegateGrant'
            }
        },
    ],
    '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 KMS key from Key Management Service. The KMS key 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) --
        
        Received status reason.
      - AllowedOperations (list) --
        
        Allowed operations.
        
        (string) --
      - GrantType (string) --
        
        The type of the grant through which the license was received. Valid values:
        
        BuyerGrant - Grants you the entitlement to use the license.
        
        DelegateGrant - Gives you read-only visibility into the licenses and grants distributed to buyers, with no entitlement to use them.
- NextToken (string) --
  
  Token for the next set of results.

ListReceivedLicensesForOrganization (updated)

Link ¶
Changes (response)

{'Licenses': {'ReceivedMetadata': {'AllowedOperations': {'ListReceivedLicenses'},
                                   'GrantType': 'BuyerGrant | DelegateGrant'}}}

Lists the licenses received for all accounts in the organization.

See also: AWS API Documentation

Request Syntax

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

type Filters:

list

param Filters:

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

Beneficiary
ProductSKU

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

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'|'ListReceivedLicenses',
                ],
                'GrantType': 'BuyerGrant'|'DelegateGrant'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Licenses (list) --
  
  Lists the licenses the organization has received.
  - (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 KMS key from Key Management Service. The KMS key 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) --
        
        Received status reason.
      - AllowedOperations (list) --
        
        Allowed operations.
        
        (string) --
      - GrantType (string) --
        
        The type of the grant through which the license was received. Valid values:
        
        BuyerGrant - Grants you the entitlement to use the license.
        
        DelegateGrant - Gives you read-only visibility into the licenses and grants distributed to buyers, with no entitlement to use them.
- NextToken (string) --
  
  Token for the next set of results.