Get Resource Explorer Setup

resourceexplorer_get_resource_explorer_setup

R Documentation

Retrieves the status and details of a Resource Explorer setup operation¶

Description¶

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.

Usage¶

resourceexplorer_get_resource_explorer_setup(TaskId, MaxResults,
  NextToken)

Arguments¶

TaskId

[required] The unique identifier of the setup task to retrieve status information for. This ID is returned by create_resource_explorer_setup or delete_resource_explorer_setup operations.

MaxResults

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

NextToken

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

Value¶

A list with the following syntax:

list(
  Regions = list(
    list(
      Region = "string",
      Index = list(
        Status = "SUCCEEDED"|"FAILED"|"IN_PROGRESS"|"SKIPPED",
        Index = list(
          Region = "string",
          Arn = "string",
          Type = "LOCAL"|"AGGREGATOR"
        ),
        ErrorDetails = list(
          Code = "string",
          Message = "string"
        )
      ),
      View = list(
        Status = "SUCCEEDED"|"FAILED"|"IN_PROGRESS"|"SKIPPED",
        View = list(
          ViewArn = "string",
          ViewName = "string",
          Owner = "string",
          LastUpdatedAt = as.POSIXct(
            "2015-01-01"
          ),
          Scope = "string",
          IncludedProperties = list(
            list(
              Name = "string"
            )
          ),
          Filters = list(
            FilterString = "string"
          )
        ),
        ErrorDetails = list(
          Code = "string",
          Message = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_resource_explorer_setup(
  TaskId = "string",
  MaxResults = 123,
  NextToken = "string"
)