Table of Contents
A low-level client representing AWS License Manager:
import boto3
client = boto3.client('license-manager')
These are the available methods:
Check if an operation can be paginated.
Creates a license configuration.
A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.
See also: AWS API Documentation
Request Syntax
response = client.create_license_configuration(
Name='string',
Description='string',
LicenseCountingType='vCPU'|'Instance'|'Core'|'Socket',
LicenseCount=123,
LicenseCountHardLimit=True|False,
LicenseRules=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ProductInformationList=[
{
'ResourceType': 'string',
'ProductInformationFilterList': [
{
'ProductInformationFilterName': 'string',
'ProductInformationFilterValue': [
'string',
],
'ProductInformationFilterComparator': 'string'
},
]
},
]
)
[REQUIRED]
Name of the license configuration.
[REQUIRED]
Dimension used to track the license inventory.
License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). Available rules vary by dimension.
Tags to add to the license configuration.
Details about a tag for a license configuration.
Tag key.
Tag value.
Product information.
Describes product information for a license configuration.
Resource type. The value is SSM_MANAGED .
Product information filters. The following filters and logical operators are supported:
Describes product information filters.
Filter name.
Filter value.
Logical operator.
dict
Response Syntax
{
'LicenseConfigurationArn': 'string'
}
Response Structure
(dict) --
LicenseConfigurationArn (string) --
Amazon Resource Name (ARN) of the license configuration.
Deletes the specified license configuration.
You cannot delete a license configuration that is in use.
See also: AWS API Documentation
Request Syntax
response = client.delete_license_configuration(
LicenseConfigurationArn='string'
)
[REQUIRED]
ID of the license configuration.
{}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Gets detailed information about the specified license configuration.
See also: AWS API Documentation
Request Syntax
response = client.get_license_configuration(
LicenseConfigurationArn='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
{
'LicenseConfigurationId': 'string',
'LicenseConfigurationArn': 'string',
'Name': 'string',
'Description': 'string',
'LicenseCountingType': 'vCPU'|'Instance'|'Core'|'Socket',
'LicenseRules': [
'string',
],
'LicenseCount': 123,
'LicenseCountHardLimit': True|False,
'ConsumedLicenses': 123,
'Status': 'string',
'OwnerAccountId': 'string',
'ConsumedLicenseSummaryList': [
{
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'ConsumedLicenses': 123
},
],
'ManagedResourceSummaryList': [
{
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'AssociationCount': 123
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ProductInformationList': [
{
'ResourceType': 'string',
'ProductInformationFilterList': [
{
'ProductInformationFilterName': 'string',
'ProductInformationFilterValue': [
'string',
],
'ProductInformationFilterComparator': 'string'
},
]
},
],
'AutomatedDiscoveryInformation': {
'LastRunTime': datetime(2015, 1, 1)
}
}
Response Structure
Unique ID for the license configuration.
Amazon Resource Name (ARN) of the license configuration.
Name of the license configuration.
Description of the license configuration.
Dimension on which the licenses are counted.
License rules.
Number of available licenses.
Sets the number of available licenses as a hard limit.
Number of licenses assigned to resources.
License configuration status.
Account ID of the owner of the license configuration.
Summaries of the licenses consumed by resources.
Details about license consumption.
Resource type of the resource consuming a license.
Number of licenses consumed by the resource.
Summaries of the managed resources.
Summary information about a managed resource.
Type of resource associated with a license.
Number of resources associated with licenses.
Tags for the license configuration.
Details about a tag for a license configuration.
Tag key.
Tag value.
Product information.
Describes product information for a license configuration.
Resource type. The value is SSM_MANAGED .
Product information filters. The following filters and logical operators are supported:
Describes product information filters.
Filter name.
Filter value.
Logical operator.
Automated discovery information.
Time that automated discovery last ran.
Create a paginator for an operation.
Gets the License Manager settings for the current Region.
See also: AWS API Documentation
Request Syntax
response = client.get_service_settings()
{
'S3BucketArn': 'string',
'SnsTopicArn': 'string',
'OrganizationConfiguration': {
'EnableIntegration': True|False
},
'EnableCrossAccountsDiscovery': True|False,
'LicenseManagerResourceShareArn': 'string'
}
Response Structure
Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.
SNS topic configured to receive notifications from License Manager.
Indicates whether AWS Organizations has been integrated with License Manager for cross-account discovery.
Enables AWS Organization integration.
Indicates whether cross-account discovery has been enabled.
Amazon Resource Name (ARN) of the AWS resource share. The License Manager master account will provide member accounts with access to this share.
Returns an object that can wait for some condition.
Lists the resource associations for the specified license configuration.
Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).
See also: AWS API Documentation
Request Syntax
response = client.list_associations_for_license_configuration(
LicenseConfigurationArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of a license configuration.
dict
Response Syntax
{
'LicenseConfigurationAssociations': [
{
'ResourceArn': 'string',
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'ResourceOwnerId': 'string',
'AssociationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LicenseConfigurationAssociations (list) --
Information about the associations for the license configuration.
(dict) --
Describes an association with a license configuration.
ResourceArn (string) --
Amazon Resource Name (ARN) of the resource.
ResourceType (string) --
Type of server resource.
ResourceOwnerId (string) --
ID of the AWS account that owns the resource consuming licenses.
AssociationTime (datetime) --
Time when the license configuration was associated with the resource.
NextToken (string) --
Token for the next set of results.
Lists the license configuration operations that failed.
See also: AWS API Documentation
Request Syntax
response = client.list_failures_for_license_configuration_operations(
LicenseConfigurationArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
Amazon Resource Name of the license configuration.
dict
Response Syntax
{
'LicenseOperationFailureList': [
{
'ResourceArn': 'string',
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'ErrorMessage': 'string',
'FailureTime': datetime(2015, 1, 1),
'OperationName': 'string',
'ResourceOwnerId': 'string',
'OperationRequestedBy': 'string',
'MetadataList': [
{
'Name': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LicenseOperationFailureList (list) --
License configuration operations that failed.
(dict) --
Describes the failure of a license operation.
ResourceArn (string) --
Amazon Resource Name (ARN) of the resource.
ResourceType (string) --
Resource type.
ErrorMessage (string) --
Error message.
FailureTime (datetime) --
Failure time.
OperationName (string) --
Name of the operation.
ResourceOwnerId (string) --
ID of the AWS account that owns the resource.
OperationRequestedBy (string) --
The requester is "License Manager Automated Discovery".
MetadataList (list) --
Reserved.
(dict) --
Reserved.
Name (string) --
Reserved.
Value (string) --
Reserved.
NextToken (string) --
Token for the next set of results.
Lists the license configurations for your account.
See also: AWS API Documentation
Request Syntax
response = client.list_license_configurations(
LicenseConfigurationArns=[
'string',
],
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
Amazon Resource Names (ARN) of the license configurations.
Filters to scope the results. The following filters and logical operators are supported:
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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LicenseConfigurations': [
{
'LicenseConfigurationId': 'string',
'LicenseConfigurationArn': 'string',
'Name': 'string',
'Description': 'string',
'LicenseCountingType': 'vCPU'|'Instance'|'Core'|'Socket',
'LicenseRules': [
'string',
],
'LicenseCount': 123,
'LicenseCountHardLimit': True|False,
'ConsumedLicenses': 123,
'Status': 'string',
'OwnerAccountId': 'string',
'ConsumedLicenseSummaryList': [
{
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'ConsumedLicenses': 123
},
],
'ManagedResourceSummaryList': [
{
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'AssociationCount': 123
},
],
'ProductInformationList': [
{
'ResourceType': 'string',
'ProductInformationFilterList': [
{
'ProductInformationFilterName': 'string',
'ProductInformationFilterValue': [
'string',
],
'ProductInformationFilterComparator': 'string'
},
]
},
],
'AutomatedDiscoveryInformation': {
'LastRunTime': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LicenseConfigurations (list) --
Information about the license configurations.
(dict) --
A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.
LicenseConfigurationId (string) --
Unique ID of the license configuration.
LicenseConfigurationArn (string) --
Amazon Resource Name (ARN) of the license configuration.
Name (string) --
Name of the license configuration.
Description (string) --
Description of the license configuration.
LicenseCountingType (string) --
Dimension to use to track the license inventory.
LicenseRules (list) --
License rules.
LicenseCount (integer) --
Number of licenses managed by the license configuration.
LicenseCountHardLimit (boolean) --
Number of available licenses as a hard limit.
ConsumedLicenses (integer) --
Number of licenses consumed.
Status (string) --
Status of the license configuration.
OwnerAccountId (string) --
Account ID of the license configuration's owner.
ConsumedLicenseSummaryList (list) --
Summaries for licenses consumed by various resources.
(dict) --
Details about license consumption.
ResourceType (string) --
Resource type of the resource consuming a license.
ConsumedLicenses (integer) --
Number of licenses consumed by the resource.
ManagedResourceSummaryList (list) --
Summaries for managed resources.
(dict) --
Summary information about a managed resource.
ResourceType (string) --
Type of resource associated with a license.
AssociationCount (integer) --
Number of resources associated with licenses.
ProductInformationList (list) --
Product information.
(dict) --
Describes product information for a license configuration.
ResourceType (string) --
Resource type. The value is SSM_MANAGED .
ProductInformationFilterList (list) --
Product information filters. The following filters and logical operators are supported:
(dict) --
Describes product information filters.
ProductInformationFilterName (string) --
Filter name.
ProductInformationFilterValue (list) --
Filter value.
ProductInformationFilterComparator (string) --
Logical operator.
AutomatedDiscoveryInformation (dict) --
Automated discovery information.
LastRunTime (datetime) --
Time that automated discovery last ran.
NextToken (string) --
Token for the next set of results.
Describes the license configurations for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_license_specifications_for_resource(
ResourceArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of a resource that has an associated license configuration.
dict
Response Syntax
{
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LicenseSpecifications (list) --
License configurations associated with a resource.
(dict) --
Details for associating a license configuration with a resource.
LicenseConfigurationArn (string) --
Amazon Resource Name (ARN) of the license configuration.
NextToken (string) --
Token for the next set of results.
Lists resources managed using Systems Manager inventory.
See also: AWS API Documentation
Request Syntax
response = client.list_resource_inventory(
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Condition': 'EQUALS'|'NOT_EQUALS'|'BEGINS_WITH'|'CONTAINS',
'Value': 'string'
},
]
)
Filters to scope the results. The following filters and logical operators are supported:
An inventory filter.
Name of the filter.
Condition of the filter.
Value of the filter.
dict
Response Syntax
{
'ResourceInventoryList': [
{
'ResourceId': 'string',
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'ResourceArn': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'ResourceOwningAccountId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceInventoryList (list) --
Information about the resources.
(dict) --
Details about a resource.
ResourceId (string) --
ID of the resource.
ResourceType (string) --
Type of resource.
ResourceArn (string) --
Amazon Resource Name (ARN) of the resource.
Platform (string) --
Platform of the resource.
PlatformVersion (string) --
Platform version of the resource in the inventory.
ResourceOwningAccountId (string) --
ID of the account that owns the resource.
NextToken (string) --
Token for the next set of results.
Lists the tags for the specified license configuration.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
Information about the tags.
Details about a tag for a license configuration.
Tag key.
Tag value.
Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.
See also: AWS API Documentation
Request Syntax
response = client.list_usage_for_license_configuration(
LicenseConfigurationArn='string',
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
Filters to scope the results. The following filters and logical operators are supported:
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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'LicenseConfigurationUsageList': [
{
'ResourceArn': 'string',
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'ResourceStatus': 'string',
'ResourceOwnerId': 'string',
'AssociationTime': datetime(2015, 1, 1),
'ConsumedLicenses': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LicenseConfigurationUsageList (list) --
Information about the license configurations.
(dict) --
Details about the usage of a resource associated with a license configuration.
ResourceArn (string) --
Amazon Resource Name (ARN) of the resource.
ResourceType (string) --
Type of resource.
ResourceStatus (string) --
Status of the resource.
ResourceOwnerId (string) --
ID of the account that owns the resource.
AssociationTime (datetime) --
Time when the license configuration was initially associated with the resource.
ConsumedLicenses (integer) --
Number of licenses consumed by the resource.
NextToken (string) --
Token for the next set of results.
Adds the specified tags to the specified license configuration.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
[REQUIRED]
One or more tags.
Details about a tag for a license configuration.
Tag key.
Tag value.
dict
Response Syntax
{}
Response Structure
Removes the specified tags from the specified license configuration.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
[REQUIRED]
Keys identifying the tags to remove.
dict
Response Syntax
{}
Response Structure
Modifies the attributes of an existing license configuration.
A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.
See also: AWS API Documentation
Request Syntax
response = client.update_license_configuration(
LicenseConfigurationArn='string',
LicenseConfigurationStatus='AVAILABLE'|'DISABLED',
LicenseRules=[
'string',
],
LicenseCount=123,
LicenseCountHardLimit=True|False,
Name='string',
Description='string',
ProductInformationList=[
{
'ResourceType': 'string',
'ProductInformationFilterList': [
{
'ProductInformationFilterName': 'string',
'ProductInformationFilterValue': [
'string',
],
'ProductInformationFilterComparator': 'string'
},
]
},
]
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
New license rules.
New product information.
Describes product information for a license configuration.
Resource type. The value is SSM_MANAGED .
Product information filters. The following filters and logical operators are supported:
Describes product information filters.
Filter name.
Filter value.
Logical operator.
dict
Response Syntax
{}
Response Structure
Adds or removes the specified license configurations for the specified AWS resource.
You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and AWS CloudFormation templates, as they send license configurations to the operation that creates the resource.
See also: AWS API Documentation
Request Syntax
response = client.update_license_specifications_for_resource(
ResourceArn='string',
AddLicenseSpecifications=[
{
'LicenseConfigurationArn': 'string'
},
],
RemoveLicenseSpecifications=[
{
'LicenseConfigurationArn': 'string'
},
]
)
[REQUIRED]
Amazon Resource Name (ARN) of the AWS resource.
ARNs of the license configurations to add.
Details for associating a license configuration with a resource.
Amazon Resource Name (ARN) of the license configuration.
ARNs of the license configurations to remove.
Details for associating a license configuration with a resource.
Amazon Resource Name (ARN) of the license configuration.
dict
Response Syntax
{}
Response Structure
Updates License Manager settings for the current Region.
See also: AWS API Documentation
Request Syntax
response = client.update_service_settings(
S3BucketArn='string',
SnsTopicArn='string',
OrganizationConfiguration={
'EnableIntegration': True|False
},
EnableCrossAccountsDiscovery=True|False
)
Enables integration with AWS Organizations for cross-account discovery.
Enables AWS Organization integration.
dict
Response Syntax
{}
Response Structure
The available paginators are:
paginator = client.get_paginator('list_associations_for_license_configuration')
Creates an iterator that will paginate through responses from LicenseManager.Client.list_associations_for_license_configuration().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LicenseConfigurationArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Amazon Resource Name (ARN) of a license configuration.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LicenseConfigurationAssociations': [
{
'ResourceArn': 'string',
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'ResourceOwnerId': 'string',
'AssociationTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
LicenseConfigurationAssociations (list) --
Information about the associations for the license configuration.
(dict) --
Describes an association with a license configuration.
ResourceArn (string) --
Amazon Resource Name (ARN) of the resource.
ResourceType (string) --
Type of server resource.
ResourceOwnerId (string) --
ID of the AWS account that owns the resource consuming licenses.
AssociationTime (datetime) --
Time when the license configuration was associated with the resource.
paginator = client.get_paginator('list_license_configurations')
Creates an iterator that will paginate through responses from LicenseManager.Client.list_license_configurations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LicenseConfigurationArns=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Amazon Resource Names (ARN) of the license configurations.
Filters to scope the results. The following filters and logical operators are supported:
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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LicenseConfigurations': [
{
'LicenseConfigurationId': 'string',
'LicenseConfigurationArn': 'string',
'Name': 'string',
'Description': 'string',
'LicenseCountingType': 'vCPU'|'Instance'|'Core'|'Socket',
'LicenseRules': [
'string',
],
'LicenseCount': 123,
'LicenseCountHardLimit': True|False,
'ConsumedLicenses': 123,
'Status': 'string',
'OwnerAccountId': 'string',
'ConsumedLicenseSummaryList': [
{
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'ConsumedLicenses': 123
},
],
'ManagedResourceSummaryList': [
{
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'AssociationCount': 123
},
],
'ProductInformationList': [
{
'ResourceType': 'string',
'ProductInformationFilterList': [
{
'ProductInformationFilterName': 'string',
'ProductInformationFilterValue': [
'string',
],
'ProductInformationFilterComparator': 'string'
},
]
},
],
'AutomatedDiscoveryInformation': {
'LastRunTime': datetime(2015, 1, 1)
}
},
],
}
Response Structure
(dict) --
LicenseConfigurations (list) --
Information about the license configurations.
(dict) --
A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.
LicenseConfigurationId (string) --
Unique ID of the license configuration.
LicenseConfigurationArn (string) --
Amazon Resource Name (ARN) of the license configuration.
Name (string) --
Name of the license configuration.
Description (string) --
Description of the license configuration.
LicenseCountingType (string) --
Dimension to use to track the license inventory.
LicenseRules (list) --
License rules.
LicenseCount (integer) --
Number of licenses managed by the license configuration.
LicenseCountHardLimit (boolean) --
Number of available licenses as a hard limit.
ConsumedLicenses (integer) --
Number of licenses consumed.
Status (string) --
Status of the license configuration.
OwnerAccountId (string) --
Account ID of the license configuration's owner.
ConsumedLicenseSummaryList (list) --
Summaries for licenses consumed by various resources.
(dict) --
Details about license consumption.
ResourceType (string) --
Resource type of the resource consuming a license.
ConsumedLicenses (integer) --
Number of licenses consumed by the resource.
ManagedResourceSummaryList (list) --
Summaries for managed resources.
(dict) --
Summary information about a managed resource.
ResourceType (string) --
Type of resource associated with a license.
AssociationCount (integer) --
Number of resources associated with licenses.
ProductInformationList (list) --
Product information.
(dict) --
Describes product information for a license configuration.
ResourceType (string) --
Resource type. The value is SSM_MANAGED .
ProductInformationFilterList (list) --
Product information filters. The following filters and logical operators are supported:
(dict) --
Describes product information filters.
ProductInformationFilterName (string) --
Filter name.
ProductInformationFilterValue (list) --
Filter value.
ProductInformationFilterComparator (string) --
Logical operator.
AutomatedDiscoveryInformation (dict) --
Automated discovery information.
LastRunTime (datetime) --
Time that automated discovery last ran.
paginator = client.get_paginator('list_license_specifications_for_resource')
Creates an iterator that will paginate through responses from LicenseManager.Client.list_license_specifications_for_resource().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Amazon Resource Name (ARN) of a resource that has an associated license configuration.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LicenseSpecifications': [
{
'LicenseConfigurationArn': 'string'
},
],
}
Response Structure
(dict) --
LicenseSpecifications (list) --
License configurations associated with a resource.
(dict) --
Details for associating a license configuration with a resource.
LicenseConfigurationArn (string) --
Amazon Resource Name (ARN) of the license configuration.
paginator = client.get_paginator('list_resource_inventory')
Creates an iterator that will paginate through responses from LicenseManager.Client.list_resource_inventory().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'string',
'Condition': 'EQUALS'|'NOT_EQUALS'|'BEGINS_WITH'|'CONTAINS',
'Value': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters to scope the results. The following filters and logical operators are supported:
An inventory filter.
Name of the filter.
Condition of the filter.
Value of the filter.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ResourceInventoryList': [
{
'ResourceId': 'string',
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'ResourceArn': 'string',
'Platform': 'string',
'PlatformVersion': 'string',
'ResourceOwningAccountId': 'string'
},
],
}
Response Structure
(dict) --
ResourceInventoryList (list) --
Information about the resources.
(dict) --
Details about a resource.
ResourceId (string) --
ID of the resource.
ResourceType (string) --
Type of resource.
ResourceArn (string) --
Amazon Resource Name (ARN) of the resource.
Platform (string) --
Platform of the resource.
PlatformVersion (string) --
Platform version of the resource in the inventory.
ResourceOwningAccountId (string) --
ID of the account that owns the resource.
paginator = client.get_paginator('list_usage_for_license_configuration')
Creates an iterator that will paginate through responses from LicenseManager.Client.list_usage_for_license_configuration().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
LicenseConfigurationArn='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Amazon Resource Name (ARN) of the license configuration.
Filters to scope the results. The following filters and logical operators are supported:
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 of the filter. Filter names are case-sensitive.
Filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LicenseConfigurationUsageList': [
{
'ResourceArn': 'string',
'ResourceType': 'EC2_INSTANCE'|'EC2_HOST'|'EC2_AMI'|'RDS'|'SYSTEMS_MANAGER_MANAGED_INSTANCE',
'ResourceStatus': 'string',
'ResourceOwnerId': 'string',
'AssociationTime': datetime(2015, 1, 1),
'ConsumedLicenses': 123
},
],
}
Response Structure
(dict) --
LicenseConfigurationUsageList (list) --
Information about the license configurations.
(dict) --
Details about the usage of a resource associated with a license configuration.
ResourceArn (string) --
Amazon Resource Name (ARN) of the resource.
ResourceType (string) --
Type of resource.
ResourceStatus (string) --
Status of the resource.
ResourceOwnerId (string) --
ID of the account that owns the resource.
AssociationTime (datetime) --
Time when the license configuration was initially associated with the resource.
ConsumedLicenses (integer) --
Number of licenses consumed by the resource.