LicenseManager / Paginator / ListUsageForLicenseConfiguration

ListUsageForLicenseConfiguration

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.