com.amazonaws.services.s3outposts

Class AmazonS3OutpostsAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.s3outposts.AmazonS3OutpostsClient

com.amazonaws.services.s3outposts.AmazonS3OutpostsAsyncClient

All Implemented Interfaces:

AmazonS3Outposts, AmazonS3OutpostsAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonS3OutpostsAsyncClient
extends AmazonS3OutpostsClient
implements AmazonS3OutpostsAsync

Client for accessing Amazon S3 Outposts asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon S3 on Outposts provides access to S3 on Outposts operations.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.s3outposts.AmazonS3Outposts

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonS3OutpostsAsyncClientBuilder	asyncBuilder()
Future<CreateEndpointResult>	createEndpointAsync(CreateEndpointRequest request) Creates an endpoint and associates it with the specified Outpost.
Future<CreateEndpointResult>	createEndpointAsync(CreateEndpointRequest request, AsyncHandler<CreateEndpointRequest,CreateEndpointResult> asyncHandler) Creates an endpoint and associates it with the specified Outpost.
Future<DeleteEndpointResult>	deleteEndpointAsync(DeleteEndpointRequest request) Deletes an endpoint.
Future<DeleteEndpointResult>	deleteEndpointAsync(DeleteEndpointRequest request, AsyncHandler<DeleteEndpointRequest,DeleteEndpointResult> asyncHandler) Deletes an endpoint.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListEndpointsResult>	listEndpointsAsync(ListEndpointsRequest request) Lists endpoints associated with the specified Outpost.
Future<ListEndpointsResult>	listEndpointsAsync(ListEndpointsRequest request, AsyncHandler<ListEndpointsRequest,ListEndpointsResult> asyncHandler) Lists endpoints associated with the specified Outpost.
Future<ListOutpostsWithS3Result>	listOutpostsWithS3Async(ListOutpostsWithS3Request request) Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
Future<ListOutpostsWithS3Result>	listOutpostsWithS3Async(ListOutpostsWithS3Request request, AsyncHandler<ListOutpostsWithS3Request,ListOutpostsWithS3Result> asyncHandler) Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
Future<ListSharedEndpointsResult>	listSharedEndpointsAsync(ListSharedEndpointsRequest request) Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
Future<ListSharedEndpointsResult>	listSharedEndpointsAsync(ListSharedEndpointsRequest request, AsyncHandler<ListSharedEndpointsRequest,ListSharedEndpointsResult> asyncHandler) Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.s3outposts.AmazonS3OutpostsClient

builder, createEndpoint, deleteEndpoint, getCachedResponseMetadata, listEndpoints, listOutpostsWithS3, listSharedEndpoints

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.s3outposts.AmazonS3Outposts

createEndpoint, deleteEndpoint, getCachedResponseMetadata, listEndpoints, listOutpostsWithS3, listSharedEndpoints

Method Detail

asyncBuilder

public static AmazonS3OutpostsAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

createEndpointAsync

public Future<CreateEndpointResult> createEndpointAsync(CreateEndpointRequest request)

Description copied from interface: AmazonS3OutpostsAsync

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:

• DeleteEndpoint

• ListEndpoints

Specified by:

createEndpointAsync in interface AmazonS3OutpostsAsync

Returns:

A Java Future containing the result of the CreateEndpoint operation returned by the service.

See Also:

AWS API Documentation

createEndpointAsync

public Future<CreateEndpointResult> createEndpointAsync(CreateEndpointRequest request,
                                                        AsyncHandler<CreateEndpointRequest,CreateEndpointResult> asyncHandler)

Description copied from interface: AmazonS3OutpostsAsync

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:

• DeleteEndpoint

• ListEndpoints

Specified by:

createEndpointAsync in interface AmazonS3OutpostsAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateEndpoint operation returned by the service.

See Also:

AWS API Documentation

deleteEndpointAsync

public Future<DeleteEndpointResult> deleteEndpointAsync(DeleteEndpointRequest request)

