LicenseManager / Paginator / ListLicenseConfigurations

ListLicenseConfigurations

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 for which licenses are counted. Possible values are vCPU | Instance | Core | Socket. 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) –

      The value of the filter, which is case-sensitive. You can only specify one value for the filter.

      • (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,
            'DisassociateWhenNotFound': 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.

      • DisassociateWhenNotFound (boolean) –

        When true, disassociates a resource when software is uninstalled.

      • 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 possible values are SSM_MANAGED | RDS.

          • ProductInformationFilterList (list) –

            A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

            Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

            The following filters and are supported when the resource type is SSM_MANAGED:

            • 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.

            • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

            • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_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.

            The following filters and logical operators are supported when the resource type is RDS:

            • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.

            • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

            • (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.