Package software.amazon.awssdk.services.s3outposts

Interface S3OutpostsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface S3OutpostsClient
extends AwsClient

Service client for accessing Amazon S3 Outposts. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static S3OutpostsClientBuilder	builder()	Create a builder that can be used to configure and create a S3OutpostsClient.
static S3OutpostsClient	create()	Create a S3OutpostsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateEndpointResponse	createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest)	Creates an endpoint and associates it with the specified Outpost.
default CreateEndpointResponse	createEndpoint(CreateEndpointRequest createEndpointRequest)	Creates an endpoint and associates it with the specified Outpost.
default DeleteEndpointResponse	deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)	Deletes an endpoint.
default DeleteEndpointResponse	deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)	Deletes an endpoint.
default ListEndpointsResponse	listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)	Lists endpoints associated with the specified Outpost.
default ListEndpointsResponse	listEndpoints(ListEndpointsRequest listEndpointsRequest)	Lists endpoints associated with the specified Outpost.
default ListEndpointsIterable	listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)	Lists endpoints associated with the specified Outpost.
default ListEndpointsIterable	listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)	Lists endpoints associated with the specified Outpost.
default ListOutpostsWithS3Response	listOutpostsWithS3(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request)	Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
default ListOutpostsWithS3Response	listOutpostsWithS3(ListOutpostsWithS3Request listOutpostsWithS3Request)	Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
default ListOutpostsWithS3Iterable	listOutpostsWithS3Paginator(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request)	Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
default ListOutpostsWithS3Iterable	listOutpostsWithS3Paginator(ListOutpostsWithS3Request listOutpostsWithS3Request)	Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
default ListSharedEndpointsResponse	listSharedEndpoints(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest)	Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
default ListSharedEndpointsResponse	listSharedEndpoints(ListSharedEndpointsRequest listSharedEndpointsRequest)	Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
default ListSharedEndpointsIterable	listSharedEndpointsPaginator(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest)	Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
default ListSharedEndpointsIterable	listSharedEndpointsPaginator(ListSharedEndpointsRequest listSharedEndpointsRequest)	Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
default S3OutpostsServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

createEndpoint

default CreateEndpointResponse createEndpoint(CreateEndpointRequest createEndpointRequest)
                                       throws InternalServerException,
                                              ValidationException,
                                              AccessDeniedException,
                                              ResourceNotFoundException,
                                              ConflictException,
                                              ThrottlingException,
                                              OutpostOfflineException,
                                              AwsServiceException,
                                              SdkClientException,
                                              S3OutpostsException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createEndpoint

default CreateEndpointResponse createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest)
                                       throws InternalServerException,
                                              ValidationException,
                                              AccessDeniedException,
                                              ResourceNotFoundException,
                                              ConflictException,
                                              ThrottlingException,
                                              OutpostOfflineException,
                                              AwsServiceException,
                                              SdkClientException,
                                              S3OutpostsException

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

This is a convenience which creates an instance of the CreateEndpointRequest.Builder avoiding the need to create one manually via CreateEndpointRequest.builder()

Parameters:

createEndpointRequest - A Consumer that will call methods on CreateEndpointRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteEndpoint

default DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
                                       throws InternalServerException,
                                              AccessDeniedException,
                                              ResourceNotFoundException,
                                              ValidationException,
                                              ThrottlingException,
                                              OutpostOfflineException,
                                              AwsServiceException,
                                              SdkClientException,
                                              S3OutpostsException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteEndpoint

default DeleteEndpointResponse deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)
                                       throws InternalServerException,
                                              AccessDeniedException,
                                              ResourceNotFoundException,
                                              ValidationException,
                                              ThrottlingException,
                                              OutpostOfflineException,
                                              AwsServiceException,
                                              SdkClientException,
                                              S3OutpostsException

Deletes an endpoint.

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

Related actions include:

• CreateEndpoint

• ListEndpoints

This is a convenience which creates an instance of the DeleteEndpointRequest.Builder avoiding the need to create one manually via DeleteEndpointRequest.builder()

Parameters:

deleteEndpointRequest - A Consumer that will call methods on DeleteEndpointRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEndpoints

default ListEndpointsResponse listEndpoints(ListEndpointsRequest listEndpointsRequest)
                                     throws InternalServerException,
                                            ResourceNotFoundException,
                                            AccessDeniedException,
                                            ValidationException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            S3OutpostsException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEndpoints

default ListEndpointsResponse listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
                                     throws InternalServerException,
                                            ResourceNotFoundException,
                                            AccessDeniedException,
                                            ValidationException,
                                            ThrottlingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            S3OutpostsException

Lists endpoints associated with the specified Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

This is a convenience which creates an instance of the ListEndpointsRequest.Builder avoiding the need to create one manually via ListEndpointsRequest.builder()

Parameters:

listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEndpointsPaginator

default ListEndpointsIterable listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)
                                              throws InternalServerException,
                                                     ResourceNotFoundException,
                                                     AccessDeniedException,
                                                     ValidationException,
                                                     ThrottlingException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     S3OutpostsException

Lists endpoints associated with the specified Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

This is a variant of listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsIterable responses = client
             .listEndpointsPaginator(request);
     for (software.amazon.awssdk.services.s3outposts.model.ListEndpointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest) operation.

Parameters:

listEndpointsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEndpointsPaginator

default ListEndpointsIterable listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
                                              throws InternalServerException,
                                                     ResourceNotFoundException,
                                                     AccessDeniedException,
                                                     ValidationException,
                                                     ThrottlingException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     S3OutpostsException

Lists endpoints associated with the specified Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

This is a variant of listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsIterable responses = client
             .listEndpointsPaginator(request);
     for (software.amazon.awssdk.services.s3outposts.model.ListEndpointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest) operation.

