AWS API Changes

2022/11/11 - AWS License Manager - 2 new api methods

Changes AWS License Manager now supports onboarded Management Accounts or Delegated Admins to view granted licenses aggregated from all accounts in the organization.

ListReceivedLicensesForOrganization (new)

Link ¶

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) --
  
  Filter values. Filter values are case-sensitive.
  - (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',
                ]
            }
        },
    ],
    '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) --
- NextToken (string) --
  
  Token for the next set of results.

ListReceivedGrantsForOrganization (new)

Link ¶

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) --
  
  Filter values. Filter values are case-sensitive.
  - (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',
            ]
        },
    ],
    '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) --
- NextToken (string) --
  
  Token for the next set of results.