String viewArn
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.
String viewArn
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.
String errorMessage
The description of the error for the specified view.
String viewArn
The Amazon resource name (ARN) of the view for which Resource Explorer failed to retrieve details.
List<E> viewArns
A list of Amazon resource names (ARNs) that identify the views you want details for.
String clientToken
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.
Map<K,V> tags
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.
String arn
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
Date createdAt
The date and timestamp when the index was created.
String state
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 or UPDATING state for several hours as Resource
Explorer discovers the information about your resources and populates the index.
String clientToken
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.
SearchFilter filters
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 logical AND 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 letters us and is not tagged with a key Stage that
has the value prod.
List<E> includedProperties
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.
Map<K,V> tags
Tag key and value pairs that are attached to the view.
String viewName
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.
View view
A structure that contains the details about the new view.
String arn
The Amazon resource name (ARN) of the index that you want to delete.
String arn
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.
Date lastUpdatedAt
The date and time when you last updated this index.
String state
Indicates the current state of the index.
String viewArn
The Amazon resource name (ARN) of the view that you want to delete.
String viewArn
The Amazon resource name (ARN) of the view that you successfully deleted.
String viewArn
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.
String arn
The Amazon resource name (ARN) of the index.
Date createdAt
The date and time when the index was originally created.
Date lastUpdatedAt
The date and time when the index was last updated.
List<E> replicatingFrom
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.
List<E> replicatingTo
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.
String state
The current state of the index in this Amazon Web Services Region.
Map<K,V> tags
Tag key and value pairs that are attached to the index.
String type
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.
String viewArn
The Amazon resource name (ARN) of the view that you want information about.
String name
The name of the property that is included in this view.
You can specify the following property names for this field:
Tags
String arn
The Amazon resource name (ARN) of the index.
String region
The Amazon Web Services Region in which the index exists.
String type
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.
Integer maxResults
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 the NextToken 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.
String nextToken
The parameter for receiving additional results if you receive a NextToken response in a previous
request. A NextToken response indicates that more output is available. Set this parameter to the
value of the previous call's NextToken response to indicate where the output should continue from.
List<E> regions
If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
String type
If specified, limits the output to only indexes of the specified Type, either LOCAL or
AGGREGATOR.
Use this option to discover the aggregator index for your account.
List<E> indexes
A structure that contains the details and status of each index.
String nextToken
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 the NextToken response element comes back as null.
Integer maxResults
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 the NextToken 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.
String nextToken
The parameter for receiving additional results if you receive a NextToken response in a previous
request. A NextToken response indicates that more output is available. Set this parameter to the
value of the previous call's NextToken response to indicate where the output should continue from.
String nextToken
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 the NextToken response element comes back as null.
List<E> resourceTypes
The list of resource types supported by Resource Explorer.
String resourceArn
The Amazon resource name (ARN) of the view or index that you want to attach tags to.
Integer maxResults
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 the NextToken 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.
String nextToken
The parameter for receiving additional results if you receive a NextToken response in a previous
request. A NextToken response indicates that more output is available. Set this parameter to the
value of the previous call's NextToken response to indicate where the output should continue from.
String nextToken
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 the NextToken response element comes back as null.
List<E> views
The list of views available in the Amazon Web Services Region in which you called this operation.
String arn
The Amazon resource name (ARN) of the resource.
Date lastReportedAt
The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource.
String owningAccountId
The Amazon Web Services account that owns the resource.
List<E> properties
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.
String region
The Amazon Web Services Region in which the resource was created and exists.
String resourceType
The type of the resource.
String service
The Amazon Web Service that owns the resource and is responsible for creating and updating it.
Boolean complete
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.
Long totalResources
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.
String filterString
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.
Integer maxResults
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 the NextToken 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.
String nextToken
The parameter for receiving additional results if you receive a NextToken response in a previous
request. A NextToken response indicates that more output is available. Set this parameter to the
value of the previous call's NextToken response to indicate where the output should continue from.
String queryString
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.
String viewArn
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.
ResourceCount count
The number of resources that match the query.
String nextToken
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 the NextToken response element comes back as null.
List<E> resources
The list of structures that describe the resources that match the query.
String viewArn
The Amazon resource name (ARN) of the view that this operation used to perform the search.
String arn
The Amazon resource name (ARN) of the index that you want to update.
String type
The type of the index. To understand the difference between LOCAL and AGGREGATOR, see
Turning on
cross-Region search in the Amazon Web Services Resource Explorer User Guide.
String arn
The Amazon resource name (ARN) of the index that you updated.
Date lastUpdatedAt
The date and timestamp when the index was last updated.
String state
Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.
String type
Specifies the type of the specified index after the operation completes.
SearchFilter filters
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 logical AND 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 letters us and is not tagged with a key Stage that
has the value prod.
List<E> includedProperties
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.
String viewArn
The Amazon resource name (ARN) of the view that you want to modify.
View view
Details about the view that you changed with this operation.
SearchFilter filters
An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.
List<E> includedProperties
A structure that contains additional information about the view.
Date lastUpdatedAt
The date and time when this view was last modified.
String owner
The Amazon Web Services account that owns this view.
String scope
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.
String viewArn
The Amazon resource name (ARN) of the view.
Copyright © 2023. All rights reserved.