2025/10/06 - AWS Resource Explorer - 8 new api methods
Changes Add new AWS Resource Explorer APIs
Deletes a Resource Explorer setup configuration. This operation removes indexes and views from the specified Regions or all Regions where Resource Explorer is configured.
See also: AWS API Documentation
Request Syntax
client.delete_resource_explorer_setup(
RegionList=[
'string',
],
DeleteInAllRegions=True|False
)
list
A list of Amazon Web Services Regions from which to delete the Resource Explorer configuration. If not specified, the operation uses the DeleteInAllRegions parameter to determine scope.
(string) --
boolean
Specifies whether to delete Resource Explorer configuration from all Regions where it is currently enabled. If this parameter is set to true, a value for RegionList must not be provided. Otherwise, the operation fails with a ValidationException error.
dict
Response Syntax
{
'TaskId': 'string'
}
Response Structure
(dict) --
TaskId (string) --
The unique identifier for the deletion task. Use this ID with GetResourceExplorerSetup to monitor the progress of the deletion operation.
Retrieves details about a specific Resource Explorer service view. This operation returns the configuration and properties of the specified view.
See also: AWS API Documentation
Request Syntax
client.get_service_view(
ServiceViewArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the service view to retrieve details for.
dict
Response Syntax
{
'View': {
'ServiceViewArn': 'string',
'Filters': {
'FilterString': 'string'
},
'IncludedProperties': [
{
'Name': 'string'
},
],
'StreamingAccessForService': 'string',
'ScopeType': 'string'
}
}
Response Structure
(dict) --
View (dict) --
A ServiceView object that contains the details and configuration of the requested service view.
ServiceViewArn (string) --
The Amazon Resource Name (ARN) of the service view.
Filters (dict) --
A search filter defines which resources can be part of a search query result set.
FilterString (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.
IncludedProperties (list) --
A list of additional resource properties that are included in this view for search and filtering purposes.
(dict) --
Information about an additional property that describes a resource, that you can optionally include in the view. This lets you view that property in search results, and filter your search results based on the value of the property.
Name (string) --
The name of the property that is included in this view.
You can specify the following property names for this field:
tags
StreamingAccessForService (string) --
The Amazon Web Services service that has streaming access to this view's data.
ScopeType (string) --
The scope type of the service view, which determines what resources are included.
Returns a list of Amazon Web Services services that have been granted streaming access to your Resource Explorer data. Streaming access allows Amazon Web Services services to receive real-time updates about your resources as they are indexed by Resource Explorer.
See also: AWS API Documentation
Request Syntax
client.list_streaming_access_for_services(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of streaming access entries to return in the response. If there are more results available, the response includes a NextToken value that you can use in a subsequent call to get the next set of results. The value must be between 1 and 50. If you don't specify a value, the default is 50.
string
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. The pagination tokens expire after 24 hours.
dict
Response Syntax
{
'StreamingAccessForServices': [
{
'ServicePrincipal': 'string',
'CreatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
StreamingAccessForServices (list) --
A list of Amazon Web Services services that have streaming access to your Resource Explorer data, including details about when the access was granted.
(dict) --
Contains information about an Amazon Web Services service that has been granted streaming access to your Resource Explorer data.
ServicePrincipal (string) --
The service principal of the Amazon Web Services service that has streaming access to your Resource Explorer data. A service principal is a unique identifier for an Amazon Web Services service.
CreatedAt (datetime) --
The date and time when streaming access was granted to the Amazon Web Services service, in ISO 8601 format.
NextToken (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 the NextToken response element comes back as null. The pagination tokens expire after 24 hours.
Creates a Resource Explorer setup configuration across multiple Amazon Web Services Regions. This operation sets up indexes and views in the specified Regions. This operation can also be used to set an aggregator Region for cross-Region resource search.
See also: AWS API Documentation
Request Syntax
client.create_resource_explorer_setup(
RegionList=[
'string',
],
AggregatorRegions=[
'string',
],
ViewName='string'
)
list
[REQUIRED]
A list of Amazon Web Services Regions where Resource Explorer should be configured. Each Region in the list will have a user-owned index created.
(string) --
list
A list of Amazon Web Services Regions that should be configured as aggregator Regions. Aggregator Regions receive replicated index information from all other Regions where there is a user-owned index.
(string) --
string
[REQUIRED]
The name for the view to be created as part of the Resource Explorer setup. The view name must be unique within the Amazon Web Services account and Region.
dict
Response Syntax
{
'TaskId': 'string'
}
Response Structure
(dict) --
TaskId (string) --
The unique identifier for the setup task. Use this ID with GetResourceExplorerSetup to monitor the progress of the configuration operation.
Lists all Resource Explorer indexes across the specified Amazon Web Services Regions. This operation returns information about indexes including their ARNs, types, and Regions.
See also: AWS API Documentation
Request Syntax
client.list_service_indexes(
Regions=[
'string',
],
MaxResults=123,
NextToken='string'
)
list
A list of Amazon Web Services Regions to include in the search for indexes. If not specified, indexes from all Regions are returned.
(string) --
integer
The maximum number of index results to return in a single response. Valid values are between 1 and 100.
string
The pagination token from a previous ListServiceIndexes response. Use this token to retrieve the next set of results.
dict
Response Syntax
{
'Indexes': [
{
'Region': 'string',
'Arn': 'string',
'Type': 'LOCAL'|'AGGREGATOR'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Indexes (list) --
A list of Index objects that describe the Resource Explorer indexes found in the specified Regions.
(dict) --
An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.
By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.
Region (string) --
The Amazon Web Services Region in which the index exists.
Arn (string) --
The Amazon resource name (ARN) of the index.
Type (string) --
The type of index. It can be one of the following values:
LOCAL – The index contains information about resources from only the same Amazon Web Services Region.
AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.
NextToken (string) --
The pagination token to use in a subsequent ListServiceIndexes request to retrieve the next set of results.
Retrieves information about the Resource Explorer index in the current Amazon Web Services Region. This operation returns the ARN and type of the index if one exists.
See also: AWS API Documentation
Request Syntax
client.get_service_index()
dict
Response Syntax
{
'Arn': 'string',
'Type': 'LOCAL'|'AGGREGATOR'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the Resource Explorer index in the current Region.
Type (string) --
The type of the index. Valid values are LOCAL (contains resources from the current Region only) or AGGREGATOR (contains replicated resource information from all Regions).
Lists all Resource Explorer service views available in the current Amazon Web Services account. This operation returns the ARNs of available service views.
See also: AWS API Documentation
Request Syntax
client.list_service_views(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of service view results to return in a single response. Valid values are between 1 and 50.
string
The pagination token from a previous ListServiceViews response. Use this token to retrieve the next set of results.
dict
Response Syntax
{
'NextToken': 'string',
'ServiceViews': [
'string',
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token to use in a subsequent ListServiceViews request to retrieve the next set of results.
ServiceViews (list) --
A list of Amazon Resource Names (ARNs) for the service views available in the current Amazon Web Services account.
(string) --
Retrieves the status and details of a Resource Explorer setup operation. This operation returns information about the progress of creating or deleting Resource Explorer configurations across Regions.
See also: AWS API Documentation
Request Syntax
client.get_resource_explorer_setup(
TaskId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique identifier of the setup task to retrieve status information for. This ID is returned by CreateResourceExplorerSetup or DeleteResourceExplorerSetup operations.
integer
The maximum number of Region status results to return in a single response. Valid values are between 1 and 100.
string
The pagination token from a previous GetResourceExplorerSetup response. Use this token to retrieve the next set of results.
dict
Response Syntax
{
'Regions': [
{
'Region': 'string',
'Index': {
'Status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS'|'SKIPPED',
'Index': {
'Region': 'string',
'Arn': 'string',
'Type': 'LOCAL'|'AGGREGATOR'
},
'ErrorDetails': {
'Code': 'string',
'Message': 'string'
}
},
'View': {
'Status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS'|'SKIPPED',
'View': {
'ViewArn': 'string',
'Owner': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'Scope': 'string',
'IncludedProperties': [
{
'Name': 'string'
},
],
'Filters': {
'FilterString': 'string'
}
},
'ErrorDetails': {
'Code': 'string',
'Message': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Regions (list) --
A list of Region status objects that describe the current state of Resource Explorer configuration in each Region.
(dict) --
Contains information about the status of Resource Explorer configuration in a specific Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region for which this status information applies.
Index (dict) --
The status information for the Resource Explorer index in this Region.
Status (string) --
The current status of the index operation. Valid values are SUCCEEDED, FAILED, IN_PROGRESS, or SKIPPED.
Index (dict) --
An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.
By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.
Region (string) --
The Amazon Web Services Region in which the index exists.
Arn (string) --
The Amazon resource name (ARN) of the index.
Type (string) --
The type of index. It can be one of the following values:
LOCAL – The index contains information about resources from only the same Amazon Web Services Region.
AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.
ErrorDetails (dict) --
Details about any error that occurred during the index operation.
Code (string) --
The error code that identifies the type of error that occurred.
Message (string) --
A human-readable description of the error that occurred.
View (dict) --
The status information for the Resource Explorer view in this Region.
Status (string) --
The current status of the view operation. Valid values are SUCCEEDED, FAILED, IN_PROGRESS, or SKIPPED.
View (dict) --
A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key "ENV" and the value "DEVELOPMENT" in the results returned by this view. You could also create a second view that includes only resources that are tagged with "ENV" and "PRODUCTION".
ViewArn (string) --
The Amazon resource name (ARN) of the view.
Owner (string) --
The Amazon Web Services account that owns this view.
LastUpdatedAt (datetime) --
The date and time when this view was last modified.
Scope (string) --
An Amazon resource name (ARN) of an Amazon Web Services account, an organization, or an organizational unit (OU) that specifies whether this view includes resources from only the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in the specified OU.
If not specified, the value defaults to the Amazon Web Services account used to call this operation.
IncludedProperties (list) --
A structure that contains additional information about the view.
(dict) --
Information about an additional property that describes a resource, that you can optionally include in the view. This lets you view that property in search results, and filter your search results based on the value of the property.
Name (string) --
The name of the property that is included in this view.
You can specify the following property names for this field:
tags
Filters (dict) --
An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.
FilterString (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.
ErrorDetails (dict) --
Details about any error that occurred during the view operation.
Code (string) --
The error code that identifies the type of error that occurred.
Message (string) --
A human-readable description of the error that occurred.
NextToken (string) --
The pagination token to use in a subsequent GetResourceExplorerSetup request to retrieve the next set of results.