ApplicationDiscoveryService / Paginator / ListConfigurations

ListConfigurations

class ApplicationDiscoveryService.Paginator.ListConfigurations

paginator = client.get_paginator('list_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ApplicationDiscoveryService.Client.list_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    configurationType='SERVER'|'PROCESS'|'CONNECTION'|'APPLICATION',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ],
            'condition': 'string'
        },
    ],
    orderBy=[
        {
            'fieldName': 'string',
            'sortOrder': 'ASC'|'DESC'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• configurationType (string) –

  [REQUIRED]

  A valid configuration identified by Application Discovery Service.

• filters (list) –

  You can filter the request using various logical operators and a key-value format. For example:

  {"key": "serverType", "value": "webServer"}

  For a complete list of filter options and guidance about using them with this action, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.

  • (dict) –

    A filter that can use conditional operators.

    For more information about filters, see Querying Discovered Configuration Items in the Amazon Web Services Application Discovery Service User Guide.

    • name (string) – [REQUIRED]

      The name of the filter.

    • values (list) – [REQUIRED]

      A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.

      • (string) –

    • condition (string) – [REQUIRED]

      A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations or ListConfigurations returns attributes of matching configuration items.

• orderBy (list) –

  Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.

  • (dict) –

    A field and direction for ordered output.

    • fieldName (string) – [REQUIRED]

      The field on which to order.

    • sortOrder (string) –

      Ordering direction.

• 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

{
    'configurations': [
        {
            'string': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • configurations (list) –

    Returns configuration details, including the configuration ID, attribute names, and attribute values.

    • (dict) –

      • (string) –

        • (string) –

  • NextToken (string) –

    A token to resume pagination.