S3OutpostsAsyncClient (AWS Java SDK :: Services

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient
```
@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface S3OutpostsAsyncClient
extends SdkClient
```
Service client for accessing Amazon S3 Outposts asynchronously. This can be created using the static builder() method.
Amazon S3 on Outposts provides access to S3 on Outposts operations.

Field Summary

Fields
Modifier and Type Field and Description

static String SERVICE_METADATA_ID
Value for looking up the service's metadata from the ServiceMetadataProvider.

static String SERVICE_NAME

Fields
Modifier and Type	Field and Description
`static String`	`SERVICE_METADATA_ID` Value for looking up the service's metadata from the `ServiceMetadataProvider`.
`static String`	`SERVICE_NAME`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static S3OutpostsAsyncClientBuilder`	`builder()` Create a builder that can be used to configure and create a `S3OutpostsAsyncClient`.
`static S3OutpostsAsyncClient`	`create()` Create a `S3OutpostsAsyncClient` with the region loaded from the `DefaultAwsRegionProviderChain` and credentials loaded from the `DefaultCredentialsProvider`.
`default CompletableFuture<CreateEndpointResponse>`	`createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest)` Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts.
`default CompletableFuture<CreateEndpointResponse>`	`createEndpoint(CreateEndpointRequest createEndpointRequest)` Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts.
`default CompletableFuture<DeleteEndpointResponse>`	`deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)` Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts.
`default CompletableFuture<DeleteEndpointResponse>`	`deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)` Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts.
`default CompletableFuture<ListEndpointsResponse>`	`listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)` Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts.
`default CompletableFuture<ListEndpointsResponse>`	`listEndpoints(ListEndpointsRequest listEndpointsRequest)` Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts.
`default ListEndpointsPublisher`	`listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)` Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts.
`default ListEndpointsPublisher`	`listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)` Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts.

Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close

- Field Detail
  - SERVICE_NAME
```
static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
  - SERVICE_METADATA_ID
```
static final String SERVICE_METADATA_ID
```
    Value for looking up the service's metadata from the ServiceMetadataProvider.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - 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.
  - createEndpoint
```
default CompletableFuture<CreateEndpointResponse> createEndpoint(CreateEndpointRequest createEndpointRequest)
```
    Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points.
    
    This action creates an endpoint and associates it with the specified Outposts.
    
    It can take up to 5 minutes for this action to complete.
    
    Related actions include:
    - DeleteEndpoint
    - ListEndpoints
    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.
    
    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.
    
    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:
    
    AWS API Documentation
  - createEndpoint
```
default CompletableFuture<CreateEndpointResponse> createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest)
```
    Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points.
    
    This action creates an endpoint and associates it with the specified Outposts.
    
    It can take up to 5 minutes for this action to complete.
    
    Related actions include:
    - DeleteEndpoint
    - ListEndpoints
    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.
    
    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.
    
    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:
    
    AWS API Documentation
  - deleteEndpoint
```
default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
```
    Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points.
    
    This action deletes an endpoint.
    
    It can take up to 5 minutes for this action to complete.
    
    Related actions include:
    - CreateEndpoint
    - ListEndpoints
    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.
    
    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.
    
    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:
    
    AWS API Documentation
  - deleteEndpoint
```
default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)
```
    Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points.
    
    This action deletes an endpoint.
    
    It can take up to 5 minutes for this action to complete.
    
    Related actions include:
    - CreateEndpoint
    - ListEndpoints
    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.
    
    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.
    
    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:
    
    AWS API Documentation
  - listEndpoints
```
default CompletableFuture<ListEndpointsResponse> listEndpoints(ListEndpointsRequest listEndpointsRequest)
```
    Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points.
    
    This action lists endpoints associated with the Outposts.
    
    Related actions include:
    - CreateEndpoint
    - DeleteEndpoint
    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.
    
    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.
    
    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:
    
    AWS API Documentation
  - listEndpoints
```
default CompletableFuture<ListEndpointsResponse> listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
```
    Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points.
    
    This action lists endpoints associated with the Outposts.
    
    Related actions include:
    - CreateEndpoint
    - DeleteEndpoint
    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.
    
    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.
    
    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:
    
    AWS API Documentation
  - listEndpointsPaginator
```
default ListEndpointsPublisher listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)
```
    Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points.
    
    This action lists endpoints associated with the Outposts.
    
    Related actions include:
    - CreateEndpoint
    - DeleteEndpoint
    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.
    
    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.
    
    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:
    
    AWS API Documentation
  - listEndpointsPaginator
```
default ListEndpointsPublisher listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
```
    Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points.
    
    This action lists endpoints associated with the Outposts.
    
    Related actions include:
    - CreateEndpoint
    - DeleteEndpoint
    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.
    
    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.
    
    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:
    
    AWS API Documentation

Interface S3OutpostsAsyncClient

Field Summary

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkClient

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

Field Detail

SERVICE_NAME

SERVICE_METADATA_ID

Method Detail

create

builder

createEndpoint

createEndpoint

deleteEndpoint

deleteEndpoint

listEndpoints

listEndpoints

listEndpointsPaginator

listEndpointsPaginator