Package software.amazon.awssdk.services.resourceexplorer2

Interface ResourceExplorer2AsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ResourceExplorer2AsyncClient extends AwsClient
Service client for accessing AWS Resource Explorer asynchronously. This can be created using the static 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 Details

  • 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 Search operation 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 invoke Throwable.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 Search operation performed in that Region.


      This is a convenience which creates an instance of the AssociateDefaultViewRequest.Builder avoiding the need to create one manually via AssociateDefaultViewRequest.builder()

      Parameters:
      associateDefaultViewRequest - A Consumer that will call methods on AssociateDefaultViewRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via BatchGetViewRequest.builder()

      Parameters:
      batchGetViewRequest - A Consumer that will call methods on BatchGetViewRequest.Builder to 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 invoke Throwable.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

      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. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.

      This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.

      For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide.

      If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.

      • Action: resource-explorer-2:CreateIndex

        Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (*) at the end of the string to match the eventual UUID. For example, the following Resource element restricts the role or user to creating an index in only the us-east-2 Region of the specified account.

        "Resource": "arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*"

        Alternatively, you can use "Resource": "*" to allow the role or user to create an index in any Region.

      • Action: iam:CreateServiceLinkedRole

        Resource: No specific resource (*).

        This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.

      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 invoke Throwable.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 an AGGREGATOR index 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:CreateIndex

        Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (*) at the end of the string to match the eventual UUID. For example, the following Resource element restricts the role or user to creating an index in only the us-east-2 Region of the specified account.

        "Resource": "arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*"

        Alternatively, you can use "Resource": "*" to allow the role or user to create an index in any Region.

      • Action: iam:CreateServiceLinkedRole

        Resource: No specific resource (*).

        This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.


      This is a convenience which creates an instance of the CreateIndexRequest.Builder avoiding the need to create one manually via CreateIndexRequest.builder()

      Parameters:
      createIndexRequest - A Consumer that will call methods on CreateIndexRequest.Builder to 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 invoke Throwable.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 an AGGREGATOR index 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

      default CompletableFuture<CreateViewResponse> createView(CreateViewRequest 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 Allow to the Search action on a Resource with the Amazon resource name (ARN) of this view can Search using views you create with this operation.

      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 invoke Throwable.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 an AGGREGATOR index 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 Allow to the Search action on a Resource with the Amazon resource name (ARN) of this view can Search using views you create with this operation.


      This is a convenience which creates an instance of the CreateViewRequest.Builder avoiding the need to create one manually via CreateViewRequest.builder()

      Parameters:
      createViewRequest - A Consumer that will call methods on CreateViewRequest.Builder to 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 invoke Throwable.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 an AGGREGATOR index 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

      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. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the Status response value.

      If the index you delete is the aggregator index for the Amazon Web Services account, you must wait 24 hours before you can promote another local index to be the aggregator index for the account. Users can't perform account-wide searches using Resource Explorer until another aggregator index is configured.

      Parameters:
      deleteIndexRequest -
      Returns:
      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 invoke Throwable.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 Status response value.

      If the index you delete is the aggregator index for the Amazon Web Services account, you must wait 24 hours before you can promote another local index to be the aggregator index for the account. Users can't perform account-wide searches using Resource Explorer until another aggregator index is configured.


      This is a convenience which creates an instance of the DeleteIndexRequest.Builder avoiding the need to create one manually via DeleteIndexRequest.builder()

      Parameters:
      deleteIndexRequest - A Consumer that will call methods on DeleteIndexRequest.Builder to 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 invoke Throwable.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:

    • deleteView

      default CompletableFuture<DeleteViewResponse> deleteView(DeleteViewRequest 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.

      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 invoke Throwable.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.Builder avoiding the need to create one manually via DeleteViewRequest.builder()

      Parameters:
      deleteViewRequest - A Consumer that will call methods on DeleteViewRequest.Builder to 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 invoke Throwable.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 Search operation 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 invoke Throwable.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 Search operation performed in that Region.


      This is a convenience which creates an instance of the DisassociateDefaultViewRequest.Builder avoiding the need to create one manually via DisassociateDefaultViewRequest.builder()

      Parameters:
      disassociateDefaultViewRequest - A Consumer that will call methods on DisassociateDefaultViewRequest.Builder to 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 invoke Throwable.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 or a delegated administrator with service access enabled 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 invoke Throwable.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 or a delegated administrator with service access enabled can invoke this API call.


      This is a convenience which creates an instance of the GetAccountLevelServiceConfigurationRequest.Builder avoiding the need to create one manually via GetAccountLevelServiceConfigurationRequest.builder()

      Parameters:
      getAccountLevelServiceConfigurationRequest - A Consumer that will call methods on GetAccountLevelServiceConfigurationRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via GetDefaultViewRequest.builder()

      Parameters:
      getDefaultViewRequest - A Consumer that will call methods on GetDefaultViewRequest.Builder to 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 invoke Throwable.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(GetIndexRequest getIndexRequest)

      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 invoke Throwable.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.Builder avoiding the need to create one manually via GetIndexRequest.builder()

      Parameters:
      getIndexRequest - A Consumer that will call methods on GetIndexRequest.Builder to 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 invoke Throwable.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

      default CompletableFuture<GetViewResponse> getView(GetViewRequest getViewRequest)

      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 invoke Throwable.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

      default CompletableFuture<GetViewResponse> getView(Consumer<GetViewRequest.Builder> getViewRequest)

      Retrieves details of the specified view.


      This is a convenience which creates an instance of the GetViewRequest.Builder avoiding the need to create one manually via GetViewRequest.builder()

      Parameters:
      getViewRequest - A Consumer that will call methods on GetViewRequest.Builder to 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 invoke Throwable.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

      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.

      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 invoke Throwable.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.Builder avoiding the need to create one manually via ListIndexesRequest.builder()

      Parameters:
      listIndexesRequest - A Consumer that will call methods on ListIndexesRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via ListIndexesForMembersRequest.builder()

      Parameters:
      listIndexesForMembersRequest - A Consumer that will call methods on ListIndexesForMembersRequest.Builder to 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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersPublisher publisher = client.listIndexesForMembersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesForMembersPublisher publisher = client.listIndexesForMembersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listIndexesForMembers(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesForMembersRequest) operation.


      This is a convenience which creates an instance of the ListIndexesForMembersRequest.Builder avoiding the need to create one manually via ListIndexesForMembersRequest.builder()

      Parameters:
      listIndexesForMembersRequest - A Consumer that will call methods on ListIndexesForMembersRequest.Builder to 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 invoke Throwable.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(ListIndexesRequest 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 new Subscription i.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 
       
 software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesPublisher publisher = client.listIndexesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.resourceexplorer2.paginators.ListIndexesPublisher publisher = client.listIndexesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listIndexes(software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest) operation.


      This is a convenience which creates an instance of the ListIndexesRequest.Builder avoiding the need to create one manually via ListIndexesRequest.builder()

      Parameters:
      listIndexesRequest - A Consumer that will call methods on ListIndexesRequest.Builder to 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 invoke Throwable.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(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 invoke Throwable.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.Builder avoiding the need to create one manually via ListSupportedResourceTypesRequest.builder()

      Parameters:
      listSupportedResourceTypesRequest - A Consumer that will call methods on ListSupportedResourceTypesRequest.Builder to 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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesPublisher publisher = client.listSupportedResourceTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.resourceexplorer2.paginators.ListSupportedResourceTypesPublisher publisher = client.listSupportedResourceTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSupportedResourceTypes(software.amazon.awssdk.services.resourceexplorer2.model.ListSupportedResourceTypesRequest) operation.


      This is a convenience which creates an instance of the ListSupportedResourceTypesRequest.Builder avoiding the need to create one manually via ListSupportedResourceTypesRequest.builder()

      Parameters:
      listSupportedResourceTypesRequest - A Consumer that will call methods on ListSupportedResourceTypesRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to 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 invoke Throwable.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

      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.

      Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

      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 invoke Throwable.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 NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.


      This is a convenience which creates an instance of the ListViewsRequest.Builder avoiding the need to create one manually via ListViewsRequest.builder()

      Parameters:
      listViewsRequest - A Consumer that will call methods on ListViewsRequest.Builder to 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 invoke Throwable.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

      default ListViewsPublisher listViewsPaginator(ListViewsRequest listViewsRequest)

      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 new Subscription i.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 
       
 software.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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

      default ListViewsPublisher listViewsPaginator(Consumer<ListViewsRequest.Builder> listViewsRequest)

      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 new Subscription i.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 
       
 software.amazon.awssdk.services.resourceexplorer2.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listViews(software.amazon.awssdk.services.resourceexplorer2.model.ListViewsRequest) operation.


      This is a convenience which creates an instance of the ListViewsRequest.Builder avoiding the need to create one manually via ListViewsRequest.builder()

      Parameters:
      listViewsRequest - A Consumer that will call methods on ListViewsRequest.Builder to 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 invoke Throwable.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

      default CompletableFuture<SearchResponse> search(SearchRequest searchRequest)

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

      All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the QueryString parameter supplied to this operation and the SearchFilter parameter attached to the view.

      For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.

      If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.

      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 invoke Throwable.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

      default CompletableFuture<SearchResponse> search(Consumer<SearchRequest.Builder> searchRequest)

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

      All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the QueryString parameter supplied to this operation and the SearchFilter parameter attached to the view.

      For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.

      If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.


      This is a convenience which creates an instance of the SearchRequest.Builder avoiding the need to create one manually via SearchRequest.builder()

      Parameters:
      searchRequest - A Consumer that will call methods on SearchRequest.Builder to 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 invoke Throwable.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

      default SearchPublisher searchPaginator(SearchRequest searchRequest)

      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 new Subscription i.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 
       
 software.amazon.awssdk.services.resourceexplorer2.paginators.SearchPublisher publisher = client.searchPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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

      default SearchPublisher searchPaginator(Consumer<SearchRequest.Builder> searchRequest)

      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 new Subscription i.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 
       
 software.amazon.awssdk.services.resourceexplorer2.paginators.SearchPublisher publisher = client.searchPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the search(software.amazon.awssdk.services.resourceexplorer2.model.SearchRequest) operation.


      This is a convenience which creates an instance of the SearchRequest.Builder avoiding the need to create one manually via SearchRequest.builder()

      Parameters:
      searchRequest - A Consumer that will call methods on SearchRequest.Builder to 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 invoke Throwable.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

      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.

      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 invoke Throwable.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 an AGGREGATOR index 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.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to 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 invoke Throwable.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 an AGGREGATOR index 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 invoke Throwable.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.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to 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 invoke Throwable.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.

      • AGGREGATOR index type

        The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.

        When you change the index type to AGGREGATOR, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.

        You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL.

      • LOCAL index type

        The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.

        When you change the index type to LOCAL, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.

        After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.

      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 invoke Throwable.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 an AGGREGATOR index 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.

      • AGGREGATOR index type

        The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.

        When you change the index type to AGGREGATOR, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.

        You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL.

      • LOCAL index type

        The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.

        When you change the index type to LOCAL, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.

        After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.


      This is a convenience which creates an instance of the UpdateIndexTypeRequest.Builder avoiding the need to create one manually via UpdateIndexTypeRequest.builder()

      Parameters:
      updateIndexTypeRequest - A Consumer that will call methods on UpdateIndexTypeRequest.Builder to 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 invoke Throwable.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 an AGGREGATOR index 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

      default CompletableFuture<UpdateViewResponse> updateView(UpdateViewRequest 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.

      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 invoke Throwable.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.Builder avoiding the need to create one manually via UpdateViewRequest.builder()

      Parameters:
      updateViewRequest - A Consumer that will call methods on UpdateViewRequest.Builder to 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 invoke Throwable.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

      default ResourceExplorer2ServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static ResourceExplorer2AsyncClient create()
      Create a ResourceExplorer2AsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ResourceExplorer2AsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ResourceExplorer2AsyncClient.