ResourceExplorer / Paginator / ListIndexesForMembers

ListIndexesForMembers#

class ResourceExplorer.Paginator.ListIndexesForMembers#

paginator = client.get_paginator('list_indexes_for_members')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    AccountIdList=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

AccountIdList (list) –
[REQUIRED]

The account IDs will limit the output to only indexes from these accounts.
- (string) –
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': [
        {
            'AccountId': 'string',
            '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.
    - AccountId (string) –
      
      The account ID for the index.
    - 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.