@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface S3OutpostsClient extends SdkClient
builder() method.
Amazon S3 on Outposts provides access to S3 on Outposts operations.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and 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 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).
|
static ServiceMetadata |
serviceMetadata() |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static S3OutpostsClient create()
S3OutpostsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static S3OutpostsClientBuilder builder()
S3OutpostsClient.default CreateEndpointResponse createEndpoint(CreateEndpointRequest createEndpointRequest) throws InternalServerException, ValidationException, AccessDeniedException, ResourceNotFoundException, ConflictException, 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:
createEndpointRequest - 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.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.AwsServiceExceptiondefault CreateEndpointResponse createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest) throws InternalServerException, ValidationException, AccessDeniedException, ResourceNotFoundException, ConflictException, 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:
This is a convenience which creates an instance of the CreateEndpointRequest.Builder avoiding the need to
create one manually via CreateEndpointRequest.builder()
createEndpointRequest - A Consumer that will call methods on CreateEndpointRequest.Builder to create a request.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.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.AwsServiceExceptiondefault DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws InternalServerException, AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, S3OutpostsException
Deletes an endpoint.
It can take up to 5 minutes for this action to finish.
Related actions include:
deleteEndpointRequest - 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.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.AwsServiceExceptiondefault DeleteEndpointResponse deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) throws InternalServerException, AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, S3OutpostsException
Deletes an endpoint.
It can take up to 5 minutes for this action to finish.
Related actions include:
This is a convenience which creates an instance of the DeleteEndpointRequest.Builder avoiding the need to
create one manually via DeleteEndpointRequest.builder()
deleteEndpointRequest - A Consumer that will call methods on DeleteEndpointRequest.Builder to create a request.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.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.AwsServiceExceptiondefault ListEndpointsResponse listEndpoints(ListEndpointsRequest listEndpointsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, S3OutpostsException
Lists endpoints associated with the specified Outpost.
Related actions include:
listEndpointsRequest - 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.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.AwsServiceExceptiondefault ListEndpointsResponse listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, S3OutpostsException
Lists endpoints associated with the specified Outpost.
Related actions include:
This is a convenience which creates an instance of the ListEndpointsRequest.Builder avoiding the need to
create one manually via ListEndpointsRequest.builder()
listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.Builder to create a request.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.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.AwsServiceExceptiondefault ListEndpointsIterable listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, S3OutpostsException
Lists endpoints associated with the specified Outpost.
Related actions include:
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.
listEndpointsRequest - 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.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.AwsServiceExceptiondefault ListEndpointsIterable listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, S3OutpostsException
Lists endpoints associated with the specified Outpost.
Related actions include:
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()
listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.Builder to create a request.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.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.AwsServiceExceptiondefault ListSharedEndpointsResponse listSharedEndpoints(ListSharedEndpointsRequest listSharedEndpointsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, 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:
listSharedEndpointsRequest - 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.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.AwsServiceExceptiondefault ListSharedEndpointsResponse listSharedEndpoints(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, 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:
This is a convenience which creates an instance of the ListSharedEndpointsRequest.Builder avoiding the
need to create one manually via ListSharedEndpointsRequest.builder()
listSharedEndpointsRequest - A Consumer that will call methods on ListSharedEndpointsRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault ListSharedEndpointsIterable listSharedEndpointsPaginator(ListSharedEndpointsRequest listSharedEndpointsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, 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:
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.
listSharedEndpointsRequest - 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.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.AwsServiceExceptiondefault ListSharedEndpointsIterable listSharedEndpointsPaginator(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, 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:
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()
listSharedEndpointsRequest - A Consumer that will call methods on ListSharedEndpointsRequest.Builder to create a
request.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.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.