ResourceExplorer / Paginator / ListIndexes

ListIndexes

class ResourceExplorer.Paginator.ListIndexes

paginator = client.get_paginator('list_indexes')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ResourceExplorer.Client.list_indexes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Regions=[
        'string',
    ],
    Type='LOCAL'|'AGGREGATOR',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Regions (list) –

  If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

  • (string) –

• Type (string) –

  If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

  Use this option to discover the aggregator index for your account.

• 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

{
    'Indexes': [
        {
            'Arn': 'string',
            'Region': 'string',
            'Type': 'LOCAL'|'AGGREGATOR'
        },
    ],

}

Response Structure

• (dict) –

  • Indexes (list) –

    A structure that contains the details and status of each index.

    • (dict) –

      An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.

      By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.

      • Arn (string) –

        The Amazon resource name (ARN) of the index.

      • Region (string) –

        The Amazon Web Services Region in which the index exists.

      • Type (string) –

        The type of index. It can be one of the following values:

        • LOCAL – The index contains information about resources from only the same Amazon Web Services Region.

        • AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.