This is a convenience which creates an instance of the ListEndpointsRequest.Builder avoiding the need to create one manually via ListEndpointsRequest.builder()

Parameters:

listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listOutpostsWithS3

default ListOutpostsWithS3Response listOutpostsWithS3(ListOutpostsWithS3Request listOutpostsWithS3Request)
                                               throws InternalServerException,
                                                      AccessDeniedException,
                                                      ValidationException,
                                                      ThrottlingException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      S3OutpostsException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listOutpostsWithS3

default ListOutpostsWithS3Response listOutpostsWithS3(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request)
                                               throws InternalServerException,
                                                      AccessDeniedException,
                                                      ValidationException,
                                                      ThrottlingException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      S3OutpostsException

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

This is a convenience which creates an instance of the ListOutpostsWithS3Request.Builder avoiding the need to create one manually via ListOutpostsWithS3Request.builder()

Parameters:

listOutpostsWithS3Request - A Consumer that will call methods on ListOutpostsWithS3Request.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listOutpostsWithS3Paginator

default ListOutpostsWithS3Iterable listOutpostsWithS3Paginator(ListOutpostsWithS3Request listOutpostsWithS3Request)
                                                        throws InternalServerException,
                                                               AccessDeniedException,
                                                               ValidationException,
                                                               ThrottlingException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               S3OutpostsException

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

This is a variant of listOutpostsWithS3(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Request) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3outposts.paginators.ListOutpostsWithS3Iterable responses = client.listOutpostsWithS3Paginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3outposts.paginators.ListOutpostsWithS3Iterable responses = client
             .listOutpostsWithS3Paginator(request);
     for (software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Response response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3outposts.paginators.ListOutpostsWithS3Iterable responses = client.listOutpostsWithS3Paginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listOutpostsWithS3(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Request) operation.

Parameters:

listOutpostsWithS3Request -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listOutpostsWithS3Paginator

default ListOutpostsWithS3Iterable listOutpostsWithS3Paginator(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request)
                                                        throws InternalServerException,
                                                               AccessDeniedException,
                                                               ValidationException,
                                                               ThrottlingException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               S3OutpostsException

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

This is a variant of listOutpostsWithS3(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Request) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3outposts.paginators.ListOutpostsWithS3Iterable responses = client.listOutpostsWithS3Paginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3outposts.paginators.ListOutpostsWithS3Iterable responses = client
             .listOutpostsWithS3Paginator(request);
     for (software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Response response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3outposts.paginators.ListOutpostsWithS3Iterable responses = client.listOutpostsWithS3Paginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listOutpostsWithS3(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Request) operation.

This is a convenience which creates an instance of the ListOutpostsWithS3Request.Builder avoiding the need to create one manually via ListOutpostsWithS3Request.builder()

Parameters:

listOutpostsWithS3Request - A Consumer that will call methods on ListOutpostsWithS3Request.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSharedEndpoints

default ListSharedEndpointsResponse listSharedEndpoints(ListSharedEndpointsRequest listSharedEndpointsRequest)
                                                 throws InternalServerException,
                                                        ResourceNotFoundException,
                                                        AccessDeniedException,
                                                        ValidationException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        S3OutpostsException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSharedEndpoints

default ListSharedEndpointsResponse listSharedEndpoints(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest)
                                                 throws InternalServerException,
                                                        ResourceNotFoundException,
                                                        AccessDeniedException,
                                                        ValidationException,
                                                        ThrottlingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        S3OutpostsException

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

Related actions include:

• CreateEndpoint

• DeleteEndpoint

This is a convenience which creates an instance of the ListSharedEndpointsRequest.Builder avoiding the need to create one manually via ListSharedEndpointsRequest.builder()

Parameters:

listSharedEndpointsRequest - A Consumer that will call methods on ListSharedEndpointsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSharedEndpointsPaginator

default ListSharedEndpointsIterable listSharedEndpointsPaginator(ListSharedEndpointsRequest listSharedEndpointsRequest)
                                                          throws InternalServerException,
                                                                 ResourceNotFoundException,
                                                                 AccessDeniedException,
                                                                 ValidationException,
                                                                 ThrottlingException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 S3OutpostsException

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

Related actions include:

• CreateEndpoint

• DeleteEndpoint

This is a variant of listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsIterable responses = client.listSharedEndpointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsIterable responses = client
             .listSharedEndpointsPaginator(request);
     for (software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsIterable responses = client.listSharedEndpointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest) operation.

Parameters:

listSharedEndpointsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listSharedEndpointsPaginator

default ListSharedEndpointsIterable listSharedEndpointsPaginator(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest)
                                                          throws InternalServerException,
                                                                 ResourceNotFoundException,
                                                                 AccessDeniedException,
                                                                 ValidationException,
                                                                 ThrottlingException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 S3OutpostsException

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

Related actions include:

• CreateEndpoint

• DeleteEndpoint

This is a variant of listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsIterable responses = client.listSharedEndpointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsIterable responses = client
             .listSharedEndpointsPaginator(request);
     for (software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsIterable responses = client.listSharedEndpointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest) operation.

This is a convenience which creates an instance of the ListSharedEndpointsRequest.Builder avoiding the need to create one manually via ListSharedEndpointsRequest.builder()

Parameters:

listSharedEndpointsRequest - A Consumer that will call methods on ListSharedEndpointsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

S3OutpostsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static S3OutpostsClient create()

Create a S3OutpostsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static S3OutpostsClientBuilder builder()

Create a builder that can be used to configure and create a S3OutpostsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default S3OutpostsServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient