LicenseManager ¶

Table of Contents

LicenseManager
- Client
- Paginators

Client ¶

class LicenseManager.Client¶

A low-level client representing AWS License Manager:

import boto3

client = boto3.client('license-manager')

These are the available methods:

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

create_license_configuration(**kwargs)¶

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

Parameters

Name (string) --
[REQUIRED]

Name of the license configuration.
Description (string) -- Description of the license configuration.
LicenseCountingType (string) --
[REQUIRED]

Dimension used to track the license inventory.
LicenseCount (integer) -- Number of licenses managed by the license configuration.
LicenseCountHardLimit (boolean) -- Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.
LicenseRules (list) --
License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). Available rules vary by dimension.
- Cores dimension: allowedTenancy | maximumCores | minimumCores
- Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus
- Sockets dimension: allowedTenancy | maximumSockets | minimumSockets
- vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus
- (string) --
Tags (list) --
Tags to add to the license configuration.
- (dict) --
  Details about a tag for a license configuration.
  - Key (string) --
    Tag key.
  - Value (string) --
    Tag value.
ProductInformationList (list) --
Product information.
- (dict) --
  Describes product information for a license configuration.
  - ResourceType (string) -- [REQUIRED]
    Resource type. The value is SSM_MANAGED .
  - ProductInformationFilterList (list) -- [REQUIRED]
    Product information filters. The following filters and logical operators are supported:
    - Application Name - The name of the application. Logical operator is EQUALS .
    - Application Publisher - The publisher of the application. Logical operator is EQUALS .
    - Application Version - The version of the application. Logical operator is EQUALS .
    - Platform Name - The name of the platform. Logical operator is EQUALS .
    - Platform Type - The platform type. Logical operator is EQUALS .
    - License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .
    - (dict) --
      Describes product information filters.
      - ProductInformationFilterName (string) -- [REQUIRED]
        Filter name.
      - ProductInformationFilterValue (list) -- [REQUIRED]
        Filter value.
        
        (string) --
      - ProductInformationFilterComparator (string) -- [REQUIRED]
        Logical operator.

Return type

dict

Returns

Response Syntax

{
    'LicenseConfigurationArn': 'string'
}

Response Structure

(dict) --
- LicenseConfigurationArn (string) --
  
  Amazon Resource Name (ARN) of the license configuration.

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.ResourceLimitExceededException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

delete_license_configuration(**kwargs)¶

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

Parameters

LicenseConfigurationArn (string) --

[REQUIRED]

ID of the license configuration.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters

ClientMethod (string) -- The client method to presign for
Params (dict) -- The parameters normally passed to ClientMethod.
ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

get_license_configuration(**kwargs)¶

Gets detailed information about the specified license configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_license_configuration(
    LicenseConfigurationArn='string'
)

Parameters

LicenseConfigurationArn (string) --

