Retrieves a list of a member's indexes in all AWS Regions that are currently collecting resource information for AWS Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call.
Minimum permissions
To call this operation, you must have the following permissions:
-
Action:
resource-explorer-2:ListIndexesForMembersResource: No specific resource (*).
Related operations
-
To turn on Resource Explorer in an AWS Region, use CreateIndex.
-
To turn off Resource Explorer in an AWS Region, use DeleteIndex.
-
To retrieve the details for an index and check its state or its type, use GetIndex.
-
To list all of the indexes in the AWS account, use ListIndexes.
-
To convert a local index to an aggregator index, use UpdateIndexType.
Request Syntax
POST /ListIndexesForMembers HTTP/1.1
Content-type: application/json
{
"AccountIdList": [ "string" ],
"MaxResults": number,
"NextToken": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- AccountIdList
-
The account IDs will limit the output to only indexes from these accounts.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
- 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
NextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest 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
NextTokenafter every operation to ensure that you receive all of the results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
- NextToken
-
The parameter for receiving additional results if you receive a
NextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value of the previous call'sNextTokenresponse to indicate where the output should continue from. The pagination tokens expire after 24 hours.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Indexes": [
{
"AccountId": "string",
"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 structure that contains the details and status of each index.
Type: Array of MemberIndex objects
- NextToken
-
If present, indicates that more output is available than is included in the current response. Use this value in the
NextTokenrequest parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextTokenresponse element comes back asnull. The pagination tokens expire after 24 hours.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.
HTTP Status Code: 400
Examples
Example
The following example shows how to list the existing Resource Explorer indexes in each Region for a specific account.
Sample Request
POST /ListIndexesForMembers HTTP/1.1
Host: resource-explorer-2.us-east-1.amazonaws.com
X-Amz-Date: 20221101T200059Z
Accept-Encoding: identity
User-Agent: <UserAgentString>
Content-Length: <PayloadSizeBytes>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
{
"AccountidList": [
"123456789012"
]
}Sample Response
HTTP/1.1 200 OK
Date: Tue, 01 Nov 2022 20:00:59 GMT
Content-Type: application/json
Content-Length: <PayloadSizeBytes>
{
"Indexes": [
{
"AccountId": "123456789012",
"Arn": "arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE11111",
"Region": "us-east-1",
"Type": "LOCAL"
},
{
"AccountId": "123456789012",
"Arn": "arn:aws:resource-explorer-2:us-west-2:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222",
"Region":"us-west-2",
"Type":"LOCAL"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
