@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface S3OutpostsAsyncClient extends SdkClient
builder() method.
Amazon S3 on Outposts provides access to S3 on Outposts operations.
| 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 |
| 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)
Creates an endpoint and associates it with the specified Outpost.
|
default CompletableFuture<CreateEndpointResponse> |
createEndpoint(CreateEndpointRequest createEndpointRequest)
Creates an endpoint and associates it with the specified Outpost.
|
default CompletableFuture<DeleteEndpointResponse> |
deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)
Deletes an endpoint.
|
default CompletableFuture<DeleteEndpointResponse> |
deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes an endpoint.
|
default CompletableFuture<ListEndpointsResponse> |
listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
Lists endpoints associated with the specified Outpost.
|
default CompletableFuture<ListEndpointsResponse> |
listEndpoints(ListEndpointsRequest listEndpointsRequest)
Lists endpoints associated with the specified Outpost.
|
default ListEndpointsPublisher |
listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
Lists endpoints associated with the specified Outpost.
|
default ListEndpointsPublisher |
listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)
Lists endpoints associated with the specified Outpost.
|
default CompletableFuture<ListOutpostsWithS3Response> |
listOutpostsWithS3(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request)
Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
|
default CompletableFuture<ListOutpostsWithS3Response> |
listOutpostsWithS3(ListOutpostsWithS3Request listOutpostsWithS3Request)
Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
|
default ListOutpostsWithS3Publisher |
listOutpostsWithS3Paginator(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request)
Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
|
default ListOutpostsWithS3Publisher |
listOutpostsWithS3Paginator(ListOutpostsWithS3Request listOutpostsWithS3Request)
Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
|
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).
|
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).
|
default ListSharedEndpointsPublisher |
listSharedEndpointsPaginator(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest)
Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access
Manager (RAM).
|
default ListSharedEndpointsPublisher |
listSharedEndpointsPaginator(ListSharedEndpointsRequest listSharedEndpointsRequest)
Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access
Manager (RAM).
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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:
createEndpointRequest - 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()
createEndpointRequest - A Consumer that will call methods on CreateEndpointRequest.Builder to create a request.default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes an endpoint.
It can take up to 5 minutes for this action to finish.
Related actions include:
deleteEndpointRequest - 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()
deleteEndpointRequest - A Consumer that will call methods on DeleteEndpointRequest.Builder to create a request.default CompletableFuture<ListEndpointsResponse> listEndpoints(ListEndpointsRequest listEndpointsRequest)
Lists endpoints associated with the specified Outpost.
Related actions include:
listEndpointsRequest - 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()
listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.Builder to create a request.default ListEndpointsPublisher listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)
Lists endpoints associated with the specified Outpost.
Related actions include:
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.
listEndpointsRequest - default ListEndpointsPublisher listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
Lists endpoints associated with the specified Outpost.
Related actions include:
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()
listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.Builder to create a request.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).
listOutpostsWithS3Request - 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()
listOutpostsWithS3Request - A Consumer that will call methods on ListOutpostsWithS3Request.Builder to create a
request.default ListOutpostsWithS3Publisher listOutpostsWithS3Paginator(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).
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.
listOutpostsWithS3Request - default ListOutpostsWithS3Publisher listOutpostsWithS3Paginator(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 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()
listOutpostsWithS3Request - A Consumer that will call methods on ListOutpostsWithS3Request.Builder to create a
request.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:
listSharedEndpointsRequest - 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()
listSharedEndpointsRequest - A Consumer that will call methods on ListSharedEndpointsRequest.Builder to create a
request.default ListSharedEndpointsPublisher listSharedEndpointsPaginator(ListSharedEndpointsRequest 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 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.
listSharedEndpointsRequest - default ListSharedEndpointsPublisher listSharedEndpointsPaginator(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 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()
listSharedEndpointsRequest - A Consumer that will call methods on ListSharedEndpointsRequest.Builder to create a
request.static S3OutpostsAsyncClient create()
S3OutpostsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static S3OutpostsAsyncClientBuilder builder()
S3OutpostsAsyncClient.Copyright © 2023. All rights reserved.