AWS Resource Explorer 2022-07-28
- Client: Aws\ResourceExplorer2\ResourceExplorer2Client
- Service ID: resource-explorer-2
- Version: 2022-07-28
This page describes the parameters and results for the operations of the AWS Resource Explorer (2022-07-28), and shows how to use the Aws\ResourceExplorer2\ResourceExplorer2Client object to call the described operations. This documentation is specific to the 2022-07-28 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AssociateDefaultView ( array $params = [] )
- Sets the specified view as the default for the Amazon Web Services Region in which you call this operation.
- BatchGetView ( array $params = [] )
- Retrieves details about a list of views.
- CreateIndex ( array $params = [] )
- Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index.
- CreateView ( array $params = [] )
- Creates a view that users can query by using the Search operation.
- DeleteIndex ( array $params = [] )
- Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.
- DeleteView ( array $params = [] )
- Deletes the specified view.
- DisassociateDefaultView ( array $params = [] )
- After you call this operation, the affected Amazon Web Services Region no longer has a default view.
- GetAccountLevelServiceConfiguration ( array $params = [] )
- Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature.
- GetDefaultView ( array $params = [] )
- Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation.
- GetIndex ( array $params = [] )
- Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
- GetView ( array $params = [] )
- Retrieves details of the specified view.
- ListIndexes ( array $params = [] )
- Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.
- ListIndexesForMembers ( array $params = [] )
- Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.
- ListResources ( array $params = [] )
- Returns a list of resources and their details that match the specified criteria.
- ListSupportedResourceTypes ( array $params = [] )
- Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
- ListTagsForResource ( array $params = [] )
- Lists the tags that are attached to the specified resource.
- ListViews ( array $params = [] )
- Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.
- Search ( array $params = [] )
- Searches for resources and displays details about all resources that match the specified criteria.
- TagResource ( array $params = [] )
- Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
- UntagResource ( array $params = [] )
- Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
- UpdateIndexType ( array $params = [] )
- Changes the type of the index from one of the following types to the other.
- UpdateView ( array $params = [] )
- Modifies some of the details of a view.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateDefaultView
$result = $client->associateDefaultView
([/* ... */]); $promise = $client->associateDefaultViewAsync
([/* ... */]);
Sets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Search that doesn't explicitly specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for searches performed in this Amazon Web Services Region.
If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search
operation performed in that Region.
Parameter Syntax
$result = $client->associateDefaultView([ 'ViewArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ViewArn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) of the view to set as the default for the Amazon Web Services Region and Amazon Web Services account in which you call this operation. The specified view must already exist in the called Region.
Result Syntax
[ 'ViewArn' => '<string>', ]
Result Details
Members
- ViewArn
-
- Type: string
The Amazon resource name (ARN) of the view that the operation set as the default for queries made in the Amazon Web Services Region and Amazon Web Services account in which you called this operation.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
BatchGetView
$result = $client->batchGetView
([/* ... */]); $promise = $client->batchGetViewAsync
([/* ... */]);
Retrieves details about a list of views.
Parameter Syntax
$result = $client->batchGetView([ 'ViewArns' => ['<string>', ...], ]);
Parameter Details
Members
- ViewArns
-
- Type: Array of strings
A list of Amazon resource names (ARNs) that identify the views you want details for.
Result Syntax
[ 'Errors' => [ [ 'ErrorMessage' => '<string>', 'ViewArn' => '<string>', ], // ... ], 'Views' => [ [ 'Filters' => [ 'FilterString' => '<string>', ], 'IncludedProperties' => [ [ 'Name' => '<string>', ], // ... ], 'LastUpdatedAt' => <DateTime>, 'Owner' => '<string>', 'Scope' => '<string>', 'ViewArn' => '<string>', ], // ... ], ]
Result Details
Members
- Errors
-
- Type: Array of BatchGetViewError structures
If any of the specified ARNs result in an error, then this structure describes the error.
- Views
-
- Type: Array of View structures
A structure with a list of objects with details for each of the specified views.
Errors
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException:
The principal making the request isn't permitted to perform the operation.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
CreateIndex
$result = $client->createIndex
([/* ... */]); $promise = $client->createIndexAsync
([/* ... */]);
Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide.
If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.
-
Action:
resource-explorer-2:CreateIndex
Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (
*
) at the end of the string to match the eventual UUID. For example, the followingResource
element restricts the role or user to creating an index in only theus-east-2
Region of the specified account."Resource": "arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*"
Alternatively, you can use
"Resource": "*"
to allow the role or user to create an index in any Region. -
Action:
iam:CreateServiceLinkedRole
Resource: No specific resource (*).
This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.
Parameter Syntax
$result = $client->createIndex([ 'ClientToken' => '<string>', 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- ClientToken
-
- Type: string
This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a UUID-type value to ensure the uniqueness of your index.
- Tags
-
- Type: Associative array of custom strings keys (String) to strings
The specified tags are attached only to the index created in this Amazon Web Services Region. The tags aren't attached to any of the resources listed in the index.
Result Syntax
[ 'Arn' => '<string>', 'CreatedAt' => <DateTime>, 'State' => 'CREATING|ACTIVE|DELETING|DELETED|UPDATING', ]
Result Details
Members
- Arn
-
- Type: string
The ARN of the new local index for the Region. You can reference this ARN in IAM permission policies to authorize the following operations: DeleteIndex | GetIndex | UpdateIndexType | CreateView
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and timestamp when the index was created.
- State
-
- Type: string
Indicates the current state of the index. You can check for changes to the state for asynchronous operations by calling the GetIndex operation.
The state can remain in the
CREATING
orUPDATING
state for several hours as Resource Explorer discovers the information about your resources and populates the index.
Errors
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- 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 Amazon Web Services 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 Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR
, then the request failed because you already have anAGGREGATOR
index in a different Amazon Web Services Region.- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
CreateView
$result = $client->createView
([/* ... */]); $promise = $client->createViewAsync
([/* ... */]);
Creates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view's Filters
. For more information about Amazon Web Services Resource Explorer views, see Managing views in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants Allow
to the Search
action on a Resource
with the Amazon resource name (ARN) of this view can Search using views you create with this operation.
Parameter Syntax
$result = $client->createView([ 'ClientToken' => '<string>', 'Filters' => [ 'FilterString' => '<string>', // REQUIRED ], 'IncludedProperties' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'Scope' => '<string>', 'Tags' => ['<string>', ...], 'ViewName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ClientToken
-
- Type: string
This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a UUID-type value to ensure the uniqueness of your views.
- Filters
-
- Type: SearchFilter structure
An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search's
QueryString
parameter using a logicalAND
operator.For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string
region:us* service:ec2 -tag:stage=prod
includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the lettersus
and is not tagged with a keyStage
that has the valueprod
. - IncludedProperties
-
- Type: Array of IncludedProperty structures
Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.
The default is an empty list, with no optional fields included in the results.
- Scope
-
- Type: string
The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
- Tags
-
- Type: Associative array of custom strings keys (String) to strings
Tag key and value pairs that are attached to the view.
- ViewName
-
- Required: Yes
- Type: string
The name of the new view. This name appears in the list of views in Resource Explorer.
The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.
Result Syntax
[ 'View' => [ 'Filters' => [ 'FilterString' => '<string>', ], 'IncludedProperties' => [ [ 'Name' => '<string>', ], // ... ], 'LastUpdatedAt' => <DateTime>, 'Owner' => '<string>', 'Scope' => '<string>', 'ViewArn' => '<string>', ], ]
Result Details
Members
- View
-
- Type: View structure
A structure that contains the details about the new view.
Errors
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- 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 Amazon Web Services 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 Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR
, then the request failed because you already have anAGGREGATOR
index in a different Amazon Web Services Region.- ServiceQuotaExceededException:
The request failed because it exceeds a service quota.
- UnauthorizedException:
The principal making the request isn't permitted to perform the operation.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
DeleteIndex
$result = $client->deleteIndex
([/* ... */]); $promise = $client->deleteIndexAsync
([/* ... */]);
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the Status
response value.
If the index you delete is the aggregator index for the Amazon Web Services account, you must wait 24 hours before you can promote another local index to be the aggregator index for the account. Users can't perform account-wide searches using Resource Explorer until another aggregator index is configured.
Parameter Syntax
$result = $client->deleteIndex([ 'Arn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) of the index that you want to delete.
Result Syntax
[ 'Arn' => '<string>', 'LastUpdatedAt' => <DateTime>, 'State' => 'CREATING|ACTIVE|DELETING|DELETED|UPDATING', ]
Result Details
Members
- Arn
-
- Type: string
The Amazon resource name (ARN) of the index that you successfully started the deletion process.
This operation is asynchronous. To check its status, call the GetIndex operation.
- LastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when you last updated this index.
- State
-
- Type: string
Indicates the current state of the index.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
DeleteView
$result = $client->deleteView
([/* ... */]); $promise = $client->deleteViewAsync
([/* ... */]);
Deletes the specified view.
If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use until you configure a new default by calling the AssociateDefaultView operation.
Parameter Syntax
$result = $client->deleteView([ 'ViewArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ViewArn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) of the view that you want to delete.
Result Syntax
[ 'ViewArn' => '<string>', ]
Result Details
Members
- ViewArn
-
- Type: string
The Amazon resource name (ARN) of the view that you successfully deleted.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException:
The principal making the request isn't permitted to perform the operation.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
DisassociateDefaultView
$result = $client->disassociateDefaultView
([/* ... */]); $promise = $client->disassociateDefaultViewAsync
([/* ... */]);
After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.
If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search
operation performed in that Region.
Parameter Syntax
$result = $client->disassociateDefaultView([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
GetAccountLevelServiceConfiguration
$result = $client->getAccountLevelServiceConfiguration
([/* ... */]); $promise = $client->getAccountLevelServiceConfigurationAsync
([/* ... */]);
Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature. Only the management account can invoke this API call.
Parameter Syntax
$result = $client->getAccountLevelServiceConfiguration([ ]);
Parameter Details
Members
Result Syntax
[ 'OrgConfiguration' => [ 'AWSServiceAccessStatus' => 'ENABLED|DISABLED', 'ServiceLinkedRole' => '<string>', ], ]
Result Details
Members
- OrgConfiguration
-
- Type: OrgConfiguration structure
Details about the organization, and whether configuration is
ENABLED
orDISABLED
.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
GetDefaultView
$result = $client->getDefaultView
([/* ... */]); $promise = $client->getDefaultViewAsync
([/* ... */]);
Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view.
Parameter Syntax
$result = $client->getDefaultView([ ]);
Parameter Details
Members
Result Syntax
[ 'ViewArn' => '<string>', ]
Result Details
Members
- ViewArn
-
- Type: string
The Amazon resource name (ARN) of the view that is the current default for the Amazon Web Services Region in which you called this operation.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
GetIndex
$result = $client->getIndex
([/* ... */]); $promise = $client->getIndexAsync
([/* ... */]);
Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
Parameter Syntax
$result = $client->getIndex([ ]);
Parameter Details
Members
Result Syntax
[ 'Arn' => '<string>', 'CreatedAt' => <DateTime>, 'LastUpdatedAt' => <DateTime>, 'ReplicatingFrom' => ['<string>', ...], 'ReplicatingTo' => ['<string>', ...], 'State' => 'CREATING|ACTIVE|DELETING|DELETED|UPDATING', 'Tags' => ['<string>', ...], 'Type' => 'LOCAL|AGGREGATOR', ]
Result Details
Members
- Arn
-
- Type: string
The Amazon resource name (ARN) of the index.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the index was originally created.
- LastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the index was last updated.
- ReplicatingFrom
-
- Type: Array of strings
This response value is present only if this index is
Type=AGGREGATOR
.A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
- ReplicatingTo
-
- Type: Array of strings
This response value is present only if this index is
Type=LOCAL
.The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
- State
-
- Type: string
The current state of the index in this Amazon Web Services Region.
- Tags
-
- Type: Associative array of custom strings keys (String) to strings
Tag key and value pairs that are attached to the index.
- Type
-
- Type: string
The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
GetView
$result = $client->getView
([/* ... */]); $promise = $client->getViewAsync
([/* ... */]);
Retrieves details of the specified view.
Parameter Syntax
$result = $client->getView([ 'ViewArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ViewArn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) of the view that you want information about.
Result Syntax
[ 'Tags' => ['<string>', ...], 'View' => [ 'Filters' => [ 'FilterString' => '<string>', ], 'IncludedProperties' => [ [ 'Name' => '<string>', ], // ... ], 'LastUpdatedAt' => <DateTime>, 'Owner' => '<string>', 'Scope' => '<string>', 'ViewArn' => '<string>', ], ]
Result Details
Members
- Tags
-
- Type: Associative array of custom strings keys (String) to strings
Tag key and value pairs that are attached to the view.
- View
-
- Type: View structure
A structure that contains the details for the requested view.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException:
The principal making the request isn't permitted to perform the operation.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
ListIndexes
$result = $client->listIndexes
([/* ... */]); $promise = $client->listIndexesAsync
([/* ... */]);
Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.
Parameter Syntax
$result = $client->listIndexes([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'Regions' => ['<string>', ...], 'Type' => 'LOCAL|AGGREGATOR', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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
NextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results.An API operation can return fewer results than the maximum even when there are more results available. You should check
NextToken
after every operation to ensure that you receive all of the results. - NextToken
-
- Type: string
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from. The pagination tokens expire after 24 hours. - Regions
-
- Type: Array of strings
If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
- Type
-
- Type: string
If specified, limits the output to only indexes of the specified Type, either
LOCAL
orAGGREGATOR
.Use this option to discover the aggregator index for your account.
Result Syntax
[ 'Indexes' => [ [ 'Arn' => '<string>', 'Region' => '<string>', 'Type' => 'LOCAL|AGGREGATOR', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Indexes
-
- Type: Array of Index structures
A structure that contains the details and status of each index.
- NextToken
-
- Type: string
If present, indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. The pagination tokens expire after 24 hours.
Errors
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
ListIndexesForMembers
$result = $client->listIndexesForMembers
([/* ... */]); $promise = $client->listIndexesForMembersAsync
([/* ... */]);
Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call.
Parameter Syntax
$result = $client->listIndexesForMembers([ 'AccountIdList' => ['<string>', ...], // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AccountIdList
-
- Required: Yes
- Type: Array of strings
The account IDs will limit the output to only indexes from these accounts.
- MaxResults
-
- Type: int
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
NextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results.An API operation can return fewer results than the maximum even when there are more results available. You should check
NextToken
after every operation to ensure that you receive all of the results. - NextToken
-
- Type: string
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from. The pagination tokens expire after 24 hours.
Result Syntax
[ 'Indexes' => [ [ 'AccountId' => '<string>', 'Arn' => '<string>', 'Region' => '<string>', 'Type' => 'LOCAL|AGGREGATOR', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Indexes
-
- Type: Array of MemberIndex structures
A structure that contains the details and status of each index.
- NextToken
-
- Type: string
If present, indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. The pagination tokens expire after 24 hours.
Errors
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
ListResources
$result = $client->listResources
([/* ... */]); $promise = $client->listResourcesAsync
([/* ... */]);
Returns a list of resources and their details that match the specified criteria. This query must use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.
Parameter Syntax
$result = $client->listResources([ 'Filters' => [ 'FilterString' => '<string>', // REQUIRED ], 'MaxResults' => <integer>, 'NextToken' => '<string>', 'ViewArn' => '<string>', ]);
Parameter Details
Members
- Filters
-
- Type: SearchFilter structure
A search filter defines which resources can be part of a search query result set.
- MaxResults
-
- Type: int
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
NextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results.An API operation can return fewer results than the maximum even when there are more results available. You should check
NextToken
after every operation to ensure that you receive all of the results. - NextToken
-
- Type: string
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from. The pagination tokens expire after 24 hours. - ViewArn
-
- Type: string
Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.
Result Syntax
[ 'NextToken' => '<string>', 'Resources' => [ [ 'Arn' => '<string>', 'LastReportedAt' => <DateTime>, 'OwningAccountId' => '<string>', 'Properties' => [ [ 'Data' => [ ], 'LastReportedAt' => <DateTime>, 'Name' => '<string>', ], // ... ], 'Region' => '<string>', 'ResourceType' => '<string>', 'Service' => '<string>', ], // ... ], 'ViewArn' => '<string>', ]
Result Details
Members
- NextToken
-
- Type: string
If present, indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. The pagination tokens expire after 24 hours. - Resources
-
- Type: Array of Resource structures
The list of structures that describe the resources that match the query.
- ViewArn
-
- Type: string
The Amazon resource name (ARN) of the view that this operation used to perform the search.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException:
The principal making the request isn't permitted to perform the operation.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
ListSupportedResourceTypes
$result = $client->listSupportedResourceTypes
([/* ... */]); $promise = $client->listSupportedResourceTypesAsync
([/* ... */]);
Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
Parameter Syntax
$result = $client->listSupportedResourceTypes([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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
NextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results.An API operation can return fewer results than the maximum even when there are more results available. You should check
NextToken
after every operation to ensure that you receive all of the results. - NextToken
-
- Type: string
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from. The pagination tokens expire after 24 hours.
Result Syntax
[ 'NextToken' => '<string>', 'ResourceTypes' => [ [ 'ResourceType' => '<string>', 'Service' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
If present, indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. The pagination tokens expire after 24 hours. - ResourceTypes
-
- Type: Array of SupportedResourceType structures
The list of resource types supported by Resource Explorer.
Errors
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Lists the tags that are attached to the specified resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) of the view or index that you want to attach tags to.
Result Syntax
[ 'Tags' => ['<string>', ...], ]
Result Details
Members
- Tags
-
- Type: Associative array of custom strings keys (String) to strings
The tag key and value pairs that you want to attach to the specified view or index.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException:
The principal making the request isn't permitted to perform the operation.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
ListViews
$result = $client->listViews
([/* ... */]); $promise = $client->listViewsAsync
([/* ... */]);
Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.
Always check the NextToken
response parameter for a null
value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken
response parameter value is null
only when there are no more results to display.
Parameter Syntax
$result = $client->listViews([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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
NextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results.An API operation can return fewer results than the maximum even when there are more results available. You should check
NextToken
after every operation to ensure that you receive all of the results. - NextToken
-
- Type: string
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from. The pagination tokens expire after 24 hours.
Result Syntax
[ 'NextToken' => '<string>', 'Views' => ['<string>', ...], ]
Result Details
Members
- NextToken
-
- Type: string
If present, indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. The pagination tokens expire after 24 hours. - Views
-
- Type: Array of strings
The list of views available in the Amazon Web Services Region in which you called this operation.
Errors
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
Search
$result = $client->search
([/* ... */]); $promise = $client->searchAsync
([/* ... */]);
Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.
All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the QueryString
parameter supplied to this operation and the SearchFilter
parameter attached to the view.
For the complete syntax supported by the QueryString
parameter, see Search query syntax reference for Resource Explorer.
If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.
Parameter Syntax
$result = $client->search([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'QueryString' => '<string>', // REQUIRED 'ViewArn' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
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
NextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results.An API operation can return fewer results than the maximum even when there are more results available. You should check
NextToken
after every operation to ensure that you receive all of the results. - NextToken
-
- Type: string
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from. The pagination tokens expire after 24 hours. - QueryString
-
- Required: Yes
- Type: string
A string that includes keywords and filters that specify the resources that you want to include in the results.
For the complete syntax supported by the
QueryString
parameter, see Search query syntax reference for Resource Explorer.The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results.
The operation can return only the first 1,000 results. If the resource you want is not included, then use a different value for
QueryString
to refine the results. - ViewArn
-
- Type: string
Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a
401 Unauthorized
exception.
Result Syntax
[ 'Count' => [ 'Complete' => true || false, 'TotalResources' => <integer>, ], 'NextToken' => '<string>', 'Resources' => [ [ 'Arn' => '<string>', 'LastReportedAt' => <DateTime>, 'OwningAccountId' => '<string>', 'Properties' => [ [ 'Data' => [ ], 'LastReportedAt' => <DateTime>, 'Name' => '<string>', ], // ... ], 'Region' => '<string>', 'ResourceType' => '<string>', 'Service' => '<string>', ], // ... ], 'ViewArn' => '<string>', ]
Result Details
Members
- Count
-
- Type: ResourceCount structure
The number of resources that match the query.
- NextToken
-
- Type: string
If present, indicates that more output is available than is included in the current response. Use this value in the
NextToken
request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextToken
response element comes back asnull
. The pagination tokens expire after 24 hours. - Resources
-
- Type: Array of Resource structures
The list of structures that describe the resources that match the query.
- ViewArn
-
- Type: string
The Amazon resource name (ARN) of the view that this operation used to perform the search.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException:
The principal making the request isn't permitted to perform the operation.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
Parameter Syntax
$result = $client->tagResource([ 'Tags' => ['<string>', ...], 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Tags
-
- Type: Associative array of custom strings keys (String) to strings
A list of tag key and value pairs that you want to attach to the specified view or index.
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the view or index that you want to attach tags to.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- 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 Amazon Web Services 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 Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR
, then the request failed because you already have anAGGREGATOR
index in a different Amazon Web Services Region.- UnauthorizedException:
The principal making the request isn't permitted to perform the operation.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the view or index that you want to remove tags from.
- tagKeys
-
- Required: Yes
- Type: Array of strings
A list of the keys for the tags that you want to remove from the specified view or index.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException:
The principal making the request isn't permitted to perform the operation.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
UpdateIndexType
$result = $client->updateIndexType
([/* ... */]); $promise = $client->updateIndexTypeAsync
([/* ... */]);
Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
-
AGGREGATOR
index typeThe index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.
When you change the index type to
AGGREGATOR
, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, theStatus
response of that operation changes fromUPDATING
toACTIVE
. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type
LOCAL
. -
LOCAL
index typeThe index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.
When you change the index type to
LOCAL
, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in theUPDATING
state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, theStatus
response of that operation changes fromUPDATING
toACTIVE
. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.
Parameter Syntax
$result = $client->updateIndexType([ 'Arn' => '<string>', // REQUIRED 'Type' => 'LOCAL|AGGREGATOR', // REQUIRED ]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) of the index that you want to update.
- Type
-
- Required: Yes
- Type: string
The type of the index. To understand the difference between
LOCAL
andAGGREGATOR
, see Turning on cross-Region search in the Amazon Web Services Resource Explorer User Guide.
Result Syntax
[ 'Arn' => '<string>', 'LastUpdatedAt' => <DateTime>, 'State' => 'CREATING|ACTIVE|DELETING|DELETED|UPDATING', 'Type' => 'LOCAL|AGGREGATOR', ]
Result Details
Members
- Arn
-
- Type: string
The Amazon resource name (ARN) of the index that you updated.
- LastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and timestamp when the index was last updated.
- State
-
- Type: string
Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.
- Type
-
- Type: string
Specifies the type of the specified index after the operation completes.
Errors
- ResourceNotFoundException:
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- 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 Amazon Web Services 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 Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR
, then the request failed because you already have anAGGREGATOR
index in a different Amazon Web Services Region.- ServiceQuotaExceededException:
The request failed because it exceeds a service quota.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
UpdateView
$result = $client->updateView
([/* ... */]); $promise = $client->updateViewAsync
([/* ... */]);
Modifies some of the details of a view. You can change the filter string and the list of included properties. You can't change the name of the view.
Parameter Syntax
$result = $client->updateView([ 'Filters' => [ 'FilterString' => '<string>', // REQUIRED ], 'IncludedProperties' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'ViewArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Filters
-
- Type: SearchFilter structure
An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search's
QueryString
parameter using a logicalAND
operator.For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string
region:us* service:ec2 -tag:stage=prod
includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the lettersus
and is not tagged with a keyStage
that has the valueprod
. - IncludedProperties
-
- Type: Array of IncludedProperty structures
Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.
The default is an empty list, with no optional fields included in the results.
- ViewArn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) of the view that you want to modify.
Result Syntax
[ 'View' => [ 'Filters' => [ 'FilterString' => '<string>', ], 'IncludedProperties' => [ [ 'Name' => '<string>', ], // ... ], 'LastUpdatedAt' => <DateTime>, 'Owner' => '<string>', 'Scope' => '<string>', 'ViewArn' => '<string>', ], ]
Result Details
Members
- View
-
- Type: View structure
Details about the view that you changed with this operation.
Errors
- InternalServerException:
The request failed because of internal service error. Try your request again later.
- ValidationException:
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ServiceQuotaExceededException:
The request failed because it exceeds a service quota.
- UnauthorizedException:
The principal making the request isn't permitted to perform the operation.
- ThrottlingException:
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException:
The credentials that you used to call this operation don't have the minimum required permissions.
Shapes
AccessDeniedException
Description
The credentials that you used to call this operation don't have the minimum required permissions.
Members
- Message
-
- Type: string
BatchGetViewError
Description
A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.
Members
- ErrorMessage
-
- Required: Yes
- Type: string
The description of the error for the specified view.
- ViewArn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) of the view for which Resource Explorer failed to retrieve details.
ConflictException
Description
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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region.
Members
- Message
-
- Required: Yes
- Type: string
Document
Members
IncludedProperty
Description
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.
Members
- Name
-
- Required: Yes
- Type: string
The name of the property that is included in this view.
You can specify the following property names for this field:
-
Tags
Index
Description
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.
Members
- Arn
-
- Type: string
The Amazon resource name (ARN) of the index.
- Region
-
- Type: string
The Amazon Web Services Region in which the index exists.
- Type
-
- 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.
InternalServerException
Description
The request failed because of internal service error. Try your request again later.
Members
- Message
-
- Type: string
MemberIndex
Description
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.
Members
- AccountId
-
- Type: string
The account ID for the index.
- Arn
-
- Type: string
The Amazon resource name (ARN) of the index.
- Region
-
- Type: string
The Amazon Web Services Region in which the index exists.
- Type
-
- 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.
OrgConfiguration
Description
This is a structure that contains the status of Amazon Web Services service access, and whether you have a valid service-linked role to enable multi-account search for your organization.
Members
- AWSServiceAccessStatus
-
- Required: Yes
- Type: string
This value displays whether your Amazon Web Services service access is
ENABLED
orDISABLED
. - ServiceLinkedRole
-
- Type: string
This value shows whether or not you have a valid a service-linked role required to start the multi-account search feature.
Resource
Description
A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored information in the index of the Amazon Web Services Region that contains the resource.
Members
- Arn
-
- Type: string
The Amazon resource name (ARN) of the resource.
- LastReportedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource.
- OwningAccountId
-
- Type: string
The Amazon Web Services account that owns the resource.
- Properties
-
- Type: Array of ResourceProperty structures
A structure with additional type-specific details about the resource. These properties can be added by turning on integration between Resource Explorer and other Amazon Web Services services.
- Region
-
- Type: string
The Amazon Web Services Region in which the resource was created and exists.
- ResourceType
-
- Type: string
The type of the resource.
- Service
-
- Type: string
The Amazon Web Servicesservice that owns the resource and is responsible for creating and updating it.
ResourceCount
Description
Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer doesn't count more than 1,000 matches for any query. This structure provides information about whether the query exceeded this limit.
This field is included in every page when you paginate the results.
Members
- Complete
-
- Type: boolean
Indicates whether the
TotalResources
value represents an exhaustive count of search results.-
If
True
, it indicates that the search was exhaustive. Every resource that matches the query was counted. -
If
False
, then the search reached the limit of 1,000 matching results, and stopped counting.
- TotalResources
-
- Type: long (int|float)
The number of resources that match the search query. This value can't exceed 1,000. If there are more than 1,000 resources that match the query, then only 1,000 are counted and the
Complete
field is set to false. We recommend that you refine your query to return a smaller number of results.
ResourceNotFoundException
Description
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
Members
- Message
-
- Type: string
ResourceProperty
Description
A structure that describes a property of a resource.
Members
- Data
-
- Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents
Details about this property. The content of this field is a JSON object that varies based on the resource type.
- LastReportedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the information about this resource property was last updated.
- Name
-
- Type: string
The name of this property of the resource.
SearchFilter
Description
A search filter defines which resources can be part of a search query result set.
Members
- FilterString
-
- Required: Yes
- Type: string
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.
ServiceQuotaExceededException
Description
The request failed because it exceeds a service quota.
Members
- Message
-
- Required: Yes
- Type: string
- Name
-
- Required: Yes
- Type: string
The name of the service quota that was exceeded by the request.
- Value
-
- Required: Yes
- Type: string
The current value for the quota that the request tried to exceed.
SupportedResourceType
Description
A structure that describes a resource type supported by Amazon Web Services Resource Explorer.
Members
- ResourceType
-
- Type: string
The unique identifier of the resource type.
- Service
-
- Type: string
The Amazon Web Servicesservice that is associated with the resource type. This is the primary service that lets you create and interact with resources of this type.
ThrottlingException
Description
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
Members
- Message
-
- Type: string
UnauthorizedException
Description
The principal making the request isn't permitted to perform the operation.
Members
- Message
-
- Type: string
ValidationException
Description
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
Members
- FieldList
-
- Type: Array of ValidationExceptionField structures
An array of the request fields that had validation errors.
- Message
-
- Required: Yes
- Type: string
ValidationExceptionField
Description
A structure that describes a request field with a validation error.
Members
- Name
-
- Required: Yes
- Type: string
The name of the request field that had a validation error.
- ValidationIssue
-
- Required: Yes
- Type: string
The validation error caused by the request field.
View
Description
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".
Members
- Filters
-
- Type: SearchFilter structure
An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.
- IncludedProperties
-
- Type: Array of IncludedProperty structures
A structure that contains additional information about the view.
- LastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when this view was last modified.
- Owner
-
- Type: string
The Amazon Web Services account that owns this view.
- Scope
-
- Type: 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.
- ViewArn
-
- Type: string
The Amazon resource name (ARN) of the view.