resourceexplorer2/aws.sdk.kotlin.services.resourceexplorer2/ResourceExplorer2Client

ResourceExplorer2Client

interface ResourceExplorer2Client : SdkClient

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.

Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources.

You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account, Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.

For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide.

Properties

Link copied to clipboard
abstract override val config: ResourceExplorer2Client.Config

ResourceExplorer2Client's configuration

Functions

Link copied to clipboard
abstract suspend fun associateDefaultView(input: AssociateDefaultViewRequest): AssociateDefaultViewResponse

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.

Link copied to clipboard
abstract suspend fun batchGetView(input: BatchGetViewRequest = BatchGetViewRequest { }): BatchGetViewResponse

Retrieves details about a list of views.

Link copied to clipboard
abstract suspend fun createIndex(input: CreateIndexRequest = CreateIndexRequest { }): CreateIndexResponse

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.

Link copied to clipboard
abstract suspend fun createView(input: CreateViewRequest): CreateViewResponse

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.

Link copied to clipboard
abstract suspend fun deleteIndex(input: DeleteIndexRequest): DeleteIndexResponse

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.

Link copied to clipboard
abstract suspend fun deleteView(input: DeleteViewRequest): DeleteViewResponse

Deletes the specified view.

Link copied to clipboard
abstract suspend fun disassociateDefaultView(input: DisassociateDefaultViewRequest = DisassociateDefaultViewRequest { }): DisassociateDefaultViewResponse

After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.

Link copied to clipboard
abstract suspend fun getAccountLevelServiceConfiguration(input: GetAccountLevelServiceConfigurationRequest = GetAccountLevelServiceConfigurationRequest { }): GetAccountLevelServiceConfigurationResponse

Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature. Only the management account or a delegated administrator with service access enabled can invoke this API call.

Link copied to clipboard
abstract suspend fun getDefaultView(input: GetDefaultViewRequest = GetDefaultViewRequest { }): GetDefaultViewResponse

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.

Link copied to clipboard
abstract suspend fun getIndex(input: GetIndexRequest = GetIndexRequest { }): GetIndexResponse

Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.

Link copied to clipboard
abstract suspend fun getView(input: GetViewRequest): GetViewResponse

Retrieves details of the specified view.

Link copied to clipboard
abstract suspend fun listIndexes(input: ListIndexesRequest = ListIndexesRequest { }): ListIndexesResponse

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.

Link copied to clipboard
abstract suspend fun listIndexesForMembers(input: ListIndexesForMembersRequest): ListIndexesForMembersResponse

Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call.

Link copied to clipboard
abstract suspend fun listSupportedResourceTypes(input: ListSupportedResourceTypesRequest = ListSupportedResourceTypesRequest { }): ListSupportedResourceTypesResponse

Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags that are attached to the specified resource.

Link copied to clipboard
abstract suspend fun listViews(input: ListViewsRequest = ListViewsRequest { }): ListViewsResponse

Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.

Link copied to clipboard
abstract suspend fun search(input: SearchRequest): SearchResponse

Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.

Link copied to clipboard
abstract suspend fun updateIndexType(input: UpdateIndexTypeRequest): UpdateIndexTypeResponse

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.

Link copied to clipboard
abstract suspend fun updateView(input: UpdateViewRequest): UpdateViewResponse

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.

Inherited functions

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.associateDefaultView(crossinline block: AssociateDefaultViewRequest.Builder.() -> Unit): AssociateDefaultViewResponse

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.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.batchGetView(crossinline block: BatchGetViewRequest.Builder.() -> Unit): BatchGetViewResponse

Retrieves details about a list of views.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun ResourceExplorer2Client.createIndex(crossinline block: CreateIndexRequest.Builder.() -> Unit): CreateIndexResponse

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.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.createView(crossinline block: CreateViewRequest.Builder.() -> Unit): CreateViewResponse

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.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.deleteIndex(crossinline block: DeleteIndexRequest.Builder.() -> Unit): DeleteIndexResponse

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.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.deleteView(crossinline block: DeleteViewRequest.Builder.() -> Unit): DeleteViewResponse

Deletes the specified view.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.disassociateDefaultView(crossinline block: DisassociateDefaultViewRequest.Builder.() -> Unit): DisassociateDefaultViewResponse

After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.getAccountLevelServiceConfiguration(crossinline block: GetAccountLevelServiceConfigurationRequest.Builder.() -> Unit): GetAccountLevelServiceConfigurationResponse

Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature. Only the management account or a delegated administrator with service access enabled can invoke this API call.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.getDefaultView(crossinline block: GetDefaultViewRequest.Builder.() -> Unit): GetDefaultViewResponse

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.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.getIndex(crossinline block: GetIndexRequest.Builder.() -> Unit): GetIndexResponse

Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.getView(crossinline block: GetViewRequest.Builder.() -> Unit): GetViewResponse

Retrieves details of the specified view.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.listIndexes(crossinline block: ListIndexesRequest.Builder.() -> Unit): ListIndexesResponse

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.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.listIndexesForMembers(crossinline block: ListIndexesForMembersRequest.Builder.() -> Unit): ListIndexesForMembersResponse

Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ResourceExplorer2Client.listSupportedResourceTypes(crossinline block: ListSupportedResourceTypesRequest.Builder.() -> Unit): ListSupportedResourceTypesResponse

Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ResourceExplorer2Client.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags that are attached to the specified resource.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.listViews(crossinline block: ListViewsRequest.Builder.() -> Unit): ListViewsResponse

Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.search(crossinline block: SearchRequest.Builder.() -> Unit): SearchResponse

Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ResourceExplorer2Client.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.updateIndexType(crossinline block: UpdateIndexTypeRequest.Builder.() -> Unit): UpdateIndexTypeResponse

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.

Link copied to clipboard
inline suspend fun ResourceExplorer2Client.updateView(crossinline block: UpdateViewRequest.Builder.() -> Unit): UpdateViewResponse

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.

Link copied to clipboard
fun ResourceExplorer2Client.withConfig(block: ResourceExplorer2Client.Config.Builder.() -> Unit): ResourceExplorer2Client

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.