[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.

Return type

dict

Returns

Response Syntax

{
    '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

(dict) --
- LicenseConfigurationId (string) --
  Unique ID for 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 on which the licenses are counted.
- LicenseRules (list) --
  License rules.
  - (string) --
- LicenseCount (integer) --
  Number of available licenses.
- LicenseCountHardLimit (boolean) --
  Sets the number of available licenses as a hard limit.
- ConsumedLicenses (integer) --
  Number of licenses assigned to resources.
- Status (string) --
  License configuration status.
- OwnerAccountId (string) --
  Account ID of the owner of the license configuration.
- ConsumedLicenseSummaryList (list) --
  Summaries of the licenses consumed by 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 of the 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.
- Tags (list) --
  Tags for the license configuration.
  - (dict) --
    Details about a tag for a license configuration.
    - Key (string) --
      Tag key.
    - Value (string) --
      Tag value.
- 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:
      - Application Name - The name of the application. Logical operator is EQUALS .
      - Application Publisher - The publisher of the application. Logical operator is EQUALS .
      - Application Version - The version of the application. Logical operator is EQUALS .
      - Platform Name - The name of the platform. Logical operator is EQUALS .
      - Platform Type - The platform type. Logical operator is EQUALS .
      - License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .
      - (dict) --
        Describes product information filters.
        
        ProductInformationFilterName (string) --
        Filter name.
        
        ProductInformationFilterValue (list) --
        Filter value.
        
        (string) --
        
        ProductInformationFilterComparator (string) --
        Logical operator.
- AutomatedDiscoveryInformation (dict) --
  Automated discovery information.
  - LastRunTime (datetime) --
    Time that automated discovery last ran.

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_service_settings()¶

Gets the License Manager settings for the current Region.

See also: AWS API Documentation

Request Syntax

response = client.get_service_settings()

Return type

dict

Returns

Response Syntax

{
    'S3BucketArn': 'string',
    'SnsTopicArn': 'string',
    'OrganizationConfiguration': {
        'EnableIntegration': True|False
    },
    'EnableCrossAccountsDiscovery': True|False,
    'LicenseManagerResourceShareArn': 'string'
}

Response Structure

(dict) --
- S3BucketArn (string) --
  Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.
- SnsTopicArn (string) --
  SNS topic configured to receive notifications from License Manager.
- OrganizationConfiguration (dict) --
  Indicates whether AWS Organizations has been integrated with License Manager for cross-account discovery.
  - EnableIntegration (boolean) --
    Enables AWS Organization integration.
- EnableCrossAccountsDiscovery (boolean) --
  Indicates whether cross-account discovery has been enabled.
- LicenseManagerResourceShareArn (string) --
  Amazon Resource Name (ARN) of the AWS resource share. The License Manager master account will provide member accounts with access to this share.

Exceptions

LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

list_associations_for_license_configuration(**kwargs)¶

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

Parameters

LicenseConfigurationArn (string) --
[REQUIRED]

Amazon Resource Name (ARN) of a license configuration.
MaxResults (integer) -- Maximum number of results to return in a single call.
NextToken (string) -- Token for the next set of results.

Return type

dict

Returns

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.

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.FilterLimitExceededException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

list_failures_for_license_configuration_operations(**kwargs)¶

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

Parameters

LicenseConfigurationArn (string) --
[REQUIRED]

Amazon Resource Name of the license configuration.
MaxResults (integer) -- Maximum number of results to return in a single call.
NextToken (string) -- Token for the next set of results.

Return type

dict

Returns

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.

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

list_license_configurations(**kwargs)¶

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

Parameters

LicenseConfigurationArns (list) --
Amazon Resource Names (ARN) of the license configurations.
- (string) --
MaxResults (integer) -- Maximum number of results to return in a single call.
NextToken (string) -- Token for the next set of results.
Filters (list) --
Filters to scope the results. The following filters and logical operators are supported:
- licenseCountingType - The dimension on which licenses are counted (vCPU). Logical operators are EQUALS | NOT_EQUALS .
- enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS .
- usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS .
- (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) --

Return type

dict

Returns

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.
      - (string) --
    - 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:
        
        Application Name - The name of the application. Logical operator is EQUALS .
        
        Application Publisher - The publisher of the application. Logical operator is EQUALS .
        
        Application Version - The version of the application. Logical operator is EQUALS .
        
        Platform Name - The name of the platform. Logical operator is EQUALS .
        
        Platform Type - The platform type. Logical operator is EQUALS .
        
        License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .
        
        (dict) --
        
        Describes product information filters.
        
        ProductInformationFilterName (string) --
        
        Filter name.
        
        ProductInformationFilterValue (list) --
        
        Filter value.
        
        (string) --
        
        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.

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.FilterLimitExceededException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

list_license_specifications_for_resource(**kwargs)¶

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

Parameters

ResourceArn (string) --
[REQUIRED]

Amazon Resource Name (ARN) of a resource that has an associated license configuration.
MaxResults (integer) -- Maximum number of results to return in a single call.
NextToken (string) -- Token for the next set of results.

Return type

dict

Returns

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.

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

list_resource_inventory(**kwargs)¶

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

Parameters

MaxResults (integer) -- Maximum number of results to return in a single call.
NextToken (string) -- Token for the next set of results.
Filters (list) --
Filters to scope the results. The following filters and logical operators are supported:
- account_id - The ID of the AWS account that owns the resource. Logical operators are EQUALS | NOT_EQUALS .
- application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH .
- license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS . Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .
- platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH .
- resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS .
- (dict) --
  An inventory filter.
  - Name (string) -- [REQUIRED]
    Name of the filter.
  - Condition (string) -- [REQUIRED]
    Condition of the filter.
  - Value (string) --
    Value of the filter.

Return type

dict

Returns

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.

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.FilterLimitExceededException
LicenseManager.Client.exceptions.FailedDependencyException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

list_tags_for_resource(**kwargs)¶

Lists the tags for the specified license configuration.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)

Parameters

ResourceArn (string) --

[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.

Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- Tags (list) --
  Information about the tags.
  - (dict) --
    Details about a tag for a license configuration.
    - Key (string) --
      Tag key.
    - Value (string) --
      Tag value.

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

list_usage_for_license_configuration(**kwargs)¶

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

Parameters

LicenseConfigurationArn (string) --
[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.
MaxResults (integer) -- Maximum number of results to return in a single call.
NextToken (string) -- Token for the next set of results.
Filters (list) --
Filters to scope the results. The following filters and logical operators are supported:
- resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS .
- resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS .
- resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS .
- (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) --

Return type

dict

Returns

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.

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.FilterLimitExceededException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

tag_resource(**kwargs)¶

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

Parameters

ResourceArn (string) --
[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.
Tags (list) --
[REQUIRED]

One or more tags.
- (dict) --
  Details about a tag for a license configuration.
  - Key (string) --
    Tag key.
  - Value (string) --
    Tag value.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

untag_resource(**kwargs)¶

Removes the specified tags from the specified license configuration.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

Parameters

ResourceArn (string) --
[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.
TagKeys (list) --
[REQUIRED]

Keys identifying the tags to remove.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

update_license_configuration(**kwargs)¶

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

Parameters

LicenseConfigurationArn (string) --
[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.
LicenseConfigurationStatus (string) -- New status of the license configuration.
LicenseRules (list) --
New license rules.
- (string) --
LicenseCount (integer) -- New number of licenses managed by the license configuration.
LicenseCountHardLimit (boolean) -- New hard limit of the number of available licenses.
Name (string) -- New name of the license configuration.
Description (string) -- New description of the license configuration.
ProductInformationList (list) --
New product information.
- (dict) --
  Describes product information for a license configuration.
  - ResourceType (string) -- [REQUIRED]
    Resource type. The value is SSM_MANAGED .
  - ProductInformationFilterList (list) -- [REQUIRED]
    Product information filters. The following filters and logical operators are supported:
    - Application Name - The name of the application. Logical operator is EQUALS .
    - Application Publisher - The publisher of the application. Logical operator is EQUALS .
    - Application Version - The version of the application. Logical operator is EQUALS .
    - Platform Name - The name of the platform. Logical operator is EQUALS .
    - Platform Type - The platform type. Logical operator is EQUALS .
    - License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .
    - (dict) --
      Describes product information filters.
      - ProductInformationFilterName (string) -- [REQUIRED]
        Filter name.
      - ProductInformationFilterValue (list) -- [REQUIRED]
        Filter value.
        
        (string) --
      - ProductInformationFilterComparator (string) -- [REQUIRED]
        Logical operator.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

update_license_specifications_for_resource(**kwargs)¶

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

Parameters

ResourceArn (string) --
[REQUIRED]

Amazon Resource Name (ARN) of the AWS resource.
AddLicenseSpecifications (list) --
ARNs of the license configurations to add.
- (dict) --
  Details for associating a license configuration with a resource.
  - LicenseConfigurationArn (string) -- [REQUIRED]
    Amazon Resource Name (ARN) of the license configuration.
RemoveLicenseSpecifications (list) --
ARNs of the license configurations to remove.
- (dict) --
  Details for associating a license configuration with a resource.
  - LicenseConfigurationArn (string) -- [REQUIRED]
    Amazon Resource Name (ARN) of the license configuration.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.InvalidResourceStateException
LicenseManager.Client.exceptions.LicenseUsageException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

update_service_settings(**kwargs)¶

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
)

Parameters

S3BucketArn (string) -- Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.
SnsTopicArn (string) -- Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.
OrganizationConfiguration (dict) --
Enables integration with AWS Organizations for cross-account discovery.
- EnableIntegration (boolean) -- [REQUIRED]
  Enables AWS Organization integration.
EnableCrossAccountsDiscovery (boolean) -- Activates cross-account discovery.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

LicenseManager.Client.exceptions.InvalidParameterValueException
LicenseManager.Client.exceptions.ServerInternalException
LicenseManager.Client.exceptions.AuthorizationException
LicenseManager.Client.exceptions.AccessDeniedException
LicenseManager.Client.exceptions.RateLimitExceededException

Paginators ¶

The available paginators are:

LicenseManager.Paginator.ListAssociationsForLicenseConfiguration
LicenseManager.Paginator.ListLicenseConfigurations
LicenseManager.Paginator.ListLicenseSpecificationsForResource
LicenseManager.Paginator.ListResourceInventory
LicenseManager.Paginator.ListUsageForLicenseConfiguration

class LicenseManager.Paginator.ListAssociationsForLicenseConfiguration¶

paginator = client.get_paginator('list_associations_for_license_configuration')

paginate(**kwargs)¶

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

Parameters

LicenseConfigurationArn (string) --
[REQUIRED]

Amazon Resource Name (ARN) of a license configuration.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class LicenseManager.Paginator.ListLicenseConfigurations¶

paginator = client.get_paginator('list_license_configurations')

paginate(**kwargs)¶

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

Parameters

LicenseConfigurationArns (list) --
Amazon Resource Names (ARN) of the license configurations.
- (string) --
Filters (list) --
Filters to scope the results. The following filters and logical operators are supported:
- licenseCountingType - The dimension on which licenses are counted (vCPU). Logical operators are EQUALS | NOT_EQUALS .
- enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS .
- usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS .
- (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) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.
      - (string) --
    - 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:
        
        Application Name - The name of the application. Logical operator is EQUALS .
        
        Application Publisher - The publisher of the application. Logical operator is EQUALS .
        
        Application Version - The version of the application. Logical operator is EQUALS .
        
        Platform Name - The name of the platform. Logical operator is EQUALS .
        
        Platform Type - The platform type. Logical operator is EQUALS .
        
        License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .
        
        (dict) --
        
        Describes product information filters.
        
        ProductInformationFilterName (string) --
        
        Filter name.
        
        ProductInformationFilterValue (list) --
        
        Filter value.
        
        (string) --
        
        ProductInformationFilterComparator (string) --
        
        Logical operator.
    - AutomatedDiscoveryInformation (dict) --
      
      Automated discovery information.
      - LastRunTime (datetime) --
        
        Time that automated discovery last ran.

class LicenseManager.Paginator.ListLicenseSpecificationsForResource¶

paginator = client.get_paginator('list_license_specifications_for_resource')

paginate(**kwargs)¶

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

Parameters

ResourceArn (string) --
[REQUIRED]

Amazon Resource Name (ARN) of a resource that has an associated license configuration.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class LicenseManager.Paginator.ListResourceInventory¶

paginator = client.get_paginator('list_resource_inventory')

paginate(**kwargs)¶

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

Parameters

Filters (list) --
Filters to scope the results. The following filters and logical operators are supported:
- account_id - The ID of the AWS account that owns the resource. Logical operators are EQUALS | NOT_EQUALS .
- application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH .
- license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS . Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .
- platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH .
- resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS .
- (dict) --
  An inventory filter.
  - Name (string) -- [REQUIRED]
    Name of the filter.
  - Condition (string) -- [REQUIRED]
    Condition of the filter.
  - Value (string) --
    Value of the filter.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

class LicenseManager.Paginator.ListUsageForLicenseConfiguration¶

paginator = client.get_paginator('list_usage_for_license_configuration')

paginate(**kwargs)¶

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

Parameters

LicenseConfigurationArn (string) --
[REQUIRED]

Amazon Resource Name (ARN) of the license configuration.
Filters (list) --
Filters to scope the results. The following filters and logical operators are supported:
- resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS .
- resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS .
- resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS .
- (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) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

Navigation

Table Of Contents

LicenseManager¶

Client¶

Paginators¶

Navigation

LicenseManager ¶

Client ¶

Paginators ¶