Skip to content

List Indexes

resourceexplorer_list_indexes R Documentation

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

Description

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.

Usage

resourceexplorer_list_indexes(MaxResults, NextToken, Regions, Type)

Arguments

MaxResults

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.

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

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. The pagination tokens expire after 24 hours.

Regions

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

Type

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.

Value

A list with the following syntax: 

list(
  Indexes = list(
    list(
      Arn = "string",
      Region = "string",
      Type = "LOCAL"|"AGGREGATOR"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_indexes(
  MaxResults = 123,
  NextToken = "string",
  Regions = list(
    "string"
  ),
  Type = "LOCAL"|"AGGREGATOR"
)