package awso-async
Module Awso_resource_explorer_2_asyncSource
Source
val associate_default_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.AssociateDefaultViewInput.t ->
(Awso_resource_explorer_2.Values.AssociateDefaultViewOutput.t,
Awso_resource_explorer_2.Values.AssociateDefaultViewOutput.error)
Result.t
Async.Deferred.tSource
val batch_get_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.BatchGetViewInput.t ->
(Awso_resource_explorer_2.Values.BatchGetViewOutput.t,
Awso_resource_explorer_2.Values.BatchGetViewOutput.error)
Result.t
Async.Deferred.tSource
val create_index :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.CreateIndexInput.t ->
(Awso_resource_explorer_2.Values.CreateIndexOutput.t,
Awso_resource_explorer_2.Values.CreateIndexOutput.error)
Result.t
Async.Deferred.tSource
val create_resource_explorer_setup :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.CreateResourceExplorerSetupInput.t ->
(Awso_resource_explorer_2.Values.CreateResourceExplorerSetupOutput.t,
Awso_resource_explorer_2.Values.CreateResourceExplorerSetupOutput.error)
Result.t
Async.Deferred.tSource
val create_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.CreateViewInput.t ->
(Awso_resource_explorer_2.Values.CreateViewOutput.t,
Awso_resource_explorer_2.Values.CreateViewOutput.error)
Result.t
Async.Deferred.tSource
val delete_index :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.DeleteIndexInput.t ->
(Awso_resource_explorer_2.Values.DeleteIndexOutput.t,
Awso_resource_explorer_2.Values.DeleteIndexOutput.error)
Result.t
Async.Deferred.tSource
val delete_resource_explorer_setup :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.DeleteResourceExplorerSetupInput.t ->
(Awso_resource_explorer_2.Values.DeleteResourceExplorerSetupOutput.t,
Awso_resource_explorer_2.Values.DeleteResourceExplorerSetupOutput.error)
Result.t
Async.Deferred.tSource
val delete_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.DeleteViewInput.t ->
(Awso_resource_explorer_2.Values.DeleteViewOutput.t,
Awso_resource_explorer_2.Values.DeleteViewOutput.error)
Result.t
Async.Deferred.tSource
val disassociate_default_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
unit ->
(unit, unit) Result.t Async.Deferred.tSource
val get_account_level_service_configuration :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
unit ->
(Awso_resource_explorer_2.Values.GetAccountLevelServiceConfigurationOutput.t,
Awso_resource_explorer_2.Values.GetAccountLevelServiceConfigurationOutput.error)
Result.t
Async.Deferred.tSource
val get_default_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
unit ->
(Awso_resource_explorer_2.Values.GetDefaultViewOutput.t,
Awso_resource_explorer_2.Values.GetDefaultViewOutput.error)
Result.t
Async.Deferred.tSource
val get_index :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
unit ->
(Awso_resource_explorer_2.Values.GetIndexOutput.t,
Awso_resource_explorer_2.Values.GetIndexOutput.error)
Result.t
Async.Deferred.tSource
val get_managed_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.GetManagedViewInput.t ->
(Awso_resource_explorer_2.Values.GetManagedViewOutput.t,
Awso_resource_explorer_2.Values.GetManagedViewOutput.error)
Result.t
Async.Deferred.tSource
val get_resource_explorer_setup :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.GetResourceExplorerSetupInput.t ->
(Awso_resource_explorer_2.Values.GetResourceExplorerSetupOutput.t,
Awso_resource_explorer_2.Values.GetResourceExplorerSetupOutput.error)
Result.t
Async.Deferred.tSource
val get_service_index :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
unit ->
(Awso_resource_explorer_2.Values.GetServiceIndexOutput.t,
Awso_resource_explorer_2.Values.GetServiceIndexOutput.error)
Result.t
Async.Deferred.tSource
val get_service_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.GetServiceViewInput.t ->
(Awso_resource_explorer_2.Values.GetServiceViewOutput.t,
Awso_resource_explorer_2.Values.GetServiceViewOutput.error)
Result.t
Async.Deferred.tSource
val get_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.GetViewInput.t ->
(Awso_resource_explorer_2.Values.GetViewOutput.t,
Awso_resource_explorer_2.Values.GetViewOutput.error)
Result.t
Async.Deferred.tSource
val list_indexes :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.ListIndexesInput.t ->
(Awso_resource_explorer_2.Values.ListIndexesOutput.t,
Awso_resource_explorer_2.Values.ListIndexesOutput.error)
Result.t
Async.Deferred.tSource
val list_indexes_for_members :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.ListIndexesForMembersInput.t ->
(Awso_resource_explorer_2.Values.ListIndexesForMembersOutput.t,
Awso_resource_explorer_2.Values.ListIndexesForMembersOutput.error)
Result.t
Async.Deferred.tSource
val list_managed_views :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.ListManagedViewsInput.t ->
(Awso_resource_explorer_2.Values.ListManagedViewsOutput.t,
Awso_resource_explorer_2.Values.ListManagedViewsOutput.error)
Result.t
Async.Deferred.tSource
val list_resources :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.ListResourcesInput.t ->
(Awso_resource_explorer_2.Values.ListResourcesOutput.t,
Awso_resource_explorer_2.Values.ListResourcesOutput.error)
Result.t
Async.Deferred.tSource
val list_service_indexes :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.ListServiceIndexesInput.t ->
(Awso_resource_explorer_2.Values.ListServiceIndexesOutput.t,
Awso_resource_explorer_2.Values.ListServiceIndexesOutput.error)
Result.t
Async.Deferred.tSource
val list_service_views :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.ListServiceViewsInput.t ->
(Awso_resource_explorer_2.Values.ListServiceViewsOutput.t,
Awso_resource_explorer_2.Values.ListServiceViewsOutput.error)
Result.t
Async.Deferred.tSource
val list_streaming_access_for_services :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.ListStreamingAccessForServicesInput.t ->
(Awso_resource_explorer_2.Values.ListStreamingAccessForServicesOutput.t,
Awso_resource_explorer_2.Values.ListStreamingAccessForServicesOutput.error)
Result.t
Async.Deferred.tSource
val list_supported_resource_types :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.ListSupportedResourceTypesInput.t ->
(Awso_resource_explorer_2.Values.ListSupportedResourceTypesOutput.t,
Awso_resource_explorer_2.Values.ListSupportedResourceTypesOutput.error)
Result.t
Async.Deferred.tSource
val list_tags_for_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.ListTagsForResourceInput.t ->
(Awso_resource_explorer_2.Values.ListTagsForResourceOutput.t,
Awso_resource_explorer_2.Values.ListTagsForResourceOutput.error)
Result.t
Async.Deferred.tSource
val list_views :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.ListViewsInput.t ->
(Awso_resource_explorer_2.Values.ListViewsOutput.t,
Awso_resource_explorer_2.Values.ListViewsOutput.error)
Result.t
Async.Deferred.tSource
val search :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.SearchInput.t ->
(Awso_resource_explorer_2.Values.SearchOutput.t,
Awso_resource_explorer_2.Values.SearchOutput.error)
Result.t
Async.Deferred.tSource
val tag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.TagResourceInput.t ->
(Awso_resource_explorer_2.Values.TagResourceOutput.t,
Awso_resource_explorer_2.Values.TagResourceOutput.error)
Result.t
Async.Deferred.tSource
val untag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.UntagResourceInput.t ->
(Awso_resource_explorer_2.Values.UntagResourceOutput.t,
Awso_resource_explorer_2.Values.UntagResourceOutput.error)
Result.t
Async.Deferred.tSource
val update_index_type :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.UpdateIndexTypeInput.t ->
(Awso_resource_explorer_2.Values.UpdateIndexTypeOutput.t,
Awso_resource_explorer_2.Values.UpdateIndexTypeOutput.error)
Result.t
Async.Deferred.tSource
val update_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resource_explorer_2.Values.UpdateViewInput.t ->
(Awso_resource_explorer_2.Values.UpdateViewOutput.t,
Awso_resource_explorer_2.Values.UpdateViewOutput.error)
Result.t
Async.Deferred.tinclude module type of struct include Awso_resource_explorer_2.Values end
Source
val structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]Source
val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Source
module IncludedPropertyNameString =
Awso_resource_explorer_2.Values.IncludedPropertyNameStringInformation 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.
Source
module SearchFilterFilterStringString =
Awso_resource_explorer_2.Values.SearchFilterFilterStringStringSource
module SyntheticTimestamp_date_time =
Awso_resource_explorer_2.Values.SyntheticTimestamp_date_timeA search filter defines which resources can be part of a search query result set.
A structure that describes a property of a resource.
Contains information about an error that occurred during a Resource Explorer setup operation.
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.
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".
A structure that describes a request field with a validation error.
Contains information about the status of a Resource Explorer index operation in a specific Region.
Contains information about the status of a Resource Explorer view operation in a specific Region.
Source
module ValidationExceptionFieldList =
Awso_resource_explorer_2.Values.ValidationExceptionFieldListA 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.
A structure that describes a resource type supported by Amazon Web Services Resource Explorer.
Contains information about an Amazon Web Services service that has been granted streaming access to your Resource Explorer data.
Source
module ListServiceIndexesInputRegionsListMemberString =
Awso_resource_explorer_2.Values.ListServiceIndexesInputRegionsListMemberStringSource
module ListIndexesInputRegionsListMemberString =
Awso_resource_explorer_2.Values.ListIndexesInputRegionsListMemberStringAn 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.
Contains information about the status of Resource Explorer configuration in a specific Amazon Web Services Region.
Source
module CreateResourceExplorerSetupInputAggregatorRegionsListMemberString =
Awso_resource_explorer_2.Values.CreateResourceExplorerSetupInputAggregatorRegionsListMemberStringSource
module CreateResourceExplorerSetupInputRegionListListMemberString =
Awso_resource_explorer_2.Values.CreateResourceExplorerSetupInputRegionListListMemberStringA collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.
The credentials that you used to call this operation don't have the minimum required permissions.
The request failed because of internal service error. Try your request again later.
Source
module ServiceQuotaExceededException =
Awso_resource_explorer_2.Values.ServiceQuotaExceededExceptionThe request failed because it exceeds a service quota.
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
The principal making the request isn't permitted to perform the operation.
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
Source
module UpdateViewInputViewArnString =
Awso_resource_explorer_2.Values.UpdateViewInputViewArnStringIf 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.
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
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.
Source
module SearchOutputNextTokenString =
Awso_resource_explorer_2.Values.SearchOutputNextTokenStringSource
module SearchInputMaxResultsInteger =
Awso_resource_explorer_2.Values.SearchInputMaxResultsIntegerSource
module SearchInputNextTokenString =
Awso_resource_explorer_2.Values.SearchInputNextTokenStringSource
module ListViewsInputMaxResultsInteger =
Awso_resource_explorer_2.Values.ListViewsInputMaxResultsIntegerSource
module ListSupportedResourceTypesInputMaxResultsInteger =
Awso_resource_explorer_2.Values.ListSupportedResourceTypesInputMaxResultsIntegerSource
module StreamingAccessDetailsList =
Awso_resource_explorer_2.Values.StreamingAccessDetailsListSource
module ListStreamingAccessForServicesInputMaxResultsInteger =
Awso_resource_explorer_2.Values.ListStreamingAccessForServicesInputMaxResultsIntegerSource
module ListServiceViewsInputMaxResultsInteger =
Awso_resource_explorer_2.Values.ListServiceViewsInputMaxResultsIntegerSource
module ListServiceIndexesInputMaxResultsInteger =
Awso_resource_explorer_2.Values.ListServiceIndexesInputMaxResultsIntegerSource
module ListServiceIndexesInputNextTokenString =
Awso_resource_explorer_2.Values.ListServiceIndexesInputNextTokenStringSource
module ListServiceIndexesInputRegionsList =
Awso_resource_explorer_2.Values.ListServiceIndexesInputRegionsListSource
module ListResourcesOutputNextTokenString =
Awso_resource_explorer_2.Values.ListResourcesOutputNextTokenStringSource
module ListResourcesOutputViewArnString =
Awso_resource_explorer_2.Values.ListResourcesOutputViewArnStringSource
module ListResourcesInputMaxResultsInteger =
Awso_resource_explorer_2.Values.ListResourcesInputMaxResultsIntegerSource
module ListResourcesInputNextTokenString =
Awso_resource_explorer_2.Values.ListResourcesInputNextTokenStringSource
module ListResourcesInputViewArnString =
Awso_resource_explorer_2.Values.ListResourcesInputViewArnStringSource
module ListManagedViewsInputMaxResultsInteger =
Awso_resource_explorer_2.Values.ListManagedViewsInputMaxResultsIntegerSource
module ListManagedViewsInputNextTokenString =
Awso_resource_explorer_2.Values.ListManagedViewsInputNextTokenStringSource
module ListManagedViewsInputServicePrincipalString =
Awso_resource_explorer_2.Values.ListManagedViewsInputServicePrincipalStringSource
module ListIndexesInputMaxResultsInteger =
Awso_resource_explorer_2.Values.ListIndexesInputMaxResultsIntegerSource
module ListIndexesInputNextTokenString =
Awso_resource_explorer_2.Values.ListIndexesInputNextTokenStringSource
module ListIndexesInputRegionsList =
Awso_resource_explorer_2.Values.ListIndexesInputRegionsListSource
module ListIndexesForMembersInputAccountIdListList =
Awso_resource_explorer_2.Values.ListIndexesForMembersInputAccountIdListListSource
module ListIndexesForMembersInputMaxResultsInteger =
Awso_resource_explorer_2.Values.ListIndexesForMembersInputMaxResultsIntegerSource
module ListIndexesForMembersInputNextTokenString =
Awso_resource_explorer_2.Values.ListIndexesForMembersInputNextTokenStringContains the configuration and properties of a Resource Explorer service view.
Source
module GetServiceViewInputServiceViewArnString =
Awso_resource_explorer_2.Values.GetServiceViewInputServiceViewArnStringSource
module GetResourceExplorerSetupOutputNextTokenString =
Awso_resource_explorer_2.Values.GetResourceExplorerSetupOutputNextTokenStringSource
module GetResourceExplorerSetupInputMaxResultsInteger =
Awso_resource_explorer_2.Values.GetResourceExplorerSetupInputMaxResultsIntegerSource
module GetResourceExplorerSetupInputNextTokenString =
Awso_resource_explorer_2.Values.GetResourceExplorerSetupInputNextTokenStringSource
module GetResourceExplorerSetupInputTaskIdString =
Awso_resource_explorer_2.Values.GetResourceExplorerSetupInputTaskIdStringAn Amazon Web Services-managed view is how other Amazon Web Services services can access resource information indexed by Resource Explorer for your Amazon Web Services account or organization with your consent. For more information, see Managed views.
Source
module GetManagedViewInputManagedViewArnString =
Awso_resource_explorer_2.Values.GetManagedViewInputManagedViewArnStringThis 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.
Source
module DeleteViewInputViewArnString =
Awso_resource_explorer_2.Values.DeleteViewInputViewArnStringSource
module DeleteResourceExplorerSetupOutputTaskIdString =
Awso_resource_explorer_2.Values.DeleteResourceExplorerSetupOutputTaskIdStringSource
module CreateViewInputClientTokenString =
Awso_resource_explorer_2.Values.CreateViewInputClientTokenStringSource
module CreateViewInputScopeString =
Awso_resource_explorer_2.Values.CreateViewInputScopeStringSource
module CreateResourceExplorerSetupOutputTaskIdString =
Awso_resource_explorer_2.Values.CreateResourceExplorerSetupOutputTaskIdStringSource
module CreateResourceExplorerSetupInputAggregatorRegionsList =
Awso_resource_explorer_2.Values.CreateResourceExplorerSetupInputAggregatorRegionsListSource
module CreateResourceExplorerSetupInputRegionListList =
Awso_resource_explorer_2.Values.CreateResourceExplorerSetupInputRegionListListSource
module CreateResourceExplorerSetupInputViewNameString =
Awso_resource_explorer_2.Values.CreateResourceExplorerSetupInputViewNameStringSource
module BatchGetViewInputViewArnsList =
Awso_resource_explorer_2.Values.BatchGetViewInputViewArnsListSource
module AssociateDefaultViewInputViewArnString =
Awso_resource_explorer_2.Values.AssociateDefaultViewInputViewArnStringModifies 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.
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.
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 type The 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, the Status response of that operation changes from UPDATING to ACTIVE. 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 type The 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 the UPDATING 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, the Status response of that operation changes from UPDATING to ACTIVE. 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.
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 type The 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, the Status response of that operation changes from UPDATING to ACTIVE. 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 type The 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 the UPDATING 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, the Status response of that operation changes from UPDATING to ACTIVE. 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.
Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
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.
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.
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.
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.
Lists the tags that are attached to the specified resource.
Lists the tags that are attached to the specified resource.
Source
module ListSupportedResourceTypesOutput =
Awso_resource_explorer_2.Values.ListSupportedResourceTypesOutputRetrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
Source
module ListSupportedResourceTypesInput =
Awso_resource_explorer_2.Values.ListSupportedResourceTypesInputRetrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
Source
module ListStreamingAccessForServicesOutput =
Awso_resource_explorer_2.Values.ListStreamingAccessForServicesOutputReturns 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.
Source
module ListStreamingAccessForServicesInput =
Awso_resource_explorer_2.Values.ListStreamingAccessForServicesInputReturns 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.
Lists all Resource Explorer service views available in the current Amazon Web Services account. This operation returns the ARNs of available service views.
Lists all Resource Explorer service views available in the current Amazon Web Services account. This operation returns the ARNs of available service views.
Lists all Resource Explorer indexes across the specified Amazon Web Services Regions. This operation returns information about indexes including their ARNs, types, and Regions.
Lists all Resource Explorer indexes across the specified Amazon Web Services Regions. This operation returns information about indexes including their ARNs, types, and Regions.
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.
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.
Lists the Amazon resource names (ARNs) of the Amazon Web Services-managed views available in the Amazon Web Services Region in which you call this operation.
Lists the Amazon resource names (ARNs) of the Amazon Web Services-managed views available in the Amazon Web Services Region in which you call this operation.
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.
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.
Source
module ListIndexesForMembersOutput =
Awso_resource_explorer_2.Values.ListIndexesForMembersOutputRetrieves 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.
Source
module ListIndexesForMembersInput =
Awso_resource_explorer_2.Values.ListIndexesForMembersInputRetrieves 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.
Retrieves details of the specified view.
Retrieves details of the specified view.
Retrieves details about a specific Resource Explorer service view. This operation returns the configuration and properties of the specified view.
Retrieves details about a specific Resource Explorer service view. This operation returns the configuration and properties of the specified view.
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.
Source
module GetResourceExplorerSetupOutput =
Awso_resource_explorer_2.Values.GetResourceExplorerSetupOutputRetrieves 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.
Source
module GetResourceExplorerSetupInput =
Awso_resource_explorer_2.Values.GetResourceExplorerSetupInputRetrieves 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.
Retrieves details of the specified Amazon Web Services-managed view.
Retrieves details of the specified Amazon Web Services-managed view.
Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
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.
Source
module GetAccountLevelServiceConfigurationOutput =
Awso_resource_explorer_2.Values.GetAccountLevelServiceConfigurationOutputRetrieves 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.
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.
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.
Source
module DeleteResourceExplorerSetupOutput =
Awso_resource_explorer_2.Values.DeleteResourceExplorerSetupOutputDeletes a Resource Explorer setup configuration. This operation removes indexes and views from the specified Regions or all Regions where Resource Explorer is configured.
Source
module DeleteResourceExplorerSetupInput =
Awso_resource_explorer_2.Values.DeleteResourceExplorerSetupInputDeletes a Resource Explorer setup configuration. This operation removes indexes and views from the specified Regions or all Regions where Resource Explorer is configured.
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.
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.
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.
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.
Source
module CreateResourceExplorerSetupOutput =
Awso_resource_explorer_2.Values.CreateResourceExplorerSetupOutputCreates 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.
Source
module CreateResourceExplorerSetupInput =
Awso_resource_explorer_2.Values.CreateResourceExplorerSetupInputCreates 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.
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 following Resource element restricts the role or user to creating an index in only the us-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.
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 following Resource element restricts the role or user to creating an index in only the us-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.
Retrieves details about a list of views.
Retrieves details about a list of views.
Source
module AssociateDefaultViewOutput =
Awso_resource_explorer_2.Values.AssociateDefaultViewOutputSets 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.
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.