AWS API Changes

2023/04/03 - AWS License Manager - 5 updated api methods

Changes This release adds grant override options to the CreateGrantVersion API. These options can be used to specify grant replacement behavior during grant activation.

CreateGrantVersion (updated)

Link ¶
Changes (request)

{'Options': {'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY | '
                                           'ALL_GRANTS_PERMITTED_BY_ISSUER'}}

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',
    ],
    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'
    }
)

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

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

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',
        ],
        '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.

ListDistributedGrants (updated)

Link ¶
Changes (response)

{'Grants': {'Options': {'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY '
                                                      '| '
                                                      'ALL_GRANTS_PERMITTED_BY_ISSUER'}}}

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',
            ],
            '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.

ListReceivedGrants (updated)

Link ¶
Changes (response)

{'Grants': {'Options': {'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY '
                                                      '| '
                                                      'ALL_GRANTS_PERMITTED_BY_ISSUER'}}}

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

ListReceivedGrantsForOrganization (updated)

Link ¶
Changes (response)

{'Grants': {'Options': {'ActivationOverrideBehavior': 'DISTRIBUTED_GRANTS_ONLY '
                                                      '| '
                                                      'ALL_GRANTS_PERMITTED_BY_ISSUER'}}}

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