@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface OutpostsAsyncClient extends SdkClient
builder() method.
AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.
| 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 |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static OutpostsAsyncClient create()
OutpostsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static OutpostsAsyncClientBuilder builder()
OutpostsAsyncClient.default CompletableFuture<CreateOrderResponse> createOrder(CreateOrderRequest createOrderRequest)
Creates an order for an Outpost.
createOrderRequest - default CompletableFuture<CreateOrderResponse> createOrder(Consumer<CreateOrderRequest.Builder> createOrderRequest)
Creates an order for an Outpost.
This is a convenience which creates an instance of the CreateOrderRequest.Builder avoiding the need to
create one manually via CreateOrderRequest.builder()
createOrderRequest - A Consumer that will call methods on CreateOrderInput.Builder to create a request.default CompletableFuture<CreateOutpostResponse> createOutpost(CreateOutpostRequest createOutpostRequest)
Creates an Outpost.
You can specify AvailabilityZone or AvailabilityZoneId.
createOutpostRequest - default CompletableFuture<CreateOutpostResponse> createOutpost(Consumer<CreateOutpostRequest.Builder> createOutpostRequest)
Creates an Outpost.
You can specify AvailabilityZone or AvailabilityZoneId.
This is a convenience which creates an instance of the CreateOutpostRequest.Builder avoiding the need to
create one manually via CreateOutpostRequest.builder()
createOutpostRequest - A Consumer that will call methods on CreateOutpostInput.Builder to create a request.default CompletableFuture<DeleteOutpostResponse> deleteOutpost(DeleteOutpostRequest deleteOutpostRequest)
Deletes the Outpost.
deleteOutpostRequest - default CompletableFuture<DeleteOutpostResponse> deleteOutpost(Consumer<DeleteOutpostRequest.Builder> deleteOutpostRequest)
Deletes the Outpost.
This is a convenience which creates an instance of the DeleteOutpostRequest.Builder avoiding the need to
create one manually via DeleteOutpostRequest.builder()
deleteOutpostRequest - A Consumer that will call methods on DeleteOutpostInput.Builder to create a request.default CompletableFuture<DeleteSiteResponse> deleteSite(DeleteSiteRequest deleteSiteRequest)
Deletes the site.
deleteSiteRequest - default CompletableFuture<DeleteSiteResponse> deleteSite(Consumer<DeleteSiteRequest.Builder> deleteSiteRequest)
Deletes the site.
This is a convenience which creates an instance of the DeleteSiteRequest.Builder avoiding the need to
create one manually via DeleteSiteRequest.builder()
deleteSiteRequest - A Consumer that will call methods on DeleteSiteInput.Builder to create a request.default CompletableFuture<GetOutpostResponse> getOutpost(GetOutpostRequest getOutpostRequest)
Gets information about the specified Outpost.
getOutpostRequest - default CompletableFuture<GetOutpostResponse> getOutpost(Consumer<GetOutpostRequest.Builder> getOutpostRequest)
Gets information about the specified Outpost.
This is a convenience which creates an instance of the GetOutpostRequest.Builder avoiding the need to
create one manually via GetOutpostRequest.builder()
getOutpostRequest - A Consumer that will call methods on GetOutpostInput.Builder to create a request.default CompletableFuture<GetOutpostInstanceTypesResponse> getOutpostInstanceTypes(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest)
Lists the instance types for the specified Outpost.
getOutpostInstanceTypesRequest - default CompletableFuture<GetOutpostInstanceTypesResponse> getOutpostInstanceTypes(Consumer<GetOutpostInstanceTypesRequest.Builder> getOutpostInstanceTypesRequest)
Lists the instance types for the specified Outpost.
This is a convenience which creates an instance of the GetOutpostInstanceTypesRequest.Builder avoiding
the need to create one manually via GetOutpostInstanceTypesRequest.builder()
getOutpostInstanceTypesRequest - A Consumer that will call methods on GetOutpostInstanceTypesInput.Builder to create a
request.default CompletableFuture<ListOutpostsResponse> listOutposts(ListOutpostsRequest listOutpostsRequest)
Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of
results. Use filters to match an Outpost lifecycle status, Availibility Zone (us-east-1a), and AZ ID
(use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
listOutpostsRequest - default CompletableFuture<ListOutpostsResponse> listOutposts(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest)
Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of
results. Use filters to match an Outpost lifecycle status, Availibility Zone (us-east-1a), and AZ ID
(use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a convenience which creates an instance of the ListOutpostsRequest.Builder avoiding the need to
create one manually via ListOutpostsRequest.builder()
listOutpostsRequest - A Consumer that will call methods on ListOutpostsInput.Builder to create a request.default ListOutpostsPublisher listOutpostsPaginator(ListOutpostsRequest listOutpostsRequest)
Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of
results. Use filters to match an Outpost lifecycle status, Availibility Zone (us-east-1a), and AZ ID
(use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a variant of listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest)
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.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListOutpostsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListOutpostsResponse 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
listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest) operation.
listOutpostsRequest - default ListOutpostsPublisher listOutpostsPaginator(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest)
Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of
results. Use filters to match an Outpost lifecycle status, Availibility Zone (us-east-1a), and AZ ID
(use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a variant of listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest)
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.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListOutpostsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListOutpostsResponse 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
listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest) operation.
This is a convenience which creates an instance of the ListOutpostsRequest.Builder avoiding the need to
create one manually via ListOutpostsRequest.builder()
listOutpostsRequest - A Consumer that will call methods on ListOutpostsInput.Builder to create a request.default CompletableFuture<ListSitesResponse> listSites(ListSitesRequest listSitesRequest)
Lists the sites for the specified AWS account.
listSitesRequest - default CompletableFuture<ListSitesResponse> listSites(Consumer<ListSitesRequest.Builder> listSitesRequest)
Lists the sites for the specified AWS account.
This is a convenience which creates an instance of the ListSitesRequest.Builder avoiding the need to
create one manually via ListSitesRequest.builder()
listSitesRequest - A Consumer that will call methods on ListSitesInput.Builder to create a request.default ListSitesPublisher listSitesPaginator(ListSitesRequest listSitesRequest)
Lists the sites for the specified AWS account.
This is a variant of listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest)
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.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListSitesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListSitesResponse 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
listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest) operation.
listSitesRequest - default ListSitesPublisher listSitesPaginator(Consumer<ListSitesRequest.Builder> listSitesRequest)
Lists the sites for the specified AWS account.
This is a variant of listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest)
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.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListSitesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListSitesResponse 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
listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest) operation.
This is a convenience which creates an instance of the ListSitesRequest.Builder avoiding the need to
create one manually via ListSitesRequest.builder()
listSitesRequest - A Consumer that will call methods on ListSitesInput.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags for 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()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds tags to the specified resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to the specified resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the specified resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the specified resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.Copyright © 2021. All rights reserved.