Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListServiceIndexes

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

Request Syntax


POST /ListServiceIndexes HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "Regions": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of index results to return in a single response. Valid values are between 1 and 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The pagination token from a previous ListServiceIndexes response. Use this token to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Regions

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Pattern: [a-z-]+-[a-z]+-[0-9]

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Indexes": [ 
      { 
         "Arn": "string",
         "Region": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Indexes

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

Type: Array of Index objects

NextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The credentials that you used to call this operation don't have the minimum required permissions.

HTTP Status Code: 403

InternalServerException

The request failed because of internal service error. Try your request again later.

HTTP Status Code: 500

ThrottlingException

The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

HTTP Status Code: 429

ValidationException

You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

FieldList: An array of the request fields that had validation errors.

HTTP Status Code: 400