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

GetResourceExplorerSetup

Retrieves the status and details of a Resource Explorer setup operation. This operation returns information about the progress of creating or deleting Resource Explorer configurations across Regions.

Request Syntax


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

{
   "MaxResults": number,
   "NextToken": "string",
   "TaskId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

TaskId

The unique identifier of the setup task to retrieve status information for. This ID is returned by CreateResourceExplorerSetup or DeleteResourceExplorerSetup operations.

Type: String

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

Required: Yes

MaxResults

The maximum number of Region status 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 GetResourceExplorerSetup 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

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Regions": [ 
      { 
         "Index": { 
            "ErrorDetails": { 
               "Code": "string",
               "Message": "string"
            },
            "Index": { 
               "Arn": "string",
               "Region": "string",
               "Type": "string"
            },
            "Status": "string"
         },
         "Region": "string",
         "View": { 
            "ErrorDetails": { 
               "Code": "string",
               "Message": "string"
            },
            "Status": "string",
            "View": { 
               "Filters": { 
                  "FilterString": "string"
               },
               "IncludedProperties": [ 
                  { 
                     "Name": "string"
                  }
               ],
               "LastUpdatedAt": "string",
               "Owner": "string",
               "Scope": "string",
               "ViewArn": "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.

NextToken

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

Type: String

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

Regions

A list of Region status objects that describe the current state of Resource Explorer configuration in each Region.

Type: Array of RegionStatus objects

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

ResourceNotFoundException

You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

HTTP Status Code: 404

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