LicenseManagerUserSubscriptions / Paginator / ListInstances

ListInstances#

class LicenseManagerUserSubscriptions.Paginator.ListInstances#
paginator = client.get_paginator('list_instances')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from LicenseManagerUserSubscriptions.Client.list_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Attribute': 'string',
            'Operation': 'string',
            'Value': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • Filters (list) –

    An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.

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

      • Attribute (string) –

        The name of an attribute to use as a filter.

      • Operation (string) –

        The type of search (For example, eq, geq, leq)

      • 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

{
    'InstanceSummaries': [
        {
            'InstanceId': 'string',
            'LastStatusCheckDate': 'string',
            'Products': [
                'string',
            ],
            'Status': 'string',
            'StatusMessage': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • InstanceSummaries (list) –

      Metadata that describes the list instances operation.

      • (dict) –

        Describes an EC2 instance providing user-based subscriptions.

        • InstanceId (string) –

          The ID of the EC2 instance, which provides user-based subscriptions.

        • LastStatusCheckDate (string) –

          The date of the last status check.

        • Products (list) –

          A list of provided user-based subscription products.

          • (string) –

        • Status (string) –

          The status of an EC2 instance resource.

        • StatusMessage (string) –

          The status message for an EC2 instance.