[ aws . resource-explorer-2 ]
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.
See also: AWS API Documentation
get-resource-explorer-setup
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: Regions
get-resource-explorer-setup
--task-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--task-id
(string) [required]
The unique identifier of the setup task to retrieve status information for. This ID is returned by
CreateResourceExplorerSetup
orDeleteResourceExplorerSetup
operations.Constraints:
- pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
Regions -> (list)
A list of Region status objects that describe the current state of Resource Explorer configuration in each Region.
(structure)
Contains information about the status of Resource Explorer configuration in a specific Amazon Web Services Region.
Region -> (string)
The Amazon Web Services Region for which this status information applies.
Constraints:
- pattern:
[a-z-]+-[a-z]+-[0-9]
Index -> (structure)
The status information for the Resource Explorer index in this Region.
Status -> (string)
The current status of the index operation. Valid values are
SUCCEEDED
,FAILED
,IN_PROGRESS
, orSKIPPED
.Possible values:
SUCCEEDED
FAILED
IN_PROGRESS
SKIPPED
Index -> (structure)
An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.
By default, an index is local , meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.
Region -> (string)
The Amazon Web Services Region in which the index exists.Arn -> (string)
The Amazon resource name (ARN) of the index.Type -> (string)
The type of index. It can be one of the following values:
LOCAL
– The index contains information about resources from only the same Amazon Web Services Region.AGGREGATOR
– Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.Possible values:
LOCAL
AGGREGATOR
ErrorDetails -> (structure)
Details about any error that occurred during the index operation.
Code -> (string)
The error code that identifies the type of error that occurred.Message -> (string)
A human-readable description of the error that occurred.View -> (structure)
The status information for the Resource Explorer view in this Region.
Status -> (string)
The current status of the view operation. Valid values are
SUCCEEDED
,FAILED
,IN_PROGRESS
, orSKIPPED
.Possible values:
SUCCEEDED
FAILED
IN_PROGRESS
SKIPPED
View -> (structure)
A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key “ENV” and the value “DEVELOPMENT” in the results returned by this view. You could also create a second view that includes only resources that are tagged with “ENV” and “PRODUCTION”.
ViewArn -> (string)
The Amazon resource name (ARN) of the view.Owner -> (string)
The Amazon Web Services account that owns this view.LastUpdatedAt -> (timestamp)
The date and time when this view was last modified.Scope -> (string)
An Amazon resource name (ARN) of an Amazon Web Services account, an organization, or an organizational unit (OU) that specifies whether this view includes resources from only the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in the specified OU.
If not specified, the value defaults to the Amazon Web Services account used to call this operation.
IncludedProperties -> (list)
A structure that contains additional information about the view.
(structure)
Information about an additional property that describes a resource, that you can optionally include in the view. This lets you view that property in search results, and filter your search results based on the value of the property.
Name -> (string) [required]
The name of the property that is included in this view.
You can specify the following property names for this field:
tags
Constraints:
- min:
1
- max:
1011
Filters -> (structure)
An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.
FilterString -> (string) [required]
The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a Search operation. For more details, see Search query syntax .
Constraints:
- min:
0
- max:
2048
ErrorDetails -> (structure)
Details about any error that occurred during the view operation.
Code -> (string)
The error code that identifies the type of error that occurred.Message -> (string)
A human-readable description of the error that occurred.
NextToken -> (string)
The pagination token to use in a subsequent
GetResourceExplorerSetup
request to retrieve the next set of results.Constraints:
- min:
1
- max:
2048