ResourceExplorer / Client / list_service_indexes

list_service_indexes

ResourceExplorer.Client.list_service_indexes(**kwargs)

Lists all Resource Explorer indexes across the specified Amazon Web Services Regions. This operation returns information about indexes including their ARNs, types, and Regions.

See also: AWS API Documentation

Request Syntax

response = client.list_service_indexes(
    Regions=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • Regions (list) –

    A list of Amazon Web Services Regions to include in the search for indexes. If not specified, indexes from all Regions are returned.

    • (string) –

  • MaxResults (integer) – The maximum number of index results to return in a single response. Valid values are between 1 and 100.

  • NextToken (string) – The pagination token from a previous ListServiceIndexes response. Use this token to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Indexes (list) –

      A list of Index objects that describe the Resource Explorer indexes found in the specified Regions.

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

        • Region (string) –

          The Amazon Web Services Region in which the index exists.

        • Arn (string) –

          The Amazon resource name (ARN) of the index.

        • 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) –

      The pagination token to use in a subsequent ListServiceIndexes request to retrieve the next set of results.

Exceptions

  • ResourceExplorer.Client.exceptions.InternalServerException

  • ResourceExplorer.Client.exceptions.ValidationException

  • ResourceExplorer.Client.exceptions.ThrottlingException

  • ResourceExplorer.Client.exceptions.AccessDeniedException