Interface ResourceExplorer2Client
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AssociateDefaultViewResponse
associateDefaultView
(Consumer<AssociateDefaultViewRequest.Builder> associateDefaultViewRequest) Sets the specified view as the default for the Amazon Web Services Region in which you call this operation.default AssociateDefaultViewResponse
associateDefaultView
(AssociateDefaultViewRequest associateDefaultViewRequest) Sets the specified view as the default for the Amazon Web Services Region in which you call this operation.default BatchGetViewResponse
batchGetView
(Consumer<BatchGetViewRequest.Builder> batchGetViewRequest) Retrieves details about a list of views.default BatchGetViewResponse
batchGetView
(BatchGetViewRequest batchGetViewRequest) Retrieves details about a list of views.builder()
Create a builder that can be used to configure and create aResourceExplorer2Client
.static ResourceExplorer2Client
create()
Create aResourceExplorer2Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateIndexResponse
createIndex
(Consumer<CreateIndexRequest.Builder> createIndexRequest) Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index.default CreateIndexResponse
createIndex
(CreateIndexRequest createIndexRequest) Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index.default CreateViewResponse
createView
(Consumer<CreateViewRequest.Builder> createViewRequest) Creates a view that users can query by using the Search operation.default CreateViewResponse
createView
(CreateViewRequest createViewRequest) Creates a view that users can query by using the Search operation.default DeleteIndexResponse
deleteIndex
(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest) Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.default DeleteIndexResponse
deleteIndex
(DeleteIndexRequest deleteIndexRequest) Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.default DeleteViewResponse
deleteView
(Consumer<DeleteViewRequest.Builder> deleteViewRequest) Deletes the specified view.default DeleteViewResponse
deleteView
(DeleteViewRequest deleteViewRequest) Deletes the specified view.default DisassociateDefaultViewResponse
disassociateDefaultView
(Consumer<DisassociateDefaultViewRequest.Builder> disassociateDefaultViewRequest) After you call this operation, the affected Amazon Web Services Region no longer has a default view.default DisassociateDefaultViewResponse
disassociateDefaultView
(DisassociateDefaultViewRequest disassociateDefaultViewRequest) After you call this operation, the affected Amazon Web Services Region no longer has a default view.getAccountLevelServiceConfiguration
(Consumer<GetAccountLevelServiceConfigurationRequest.Builder> getAccountLevelServiceConfigurationRequest) 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.getAccountLevelServiceConfiguration
(GetAccountLevelServiceConfigurationRequest getAccountLevelServiceConfigurationRequest) 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.default GetDefaultViewResponse
getDefaultView
(Consumer<GetDefaultViewRequest.Builder> getDefaultViewRequest) 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.default GetDefaultViewResponse
getDefaultView
(GetDefaultViewRequest getDefaultViewRequest) 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.default GetIndexResponse
getIndex
(Consumer<GetIndexRequest.Builder> getIndexRequest) Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.default GetIndexResponse
getIndex
(GetIndexRequest getIndexRequest) Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.default GetViewResponse
getView
(Consumer<GetViewRequest.Builder> getViewRequest) Retrieves details of the specified view.default GetViewResponse
getView
(GetViewRequest getViewRequest) Retrieves details of the specified view.default ListIndexesResponse
listIndexes
(Consumer<ListIndexesRequest.Builder> listIndexesRequest) 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.default ListIndexesResponse
listIndexes
(ListIndexesRequest listIndexesRequest) 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.default ListIndexesForMembersResponse
listIndexesForMembers
(Consumer<ListIndexesForMembersRequest.Builder> listIndexesForMembersRequest) 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.default ListIndexesForMembersResponse
listIndexesForMembers
(ListIndexesForMembersRequest listIndexesForMembersRequest) 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.default ListIndexesForMembersIterable
listIndexesForMembersPaginator
(Consumer<ListIndexesForMembersRequest.Builder> listIndexesForMembersRequest) This is a variant oflistIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest)
operation.default ListIndexesForMembersIterable
listIndexesForMembersPaginator
(ListIndexesForMembersRequest listIndexesForMembersRequest) This is a variant oflistIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest)
operation.default ListIndexesIterable
listIndexesPaginator
(Consumer<ListIndexesRequest.Builder> listIndexesRequest) This is a variant oflistIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest)
operation.default ListIndexesIterable
listIndexesPaginator
(ListIndexesRequest listIndexesRequest) This is a variant oflistIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest)
operation.listSupportedResourceTypes
(Consumer<ListSupportedResourceTypesRequest.Builder> listSupportedResourceTypesRequest) Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.listSupportedResourceTypes
(ListSupportedResourceTypesRequest listSupportedResourceTypesRequest) Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.listSupportedResourceTypesPaginator
(Consumer<ListSupportedResourceTypesRequest.Builder> listSupportedResourceTypesRequest) This is a variant oflistSupportedResourceTypes(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesRequest)
operation.listSupportedResourceTypesPaginator
(ListSupportedResourceTypesRequest listSupportedResourceTypesRequest) This is a variant oflistSupportedResourceTypes(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags that are attached to the specified resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are attached to the specified resource.default ListViewsResponse
listViews
(Consumer<ListViewsRequest.Builder> listViewsRequest) Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.default ListViewsResponse
listViews
(ListViewsRequest listViewsRequest) Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.default ListViewsIterable
listViewsPaginator
(Consumer<ListViewsRequest.Builder> listViewsRequest) This is a variant oflistViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest)
operation.default ListViewsIterable
listViewsPaginator
(ListViewsRequest listViewsRequest) This is a variant oflistViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest)
operation.default SearchResponse
search
(Consumer<SearchRequest.Builder> searchRequest) Searches for resources and displays details about all resources that match the specified criteria.default SearchResponse
search
(SearchRequest searchRequest) Searches for resources and displays details about all resources that match the specified criteria.default SearchIterable
searchPaginator
(Consumer<SearchRequest.Builder> searchRequest) This is a variant ofsearch(software.amazon.awssdk.services.resourceexplorer2.model.SearchRequest)
operation.default SearchIterable
searchPaginator
(SearchRequest searchRequest) This is a variant ofsearch(software.amazon.awssdk.services.resourceexplorer2.model.SearchRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.default UpdateIndexTypeResponse
updateIndexType
(Consumer<UpdateIndexTypeRequest.Builder> updateIndexTypeRequest) Changes the type of the index from one of the following types to the other.default UpdateIndexTypeResponse
updateIndexType
(UpdateIndexTypeRequest updateIndexTypeRequest) Changes the type of the index from one of the following types to the other.default UpdateViewResponse
updateView
(Consumer<UpdateViewRequest.Builder> updateViewRequest) Modifies some of the details of a view.default UpdateViewResponse
updateView
(UpdateViewRequest updateViewRequest) Modifies some of the details of a view.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateDefaultView
default AssociateDefaultViewResponse associateDefaultView(AssociateDefaultViewRequest associateDefaultViewRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.- Parameters:
associateDefaultViewRequest
-- Returns:
- Result of the AssociateDefaultView operation returned by the service.
- See Also:
-
associateDefaultView
default AssociateDefaultViewResponse associateDefaultView(Consumer<AssociateDefaultViewRequest.Builder> associateDefaultViewRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
This is a convenience which creates an instance of the
AssociateDefaultViewRequest.Builder
avoiding the need to create one manually viaAssociateDefaultViewRequest.builder()
- Parameters:
associateDefaultViewRequest
- AConsumer
that will call methods onAssociateDefaultViewRequest.Builder
to create a request.- Returns:
- Result of the AssociateDefaultView operation returned by the service.
- See Also:
-
batchGetView
default BatchGetViewResponse batchGetView(BatchGetViewRequest batchGetViewRequest) throws InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Retrieves details about a list of views.
- Parameters:
batchGetViewRequest
-- Returns:
- Result of the BatchGetView operation returned by the service.
- See Also:
-
batchGetView
default BatchGetViewResponse batchGetView(Consumer<BatchGetViewRequest.Builder> batchGetViewRequest) throws InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Retrieves details about a list of views.
This is a convenience which creates an instance of the
BatchGetViewRequest.Builder
avoiding the need to create one manually viaBatchGetViewRequest.builder()
- Parameters:
batchGetViewRequest
- AConsumer
that will call methods onBatchGetViewRequest.Builder
to create a request.- Returns:
- Result of the BatchGetView operation returned by the service.
- See Also:
-
createIndex
default CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest) throws InternalServerException, ValidationException, ConflictException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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 followingResource
element restricts the role or user to creating an index in only theus-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.
- Parameters:
createIndexRequest
-- Returns:
- Result of the CreateIndex operation returned by the service.
- See Also:
-
-
createIndex
default CreateIndexResponse createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest) throws InternalServerException, ValidationException, ConflictException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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 followingResource
element restricts the role or user to creating an index in only theus-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.
This is a convenience which creates an instance of the
CreateIndexRequest.Builder
avoiding the need to create one manually viaCreateIndexRequest.builder()
- Parameters:
createIndexRequest
- AConsumer
that will call methods onCreateIndexRequest.Builder
to create a request.- Returns:
- Result of the CreateIndex operation returned by the service.
- See Also:
-
-
createView
default CreateViewResponse createView(CreateViewRequest createViewRequest) throws InternalServerException, ValidationException, ConflictException, ServiceQuotaExceededException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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 theSearch
action on aResource
with the Amazon resource name (ARN) of this view can Search using views you create with this operation.- Parameters:
createViewRequest
-- Returns:
- Result of the CreateView operation returned by the service.
- See Also:
-
createView
default CreateViewResponse createView(Consumer<CreateViewRequest.Builder> createViewRequest) throws InternalServerException, ValidationException, ConflictException, ServiceQuotaExceededException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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 theSearch
action on aResource
with the Amazon resource name (ARN) of this view can Search using views you create with this operation.
This is a convenience which creates an instance of the
CreateViewRequest.Builder
avoiding the need to create one manually viaCreateViewRequest.builder()
- Parameters:
createViewRequest
- AConsumer
that will call methods onCreateViewRequest.Builder
to create a request.- Returns:
- Result of the CreateView operation returned by the service.
- See Also:
-
deleteIndex
default DeleteIndexResponse deleteIndex(DeleteIndexRequest deleteIndexRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
- Parameters:
deleteIndexRequest
-- Returns:
- Result of the DeleteIndex operation returned by the service.
- See Also:
-
deleteIndex
default DeleteIndexResponse deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
This is a convenience which creates an instance of the
DeleteIndexRequest.Builder
avoiding the need to create one manually viaDeleteIndexRequest.builder()
- Parameters:
deleteIndexRequest
- AConsumer
that will call methods onDeleteIndexRequest.Builder
to create a request.- Returns:
- Result of the DeleteIndex operation returned by the service.
- See Also:
-
deleteView
default DeleteViewResponse deleteView(DeleteViewRequest deleteViewRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
- Parameters:
deleteViewRequest
-- Returns:
- Result of the DeleteView operation returned by the service.
- See Also:
-
deleteView
default DeleteViewResponse deleteView(Consumer<DeleteViewRequest.Builder> deleteViewRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
This is a convenience which creates an instance of the
DeleteViewRequest.Builder
avoiding the need to create one manually viaDeleteViewRequest.builder()
- Parameters:
deleteViewRequest
- AConsumer
that will call methods onDeleteViewRequest.Builder
to create a request.- Returns:
- Result of the DeleteView operation returned by the service.
- See Also:
-
disassociateDefaultView
default DisassociateDefaultViewResponse disassociateDefaultView(DisassociateDefaultViewRequest disassociateDefaultViewRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
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.- Parameters:
disassociateDefaultViewRequest
-- Returns:
- Result of the DisassociateDefaultView operation returned by the service.
- See Also:
-
disassociateDefaultView
default DisassociateDefaultViewResponse disassociateDefaultView(Consumer<DisassociateDefaultViewRequest.Builder> disassociateDefaultViewRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
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.
This is a convenience which creates an instance of the
DisassociateDefaultViewRequest.Builder
avoiding the need to create one manually viaDisassociateDefaultViewRequest.builder()
- Parameters:
disassociateDefaultViewRequest
- AConsumer
that will call methods onDisassociateDefaultViewRequest.Builder
to create a request.- Returns:
- Result of the DisassociateDefaultView operation returned by the service.
- See Also:
-
getAccountLevelServiceConfiguration
default GetAccountLevelServiceConfigurationResponse getAccountLevelServiceConfiguration(GetAccountLevelServiceConfigurationRequest getAccountLevelServiceConfigurationRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
- Parameters:
getAccountLevelServiceConfigurationRequest
-- Returns:
- Result of the GetAccountLevelServiceConfiguration operation returned by the service.
- See Also:
-
getAccountLevelServiceConfiguration
default GetAccountLevelServiceConfigurationResponse getAccountLevelServiceConfiguration(Consumer<GetAccountLevelServiceConfigurationRequest.Builder> getAccountLevelServiceConfigurationRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
This is a convenience which creates an instance of the
GetAccountLevelServiceConfigurationRequest.Builder
avoiding the need to create one manually viaGetAccountLevelServiceConfigurationRequest.builder()
- Parameters:
getAccountLevelServiceConfigurationRequest
- AConsumer
that will call methods onGetAccountLevelServiceConfigurationRequest.Builder
to create a request.- Returns:
- Result of the GetAccountLevelServiceConfiguration operation returned by the service.
- See Also:
-
getDefaultView
default GetDefaultViewResponse getDefaultView(GetDefaultViewRequest getDefaultViewRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
- Parameters:
getDefaultViewRequest
-- Returns:
- Result of the GetDefaultView operation returned by the service.
- See Also:
-
getDefaultView
default GetDefaultViewResponse getDefaultView(Consumer<GetDefaultViewRequest.Builder> getDefaultViewRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
This is a convenience which creates an instance of the
GetDefaultViewRequest.Builder
avoiding the need to create one manually viaGetDefaultViewRequest.builder()
- Parameters:
getDefaultViewRequest
- AConsumer
that will call methods onGetDefaultViewRequest.Builder
to create a request.- Returns:
- Result of the GetDefaultView operation returned by the service.
- See Also:
-
getIndex
default GetIndexResponse getIndex(GetIndexRequest getIndexRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
- Parameters:
getIndexRequest
-- Returns:
- Result of the GetIndex operation returned by the service.
- See Also:
-
getIndex
default GetIndexResponse getIndex(Consumer<GetIndexRequest.Builder> getIndexRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
This is a convenience which creates an instance of the
GetIndexRequest.Builder
avoiding the need to create one manually viaGetIndexRequest.builder()
- Parameters:
getIndexRequest
- AConsumer
that will call methods onGetIndexRequest.Builder
to create a request.- Returns:
- Result of the GetIndex operation returned by the service.
- See Also:
-
getView
default GetViewResponse getView(GetViewRequest getViewRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Retrieves details of the specified view.
- Parameters:
getViewRequest
-- Returns:
- Result of the GetView operation returned by the service.
- See Also:
-
getView
default GetViewResponse getView(Consumer<GetViewRequest.Builder> getViewRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Retrieves details of the specified view.
This is a convenience which creates an instance of the
GetViewRequest.Builder
avoiding the need to create one manually viaGetViewRequest.builder()
- Parameters:
getViewRequest
- AConsumer
that will call methods onGetViewRequest.Builder
to create a request.- Returns:
- Result of the GetView operation returned by the service.
- See Also:
-
listIndexes
default ListIndexesResponse listIndexes(ListIndexesRequest listIndexesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
- Parameters:
listIndexesRequest
-- Returns:
- Result of the ListIndexes operation returned by the service.
- See Also:
-
listIndexes
default ListIndexesResponse listIndexes(Consumer<ListIndexesRequest.Builder> listIndexesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
This is a convenience which creates an instance of the
ListIndexesRequest.Builder
avoiding the need to create one manually viaListIndexesRequest.builder()
- Parameters:
listIndexesRequest
- AConsumer
that will call methods onListIndexesRequest.Builder
to create a request.- Returns:
- Result of the ListIndexes operation returned by the service.
- See Also:
-
listIndexesPaginator
default ListIndexesIterable listIndexesPaginator(ListIndexesRequest listIndexesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception This is a variant of
listIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesIterable responses = client.listIndexesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesIterable responses = client .listIndexesPaginator(request); for (software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesIterable responses = client.listIndexesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest)
operation.- Parameters:
listIndexesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIndexesPaginator
default ListIndexesIterable listIndexesPaginator(Consumer<ListIndexesRequest.Builder> listIndexesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception This is a variant of
listIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesIterable responses = client.listIndexesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesIterable responses = client .listIndexesPaginator(request); for (software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesIterable responses = client.listIndexesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest)
operation.
This is a convenience which creates an instance of the
ListIndexesRequest.Builder
avoiding the need to create one manually viaListIndexesRequest.builder()
- Parameters:
listIndexesRequest
- AConsumer
that will call methods onListIndexesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIndexesForMembers
default ListIndexesForMembersResponse listIndexesForMembers(ListIndexesForMembersRequest listIndexesForMembersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
- Parameters:
listIndexesForMembersRequest
-- Returns:
- Result of the ListIndexesForMembers operation returned by the service.
- See Also:
-
listIndexesForMembers
default ListIndexesForMembersResponse listIndexesForMembers(Consumer<ListIndexesForMembersRequest.Builder> listIndexesForMembersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
This is a convenience which creates an instance of the
ListIndexesForMembersRequest.Builder
avoiding the need to create one manually viaListIndexesForMembersRequest.builder()
- Parameters:
listIndexesForMembersRequest
- AConsumer
that will call methods onListIndexesForMembersRequest.Builder
to create a request.- Returns:
- Result of the ListIndexesForMembers operation returned by the service.
- See Also:
-
listIndexesForMembersPaginator
default ListIndexesForMembersIterable listIndexesForMembersPaginator(ListIndexesForMembersRequest listIndexesForMembersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception This is a variant of
listIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersIterable responses = client.listIndexesForMembersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersIterable responses = client .listIndexesForMembersPaginator(request); for (software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersIterable responses = client.listIndexesForMembersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest)
operation.- Parameters:
listIndexesForMembersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIndexesForMembersPaginator
default ListIndexesForMembersIterable listIndexesForMembersPaginator(Consumer<ListIndexesForMembersRequest.Builder> listIndexesForMembersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception This is a variant of
listIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersIterable responses = client.listIndexesForMembersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersIterable responses = client .listIndexesForMembersPaginator(request); for (software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersIterable responses = client.listIndexesForMembersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest)
operation.
This is a convenience which creates an instance of the
ListIndexesForMembersRequest.Builder
avoiding the need to create one manually viaListIndexesForMembersRequest.builder()
- Parameters:
listIndexesForMembersRequest
- AConsumer
that will call methods onListIndexesForMembersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSupportedResourceTypes
default ListSupportedResourceTypesResponse listSupportedResourceTypes(ListSupportedResourceTypesRequest listSupportedResourceTypesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
- Parameters:
listSupportedResourceTypesRequest
-- Returns:
- Result of the ListSupportedResourceTypes operation returned by the service.
- See Also:
-
listSupportedResourceTypes
default ListSupportedResourceTypesResponse listSupportedResourceTypes(Consumer<ListSupportedResourceTypesRequest.Builder> listSupportedResourceTypesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
This is a convenience which creates an instance of the
ListSupportedResourceTypesRequest.Builder
avoiding the need to create one manually viaListSupportedResourceTypesRequest.builder()
- Parameters:
listSupportedResourceTypesRequest
- AConsumer
that will call methods onListSupportedResourceTypesRequest.Builder
to create a request.- Returns:
- Result of the ListSupportedResourceTypes operation returned by the service.
- See Also:
-
listSupportedResourceTypesPaginator
default ListSupportedResourceTypesIterable listSupportedResourceTypesPaginator(ListSupportedResourceTypesRequest listSupportedResourceTypesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception This is a variant of
listSupportedResourceTypes(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesIterable responses = client.listSupportedResourceTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesIterable responses = client .listSupportedResourceTypesPaginator(request); for (software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesIterable responses = client.listSupportedResourceTypesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSupportedResourceTypes(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesRequest)
operation.- Parameters:
listSupportedResourceTypesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSupportedResourceTypesPaginator
default ListSupportedResourceTypesIterable listSupportedResourceTypesPaginator(Consumer<ListSupportedResourceTypesRequest.Builder> listSupportedResourceTypesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception This is a variant of
listSupportedResourceTypes(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesIterable responses = client.listSupportedResourceTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesIterable responses = client .listSupportedResourceTypesPaginator(request); for (software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesIterable responses = client.listSupportedResourceTypesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSupportedResourceTypes(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesRequest)
operation.
This is a convenience which creates an instance of the
ListSupportedResourceTypesRequest.Builder
avoiding the need to create one manually viaListSupportedResourceTypesRequest.builder()
- Parameters:
listSupportedResourceTypesRequest
- AConsumer
that will call methods onListSupportedResourceTypesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Lists the tags that are attached to the specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Lists the tags that are attached to the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listViews
default ListViewsResponse listViews(ListViewsRequest listViewsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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 anull
value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. TheNextToken
response parameter value isnull
only when there are no more results to display.- Parameters:
listViewsRequest
-- Returns:
- Result of the ListViews operation returned by the service.
- See Also:
-
listViews
default ListViewsResponse listViews(Consumer<ListViewsRequest.Builder> listViewsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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 anull
value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. TheNextToken
response parameter value isnull
only when there are no more results to display.
This is a convenience which creates an instance of the
ListViewsRequest.Builder
avoiding the need to create one manually viaListViewsRequest.builder()
- Parameters:
listViewsRequest
- AConsumer
that will call methods onListViewsRequest.Builder
to create a request.- Returns:
- Result of the ListViews operation returned by the service.
- See Also:
-
listViewsPaginator
default ListViewsIterable listViewsPaginator(ListViewsRequest listViewsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception This is a variant of
listViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsIterable responses = client.listViewsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsIterable responses = client.listViewsPaginator(request); for (software.amazon.awssdk.services.resourceexplorer2.model.ListViewsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsIterable responses = client.listViewsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest)
operation.- Parameters:
listViewsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listViewsPaginator
default ListViewsIterable listViewsPaginator(Consumer<ListViewsRequest.Builder> listViewsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception This is a variant of
listViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsIterable responses = client.listViewsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsIterable responses = client.listViewsPaginator(request); for (software.amazon.awssdk.services.resourceexplorer2.model.ListViewsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsIterable responses = client.listViewsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest)
operation.
This is a convenience which creates an instance of the
ListViewsRequest.Builder
avoiding the need to create one manually viaListViewsRequest.builder()
- Parameters:
listViewsRequest
- AConsumer
that will call methods onListViewsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
search
default SearchResponse search(SearchRequest searchRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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 theSearchFilter
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.
- Parameters:
searchRequest
-- Returns:
- Result of the Search operation returned by the service.
- See Also:
-
search
default SearchResponse search(Consumer<SearchRequest.Builder> searchRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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 theSearchFilter
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.
This is a convenience which creates an instance of the
SearchRequest.Builder
avoiding the need to create one manually viaSearchRequest.builder()
- Parameters:
searchRequest
- AConsumer
that will call methods onSearchRequest.Builder
to create a request.- Returns:
- Result of the Search operation returned by the service.
- See Also:
-
searchPaginator
default SearchIterable searchPaginator(SearchRequest searchRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception This is a variant of
search(software.amazon.awssdk.services.resourceexplorer2.model.SearchRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.resourceexplorer2.paginators.SearchIterable responses = client.searchPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.resourceexplorer2.paginators.SearchIterable responses = client.searchPaginator(request); for (software.amazon.awssdk.services.resourceexplorer2.model.SearchResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.resourceexplorer2.paginators.SearchIterable responses = client.searchPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
search(software.amazon.awssdk.services.resourceexplorer2.model.SearchRequest)
operation.- Parameters:
searchRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchPaginator
default SearchIterable searchPaginator(Consumer<SearchRequest.Builder> searchRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception This is a variant of
search(software.amazon.awssdk.services.resourceexplorer2.model.SearchRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.resourceexplorer2.paginators.SearchIterable responses = client.searchPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.resourceexplorer2.paginators.SearchIterable responses = client.searchPaginator(request); for (software.amazon.awssdk.services.resourceexplorer2.model.SearchResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.resourceexplorer2.paginators.SearchIterable responses = client.searchPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
search(software.amazon.awssdk.services.resourceexplorer2.model.SearchRequest)
operation.
This is a convenience which creates an instance of the
SearchRequest.Builder
avoiding the need to create one manually viaSearchRequest.builder()
- Parameters:
searchRequest
- AConsumer
that will call methods onSearchRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ValidationException, ConflictException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ValidationException, ConflictException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateIndexType
default UpdateIndexTypeResponse updateIndexType(UpdateIndexTypeRequest updateIndexTypeRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ConflictException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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 typeThe 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, theStatus
response of that operation changes fromUPDATING
toACTIVE
. 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 typeThe 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 theUPDATING
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, theStatus
response of that operation changes fromUPDATING
toACTIVE
. 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.
- Parameters:
updateIndexTypeRequest
-- Returns:
- Result of the UpdateIndexType operation returned by the service.
- See Also:
-
-
updateIndexType
default UpdateIndexTypeResponse updateIndexType(Consumer<UpdateIndexTypeRequest.Builder> updateIndexTypeRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ConflictException, ServiceQuotaExceededException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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 typeThe 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, theStatus
response of that operation changes fromUPDATING
toACTIVE
. 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 typeThe 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 theUPDATING
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, theStatus
response of that operation changes fromUPDATING
toACTIVE
. 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.
This is a convenience which creates an instance of the
UpdateIndexTypeRequest.Builder
avoiding the need to create one manually viaUpdateIndexTypeRequest.builder()
- Parameters:
updateIndexTypeRequest
- AConsumer
that will call methods onUpdateIndexTypeRequest.Builder
to create a request.- Returns:
- Result of the UpdateIndexType operation returned by the service.
- See Also:
-
-
updateView
default UpdateViewResponse updateView(UpdateViewRequest updateViewRequest) throws InternalServerException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
- Parameters:
updateViewRequest
-- Returns:
- Result of the UpdateView operation returned by the service.
- See Also:
-
updateView
default UpdateViewResponse updateView(Consumer<UpdateViewRequest.Builder> updateViewRequest) throws InternalServerException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ResourceExplorer2Exception 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.
This is a convenience which creates an instance of the
UpdateViewRequest.Builder
avoiding the need to create one manually viaUpdateViewRequest.builder()
- Parameters:
updateViewRequest
- AConsumer
that will call methods onUpdateViewRequest.Builder
to create a request.- Returns:
- Result of the UpdateView operation returned by the service.
- See Also:
-
create
Create aResourceExplorer2Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aResourceExplorer2Client
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-