ResourceExplorer / Client / list_indexes

list_indexes#

ResourceExplorer.Client.list_indexes(**kwargs)#

Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.

See also: AWS API Documentation

Request Syntax

response = client.list_indexes(
    MaxResults=123,
    NextToken='string',
    Regions=[
        'string',
    ],
    Type='LOCAL'|'AGGREGATOR'
)
Parameters:

  • MaxResults (integer) –

    The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

    Note

    An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken (string) – The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.

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

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

Exceptions

  • ResourceExplorer.Client.exceptions.InternalServerException

  • ResourceExplorer.Client.exceptions.ValidationException

  • ResourceExplorer.Client.exceptions.ThrottlingException

  • ResourceExplorer.Client.exceptions.AccessDeniedException