AWS API Changes

2022/12/21 - AWS License Manager Linux Subscriptions - 4 new api methods

Changes AWS License Manager now offers cross-region, cross-account tracking of commercial Linux subscriptions on AWS. This includes subscriptions purchased as part of EC2 subscription-included AMIs, on the AWS Marketplace, or brought to AWS via Red Hat Cloud Access Program.

UpdateServiceSettings (new)

Link ¶

Updates the service settings for Linux subscriptions.

See also: AWS API Documentation

Request Syntax

client.update_service_settings(
    AllowUpdate=True|False,
    LinuxSubscriptionsDiscovery='Enabled'|'Disabled',
    LinuxSubscriptionsDiscoverySettings={
        'OrganizationIntegration': 'Enabled'|'Disabled',
        'SourceRegions': [
            'string',
        ]
    }
)

type AllowUpdate

boolean

param AllowUpdate

Describes if updates are allowed to the service settings for Linux subscriptions. If you allow updates, you can aggregate Linux subscription data in more than one home Region.

type LinuxSubscriptionsDiscovery

string

param LinuxSubscriptionsDiscovery

[REQUIRED]

Describes if the discovery of Linux subscriptions is enabled.

type LinuxSubscriptionsDiscoverySettings

dict

param LinuxSubscriptionsDiscoverySettings

[REQUIRED]

The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.

OrganizationIntegration (string) -- [REQUIRED]

Details if you have enabled resource discovery across your accounts in Organizations.
SourceRegions (list) -- [REQUIRED]

The Regions in which to discover data for Linux subscriptions.
- (string) --

rtype

dict

returns

Response Syntax

{
    'HomeRegions': [
        'string',
    ],
    'LinuxSubscriptionsDiscovery': 'Enabled'|'Disabled',
    'LinuxSubscriptionsDiscoverySettings': {
        'OrganizationIntegration': 'Enabled'|'Disabled',
        'SourceRegions': [
            'string',
        ]
    },
    'Status': 'InProgress'|'Completed'|'Successful'|'Failed',
    'StatusMessage': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- HomeRegions (list) --
  
  The Region in which License Manager displays the aggregated data for Linux subscriptions.
  - (string) --
- LinuxSubscriptionsDiscovery (string) --
  
  Lists if discovery has been enabled for Linux subscriptions.
- LinuxSubscriptionsDiscoverySettings (dict) --
  
  The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.
  - OrganizationIntegration (string) --
    
    Details if you have enabled resource discovery across your accounts in Organizations.
  - SourceRegions (list) --
    
    The Regions in which to discover data for Linux subscriptions.
    - (string) --
- Status (string) --
  
  Indicates the status of Linux subscriptions settings being applied.
- StatusMessage (dict) --
  
  A message which details the Linux subscriptions service settings current status.
  - (string) --
    - (string) --

ListLinuxSubscriptions (new)

Link ¶

Lists the Linux subscriptions that have been discovered. If you have linked your organization, the returned results will include data aggregated across your accounts in Organizations.

See also: AWS API Documentation

Request Syntax

client.list_linux_subscriptions(
    Filters=[
        {
            'Name': 'string',
            'Operator': 'Equal'|'NotEqual'|'Contains',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type Filters

list

param Filters

An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify. For example, you can filter by the name of Subscription with an optional operator to see subscriptions that match, partially match, or don't match a certain subscription's name.

The valid names for this filter are:

Subscription

The valid Operators for this filter are:

contains
equals
Notequal

(dict) --

A filter object 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.
- Name (string) --
  
  The type of name to filter by.
- Operator (string) --
  
  An operator for filtering results.
- Values (list) --
  
  One or more values for the name to filter by.
  - (string) --

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

type NextToken

string

param NextToken

Token for the next set of results.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'Subscriptions': [
        {
            'InstanceCount': 123,
            'Name': 'string',
            'Type': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  Token for the next set of results.
- Subscriptions (list) --
  
  An array that contains subscription objects.
  - (dict) --
    
    An object which details a discovered Linux subscription.
    - InstanceCount (integer) --
      
      The total amount of running instances using this subscription.
    - Name (string) --
      
      The name of the subscription.
    - Type (string) --
      
      The type of subscription. The type can be subscription-included with Amazon EC2, Bring Your Own Subscription model (BYOS), or from the Amazon Web Services Marketplace. Certain subscriptions may use licensing from the Amazon Web Services Marketplace as well as OS licensing from Amazon EC2 or BYOS.

GetServiceSettings (new)

Link ¶

Lists the Linux subscriptions service settings.

See also: AWS API Documentation

Request Syntax

client.get_service_settings()

rtype

dict

returns

Response Syntax

{
    'HomeRegions': [
        'string',
    ],
    'LinuxSubscriptionsDiscovery': 'Enabled'|'Disabled',
    'LinuxSubscriptionsDiscoverySettings': {
        'OrganizationIntegration': 'Enabled'|'Disabled',
        'SourceRegions': [
            'string',
        ]
    },
    'Status': 'InProgress'|'Completed'|'Successful'|'Failed',
    'StatusMessage': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- HomeRegions (list) --
  
  The Region in which License Manager displays the aggregated data for Linux subscriptions.
  - (string) --
- LinuxSubscriptionsDiscovery (string) --
  
  Lists if discovery has been enabled for Linux subscriptions.
- LinuxSubscriptionsDiscoverySettings (dict) --
  
  Lists the settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.
  - OrganizationIntegration (string) --
    
    Details if you have enabled resource discovery across your accounts in Organizations.
  - SourceRegions (list) --
    
    The Regions in which to discover data for Linux subscriptions.
    - (string) --
- Status (string) --
  
  Indicates the status of Linux subscriptions settings being applied.
- StatusMessage (dict) --
  
  A message which details the Linux subscriptions service settings current status.
  - (string) --
    - (string) --

ListLinuxSubscriptionInstances (new)

Link ¶

Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.

See also: AWS API Documentation

Request Syntax

client.list_linux_subscription_instances(
    Filters=[
        {
            'Name': 'string',
            'Operator': 'Equal'|'NotEqual'|'Contains',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type Filters

list

param Filters

An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify. For example, you can filter by the name of AmiID with an optional operator to see subscriptions that match, partially match, or don't match a certain Amazon Machine Image (AMI) ID.

The valid names for this filter are:

AmiID
InstanceID
AccountID
Status
Region
UsageOperation
ProductCode
InstanceType

The valid Operators for this filter are:

contains
equals
Notequal

(dict) --

A filter object 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.
- Name (string) --
  
  The type of name to filter by.
- Operator (string) --
  
  An operator for filtering results.
- Values (list) --
  
  One or more values for the name to filter by.
  - (string) --

type MaxResults

integer

param MaxResults

Maximum number of results to return in a single call.

type NextToken

string

param NextToken

Token for the next set of results.

rtype

dict

returns

Response Syntax

{
    'Instances': [
        {
            'AccountID': 'string',
            'AmiId': 'string',
            'InstanceID': 'string',
            'InstanceType': 'string',
            'LastUpdatedTime': 'string',
            'ProductCode': [
                'string',
            ],
            'Region': 'string',
            'Status': 'string',
            'SubscriptionName': 'string',
            'UsageOperation': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Instances (list) --
  
  An array that contains instance objects.
  - (dict) --
    
    Details discovered information about a running instance using Linux subscriptions.
    - AccountID (string) --
      
      The account ID which owns the instance.
    - AmiId (string) --
      
      The AMI ID used to launch the instance.
    - InstanceID (string) --
      
      The instance ID of the resource.
    - InstanceType (string) --
      
      The instance type of the resource.
    - LastUpdatedTime (string) --
      
      The time in which the last discovery updated the instance details.
    - ProductCode (list) --
      
      The product code for the instance. For more information, see Usage operation values in the License Manager User Guide .
      - (string) --
    - Region (string) --
      
      The Region the instance is running in.
    - Status (string) --
      
      The status of the instance.
    - SubscriptionName (string) --
      
      The name of the subscription being used by the instance.
    - UsageOperation (string) --
      
      The usage operation of the instance. For more information, see For more information, see Usage operation values in the License Manager User Guide .
- NextToken (string) --
  
  Token for the next set of results.