/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.s3outposts;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.s3outposts.model.*;
/**
* Interface for accessing Amazon S3 Outposts.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.s3outposts.AbstractAmazonS3Outposts} instead.
*
*
*
* Amazon S3 on Outposts provides access to S3 on Outposts operations.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonS3Outposts {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "s3-outposts";
/**
*
* 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:
*
*
*
* @param createEndpointRequest
* @return Result of the CreateEndpoint operation returned by the service.
* @throws InternalServerException
* There was an exception with the internal server.
* @throws ValidationException
* There was an exception validating this data.
* @throws AccessDeniedException
* Access was denied for this action.
* @throws ResourceNotFoundException
* The requested resource was not found.
* @throws ConflictException
* There was a conflict with this action, and it could not be completed.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws OutpostOfflineException
* The service link connection to your Outposts home Region is down. Check your connection and try again.
* @sample AmazonS3Outposts.CreateEndpoint
* @see AWS API
* Documentation
*/
CreateEndpointResult createEndpoint(CreateEndpointRequest createEndpointRequest);
/**
*
* Deletes an endpoint.
*
*
*
* It can take up to 5 minutes for this action to finish.
*
*
*
*
* Related actions include:
*
*
*
* @param deleteEndpointRequest
* @return Result of the DeleteEndpoint operation returned by the service.
* @throws InternalServerException
* There was an exception with the internal server.
* @throws AccessDeniedException
* Access was denied for this action.
* @throws ResourceNotFoundException
* The requested resource was not found.
* @throws ValidationException
* There was an exception validating this data.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws OutpostOfflineException
* The service link connection to your Outposts home Region is down. Check your connection and try again.
* @sample AmazonS3Outposts.DeleteEndpoint
* @see AWS API
* Documentation
*/
DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest);
/**
*
* Lists endpoints associated with the specified Outpost.
*
*
* Related actions include:
*
*
*
* @param listEndpointsRequest
* @return Result of the ListEndpoints operation returned by the service.
* @throws InternalServerException
* There was an exception with the internal server.
* @throws ResourceNotFoundException
* The requested resource was not found.
* @throws AccessDeniedException
* Access was denied for this action.
* @throws ValidationException
* There was an exception validating this data.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonS3Outposts.ListEndpoints
* @see AWS API
* Documentation
*/
ListEndpointsResult listEndpoints(ListEndpointsRequest listEndpointsRequest);
/**
*
* 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).
*
*
* @param listOutpostsWithS3Request
* @return Result of the ListOutpostsWithS3 operation returned by the service.
* @throws InternalServerException
* There was an exception with the internal server.
* @throws AccessDeniedException
* Access was denied for this action.
* @throws ValidationException
* There was an exception validating this data.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonS3Outposts.ListOutpostsWithS3
* @see AWS
* API Documentation
*/
ListOutpostsWithS3Result listOutpostsWithS3(ListOutpostsWithS3Request listOutpostsWithS3Request);
/**
*
* Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access
* Manager (RAM).
*
*
* Related actions include:
*
*
*
* @param listSharedEndpointsRequest
* @return Result of the ListSharedEndpoints operation returned by the service.
* @throws InternalServerException
* There was an exception with the internal server.
* @throws ResourceNotFoundException
* The requested resource was not found.
* @throws AccessDeniedException
* Access was denied for this action.
* @throws ValidationException
* There was an exception validating this data.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonS3Outposts.ListSharedEndpoints
* @see AWS
* API Documentation
*/
ListSharedEndpointsResult listSharedEndpoints(ListSharedEndpointsRequest listSharedEndpointsRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}