com.amazonaws.services.s3outposts

Class AmazonS3OutpostsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.s3outposts.AmazonS3OutpostsClient

All Implemented Interfaces:

AmazonS3Outposts

Direct Known Subclasses:

AmazonS3OutpostsAsyncClient

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

Client for accessing Amazon S3 Outposts. All service calls made using this client are blocking, and will not return until the service call 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 AmazonS3OutpostsClientBuilder	builder()
CreateEndpointResult	createEndpoint(CreateEndpointRequest request) Creates an endpoint and associates it with the specified Outpost.
DeleteEndpointResult	deleteEndpoint(DeleteEndpointRequest request) Deletes an endpoint.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListEndpointsResult	listEndpoints(ListEndpointsRequest request) Lists endpoints associated with the specified Outpost.
ListOutpostsWithS3Result	listOutpostsWithS3(ListOutpostsWithS3Request request) Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
ListSharedEndpointsResult	listSharedEndpoints(ListSharedEndpointsRequest request) Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

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

Method Detail

builder

public static AmazonS3OutpostsClientBuilder builder()

createEndpoint

public CreateEndpointResult createEndpoint(CreateEndpointRequest request)

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:

createEndpoint in interface AmazonS3Outposts

Parameters:

createEndpointRequest -

Returns:

Result of the CreateEndpoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteEndpoint

public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)

Deletes an endpoint.

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

Related actions include:

• CreateEndpoint

• ListEndpoints

Specified by:

deleteEndpoint in interface AmazonS3Outposts

Parameters:

deleteEndpointRequest -

Returns:

Result of the DeleteEndpoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listEndpoints

public ListEndpointsResult listEndpoints(ListEndpointsRequest request)

Lists endpoints associated with the specified Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

Specified by:

listEndpoints in interface AmazonS3Outposts

Parameters:

listEndpointsRequest -

Returns:

Result of the ListEndpoints operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listOutpostsWithS3

public ListOutpostsWithS3Result listOutpostsWithS3(ListOutpostsWithS3Request request)

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:

listOutpostsWithS3 in interface AmazonS3Outposts

Parameters:

listOutpostsWithS3Request -

Returns:

Result of the ListOutpostsWithS3 operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSharedEndpoints

public ListSharedEndpointsResult listSharedEndpoints(ListSharedEndpointsRequest request)

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:

listSharedEndpoints in interface AmazonS3Outposts

Parameters:

listSharedEndpointsRequest -

Returns:

Result of the ListSharedEndpoints operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonS3Outposts

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonS3Outposts

Overrides:

shutdown in class AmazonWebServiceClient