com.amazonaws.services.s3outposts

Interface AmazonS3Outposts

All Known Subinterfaces:

AmazonS3OutpostsAsync

All Known Implementing Classes:

AbstractAmazonS3Outposts, AbstractAmazonS3OutpostsAsync, AmazonS3OutpostsAsyncClient, AmazonS3OutpostsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonS3Outposts

Interface for accessing Amazon S3 Outposts.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonS3Outposts instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateEndpointResult	createEndpoint(CreateEndpointRequest createEndpointRequest) Creates an endpoint and associates it with the specified Outpost.
DeleteEndpointResult	deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) 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 listEndpointsRequest) Lists endpoints associated with the specified Outpost.
ListOutpostsWithS3Result	listOutpostsWithS3(ListOutpostsWithS3Request listOutpostsWithS3Request) Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
ListSharedEndpointsResult	listSharedEndpoints(ListSharedEndpointsRequest listSharedEndpointsRequest) 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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createEndpoint

CreateEndpointResult 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:

• DeleteEndpoint

• ListEndpoints

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

DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)

Deletes an endpoint.

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

Related actions include:

• CreateEndpoint

• ListEndpoints

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

ListEndpointsResult listEndpoints(ListEndpointsRequest listEndpointsRequest)

Lists endpoints associated with the specified Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

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

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

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

ListSharedEndpointsResult 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:

• CreateEndpoint

• DeleteEndpoint

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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