Description copied from interface: AmazonS3OutpostsAsync

Deletes an endpoint.

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

Related actions include:

• CreateEndpoint

• ListEndpoints

Specified by:

deleteEndpointAsync in interface AmazonS3OutpostsAsync

Returns:

A Java Future containing the result of the DeleteEndpoint operation returned by the service.

See Also:

AWS API Documentation

deleteEndpointAsync

public Future<DeleteEndpointResult> deleteEndpointAsync(DeleteEndpointRequest request,
                                                        AsyncHandler<DeleteEndpointRequest,DeleteEndpointResult> asyncHandler)

Description copied from interface: AmazonS3OutpostsAsync

Deletes an endpoint.

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

Related actions include:

• CreateEndpoint

• ListEndpoints

Specified by:

deleteEndpointAsync in interface AmazonS3OutpostsAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteEndpoint operation returned by the service.

See Also:

AWS API Documentation

listEndpointsAsync

public Future<ListEndpointsResult> listEndpointsAsync(ListEndpointsRequest request)

Description copied from interface: AmazonS3OutpostsAsync

Lists endpoints associated with the specified Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

Specified by:

listEndpointsAsync in interface AmazonS3OutpostsAsync

Returns:

A Java Future containing the result of the ListEndpoints operation returned by the service.

See Also:

AWS API Documentation

listEndpointsAsync

public Future<ListEndpointsResult> listEndpointsAsync(ListEndpointsRequest request,
                                                      AsyncHandler<ListEndpointsRequest,ListEndpointsResult> asyncHandler)

Description copied from interface: AmazonS3OutpostsAsync

Lists endpoints associated with the specified Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

Specified by:

listEndpointsAsync in interface AmazonS3OutpostsAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListEndpoints operation returned by the service.

See Also:

AWS API Documentation

listOutpostsWithS3Async

public Future<ListOutpostsWithS3Result> listOutpostsWithS3Async(ListOutpostsWithS3Request request)

Description copied from interface: AmazonS3OutpostsAsync

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).

Specified by:

listOutpostsWithS3Async in interface AmazonS3OutpostsAsync

Returns:

A Java Future containing the result of the ListOutpostsWithS3 operation returned by the service.

See Also:

AWS API Documentation

listOutpostsWithS3Async

public Future<ListOutpostsWithS3Result> listOutpostsWithS3Async(ListOutpostsWithS3Request request,
                                                                AsyncHandler<ListOutpostsWithS3Request,ListOutpostsWithS3Result> asyncHandler)

Description copied from interface: AmazonS3OutpostsAsync

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).

Specified by:

listOutpostsWithS3Async in interface AmazonS3OutpostsAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListOutpostsWithS3 operation returned by the service.

See Also:

AWS API Documentation

listSharedEndpointsAsync

public Future<ListSharedEndpointsResult> listSharedEndpointsAsync(ListSharedEndpointsRequest request)

Description copied from interface: AmazonS3OutpostsAsync

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

Related actions include:

• CreateEndpoint

• DeleteEndpoint

Specified by:

listSharedEndpointsAsync in interface AmazonS3OutpostsAsync

Returns:

A Java Future containing the result of the ListSharedEndpoints operation returned by the service.

See Also:

AWS API Documentation

listSharedEndpointsAsync

public Future<ListSharedEndpointsResult> listSharedEndpointsAsync(ListSharedEndpointsRequest request,
                                                                  AsyncHandler<ListSharedEndpointsRequest,ListSharedEndpointsResult> asyncHandler)

Description copied from interface: AmazonS3OutpostsAsync

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

Related actions include:

• CreateEndpoint

• DeleteEndpoint

Specified by:

listSharedEndpointsAsync in interface AmazonS3OutpostsAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListSharedEndpoints operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonS3Outposts

Overrides:

shutdown in class AmazonS3OutpostsClient