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

CreateResourceExplorerSetup

Creates a Resource Explorer setup configuration across multiple AWS Regions. This operation sets up indexes and views in the specified Regions. This operation can also be used to set an aggregator Region for cross-Region resource search.

Request Syntax


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

{
   "AggregatorRegions": [ "string" ],
   "RegionList": [ "string" ],
   "ViewName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

RegionList

A list of AWS Regions where Resource Explorer should be configured. Each Region in the list will have a user-owned index created.

Type: Array of strings

Array Members: Minimum number of 1 item.

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

Required: Yes

ViewName

The name for the view to be created as part of the Resource Explorer setup. The view name must be unique within the AWS account and Region.

Type: String

Pattern: [a-zA-Z0-9-]{1,64}

Required: Yes

AggregatorRegions

A list of AWS Regions that should be configured as aggregator Regions. Aggregator Regions receive replicated index information from all other Regions where there is a user-owned index.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1 item.

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "TaskId": "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.

TaskId

The unique identifier for the setup task. Use this ID with GetResourceExplorerSetup to monitor the progress of the configuration operation.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

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

ConflictException

If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this AWS Region.

If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current AWS Region.

If you attempted to update an index type to AGGREGATOR, then the request failed because you already have an AGGREGATOR index in a different AWS Region.

HTTP Status Code: 409

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