2026/01/16 - AWS Resource Explorer - 6 updated api methods
Changes Added ViewName to View-related responses and ServiceViewName to GetServiceView response.
{'Views': {'ViewName': 'string'}}
Retrieves details about a list of views.
See also: AWS API Documentation
Request Syntax
client.batch_get_view(
ViewArns=[
'string',
]
)
list
A list of Amazon resource names (ARNs) that identify the views you want details for.
(string) --
dict
Response Syntax
{
'Views': [
{
'ViewArn': 'string',
'ViewName': 'string',
'Owner': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'Scope': 'string',
'IncludedProperties': [
{
'Name': 'string'
},
],
'Filters': {
'FilterString': 'string'
}
},
],
'Errors': [
{
'ViewArn': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
Views (list) --
A structure with a list of objects with details for each of the specified views.
(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.
ViewName (string) --
The name 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.
Errors (list) --
If any of the specified ARNs result in an error, then this structure describes the error.
(dict) --
A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.
ViewArn (string) --
The Amazon resource name (ARN) of the view for which Resource Explorer failed to retrieve details.
ErrorMessage (string) --
The description of the error for the specified view.
{'View': {'ViewName': 'string'}}
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.
See also: AWS API Documentation
Request Syntax
client.create_view(
ClientToken='string',
ViewName='string',
IncludedProperties=[
{
'Name': 'string'
},
],
Scope='string',
Filters={
'FilterString': 'string'
},
Tags={
'string': 'string'
}
)
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.
This field is autopopulated if not provided.
string
[REQUIRED]
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.
list
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.
(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) -- [REQUIRED]
The name of the property that is included in this view.
You can specify the following property names for this field:
tags
string
The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
dict
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.
FilterString (string) -- [REQUIRED]
The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a Search operation. For more details, see Search query syntax.
dict
Tag key and value pairs that are attached to the view.
(string) --
(string) --
dict
Response Syntax
{
'View': {
'ViewArn': 'string',
'ViewName': 'string',
'Owner': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'Scope': 'string',
'IncludedProperties': [
{
'Name': 'string'
},
],
'Filters': {
'FilterString': 'string'
}
}
}
Response Structure
(dict) --
View (dict) --
A structure that contains the details about the new view.
ViewArn (string) --
The Amazon resource name (ARN) of the view.
ViewName (string) --
The name 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.
{'Regions': {'View': {'View': {'ViewName': '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',
'ViewName': '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.
ViewName (string) --
The name 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.
{'View': {'ServiceViewName': 'string'}}
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',
'ServiceViewName': '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.
ServiceViewName (string) --
The name 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.
{'View': {'ViewName': 'string'}}
Retrieves details of the specified view.
See also: AWS API Documentation
Request Syntax
client.get_view(
ViewArn='string'
)
string
[REQUIRED]
The Amazon resource name (ARN) of the view that you want information about.
dict
Response Syntax
{
'View': {
'ViewArn': 'string',
'ViewName': 'string',
'Owner': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'Scope': 'string',
'IncludedProperties': [
{
'Name': 'string'
},
],
'Filters': {
'FilterString': 'string'
}
},
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
View (dict) --
A structure that contains the details for the requested view.
ViewArn (string) --
The Amazon resource name (ARN) of the view.
ViewName (string) --
The name 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.
Tags (dict) --
Tag key and value pairs that are attached to the view.
(string) --
(string) --
{'View': {'ViewName': 'string'}}
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.
See also: AWS API Documentation
Request Syntax
client.update_view(
ViewArn='string',
IncludedProperties=[
{
'Name': 'string'
},
],
Filters={
'FilterString': 'string'
}
)
string
[REQUIRED]
The Amazon resource name (ARN) of the view that you want to modify.
list
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.
(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) -- [REQUIRED]
The name of the property that is included in this view.
You can specify the following property names for this field:
tags
dict
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.
FilterString (string) -- [REQUIRED]
The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a Search operation. For more details, see Search query syntax.
dict
Response Syntax
{
'View': {
'ViewArn': 'string',
'ViewName': 'string',
'Owner': 'string',
'LastUpdatedAt': datetime(2015, 1, 1),
'Scope': 'string',
'IncludedProperties': [
{
'Name': 'string'
},
],
'Filters': {
'FilterString': 'string'
}
}
}
Response Structure
(dict) --
View (dict) --
Details about the view that you changed with this operation.
ViewArn (string) --
The Amazon resource name (ARN) of the view.
ViewName (string) --
The name 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.