Interface S3OutpostsClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
Amazon S3 on Outposts provides access to S3 on Outposts operations.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic S3OutpostsClientBuilderbuilder()Create a builder that can be used to configure and create aS3OutpostsClient.static S3OutpostsClientcreate()Create aS3OutpostsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateEndpointResponsecreateEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest) Creates an endpoint and associates it with the specified Outpost.default CreateEndpointResponsecreateEndpoint(CreateEndpointRequest createEndpointRequest) Creates an endpoint and associates it with the specified Outpost.default DeleteEndpointResponsedeleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) Deletes an endpoint.default DeleteEndpointResponsedeleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) Deletes an endpoint.default ListEndpointsResponselistEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) Lists endpoints associated with the specified Outpost.default ListEndpointsResponselistEndpoints(ListEndpointsRequest listEndpointsRequest) Lists endpoints associated with the specified Outpost.default ListEndpointsIterablelistEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) This is a variant oflistEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest)operation.default ListEndpointsIterablelistEndpointsPaginator(ListEndpointsRequest listEndpointsRequest) This is a variant oflistEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest)operation.default ListOutpostsWithS3ResponselistOutpostsWithS3(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request) Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.default ListOutpostsWithS3ResponselistOutpostsWithS3(ListOutpostsWithS3Request listOutpostsWithS3Request) Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.default ListOutpostsWithS3IterablelistOutpostsWithS3Paginator(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request) This is a variant oflistOutpostsWithS3(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Request)operation.default ListOutpostsWithS3IterablelistOutpostsWithS3Paginator(ListOutpostsWithS3Request listOutpostsWithS3Request) This is a variant oflistOutpostsWithS3(software.amazon.awssdk.services.s3outposts.model.ListOutpostsWithS3Request)operation.default ListSharedEndpointsResponselistSharedEndpoints(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest) Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).default ListSharedEndpointsResponselistSharedEndpoints(ListSharedEndpointsRequest listSharedEndpointsRequest) Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).default ListSharedEndpointsIterablelistSharedEndpointsPaginator(Consumer<ListSharedEndpointsRequest.Builder> listSharedEndpointsRequest) This is a variant oflistSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest)operation.default ListSharedEndpointsIterablelistSharedEndpointsPaginator(ListSharedEndpointsRequest listSharedEndpointsRequest) This is a variant oflistSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadataMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
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:
- Parameters:
createEndpointRequest-- Returns:
- Result of the CreateEndpoint operation returned by the service.
- See Also:
-
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:
This is a convenience which creates an instance of the
CreateEndpointRequest.Builderavoiding the need to create one manually viaCreateEndpointRequest.builder()- Parameters:
createEndpointRequest- AConsumerthat will call methods onCreateEndpointRequest.Builderto create a request.- Returns:
- Result of the CreateEndpoint operation returned by the service.
- See Also:
-
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:
- Parameters:
deleteEndpointRequest-- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- See Also:
-
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:
This is a convenience which creates an instance of the
DeleteEndpointRequest.Builderavoiding the need to create one manually viaDeleteEndpointRequest.builder()- Parameters:
deleteEndpointRequest- AConsumerthat will call methods onDeleteEndpointRequest.Builderto create a request.- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- See Also:
-
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:
- Parameters:
listEndpointsRequest-- Returns:
- Result of the ListEndpoints operation returned by the service.
- See Also:
-
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:
This is a convenience which creates an instance of the
ListEndpointsRequest.Builderavoiding the need to create one manually viaListEndpointsRequest.builder()- Parameters:
listEndpointsRequest- AConsumerthat will call methods onListEndpointsRequest.Builderto create a request.- Returns:
- Result of the ListEndpoints operation returned by the service.
- See Also:
-
listEndpointsPaginator
default ListEndpointsIterable listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, S3OutpostsException 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
2) Using For loopsoftware.amazon.awssdk.services.s3outposts.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- See Also:
-
listEndpointsPaginator
default ListEndpointsIterable listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws InternalServerException, ResourceNotFoundException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, S3OutpostsException 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
2) Using For loopsoftware.amazon.awssdk.services.s3outposts.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListEndpointsRequest.builder()- Parameters:
listEndpointsRequest- AConsumerthat will call methods onListEndpointsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builderavoiding the need to create one manually viaListOutpostsWithS3Request.builder()- Parameters:
listOutpostsWithS3Request- AConsumerthat will call methods onListOutpostsWithS3Request.Builderto create a request.- Returns:
- Result of the ListOutpostsWithS3 operation returned by the service.
- See Also:
-
listOutpostsWithS3Paginator
default ListOutpostsWithS3Iterable listOutpostsWithS3Paginator(ListOutpostsWithS3Request listOutpostsWithS3Request) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, S3OutpostsException 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
2) Using For loopsoftware.amazon.awssdk.services.s3outposts.paginators.ListOutpostsWithS3Iterable responses = client.listOutpostsWithS3Paginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- See Also:
-
listOutpostsWithS3Paginator
default ListOutpostsWithS3Iterable listOutpostsWithS3Paginator(Consumer<ListOutpostsWithS3Request.Builder> listOutpostsWithS3Request) throws InternalServerException, AccessDeniedException, ValidationException, ThrottlingException, AwsServiceException, SdkClientException, S3OutpostsException 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
2) Using For loopsoftware.amazon.awssdk.services.s3outposts.paginators.ListOutpostsWithS3Iterable responses = client.listOutpostsWithS3Paginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListOutpostsWithS3Request.builder()- Parameters:
listOutpostsWithS3Request- AConsumerthat will call methods onListOutpostsWithS3Request.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
create
Create aS3OutpostsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aS3OutpostsClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-