Interface ResourceExplorer2AsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionassociateDefaultView(Consumer<AssociateDefaultViewRequest.Builder> associateDefaultViewRequest) Sets the specified view as the default for the Amazon Web Services Region in which you call this operation.associateDefaultView(AssociateDefaultViewRequest associateDefaultViewRequest) Sets the specified view as the default for the Amazon Web Services Region in which you call this operation.default CompletableFuture<BatchGetViewResponse> batchGetView(Consumer<BatchGetViewRequest.Builder> batchGetViewRequest) Retrieves details about a list of views.default CompletableFuture<BatchGetViewResponse> batchGetView(BatchGetViewRequest batchGetViewRequest) Retrieves details about a list of views.builder()Create a builder that can be used to configure and create aResourceExplorer2AsyncClient.static ResourceExplorer2AsyncClientcreate()Create aResourceExplorer2AsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<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 CompletableFuture<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.createResourceExplorerSetup(Consumer<CreateResourceExplorerSetupRequest.Builder> createResourceExplorerSetupRequest) Creates a Resource Explorer setup configuration across multiple Amazon Web Services Regions.createResourceExplorerSetup(CreateResourceExplorerSetupRequest createResourceExplorerSetupRequest) Creates a Resource Explorer setup configuration across multiple Amazon Web Services Regions.default CompletableFuture<CreateViewResponse> createView(Consumer<CreateViewRequest.Builder> createViewRequest) Creates a view that users can query by using the Search operation.default CompletableFuture<CreateViewResponse> createView(CreateViewRequest createViewRequest) Creates a view that users can query by using the Search operation.default CompletableFuture<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 CompletableFuture<DeleteIndexResponse> deleteIndex(DeleteIndexRequest deleteIndexRequest) Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.deleteResourceExplorerSetup(Consumer<DeleteResourceExplorerSetupRequest.Builder> deleteResourceExplorerSetupRequest) Deletes a Resource Explorer setup configuration.deleteResourceExplorerSetup(DeleteResourceExplorerSetupRequest deleteResourceExplorerSetupRequest) Deletes a Resource Explorer setup configuration.default CompletableFuture<DeleteViewResponse> deleteView(Consumer<DeleteViewRequest.Builder> deleteViewRequest) Deletes the specified view.default CompletableFuture<DeleteViewResponse> deleteView(DeleteViewRequest deleteViewRequest) Deletes the specified view.disassociateDefaultView(Consumer<DisassociateDefaultViewRequest.Builder> disassociateDefaultViewRequest) After you call this operation, the affected Amazon Web Services Region no longer has a default view.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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<GetManagedViewResponse> getManagedView(Consumer<GetManagedViewRequest.Builder> getManagedViewRequest) Retrieves details of the specified Amazon Web Services-managed view.default CompletableFuture<GetManagedViewResponse> getManagedView(GetManagedViewRequest getManagedViewRequest) Retrieves details of the specified Amazon Web Services-managed view.getResourceExplorerSetup(Consumer<GetResourceExplorerSetupRequest.Builder> getResourceExplorerSetupRequest) Retrieves the status and details of a Resource Explorer setup operation.getResourceExplorerSetup(GetResourceExplorerSetupRequest getResourceExplorerSetupRequest) Retrieves the status and details of a Resource Explorer setup operation.getResourceExplorerSetupPaginator(Consumer<GetResourceExplorerSetupRequest.Builder> getResourceExplorerSetupRequest) This is a variant ofgetResourceExplorerSetup(software.amazon.awssdk.services.resourceexplorer2.model.GetResourceExplorerSetupRequest)operation.getResourceExplorerSetupPaginator(GetResourceExplorerSetupRequest getResourceExplorerSetupRequest) This is a variant ofgetResourceExplorerSetup(software.amazon.awssdk.services.resourceexplorer2.model.GetResourceExplorerSetupRequest)operation.default CompletableFuture<GetServiceIndexResponse> getServiceIndex(Consumer<GetServiceIndexRequest.Builder> getServiceIndexRequest) Retrieves information about the Resource Explorer index in the current Amazon Web Services Region.default CompletableFuture<GetServiceIndexResponse> getServiceIndex(GetServiceIndexRequest getServiceIndexRequest) Retrieves information about the Resource Explorer index in the current Amazon Web Services Region.default CompletableFuture<GetServiceViewResponse> getServiceView(Consumer<GetServiceViewRequest.Builder> getServiceViewRequest) Retrieves details about a specific Resource Explorer service view.default CompletableFuture<GetServiceViewResponse> getServiceView(GetServiceViewRequest getServiceViewRequest) Retrieves details about a specific Resource Explorer service view.default CompletableFuture<GetViewResponse> getView(Consumer<GetViewRequest.Builder> getViewRequest) Retrieves details of the specified view.default CompletableFuture<GetViewResponse> getView(GetViewRequest getViewRequest) Retrieves details of the specified view.default CompletableFuture<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 CompletableFuture<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.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.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 ListIndexesForMembersPublisherlistIndexesForMembersPaginator(Consumer<ListIndexesForMembersRequest.Builder> listIndexesForMembersRequest) This is a variant oflistIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest)operation.default ListIndexesForMembersPublisherlistIndexesForMembersPaginator(ListIndexesForMembersRequest listIndexesForMembersRequest) This is a variant oflistIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest)operation.default ListIndexesPublisherlistIndexesPaginator(Consumer<ListIndexesRequest.Builder> listIndexesRequest) This is a variant oflistIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest)operation.default ListIndexesPublisherlistIndexesPaginator(ListIndexesRequest listIndexesRequest) This is a variant oflistIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest)operation.listManagedViews(Consumer<ListManagedViewsRequest.Builder> listManagedViewsRequest) Lists the Amazon resource names (ARNs) of the Amazon Web Services-managed views available in the Amazon Web Services Region in which you call this operation.listManagedViews(ListManagedViewsRequest listManagedViewsRequest) Lists the Amazon resource names (ARNs) of the Amazon Web Services-managed views available in the Amazon Web Services Region in which you call this operation.default ListManagedViewsPublisherlistManagedViewsPaginator(Consumer<ListManagedViewsRequest.Builder> listManagedViewsRequest) This is a variant oflistManagedViews(software.amazon.awssdk.services.resourceexplorer2.model.ListManagedViewsRequest)operation.default ListManagedViewsPublisherlistManagedViewsPaginator(ListManagedViewsRequest listManagedViewsRequest) This is a variant oflistManagedViews(software.amazon.awssdk.services.resourceexplorer2.model.ListManagedViewsRequest)operation.default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Returns a list of resources and their details that match the specified criteria.default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest) Returns a list of resources and their details that match the specified criteria.default ListResourcesPublisherlistResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesRequest)operation.default ListResourcesPublisherlistResourcesPaginator(ListResourcesRequest listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesRequest)operation.listServiceIndexes(Consumer<ListServiceIndexesRequest.Builder> listServiceIndexesRequest) Lists all Resource Explorer indexes across the specified Amazon Web Services Regions.listServiceIndexes(ListServiceIndexesRequest listServiceIndexesRequest) Lists all Resource Explorer indexes across the specified Amazon Web Services Regions.default ListServiceIndexesPublisherlistServiceIndexesPaginator(Consumer<ListServiceIndexesRequest.Builder> listServiceIndexesRequest) This is a variant oflistServiceIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceIndexesRequest)operation.default ListServiceIndexesPublisherlistServiceIndexesPaginator(ListServiceIndexesRequest listServiceIndexesRequest) This is a variant oflistServiceIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceIndexesRequest)operation.listServiceViews(Consumer<ListServiceViewsRequest.Builder> listServiceViewsRequest) Lists all Resource Explorer service views available in the current Amazon Web Services account.listServiceViews(ListServiceViewsRequest listServiceViewsRequest) Lists all Resource Explorer service views available in the current Amazon Web Services account.default ListServiceViewsPublisherlistServiceViewsPaginator(Consumer<ListServiceViewsRequest.Builder> listServiceViewsRequest) This is a variant oflistServiceViews(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceViewsRequest)operation.default ListServiceViewsPublisherlistServiceViewsPaginator(ListServiceViewsRequest listServiceViewsRequest) This is a variant oflistServiceViews(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceViewsRequest)operation.listStreamingAccessForServices(Consumer<ListStreamingAccessForServicesRequest.Builder> listStreamingAccessForServicesRequest) Returns a list of Amazon Web Services services that have been granted streaming access to your Resource Explorer data.listStreamingAccessForServices(ListStreamingAccessForServicesRequest listStreamingAccessForServicesRequest) Returns a list of Amazon Web Services services that have been granted streaming access to your Resource Explorer data.listStreamingAccessForServicesPaginator(Consumer<ListStreamingAccessForServicesRequest.Builder> listStreamingAccessForServicesRequest) This is a variant oflistStreamingAccessForServices(software.amazon.awssdk.services.resourceexplorer2.model.ListStreamingAccessForServicesRequest)operation.listStreamingAccessForServicesPaginator(ListStreamingAccessForServicesRequest listStreamingAccessForServicesRequest) This is a variant oflistStreamingAccessForServices(software.amazon.awssdk.services.resourceexplorer2.model.ListStreamingAccessForServicesRequest)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.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags that are attached to the specified resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are attached to the specified resource.default CompletableFuture<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 CompletableFuture<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 ListViewsPublisherlistViewsPaginator(Consumer<ListViewsRequest.Builder> listViewsRequest) This is a variant oflistViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest)operation.default ListViewsPublisherlistViewsPaginator(ListViewsRequest listViewsRequest) This is a variant oflistViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest)operation.default CompletableFuture<SearchResponse> search(Consumer<SearchRequest.Builder> searchRequest) Searches for resources and displays details about all resources that match the specified criteria.default CompletableFuture<SearchResponse> search(SearchRequest searchRequest) Searches for resources and displays details about all resources that match the specified criteria.default SearchPublishersearchPaginator(Consumer<SearchRequest.Builder> searchRequest) This is a variant ofsearch(software.amazon.awssdk.services.resourceexplorer2.model.SearchRequest)operation.default SearchPublishersearchPaginator(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., ClientOverrideConfigurationdefault CompletableFuture<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 CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.default CompletableFuture<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 CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.default CompletableFuture<UpdateIndexTypeResponse> updateIndexType(Consumer<UpdateIndexTypeRequest.Builder> updateIndexTypeRequest) Changes the type of the index from one of the following types to the other.default CompletableFuture<UpdateIndexTypeResponse> updateIndexType(UpdateIndexTypeRequest updateIndexTypeRequest) Changes the type of the index from one of the following types to the other.default CompletableFuture<UpdateViewResponse> updateView(Consumer<UpdateViewRequest.Builder> updateViewRequest) Modifies some of the details of a view.default CompletableFuture<UpdateViewResponse> updateView(UpdateViewRequest updateViewRequest) Modifies some of the details of a view.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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 CompletableFuture<AssociateDefaultViewResponse> associateDefaultView(AssociateDefaultViewRequest associateDefaultViewRequest) 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
Searchoperation performed in that Region.- Parameters:
associateDefaultViewRequest-- Returns:
- A Java Future containing the result of the AssociateDefaultView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateDefaultView
default CompletableFuture<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. 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
Searchoperation performed in that Region.
This is a convenience which creates an instance of the
AssociateDefaultViewRequest.Builderavoiding the need to create one manually viaAssociateDefaultViewRequest.builder()- Parameters:
associateDefaultViewRequest- AConsumerthat will call methods onAssociateDefaultViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AssociateDefaultView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetView
default CompletableFuture<BatchGetViewResponse> batchGetView(BatchGetViewRequest batchGetViewRequest) Retrieves details about a list of views.
- Parameters:
batchGetViewRequest-- Returns:
- A Java Future containing the result of the BatchGetView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetView
default CompletableFuture<BatchGetViewResponse> batchGetView(Consumer<BatchGetViewRequest.Builder> batchGetViewRequest) Retrieves details about a list of views.
This is a convenience which creates an instance of the
BatchGetViewRequest.Builderavoiding the need to create one manually viaBatchGetViewRequest.builder()- Parameters:
batchGetViewRequest- AConsumerthat will call methods onBatchGetViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchGetView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIndex
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:CreateIndexResource: 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 followingResourceelement restricts the role or user to creating an index in only theus-east-2Region 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:CreateServiceLinkedRoleResource: 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:
- A Java Future containing the result of the CreateIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createIndex
default CompletableFuture<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. 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:CreateIndexResource: 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 followingResourceelement restricts the role or user to creating an index in only theus-east-2Region 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:CreateServiceLinkedRoleResource: 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.Builderavoiding the need to create one manually viaCreateIndexRequest.builder()- Parameters:
createIndexRequest- AConsumerthat will call methods onCreateIndexRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createResourceExplorerSetup
default CompletableFuture<CreateResourceExplorerSetupResponse> createResourceExplorerSetup(CreateResourceExplorerSetupRequest createResourceExplorerSetupRequest) Creates a Resource Explorer setup configuration across multiple Amazon Web Services Regions. This operation sets up indexes and views in the specified Regions. This operation can also be used to set an aggregator Region for cross-Region resource search.
- Parameters:
createResourceExplorerSetupRequest-- Returns:
- A Java Future containing the result of the CreateResourceExplorerSetup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createResourceExplorerSetup
default CompletableFuture<CreateResourceExplorerSetupResponse> createResourceExplorerSetup(Consumer<CreateResourceExplorerSetupRequest.Builder> createResourceExplorerSetupRequest) Creates a Resource Explorer setup configuration across multiple Amazon Web Services Regions. This operation sets up indexes and views in the specified Regions. This operation can also be used to set an aggregator Region for cross-Region resource search.
This is a convenience which creates an instance of the
CreateResourceExplorerSetupRequest.Builderavoiding the need to create one manually viaCreateResourceExplorerSetupRequest.builder()- Parameters:
createResourceExplorerSetupRequest- AConsumerthat will call methods onCreateResourceExplorerSetupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateResourceExplorerSetup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createView
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
Allowto theSearchaction on aResourcewith the Amazon resource name (ARN) of this view can Search using views you create with this operation.- Parameters:
createViewRequest-- Returns:
- A Java Future containing the result of the CreateView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - ServiceQuotaExceededException The request failed because it exceeds a service quota.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createView
default CompletableFuture<CreateViewResponse> createView(Consumer<CreateViewRequest.Builder> createViewRequest) 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
Allowto theSearchaction on aResourcewith 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.Builderavoiding the need to create one manually viaCreateViewRequest.builder()- Parameters:
createViewRequest- AConsumerthat will call methods onCreateViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - ServiceQuotaExceededException The request failed because it exceeds a service quota.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIndex
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
Statusresponse 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:
- A Java Future containing the result of the DeleteIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIndex
default CompletableFuture<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. 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
Statusresponse 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.Builderavoiding the need to create one manually viaDeleteIndexRequest.builder()- Parameters:
deleteIndexRequest- AConsumerthat will call methods onDeleteIndexRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourceExplorerSetup
default CompletableFuture<DeleteResourceExplorerSetupResponse> deleteResourceExplorerSetup(DeleteResourceExplorerSetupRequest deleteResourceExplorerSetupRequest) Deletes a Resource Explorer setup configuration. This operation removes indexes and views from the specified Regions or all Regions where Resource Explorer is configured.
- Parameters:
deleteResourceExplorerSetupRequest-- Returns:
- A Java Future containing the result of the DeleteResourceExplorerSetup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourceExplorerSetup
default CompletableFuture<DeleteResourceExplorerSetupResponse> deleteResourceExplorerSetup(Consumer<DeleteResourceExplorerSetupRequest.Builder> deleteResourceExplorerSetupRequest) Deletes a Resource Explorer setup configuration. This operation removes indexes and views from the specified Regions or all Regions where Resource Explorer is configured.
This is a convenience which creates an instance of the
DeleteResourceExplorerSetupRequest.Builderavoiding the need to create one manually viaDeleteResourceExplorerSetupRequest.builder()- Parameters:
deleteResourceExplorerSetupRequest- AConsumerthat will call methods onDeleteResourceExplorerSetupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteResourceExplorerSetup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteView
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:
- A Java Future containing the result of the DeleteView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteView
default CompletableFuture<DeleteViewResponse> deleteView(Consumer<DeleteViewRequest.Builder> deleteViewRequest) 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.Builderavoiding the need to create one manually viaDeleteViewRequest.builder()- Parameters:
deleteViewRequest- AConsumerthat will call methods onDeleteViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateDefaultView
default CompletableFuture<DisassociateDefaultViewResponse> disassociateDefaultView(DisassociateDefaultViewRequest disassociateDefaultViewRequest) 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
Searchoperation performed in that Region.- Parameters:
disassociateDefaultViewRequest-- Returns:
- A Java Future containing the result of the DisassociateDefaultView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateDefaultView
default CompletableFuture<DisassociateDefaultViewResponse> disassociateDefaultView(Consumer<DisassociateDefaultViewRequest.Builder> disassociateDefaultViewRequest) 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
Searchoperation performed in that Region.
This is a convenience which creates an instance of the
DisassociateDefaultViewRequest.Builderavoiding the need to create one manually viaDisassociateDefaultViewRequest.builder()- Parameters:
disassociateDefaultViewRequest- AConsumerthat will call methods onDisassociateDefaultViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateDefaultView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountLevelServiceConfiguration
default CompletableFuture<GetAccountLevelServiceConfigurationResponse> 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. Only the management account can invoke this API call.
- Parameters:
getAccountLevelServiceConfigurationRequest-- Returns:
- A Java Future containing the result of the GetAccountLevelServiceConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountLevelServiceConfiguration
default CompletableFuture<GetAccountLevelServiceConfigurationResponse> 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. Only the management account can invoke this API call.
This is a convenience which creates an instance of the
GetAccountLevelServiceConfigurationRequest.Builderavoiding the need to create one manually viaGetAccountLevelServiceConfigurationRequest.builder()- Parameters:
getAccountLevelServiceConfigurationRequest- AConsumerthat will call methods onGetAccountLevelServiceConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAccountLevelServiceConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDefaultView
default CompletableFuture<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. You can then call GetView to retrieve the details of that view.
- Parameters:
getDefaultViewRequest-- Returns:
- A Java Future containing the result of the GetDefaultView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDefaultView
default CompletableFuture<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. You can then call GetView to retrieve the details of that view.
This is a convenience which creates an instance of the
GetDefaultViewRequest.Builderavoiding the need to create one manually viaGetDefaultViewRequest.builder()- Parameters:
getDefaultViewRequest- AConsumerthat will call methods onGetDefaultViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDefaultView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIndex
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:
- A Java Future containing the result of the GetIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIndex
default CompletableFuture<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.
This is a convenience which creates an instance of the
GetIndexRequest.Builderavoiding the need to create one manually viaGetIndexRequest.builder()- Parameters:
getIndexRequest- AConsumerthat will call methods onGetIndexRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getManagedView
default CompletableFuture<GetManagedViewResponse> getManagedView(GetManagedViewRequest getManagedViewRequest) Retrieves details of the specified Amazon Web Services-managed view.
- Parameters:
getManagedViewRequest-- Returns:
- A Java Future containing the result of the GetManagedView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getManagedView
default CompletableFuture<GetManagedViewResponse> getManagedView(Consumer<GetManagedViewRequest.Builder> getManagedViewRequest) Retrieves details of the specified Amazon Web Services-managed view.
This is a convenience which creates an instance of the
GetManagedViewRequest.Builderavoiding the need to create one manually viaGetManagedViewRequest.builder()- Parameters:
getManagedViewRequest- AConsumerthat will call methods onGetManagedViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetManagedView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourceExplorerSetup
default CompletableFuture<GetResourceExplorerSetupResponse> getResourceExplorerSetup(GetResourceExplorerSetupRequest getResourceExplorerSetupRequest) Retrieves the status and details of a Resource Explorer setup operation. This operation returns information about the progress of creating or deleting Resource Explorer configurations across Regions.
- Parameters:
getResourceExplorerSetupRequest-- Returns:
- A Java Future containing the result of the GetResourceExplorerSetup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourceExplorerSetup
default CompletableFuture<GetResourceExplorerSetupResponse> getResourceExplorerSetup(Consumer<GetResourceExplorerSetupRequest.Builder> getResourceExplorerSetupRequest) Retrieves the status and details of a Resource Explorer setup operation. This operation returns information about the progress of creating or deleting Resource Explorer configurations across Regions.
This is a convenience which creates an instance of the
GetResourceExplorerSetupRequest.Builderavoiding the need to create one manually viaGetResourceExplorerSetupRequest.builder()- Parameters:
getResourceExplorerSetupRequest- AConsumerthat will call methods onGetResourceExplorerSetupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetResourceExplorerSetup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourceExplorerSetupPaginator
default GetResourceExplorerSetupPublisher getResourceExplorerSetupPaginator(GetResourceExplorerSetupRequest getResourceExplorerSetupRequest) This is a variant of
getResourceExplorerSetup(software.amazon.awssdk.services.resourceexplorer2.model.GetResourceExplorerSetupRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.GetResourceExplorerSetupPublisher publisher = client.getResourceExplorerSetupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.GetResourceExplorerSetupPublisher publisher = client.getResourceExplorerSetupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.GetResourceExplorerSetupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.GetResourceExplorerSetupResponse response) { //... }; });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
getResourceExplorerSetup(software.amazon.awssdk.services.resourceexplorer2.model.GetResourceExplorerSetupRequest)operation.- Parameters:
getResourceExplorerSetupRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourceExplorerSetupPaginator
default GetResourceExplorerSetupPublisher getResourceExplorerSetupPaginator(Consumer<GetResourceExplorerSetupRequest.Builder> getResourceExplorerSetupRequest) This is a variant of
getResourceExplorerSetup(software.amazon.awssdk.services.resourceexplorer2.model.GetResourceExplorerSetupRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.GetResourceExplorerSetupPublisher publisher = client.getResourceExplorerSetupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.GetResourceExplorerSetupPublisher publisher = client.getResourceExplorerSetupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.GetResourceExplorerSetupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.GetResourceExplorerSetupResponse response) { //... }; });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
getResourceExplorerSetup(software.amazon.awssdk.services.resourceexplorer2.model.GetResourceExplorerSetupRequest)operation.
This is a convenience which creates an instance of the
GetResourceExplorerSetupRequest.Builderavoiding the need to create one manually viaGetResourceExplorerSetupRequest.builder()- Parameters:
getResourceExplorerSetupRequest- AConsumerthat will call methods onGetResourceExplorerSetupRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServiceIndex
default CompletableFuture<GetServiceIndexResponse> getServiceIndex(GetServiceIndexRequest getServiceIndexRequest) Retrieves information about the Resource Explorer index in the current Amazon Web Services Region. This operation returns the ARN and type of the index if one exists.
- Parameters:
getServiceIndexRequest-- Returns:
- A Java Future containing the result of the GetServiceIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServiceIndex
default CompletableFuture<GetServiceIndexResponse> getServiceIndex(Consumer<GetServiceIndexRequest.Builder> getServiceIndexRequest) Retrieves information about the Resource Explorer index in the current Amazon Web Services Region. This operation returns the ARN and type of the index if one exists.
This is a convenience which creates an instance of the
GetServiceIndexRequest.Builderavoiding the need to create one manually viaGetServiceIndexRequest.builder()- Parameters:
getServiceIndexRequest- AConsumerthat will call methods onGetServiceIndexRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetServiceIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServiceView
default CompletableFuture<GetServiceViewResponse> getServiceView(GetServiceViewRequest getServiceViewRequest) Retrieves details about a specific Resource Explorer service view. This operation returns the configuration and properties of the specified view.
- Parameters:
getServiceViewRequest-- Returns:
- A Java Future containing the result of the GetServiceView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServiceView
default CompletableFuture<GetServiceViewResponse> getServiceView(Consumer<GetServiceViewRequest.Builder> getServiceViewRequest) Retrieves details about a specific Resource Explorer service view. This operation returns the configuration and properties of the specified view.
This is a convenience which creates an instance of the
GetServiceViewRequest.Builderavoiding the need to create one manually viaGetServiceViewRequest.builder()- Parameters:
getServiceViewRequest- AConsumerthat will call methods onGetServiceViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetServiceView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getView
Retrieves details of the specified view.
- Parameters:
getViewRequest-- Returns:
- A Java Future containing the result of the GetView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getView
Retrieves details of the specified view.
This is a convenience which creates an instance of the
GetViewRequest.Builderavoiding the need to create one manually viaGetViewRequest.builder()- Parameters:
getViewRequest- AConsumerthat will call methods onGetViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIndexes
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:
- A Java Future containing the result of the ListIndexes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIndexes
default CompletableFuture<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.
This is a convenience which creates an instance of the
ListIndexesRequest.Builderavoiding the need to create one manually viaListIndexesRequest.builder()- Parameters:
listIndexesRequest- AConsumerthat will call methods onListIndexesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListIndexes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIndexesForMembers
default CompletableFuture<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. Only the management account or a delegated administrator with service access enabled can invoke this API call.
- Parameters:
listIndexesForMembersRequest-- Returns:
- A Java Future containing the result of the ListIndexesForMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIndexesForMembers
default CompletableFuture<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. 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.Builderavoiding the need to create one manually viaListIndexesForMembersRequest.builder()- Parameters:
listIndexesForMembersRequest- AConsumerthat will call methods onListIndexesForMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListIndexesForMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIndexesForMembersPaginator
default ListIndexesForMembersPublisher listIndexesForMembersPaginator(ListIndexesForMembersRequest listIndexesForMembersRequest) This is a variant of
listIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersPublisher publisher = client.listIndexesForMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersPublisher publisher = client.listIndexesForMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIndexesForMembersPaginator
default ListIndexesForMembersPublisher listIndexesForMembersPaginator(Consumer<ListIndexesForMembersRequest.Builder> listIndexesForMembersRequest) This is a variant of
listIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersPublisher publisher = client.listIndexesForMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersPublisher publisher = client.listIndexesForMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListIndexesForMembersRequest.builder()- Parameters:
listIndexesForMembersRequest- AConsumerthat will call methods onListIndexesForMembersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIndexesPaginator
This is a variant of
listIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesPublisher publisher = client.listIndexesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesPublisher publisher = client.listIndexesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIndexesPaginator
default ListIndexesPublisher listIndexesPaginator(Consumer<ListIndexesRequest.Builder> listIndexesRequest) This is a variant of
listIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesPublisher publisher = client.listIndexesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesPublisher publisher = client.listIndexesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListIndexesRequest.builder()- Parameters:
listIndexesRequest- AConsumerthat will call methods onListIndexesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedViews
default CompletableFuture<ListManagedViewsResponse> listManagedViews(ListManagedViewsRequest listManagedViewsRequest) Lists the Amazon resource names (ARNs) of the Amazon Web Services-managed views available in the Amazon Web Services Region in which you call this operation.
- Parameters:
listManagedViewsRequest-- Returns:
- A Java Future containing the result of the ListManagedViews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedViews
default CompletableFuture<ListManagedViewsResponse> listManagedViews(Consumer<ListManagedViewsRequest.Builder> listManagedViewsRequest) Lists the Amazon resource names (ARNs) of the Amazon Web Services-managed views available in the Amazon Web Services Region in which you call this operation.
This is a convenience which creates an instance of the
ListManagedViewsRequest.Builderavoiding the need to create one manually viaListManagedViewsRequest.builder()- Parameters:
listManagedViewsRequest- AConsumerthat will call methods onListManagedViewsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListManagedViews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedViewsPaginator
default ListManagedViewsPublisher listManagedViewsPaginator(ListManagedViewsRequest listManagedViewsRequest) This is a variant of
listManagedViews(software.amazon.awssdk.services.resourceexplorer2.model.ListManagedViewsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListManagedViewsPublisher publisher = client.listManagedViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListManagedViewsPublisher publisher = client.listManagedViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListManagedViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListManagedViewsResponse response) { //... }; });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
listManagedViews(software.amazon.awssdk.services.resourceexplorer2.model.ListManagedViewsRequest)operation.- Parameters:
listManagedViewsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedViewsPaginator
default ListManagedViewsPublisher listManagedViewsPaginator(Consumer<ListManagedViewsRequest.Builder> listManagedViewsRequest) This is a variant of
listManagedViews(software.amazon.awssdk.services.resourceexplorer2.model.ListManagedViewsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListManagedViewsPublisher publisher = client.listManagedViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListManagedViewsPublisher publisher = client.listManagedViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListManagedViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListManagedViewsResponse response) { //... }; });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
listManagedViews(software.amazon.awssdk.services.resourceexplorer2.model.ListManagedViewsRequest)operation.
This is a convenience which creates an instance of the
ListManagedViewsRequest.Builderavoiding the need to create one manually viaListManagedViewsRequest.builder()- Parameters:
listManagedViewsRequest- AConsumerthat will call methods onListManagedViewsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResources
default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest) Returns a list of resources and their details that match the specified criteria. This query must use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.
- Parameters:
listResourcesRequest-- Returns:
- A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResources
default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Returns a list of resources and their details that match the specified criteria. This query must use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.
This is a convenience which creates an instance of the
ListResourcesRequest.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcesPaginator
This is a variant of
listResources(software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesResponse response) { //... }; });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
listResources(software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesRequest)operation.- Parameters:
listResourcesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcesPaginator
default ListResourcesPublisher listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant of
listResources(software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesResponse response) { //... }; });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
listResources(software.amazon.awssdk.services.resourceexplorer2.model.ListResourcesRequest)operation.
This is a convenience which creates an instance of the
ListResourcesRequest.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServiceIndexes
default CompletableFuture<ListServiceIndexesResponse> listServiceIndexes(ListServiceIndexesRequest listServiceIndexesRequest) Lists all Resource Explorer indexes across the specified Amazon Web Services Regions. This operation returns information about indexes including their ARNs, types, and Regions.
- Parameters:
listServiceIndexesRequest-- Returns:
- A Java Future containing the result of the ListServiceIndexes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServiceIndexes
default CompletableFuture<ListServiceIndexesResponse> listServiceIndexes(Consumer<ListServiceIndexesRequest.Builder> listServiceIndexesRequest) Lists all Resource Explorer indexes across the specified Amazon Web Services Regions. This operation returns information about indexes including their ARNs, types, and Regions.
This is a convenience which creates an instance of the
ListServiceIndexesRequest.Builderavoiding the need to create one manually viaListServiceIndexesRequest.builder()- Parameters:
listServiceIndexesRequest- AConsumerthat will call methods onListServiceIndexesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListServiceIndexes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServiceIndexesPaginator
default ListServiceIndexesPublisher listServiceIndexesPaginator(ListServiceIndexesRequest listServiceIndexesRequest) This is a variant of
listServiceIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceIndexesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListServiceIndexesPublisher publisher = client.listServiceIndexesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListServiceIndexesPublisher publisher = client.listServiceIndexesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListServiceIndexesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceIndexesResponse response) { //... }; });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
listServiceIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceIndexesRequest)operation.- Parameters:
listServiceIndexesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServiceIndexesPaginator
default ListServiceIndexesPublisher listServiceIndexesPaginator(Consumer<ListServiceIndexesRequest.Builder> listServiceIndexesRequest) This is a variant of
listServiceIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceIndexesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListServiceIndexesPublisher publisher = client.listServiceIndexesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListServiceIndexesPublisher publisher = client.listServiceIndexesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListServiceIndexesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceIndexesResponse response) { //... }; });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
listServiceIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceIndexesRequest)operation.
This is a convenience which creates an instance of the
ListServiceIndexesRequest.Builderavoiding the need to create one manually viaListServiceIndexesRequest.builder()- Parameters:
listServiceIndexesRequest- AConsumerthat will call methods onListServiceIndexesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServiceViews
default CompletableFuture<ListServiceViewsResponse> listServiceViews(ListServiceViewsRequest listServiceViewsRequest) Lists all Resource Explorer service views available in the current Amazon Web Services account. This operation returns the ARNs of available service views.
- Parameters:
listServiceViewsRequest-- Returns:
- A Java Future containing the result of the ListServiceViews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServiceViews
default CompletableFuture<ListServiceViewsResponse> listServiceViews(Consumer<ListServiceViewsRequest.Builder> listServiceViewsRequest) Lists all Resource Explorer service views available in the current Amazon Web Services account. This operation returns the ARNs of available service views.
This is a convenience which creates an instance of the
ListServiceViewsRequest.Builderavoiding the need to create one manually viaListServiceViewsRequest.builder()- Parameters:
listServiceViewsRequest- AConsumerthat will call methods onListServiceViewsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListServiceViews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServiceViewsPaginator
default ListServiceViewsPublisher listServiceViewsPaginator(ListServiceViewsRequest listServiceViewsRequest) This is a variant of
listServiceViews(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceViewsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListServiceViewsPublisher publisher = client.listServiceViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListServiceViewsPublisher publisher = client.listServiceViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListServiceViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceViewsResponse response) { //... }; });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
listServiceViews(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceViewsRequest)operation.- Parameters:
listServiceViewsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listServiceViewsPaginator
default ListServiceViewsPublisher listServiceViewsPaginator(Consumer<ListServiceViewsRequest.Builder> listServiceViewsRequest) This is a variant of
listServiceViews(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceViewsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListServiceViewsPublisher publisher = client.listServiceViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListServiceViewsPublisher publisher = client.listServiceViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListServiceViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceViewsResponse response) { //... }; });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
listServiceViews(software.amazon.awssdk.services.resourceexplorer2.model.ListServiceViewsRequest)operation.
This is a convenience which creates an instance of the
ListServiceViewsRequest.Builderavoiding the need to create one manually viaListServiceViewsRequest.builder()- Parameters:
listServiceViewsRequest- AConsumerthat will call methods onListServiceViewsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingAccessForServices
default CompletableFuture<ListStreamingAccessForServicesResponse> listStreamingAccessForServices(ListStreamingAccessForServicesRequest listStreamingAccessForServicesRequest) Returns a list of Amazon Web Services services that have been granted streaming access to your Resource Explorer data. Streaming access allows Amazon Web Services services to receive real-time updates about your resources as they are indexed by Resource Explorer.
- Parameters:
listStreamingAccessForServicesRequest-- Returns:
- A Java Future containing the result of the ListStreamingAccessForServices operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingAccessForServices
default CompletableFuture<ListStreamingAccessForServicesResponse> listStreamingAccessForServices(Consumer<ListStreamingAccessForServicesRequest.Builder> listStreamingAccessForServicesRequest) Returns a list of Amazon Web Services services that have been granted streaming access to your Resource Explorer data. Streaming access allows Amazon Web Services services to receive real-time updates about your resources as they are indexed by Resource Explorer.
This is a convenience which creates an instance of the
ListStreamingAccessForServicesRequest.Builderavoiding the need to create one manually viaListStreamingAccessForServicesRequest.builder()- Parameters:
listStreamingAccessForServicesRequest- AConsumerthat will call methods onListStreamingAccessForServicesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListStreamingAccessForServices operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingAccessForServicesPaginator
default ListStreamingAccessForServicesPublisher listStreamingAccessForServicesPaginator(ListStreamingAccessForServicesRequest listStreamingAccessForServicesRequest) This is a variant of
listStreamingAccessForServices(software.amazon.awssdk.services.resourceexplorer2.model.ListStreamingAccessForServicesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListStreamingAccessForServicesPublisher publisher = client.listStreamingAccessForServicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListStreamingAccessForServicesPublisher publisher = client.listStreamingAccessForServicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListStreamingAccessForServicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListStreamingAccessForServicesResponse response) { //... }; });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
listStreamingAccessForServices(software.amazon.awssdk.services.resourceexplorer2.model.ListStreamingAccessForServicesRequest)operation.- Parameters:
listStreamingAccessForServicesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamingAccessForServicesPaginator
default ListStreamingAccessForServicesPublisher listStreamingAccessForServicesPaginator(Consumer<ListStreamingAccessForServicesRequest.Builder> listStreamingAccessForServicesRequest) This is a variant of
listStreamingAccessForServices(software.amazon.awssdk.services.resourceexplorer2.model.ListStreamingAccessForServicesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListStreamingAccessForServicesPublisher publisher = client.listStreamingAccessForServicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListStreamingAccessForServicesPublisher publisher = client.listStreamingAccessForServicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListStreamingAccessForServicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListStreamingAccessForServicesResponse response) { //... }; });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
listStreamingAccessForServices(software.amazon.awssdk.services.resourceexplorer2.model.ListStreamingAccessForServicesRequest)operation.
This is a convenience which creates an instance of the
ListStreamingAccessForServicesRequest.Builderavoiding the need to create one manually viaListStreamingAccessForServicesRequest.builder()- Parameters:
listStreamingAccessForServicesRequest- AConsumerthat will call methods onListStreamingAccessForServicesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSupportedResourceTypes
default CompletableFuture<ListSupportedResourceTypesResponse> listSupportedResourceTypes(ListSupportedResourceTypesRequest listSupportedResourceTypesRequest) Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
- Parameters:
listSupportedResourceTypesRequest-- Returns:
- A Java Future containing the result of the ListSupportedResourceTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSupportedResourceTypes
default CompletableFuture<ListSupportedResourceTypesResponse> listSupportedResourceTypes(Consumer<ListSupportedResourceTypesRequest.Builder> listSupportedResourceTypesRequest) 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.Builderavoiding the need to create one manually viaListSupportedResourceTypesRequest.builder()- Parameters:
listSupportedResourceTypesRequest- AConsumerthat will call methods onListSupportedResourceTypesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListSupportedResourceTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSupportedResourceTypesPaginator
default ListSupportedResourceTypesPublisher listSupportedResourceTypesPaginator(ListSupportedResourceTypesRequest listSupportedResourceTypesRequest) This is a variant of
listSupportedResourceTypes(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesPublisher publisher = client.listSupportedResourceTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesPublisher publisher = client.listSupportedResourceTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSupportedResourceTypesPaginator
default ListSupportedResourceTypesPublisher listSupportedResourceTypesPaginator(Consumer<ListSupportedResourceTypesRequest.Builder> listSupportedResourceTypesRequest) This is a variant of
listSupportedResourceTypes(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesPublisher publisher = client.listSupportedResourceTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesPublisher publisher = client.listSupportedResourceTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListSupportedResourceTypesRequest.builder()- Parameters:
listSupportedResourceTypesRequest- AConsumerthat will call methods onListSupportedResourceTypesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are attached to the specified resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags that are attached to the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listViews
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
NextTokenresponse parameter for anullvalue when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. TheNextTokenresponse parameter value isnullonly when there are no more results to display.- Parameters:
listViewsRequest-- Returns:
- A Java Future containing the result of the ListViews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listViews
default CompletableFuture<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.
Always check the
NextTokenresponse parameter for anullvalue when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. TheNextTokenresponse parameter value isnullonly when there are no more results to display.
This is a convenience which creates an instance of the
ListViewsRequest.Builderavoiding the need to create one manually viaListViewsRequest.builder()- Parameters:
listViewsRequest- AConsumerthat will call methods onListViewsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListViews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listViewsPaginator
This is a variant of
listViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listViewsPaginator
This is a variant of
listViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.ListViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListViewsRequest.builder()- Parameters:
listViewsRequest- AConsumerthat will call methods onListViewsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
search
Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.
All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the
QueryStringparameter supplied to this operation and theSearchFilterparameter attached to the view.For the complete syntax supported by the
QueryStringparameter, 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:
- A Java Future containing the result of the Search operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
search
Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.
All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the
QueryStringparameter supplied to this operation and theSearchFilterparameter attached to the view.For the complete syntax supported by the
QueryStringparameter, 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.Builderavoiding the need to create one manually viaSearchRequest.builder()- Parameters:
searchRequest- AConsumerthat will call methods onSearchRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the Search operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPaginator
This is a variant of
search(software.amazon.awssdk.services.resourceexplorer2.model.SearchRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.SearchPublisher publisher = client.searchPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.SearchPublisher publisher = client.searchPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.SearchResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.SearchResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPaginator
This is a variant of
search(software.amazon.awssdk.services.resourceexplorer2.model.SearchRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.resourceexplorer2.paginators.SearchPublisher publisher = client.searchPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.resourceexplorer2.paginators.SearchPublisher publisher = client.searchPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourceexplorer2.model.SearchResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.resourceexplorer2.model.SearchResponse response) { //... }; });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.Builderavoiding the need to create one manually viaSearchRequest.builder()- Parameters:
searchRequest- AConsumerthat will call methods onSearchRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<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.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<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.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIndexType
default CompletableFuture<UpdateIndexTypeResponse> updateIndexType(UpdateIndexTypeRequest updateIndexTypeRequest) 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.
-
AGGREGATORindex 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, theStatusresponse of that operation changes fromUPDATINGtoACTIVE. 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. -
LOCALindex 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 theUPDATINGstate 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, theStatusresponse of that operation changes fromUPDATINGtoACTIVE. 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:
- A Java Future containing the result of the UpdateIndexType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - ServiceQuotaExceededException The request failed because it exceeds a service quota.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateIndexType
default CompletableFuture<UpdateIndexTypeResponse> updateIndexType(Consumer<UpdateIndexTypeRequest.Builder> updateIndexTypeRequest) 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.
-
AGGREGATORindex 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, theStatusresponse of that operation changes fromUPDATINGtoACTIVE. 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. -
LOCALindex 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 theUPDATINGstate 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, theStatusresponse of that operation changes fromUPDATINGtoACTIVE. 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.Builderavoiding the need to create one manually viaUpdateIndexTypeRequest.builder()- Parameters:
updateIndexTypeRequest- AConsumerthat will call methods onUpdateIndexTypeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateIndexType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ConflictException If you attempted to create a view, then the request failed because either you
specified parameters that didn’t match the original request, or you attempted to create a view with a
name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to
AGGREGATOR, then the request failed because you already have anAGGREGATORindex in a different Amazon Web Services Region. - ServiceQuotaExceededException The request failed because it exceeds a service quota.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateView
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:
- A Java Future containing the result of the UpdateView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ServiceQuotaExceededException The request failed because it exceeds a service quota.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateView
default CompletableFuture<UpdateViewResponse> updateView(Consumer<UpdateViewRequest.Builder> updateViewRequest) 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.Builderavoiding the need to create one manually viaUpdateViewRequest.builder()- Parameters:
updateViewRequest- AConsumerthat will call methods onUpdateViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException The request failed because of internal service error. Try your request again later.
- ValidationException You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
- ServiceQuotaExceededException The request failed because it exceeds a service quota.
- UnauthorizedException The principal making the request isn't permitted to perform the operation.
- ThrottlingException The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
- AccessDeniedException The credentials that you used to call this operation don't have the minimum required permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ResourceExplorer2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aResourceExplorer2AsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aResourceExplorer2AsyncClient.
-