Package software.amazon.awssdk.services.s3outposts

Interface S3OutpostsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface S3OutpostsAsyncClient extends AwsClient
Service client for accessing Amazon S3 Outposts 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 S3 on Outposts provides access to S3 on Outposts operations.

  • Field Details

  • Method Details

    • createEndpoint

      default CompletableFuture<CreateEndpointResponse> createEndpoint(CreateEndpointRequest createEndpointRequest)

      Creates an endpoint and associates it with the specified Outpost.

      It can take up to 5 minutes for this action to finish.

      Related actions include:

      Parameters:
      createEndpointRequest -
      Returns:
      A Java Future containing the result of the CreateEndpoint 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 There was an exception with the internal server.
      • ValidationException There was an exception validating this data.
      • AccessDeniedException Access was denied for this action.
      • ResourceNotFoundException The requested resource was not found.
      • ConflictException There was a conflict with this action, and it could not be completed.
      • ThrottlingException The request was denied due to request throttling.
      • OutpostOfflineException The service link connection to your Outposts home Region is down. Check your connection and try again.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEndpoint

      default CompletableFuture<CreateEndpointResponse> createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest)

      Creates an endpoint and associates it with the specified Outpost.

      It can take up to 5 minutes for this action to finish.

      Related actions include:


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

      Parameters:
      createEndpointRequest - A Consumer that will call methods on CreateEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEndpoint 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 There was an exception with the internal server.
      • ValidationException There was an exception validating this data.
      • AccessDeniedException Access was denied for this action.
      • ResourceNotFoundException The requested resource was not found.
      • ConflictException There was a conflict with this action, and it could not be completed.
      • ThrottlingException The request was denied due to request throttling.
      • OutpostOfflineException The service link connection to your Outposts home Region is down. Check your connection and try again.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEndpoint

      default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)

      Deletes an endpoint.

      It can take up to 5 minutes for this action to finish.

      Related actions include:

      Parameters:
      deleteEndpointRequest -
      Returns:
      A Java Future containing the result of the DeleteEndpoint 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 There was an exception with the internal server.
      • AccessDeniedException Access was denied for this action.
      • ResourceNotFoundException The requested resource was not found.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • OutpostOfflineException The service link connection to your Outposts home Region is down. Check your connection and try again.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEndpoint

      default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)

      Deletes an endpoint.

      It can take up to 5 minutes for this action to finish.

      Related actions include:


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

      Parameters:
      deleteEndpointRequest - A Consumer that will call methods on DeleteEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEndpoint 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 There was an exception with the internal server.
      • AccessDeniedException Access was denied for this action.
      • ResourceNotFoundException The requested resource was not found.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • OutpostOfflineException The service link connection to your Outposts home Region is down. Check your connection and try again.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpoints

      default CompletableFuture<ListEndpointsResponse> listEndpoints(ListEndpointsRequest listEndpointsRequest)

      Lists endpoints associated with the specified Outpost.

      Related actions include:

      Parameters:
      listEndpointsRequest -
      Returns:
      A Java Future containing the result of the ListEndpoints 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 There was an exception with the internal server.
      • ResourceNotFoundException The requested resource was not found.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpoints

      default CompletableFuture<ListEndpointsResponse> listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)

      Lists endpoints associated with the specified Outpost.

      Related actions include:


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

      Parameters:
      listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEndpoints 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 There was an exception with the internal server.
      • ResourceNotFoundException The requested resource was not found.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointsPaginator

      default ListEndpointsPublisher listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)

      This is a variant of listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest) 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.s3outposts.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3outposts.model.ListEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3outposts.model.ListEndpointsResponse 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 listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest) operation.

      Parameters:
      listEndpointsRequest -
      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 There was an exception with the internal server.
      • ResourceNotFoundException The requested resource was not found.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointsPaginator

      default ListEndpointsPublisher listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)

      This is a variant of listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest) 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.s3outposts.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3outposts.model.ListEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3outposts.model.ListEndpointsResponse 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 listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest) operation.


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

      Parameters:
      listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.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 There was an exception with the internal server.
      • ResourceNotFoundException The requested resource was not found.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOutpostsWithS3

      default CompletableFuture<ListOutpostsWithS3Response> listOutpostsWithS3(ListOutpostsWithS3Request listOutpostsWithS3Request)

      Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM).

      Parameters:
      listOutpostsWithS3Request -
      Returns:
      A Java Future containing the result of the ListOutpostsWithS3 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 There was an exception with the internal server.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOutpostsWithS3

      default CompletableFuture<ListOutpostsWithS3Response> listOutpostsWithS3(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request)

      Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM).


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

      Parameters:
      listOutpostsWithS3Request - A Consumer that will call methods on ListOutpostsWithS3Request.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListOutpostsWithS3 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 There was an exception with the internal server.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOutpostsWithS3Paginator

      default ListOutpostsWithS3Publisher listOutpostsWithS3Paginator(ListOutpostsWithS3Request listOutpostsWithS3Request)

      This is a variant of listOutpostsWithS3(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Request) 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.s3outposts.paginators.ListOutpostsWithS3Publisher publisher = client.listOutpostsWithS3Paginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3outposts.paginators.ListOutpostsWithS3Publisher publisher = client.listOutpostsWithS3Paginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Response>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Response 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 listOutpostsWithS3(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Request) operation.

      Parameters:
      listOutpostsWithS3Request -
      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 There was an exception with the internal server.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOutpostsWithS3Paginator

      default ListOutpostsWithS3Publisher listOutpostsWithS3Paginator(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request)

      This is a variant of listOutpostsWithS3(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Request) 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.s3outposts.paginators.ListOutpostsWithS3Publisher publisher = client.listOutpostsWithS3Paginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3outposts.paginators.ListOutpostsWithS3Publisher publisher = client.listOutpostsWithS3Paginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Response>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Response 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 listOutpostsWithS3(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Request) operation.


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

      Parameters:
      listOutpostsWithS3Request - A Consumer that will call methods on ListOutpostsWithS3Request.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 There was an exception with the internal server.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSharedEndpoints

      default CompletableFuture<ListSharedEndpointsResponse> listSharedEndpoints(ListSharedEndpointsRequest listSharedEndpointsRequest)

      Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).

      Related actions include:

      Parameters:
      listSharedEndpointsRequest -
      Returns:
      A Java Future containing the result of the ListSharedEndpoints 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 There was an exception with the internal server.
      • ResourceNotFoundException The requested resource was not found.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSharedEndpoints

      default CompletableFuture<ListSharedEndpointsResponse> listSharedEndpoints(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest)

      Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).

      Related actions include:


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

      Parameters:
      listSharedEndpointsRequest - A Consumer that will call methods on ListSharedEndpointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSharedEndpoints 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 There was an exception with the internal server.
      • ResourceNotFoundException The requested resource was not found.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSharedEndpointsPaginator

      default ListSharedEndpointsPublisher listSharedEndpointsPaginator(ListSharedEndpointsRequest listSharedEndpointsRequest)

      This is a variant of listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest) 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.s3outposts.paginators.ListSharedEndpointsPublisher publisher = client.listSharedEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsPublisher publisher = client.listSharedEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsResponse 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 listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest) operation.

      Parameters:
      listSharedEndpointsRequest -
      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 There was an exception with the internal server.
      • ResourceNotFoundException The requested resource was not found.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSharedEndpointsPaginator

      default ListSharedEndpointsPublisher listSharedEndpointsPaginator(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest)

      This is a variant of listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest) 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.s3outposts.paginators.ListSharedEndpointsPublisher publisher = client.listSharedEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsPublisher publisher = client.listSharedEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsResponse 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 listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest) operation.


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

      Parameters:
      listSharedEndpointsRequest - A Consumer that will call methods on ListSharedEndpointsRequest.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 There was an exception with the internal server.
      • ResourceNotFoundException The requested resource was not found.
      • AccessDeniedException Access was denied for this action.
      • ValidationException There was an exception validating this data.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default S3OutpostsServiceClientConfiguration 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 S3OutpostsAsyncClient create()
      Create a S3OutpostsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static S3OutpostsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a S3OutpostsAsyncClient.