Interface GlacierAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Amazon S3 Glacier (Glacier) is a storage solution for "cold data."
Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Glacier, customers can store their data cost effectively for months, years, or decades. Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.
Glacier is a great storage choice when low storage cost is paramount and your data is rarely retrieved. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see Amazon Simple Storage Service (Amazon S3).
You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Glacier.
If you are a first-time user of Glacier, we recommend that you begin by reading the following sections in the Amazon S3 Glacier Developer Guide:
-
What is Amazon S3 Glacier - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.
-
Getting Started with Amazon S3 Glacier - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionabortMultipartUpload
(Consumer<AbortMultipartUploadRequest.Builder> abortMultipartUploadRequest) This operation aborts a multipart upload identified by the upload ID.abortMultipartUpload
(AbortMultipartUploadRequest abortMultipartUploadRequest) This operation aborts a multipart upload identified by the upload ID.default CompletableFuture
<AbortVaultLockResponse> abortVaultLock
(Consumer<AbortVaultLockRequest.Builder> abortVaultLockRequest) This operation aborts the vault locking process if the vault lock is not in theLocked
state.default CompletableFuture
<AbortVaultLockResponse> abortVaultLock
(AbortVaultLockRequest abortVaultLockRequest) This operation aborts the vault locking process if the vault lock is not in theLocked
state.default CompletableFuture
<AddTagsToVaultResponse> addTagsToVault
(Consumer<AddTagsToVaultRequest.Builder> addTagsToVaultRequest) This operation adds the specified tags to a vault.default CompletableFuture
<AddTagsToVaultResponse> addTagsToVault
(AddTagsToVaultRequest addTagsToVaultRequest) This operation adds the specified tags to a vault.static GlacierAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aGlacierAsyncClient
.completeMultipartUpload
(Consumer<CompleteMultipartUploadRequest.Builder> completeMultipartUploadRequest) You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts.completeMultipartUpload
(CompleteMultipartUploadRequest completeMultipartUploadRequest) You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts.completeVaultLock
(Consumer<CompleteVaultLockRequest.Builder> completeVaultLockRequest) This operation completes the vault locking process by transitioning the vault lock from theInProgress
state to theLocked
state, which causes the vault lock policy to become unchangeable.completeVaultLock
(CompleteVaultLockRequest completeVaultLockRequest) This operation completes the vault locking process by transitioning the vault lock from theInProgress
state to theLocked
state, which causes the vault lock policy to become unchangeable.static GlacierAsyncClient
create()
Create aGlacierAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateVaultResponse> createVault
(Consumer<CreateVaultRequest.Builder> createVaultRequest) This operation creates a new vault with the specified name.default CompletableFuture
<CreateVaultResponse> createVault
(CreateVaultRequest createVaultRequest) This operation creates a new vault with the specified name.default CompletableFuture
<DeleteArchiveResponse> deleteArchive
(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest) This operation deletes an archive from a vault.default CompletableFuture
<DeleteArchiveResponse> deleteArchive
(DeleteArchiveRequest deleteArchiveRequest) This operation deletes an archive from a vault.default CompletableFuture
<DeleteVaultResponse> deleteVault
(Consumer<DeleteVaultRequest.Builder> deleteVaultRequest) This operation deletes a vault.default CompletableFuture
<DeleteVaultResponse> deleteVault
(DeleteVaultRequest deleteVaultRequest) This operation deletes a vault.deleteVaultAccessPolicy
(Consumer<DeleteVaultAccessPolicyRequest.Builder> deleteVaultAccessPolicyRequest) This operation deletes the access policy associated with the specified vault.deleteVaultAccessPolicy
(DeleteVaultAccessPolicyRequest deleteVaultAccessPolicyRequest) This operation deletes the access policy associated with the specified vault.deleteVaultNotifications
(Consumer<DeleteVaultNotificationsRequest.Builder> deleteVaultNotificationsRequest) This operation deletes the notification configuration set for a vault.deleteVaultNotifications
(DeleteVaultNotificationsRequest deleteVaultNotificationsRequest) This operation deletes the notification configuration set for a vault.default CompletableFuture
<DescribeJobResponse> describeJob
(Consumer<DescribeJobRequest.Builder> describeJobRequest) This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job.default CompletableFuture
<DescribeJobResponse> describeJob
(DescribeJobRequest describeJobRequest) This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job.default CompletableFuture
<DescribeVaultResponse> describeVault
(Consumer<DescribeVaultRequest.Builder> describeVaultRequest) This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault.default CompletableFuture
<DescribeVaultResponse> describeVault
(DescribeVaultRequest describeVaultRequest) This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault.This operation returns the current data retrieval policy for the account and region specified in the GET request.getDataRetrievalPolicy
(Consumer<GetDataRetrievalPolicyRequest.Builder> getDataRetrievalPolicyRequest) This operation returns the current data retrieval policy for the account and region specified in the GET request.getDataRetrievalPolicy
(GetDataRetrievalPolicyRequest getDataRetrievalPolicyRequest) This operation returns the current data retrieval policy for the account and region specified in the GET request.default CompletableFuture
<GetJobOutputResponse> getJobOutput
(Consumer<GetJobOutputRequest.Builder> getJobOutputRequest, Path destinationPath) This operation downloads the output of the job you initiated using InitiateJob.default <ReturnT> CompletableFuture
<ReturnT> getJobOutput
(Consumer<GetJobOutputRequest.Builder> getJobOutputRequest, AsyncResponseTransformer<GetJobOutputResponse, ReturnT> asyncResponseTransformer) This operation downloads the output of the job you initiated using InitiateJob.default CompletableFuture
<GetJobOutputResponse> getJobOutput
(GetJobOutputRequest getJobOutputRequest, Path destinationPath) This operation downloads the output of the job you initiated using InitiateJob.default <ReturnT> CompletableFuture
<ReturnT> getJobOutput
(GetJobOutputRequest getJobOutputRequest, AsyncResponseTransformer<GetJobOutputResponse, ReturnT> asyncResponseTransformer) This operation downloads the output of the job you initiated using InitiateJob.getVaultAccessPolicy
(Consumer<GetVaultAccessPolicyRequest.Builder> getVaultAccessPolicyRequest) This operation retrieves theaccess-policy
subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy).getVaultAccessPolicy
(GetVaultAccessPolicyRequest getVaultAccessPolicyRequest) This operation retrieves theaccess-policy
subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy).default CompletableFuture
<GetVaultLockResponse> getVaultLock
(Consumer<GetVaultLockRequest.Builder> getVaultLockRequest) This operation retrieves the following attributes from thelock-policy
subresource set on the specified vault:default CompletableFuture
<GetVaultLockResponse> getVaultLock
(GetVaultLockRequest getVaultLockRequest) This operation retrieves the following attributes from thelock-policy
subresource set on the specified vault:getVaultNotifications
(Consumer<GetVaultNotificationsRequest.Builder> getVaultNotificationsRequest) This operation retrieves thenotification-configuration
subresource of the specified vault.getVaultNotifications
(GetVaultNotificationsRequest getVaultNotificationsRequest) This operation retrieves thenotification-configuration
subresource of the specified vault.default CompletableFuture
<InitiateJobResponse> initiateJob
(Consumer<InitiateJobRequest.Builder> initiateJobRequest) This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval.default CompletableFuture
<InitiateJobResponse> initiateJob
(InitiateJobRequest initiateJobRequest) This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval.initiateMultipartUpload
(Consumer<InitiateMultipartUploadRequest.Builder> initiateMultipartUploadRequest) This operation initiates a multipart upload.initiateMultipartUpload
(InitiateMultipartUploadRequest initiateMultipartUploadRequest) This operation initiates a multipart upload.initiateVaultLock
(Consumer<InitiateVaultLockRequest.Builder> initiateVaultLockRequest) This operation initiates the vault locking process by doing the following:initiateVaultLock
(InitiateVaultLockRequest initiateVaultLockRequest) This operation initiates the vault locking process by doing the following:default CompletableFuture
<ListJobsResponse> listJobs
(Consumer<ListJobsRequest.Builder> listJobsRequest) This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.default CompletableFuture
<ListJobsResponse> listJobs
(ListJobsRequest listJobsRequest) This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.default ListJobsPublisher
listJobsPaginator
(Consumer<ListJobsRequest.Builder> listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.glacier.model.ListJobsRequest)
operation.default ListJobsPublisher
listJobsPaginator
(ListJobsRequest listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.glacier.model.ListJobsRequest)
operation.listMultipartUploads
(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest) This operation lists in-progress multipart uploads for the specified vault.listMultipartUploads
(ListMultipartUploadsRequest listMultipartUploadsRequest) This operation lists in-progress multipart uploads for the specified vault.default ListMultipartUploadsPublisher
listMultipartUploadsPaginator
(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest) This is a variant oflistMultipartUploads(software.amazon.awssdk.services.glacier.model.ListMultipartUploadsRequest)
operation.default ListMultipartUploadsPublisher
listMultipartUploadsPaginator
(ListMultipartUploadsRequest listMultipartUploadsRequest) This is a variant oflistMultipartUploads(software.amazon.awssdk.services.glacier.model.ListMultipartUploadsRequest)
operation.default CompletableFuture
<ListPartsResponse> listParts
(Consumer<ListPartsRequest.Builder> listPartsRequest) This operation lists the parts of an archive that have been uploaded in a specific multipart upload.default CompletableFuture
<ListPartsResponse> listParts
(ListPartsRequest listPartsRequest) This operation lists the parts of an archive that have been uploaded in a specific multipart upload.default ListPartsPublisher
listPartsPaginator
(Consumer<ListPartsRequest.Builder> listPartsRequest) This is a variant oflistParts(software.amazon.awssdk.services.glacier.model.ListPartsRequest)
operation.default ListPartsPublisher
listPartsPaginator
(ListPartsRequest listPartsRequest) This is a variant oflistParts(software.amazon.awssdk.services.glacier.model.ListPartsRequest)
operation.This operation lists the provisioned capacity units for the specified AWS account.listProvisionedCapacity
(Consumer<ListProvisionedCapacityRequest.Builder> listProvisionedCapacityRequest) This operation lists the provisioned capacity units for the specified AWS account.listProvisionedCapacity
(ListProvisionedCapacityRequest listProvisionedCapacityRequest) This operation lists the provisioned capacity units for the specified AWS account.listTagsForVault
(Consumer<ListTagsForVaultRequest.Builder> listTagsForVaultRequest) This operation lists all the tags attached to a vault.listTagsForVault
(ListTagsForVaultRequest listTagsForVaultRequest) This operation lists all the tags attached to a vault.default CompletableFuture
<ListVaultsResponse> This operation lists all vaults owned by the calling user's account.default CompletableFuture
<ListVaultsResponse> listVaults
(Consumer<ListVaultsRequest.Builder> listVaultsRequest) This operation lists all vaults owned by the calling user's account.default CompletableFuture
<ListVaultsResponse> listVaults
(ListVaultsRequest listVaultsRequest) This operation lists all vaults owned by the calling user's account.default ListVaultsPublisher
This is a variant oflistVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest)
operation.default ListVaultsPublisher
listVaultsPaginator
(Consumer<ListVaultsRequest.Builder> listVaultsRequest) This is a variant oflistVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest)
operation.default ListVaultsPublisher
listVaultsPaginator
(ListVaultsRequest listVaultsRequest) This is a variant oflistVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest)
operation.This operation purchases a provisioned capacity unit for an AWS account.purchaseProvisionedCapacity
(Consumer<PurchaseProvisionedCapacityRequest.Builder> purchaseProvisionedCapacityRequest) This operation purchases a provisioned capacity unit for an AWS account.purchaseProvisionedCapacity
(PurchaseProvisionedCapacityRequest purchaseProvisionedCapacityRequest) This operation purchases a provisioned capacity unit for an AWS account.removeTagsFromVault
(Consumer<RemoveTagsFromVaultRequest.Builder> removeTagsFromVaultRequest) This operation removes one or more tags from the set of tags attached to a vault.removeTagsFromVault
(RemoveTagsFromVaultRequest removeTagsFromVaultRequest) This operation removes one or more tags from the set of tags attached to a vault.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationsetDataRetrievalPolicy
(Consumer<SetDataRetrievalPolicyRequest.Builder> setDataRetrievalPolicyRequest) This operation sets and then enacts a data retrieval policy in the region specified in the PUT request.setDataRetrievalPolicy
(SetDataRetrievalPolicyRequest setDataRetrievalPolicyRequest) This operation sets and then enacts a data retrieval policy in the region specified in the PUT request.setVaultAccessPolicy
(Consumer<SetVaultAccessPolicyRequest.Builder> setVaultAccessPolicyRequest) This operation configures an access policy for a vault and will overwrite an existing policy.setVaultAccessPolicy
(SetVaultAccessPolicyRequest setVaultAccessPolicyRequest) This operation configures an access policy for a vault and will overwrite an existing policy.setVaultNotifications
(Consumer<SetVaultNotificationsRequest.Builder> setVaultNotificationsRequest) This operation configures notifications that will be sent when specific events happen to a vault.setVaultNotifications
(SetVaultNotificationsRequest setVaultNotificationsRequest) This operation configures notifications that will be sent when specific events happen to a vault.default CompletableFuture
<UploadArchiveResponse> uploadArchive
(Consumer<UploadArchiveRequest.Builder> uploadArchiveRequest, Path sourcePath) This operation adds an archive to a vault.default CompletableFuture
<UploadArchiveResponse> uploadArchive
(Consumer<UploadArchiveRequest.Builder> uploadArchiveRequest, AsyncRequestBody requestBody) This operation adds an archive to a vault.default CompletableFuture
<UploadArchiveResponse> uploadArchive
(UploadArchiveRequest uploadArchiveRequest, Path sourcePath) This operation adds an archive to a vault.default CompletableFuture
<UploadArchiveResponse> uploadArchive
(UploadArchiveRequest uploadArchiveRequest, AsyncRequestBody requestBody) This operation adds an archive to a vault.uploadMultipartPart
(Consumer<UploadMultipartPartRequest.Builder> uploadMultipartPartRequest, Path sourcePath) This operation uploads a part of an archive.uploadMultipartPart
(Consumer<UploadMultipartPartRequest.Builder> uploadMultipartPartRequest, AsyncRequestBody requestBody) This operation uploads a part of an archive.uploadMultipartPart
(UploadMultipartPartRequest uploadMultipartPartRequest, Path sourcePath) This operation uploads a part of an archive.uploadMultipartPart
(UploadMultipartPartRequest uploadMultipartPartRequest, AsyncRequestBody requestBody) This operation uploads a part of an archive.default GlacierAsyncWaiter
waiter()
Create an instance ofGlacierAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods 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
-
abortMultipartUpload
default CompletableFuture<AbortMultipartUploadResponse> abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest) This operation aborts a multipart upload identified by the upload ID.
After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Working with Archives in Amazon S3 Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide.
- Parameters:
abortMultipartUploadRequest
- Provides options to abort a multipart upload identified by the upload ID.For information about the underlying REST API, see Abort Multipart Upload. For conceptual information, see Working with Archives in Amazon S3 Glacier.
- Returns:
- A Java Future containing the result of the AbortMultipartUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
abortMultipartUpload
default CompletableFuture<AbortMultipartUploadResponse> abortMultipartUpload(Consumer<AbortMultipartUploadRequest.Builder> abortMultipartUploadRequest) This operation aborts a multipart upload identified by the upload ID.
After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Working with Archives in Amazon S3 Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
AbortMultipartUploadRequest.Builder
avoiding the need to create one manually viaAbortMultipartUploadRequest.builder()
- Parameters:
abortMultipartUploadRequest
- AConsumer
that will call methods onAbortMultipartUploadRequest.Builder
to create a request. Provides options to abort a multipart upload identified by the upload ID.For information about the underlying REST API, see Abort Multipart Upload. For conceptual information, see Working with Archives in Amazon S3 Glacier.
- Returns:
- A Java Future containing the result of the AbortMultipartUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
abortVaultLock
default CompletableFuture<AbortVaultLockResponse> abortVaultLock(AbortVaultLockRequest abortVaultLockRequest) This operation aborts the vault locking process if the vault lock is not in the
Locked
state. If the vault lock is in theLocked
state when this operation is requested, the operation returns anAccessDeniedException
error. Aborting the vault locking process removes the vault lock policy from the specified vault.A vault lock is put into the
InProgress
state by calling InitiateVaultLock. A vault lock is put into theLocked
state by calling CompleteVaultLock. You can get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the
InProgress
state or if there is no policy associated with the vault.- Parameters:
abortVaultLockRequest
- The input values forAbortVaultLock
.- Returns:
- A Java Future containing the result of the AbortVaultLock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
abortVaultLock
default CompletableFuture<AbortVaultLockResponse> abortVaultLock(Consumer<AbortVaultLockRequest.Builder> abortVaultLockRequest) This operation aborts the vault locking process if the vault lock is not in the
Locked
state. If the vault lock is in theLocked
state when this operation is requested, the operation returns anAccessDeniedException
error. Aborting the vault locking process removes the vault lock policy from the specified vault.A vault lock is put into the
InProgress
state by calling InitiateVaultLock. A vault lock is put into theLocked
state by calling CompleteVaultLock. You can get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the
InProgress
state or if there is no policy associated with the vault.
This is a convenience which creates an instance of the
AbortVaultLockRequest.Builder
avoiding the need to create one manually viaAbortVaultLockRequest.builder()
- Parameters:
abortVaultLockRequest
- AConsumer
that will call methods onAbortVaultLockRequest.Builder
to create a request. The input values forAbortVaultLock
.- Returns:
- A Java Future containing the result of the AbortVaultLock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
addTagsToVault
default CompletableFuture<AddTagsToVaultResponse> addTagsToVault(AddTagsToVaultRequest addTagsToVaultRequest) This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the
LimitExceededException
error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon S3 Glacier Resources.- Parameters:
addTagsToVaultRequest
- The input values forAddTagsToVault
.- Returns:
- A Java Future containing the result of the AddTagsToVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- LimitExceededException Returned if the request results in a vault or account limit being exceeded.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
addTagsToVault
default CompletableFuture<AddTagsToVaultResponse> addTagsToVault(Consumer<AddTagsToVaultRequest.Builder> addTagsToVaultRequest) This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the
LimitExceededException
error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon S3 Glacier Resources.
This is a convenience which creates an instance of the
AddTagsToVaultRequest.Builder
avoiding the need to create one manually viaAddTagsToVaultRequest.builder()
- Parameters:
addTagsToVaultRequest
- AConsumer
that will call methods onAddTagsToVaultRequest.Builder
to create a request. The input values forAddTagsToVault
.- Returns:
- A Java Future containing the result of the AddTagsToVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- LimitExceededException Returned if the request results in a vault or account limit being exceeded.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
completeMultipartUpload
default CompletableFuture<CompleteMultipartUploadResponse> completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest) You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.
Additionally, Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Glacier returns an error and the operation fails.
Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide.
- Parameters:
completeMultipartUploadRequest
- Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon S3 Glacier (Glacier) can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource.- Returns:
- A Java Future containing the result of the CompleteMultipartUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
completeMultipartUpload
default CompletableFuture<CompleteMultipartUploadResponse> completeMultipartUpload(Consumer<CompleteMultipartUploadRequest.Builder> completeMultipartUploadRequest) You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.
Additionally, Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Glacier returns an error and the operation fails.
Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
CompleteMultipartUploadRequest.Builder
avoiding the need to create one manually viaCompleteMultipartUploadRequest.builder()
- Parameters:
completeMultipartUploadRequest
- AConsumer
that will call methods onCompleteMultipartUploadRequest.Builder
to create a request. Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon S3 Glacier (Glacier) can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource.- Returns:
- A Java Future containing the result of the CompleteMultipartUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
completeVaultLock
default CompletableFuture<CompleteVaultLockResponse> completeVaultLock(CompleteVaultLockRequest completeVaultLockRequest) This operation completes the vault locking process by transitioning the vault lock from the
InProgress
state to theLocked
state, which causes the vault lock policy to become unchangeable. A vault lock is put into theInProgress
state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.This operation is idempotent. This request is always successful if the vault lock is in the
Locked
state and the provided lock ID matches the lock ID originally used to lock the vault.If an invalid lock ID is passed in the request when the vault lock is in the
Locked
state, the operation returns anAccessDeniedException
error. If an invalid lock ID is passed in the request when the vault lock is in theInProgress
state, the operation throws anInvalidParameter
error.- Parameters:
completeVaultLockRequest
- The input values forCompleteVaultLock
.- Returns:
- A Java Future containing the result of the CompleteVaultLock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
completeVaultLock
default CompletableFuture<CompleteVaultLockResponse> completeVaultLock(Consumer<CompleteVaultLockRequest.Builder> completeVaultLockRequest) This operation completes the vault locking process by transitioning the vault lock from the
InProgress
state to theLocked
state, which causes the vault lock policy to become unchangeable. A vault lock is put into theInProgress
state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.This operation is idempotent. This request is always successful if the vault lock is in the
Locked
state and the provided lock ID matches the lock ID originally used to lock the vault.If an invalid lock ID is passed in the request when the vault lock is in the
Locked
state, the operation returns anAccessDeniedException
error. If an invalid lock ID is passed in the request when the vault lock is in theInProgress
state, the operation throws anInvalidParameter
error.
This is a convenience which creates an instance of the
CompleteVaultLockRequest.Builder
avoiding the need to create one manually viaCompleteVaultLockRequest.builder()
- Parameters:
completeVaultLockRequest
- AConsumer
that will call methods onCompleteVaultLockRequest.Builder
to create a request. The input values forCompleteVaultLock
.- Returns:
- A Java Future containing the result of the CompleteVaultLock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createVault
This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon S3 Glacier.
You must use the following guidelines when naming a vault.
-
Names can be between 1 and 255 characters long.
-
Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide.
- Parameters:
createVaultRequest
- Provides options to create a vault.- Returns:
- A Java Future containing the result of the CreateVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- LimitExceededException Returned if the request results in a vault or account limit being exceeded.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
createVault
default CompletableFuture<CreateVaultResponse> createVault(Consumer<CreateVaultRequest.Builder> createVaultRequest) This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon S3 Glacier.
You must use the following guidelines when naming a vault.
-
Names can be between 1 and 255 characters long.
-
Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
CreateVaultRequest.Builder
avoiding the need to create one manually viaCreateVaultRequest.builder()
- Parameters:
createVaultRequest
- AConsumer
that will call methods onCreateVaultRequest.Builder
to create a request. Provides options to create a vault.- Returns:
- A Java Future containing the result of the CreateVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- LimitExceededException Returned if the request results in a vault or account limit being exceeded.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
deleteArchive
default CompletableFuture<DeleteArchiveResponse> deleteArchive(DeleteArchiveRequest deleteArchiveRequest) This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:
-
If the archive retrieval job is actively preparing the data for download when Amazon S3 Glacier receives the delete archive request, the archival retrieval operation might fail.
-
If the archive retrieval job has successfully prepared the archive for download when Amazon S3 Glacier receives the delete archive request, you will be able to download the output.
This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide.
- Parameters:
deleteArchiveRequest
- Provides options for deleting an archive from an Amazon S3 Glacier vault.- Returns:
- A Java Future containing the result of the DeleteArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
deleteArchive
default CompletableFuture<DeleteArchiveResponse> deleteArchive(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest) This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:
-
If the archive retrieval job is actively preparing the data for download when Amazon S3 Glacier receives the delete archive request, the archival retrieval operation might fail.
-
If the archive retrieval job has successfully prepared the archive for download when Amazon S3 Glacier receives the delete archive request, you will be able to download the output.
This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
DeleteArchiveRequest.Builder
avoiding the need to create one manually viaDeleteArchiveRequest.builder()
- Parameters:
deleteArchiveRequest
- AConsumer
that will call methods onDeleteArchiveRequest.Builder
to create a request. Provides options for deleting an archive from an Amazon S3 Glacier vault.- Returns:
- A Java Future containing the result of the DeleteArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
deleteVault
This operation deletes a vault. Amazon S3 Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon S3 Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive).
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon S3 Glacier Developer Guide.
- Parameters:
deleteVaultRequest
- Provides options for deleting a vault from Amazon S3 Glacier.- Returns:
- A Java Future containing the result of the DeleteVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteVault
default CompletableFuture<DeleteVaultResponse> deleteVault(Consumer<DeleteVaultRequest.Builder> deleteVaultRequest) This operation deletes a vault. Amazon S3 Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon S3 Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive).
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon S3 Glacier Developer Guide.
This is a convenience which creates an instance of the
DeleteVaultRequest.Builder
avoiding the need to create one manually viaDeleteVaultRequest.builder()
- Parameters:
deleteVaultRequest
- AConsumer
that will call methods onDeleteVaultRequest.Builder
to create a request. Provides options for deleting a vault from Amazon S3 Glacier.- Returns:
- A Java Future containing the result of the DeleteVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteVaultAccessPolicy
default CompletableFuture<DeleteVaultAccessPolicyResponse> deleteVaultAccessPolicy(DeleteVaultAccessPolicyRequest deleteVaultAccessPolicyRequest) This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request.
This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.
- Parameters:
deleteVaultAccessPolicyRequest
- DeleteVaultAccessPolicy input.- Returns:
- A Java Future containing the result of the DeleteVaultAccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteVaultAccessPolicy
default CompletableFuture<DeleteVaultAccessPolicyResponse> deleteVaultAccessPolicy(Consumer<DeleteVaultAccessPolicyRequest.Builder> deleteVaultAccessPolicyRequest) This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request.
This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.
This is a convenience which creates an instance of the
DeleteVaultAccessPolicyRequest.Builder
avoiding the need to create one manually viaDeleteVaultAccessPolicyRequest.builder()
- Parameters:
deleteVaultAccessPolicyRequest
- AConsumer
that will call methods onDeleteVaultAccessPolicyRequest.Builder
to create a request. DeleteVaultAccessPolicy input.- Returns:
- A Java Future containing the result of the DeleteVaultAccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteVaultNotifications
default CompletableFuture<DeleteVaultNotificationsResponse> deleteVaultNotifications(DeleteVaultNotificationsRequest deleteVaultNotificationsRequest) This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Delete Vault Notification Configuration in the Amazon S3 Glacier Developer Guide.
- Parameters:
deleteVaultNotificationsRequest
- Provides options for deleting a vault notification configuration from an Amazon Glacier vault.- Returns:
- A Java Future containing the result of the DeleteVaultNotifications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteVaultNotifications
default CompletableFuture<DeleteVaultNotificationsResponse> deleteVaultNotifications(Consumer<DeleteVaultNotificationsRequest.Builder> deleteVaultNotificationsRequest) This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Delete Vault Notification Configuration in the Amazon S3 Glacier Developer Guide.
This is a convenience which creates an instance of the
DeleteVaultNotificationsRequest.Builder
avoiding the need to create one manually viaDeleteVaultNotificationsRequest.builder()
- Parameters:
deleteVaultNotificationsRequest
- AConsumer
that will call methods onDeleteVaultNotificationsRequest.Builder
to create a request. Provides options for deleting a vault notification configuration from an Amazon Glacier vault.- Returns:
- A Java Future containing the result of the DeleteVaultNotifications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeJob
This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job. For more information about initiating a job, see InitiateJob.
This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Glacier can notify the topic after it completes the job.
A job ID will not expire for at least 24 hours after Glacier completes the job.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For more information about using this operation, see the documentation for the underlying REST API Describe Job in the Amazon Glacier Developer Guide.
- Parameters:
describeJobRequest
- Provides options for retrieving a job description.- Returns:
- A Java Future containing the result of the DescribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeJob
default CompletableFuture<DescribeJobResponse> describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest) This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job. For more information about initiating a job, see InitiateJob.
This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Glacier can notify the topic after it completes the job.
A job ID will not expire for at least 24 hours after Glacier completes the job.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For more information about using this operation, see the documentation for the underlying REST API Describe Job in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
DescribeJobRequest.Builder
avoiding the need to create one manually viaDescribeJobRequest.builder()
- Parameters:
describeJobRequest
- AConsumer
that will call methods onDescribeJobRequest.Builder
to create a request. Provides options for retrieving a job description.- Returns:
- A Java Future containing the result of the DescribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeVault
default CompletableFuture<DescribeVaultResponse> describeVault(DescribeVaultRequest describeVaultRequest) This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob. Amazon S3 Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon S3 Glacier.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier and Describe Vault in the Amazon Glacier Developer Guide.
- Parameters:
describeVaultRequest
- Provides options for retrieving metadata for a specific vault in Amazon Glacier.- Returns:
- A Java Future containing the result of the DescribeVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeVault
default CompletableFuture<DescribeVaultResponse> describeVault(Consumer<DescribeVaultRequest.Builder> describeVaultRequest) This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob. Amazon S3 Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon S3 Glacier.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier and Describe Vault in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
DescribeVaultRequest.Builder
avoiding the need to create one manually viaDescribeVaultRequest.builder()
- Parameters:
describeVaultRequest
- AConsumer
that will call methods onDescribeVaultRequest.Builder
to create a request. Provides options for retrieving metadata for a specific vault in Amazon Glacier.- Returns:
- A Java Future containing the result of the DescribeVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getDataRetrievalPolicy
default CompletableFuture<GetDataRetrievalPolicyResponse> getDataRetrievalPolicy(GetDataRetrievalPolicyRequest getDataRetrievalPolicyRequest) This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.
- Parameters:
getDataRetrievalPolicyRequest
- Input for GetDataRetrievalPolicy.- Returns:
- A Java Future containing the result of the GetDataRetrievalPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getDataRetrievalPolicy
default CompletableFuture<GetDataRetrievalPolicyResponse> getDataRetrievalPolicy(Consumer<GetDataRetrievalPolicyRequest.Builder> getDataRetrievalPolicyRequest) This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.
This is a convenience which creates an instance of the
GetDataRetrievalPolicyRequest.Builder
avoiding the need to create one manually viaGetDataRetrievalPolicyRequest.builder()
- Parameters:
getDataRetrievalPolicyRequest
- AConsumer
that will call methods onGetDataRetrievalPolicyRequest.Builder
to create a request. Input for GetDataRetrievalPolicy.- Returns:
- A Java Future containing the result of the GetDataRetrievalPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getDataRetrievalPolicy
This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.
- Returns:
- A Java Future containing the result of the GetDataRetrievalPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getJobOutput
default <ReturnT> CompletableFuture<ReturnT> getJobOutput(GetJobOutputRequest getJobOutputRequest, AsyncResponseTransformer<GetJobOutputResponse, ReturnT> asyncResponseTransformer) This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.
You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.
A job ID will not expire for at least 24 hours after Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.
For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of
bytes=0-1048575
, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon S3 Glacier The expected size is also returned in the headers from the Get Job Output response.In the case of an archive retrieval job, depending on the byte range you specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.
A job ID does not expire for at least 24 hours after Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output
- Parameters:
getJobOutputRequest
- Provides options for downloading output of an Amazon S3 Glacier job.asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformer
for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The job data, either archive data or inventory data.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getJobOutput
default <ReturnT> CompletableFuture<ReturnT> getJobOutput(Consumer<GetJobOutputRequest.Builder> getJobOutputRequest, AsyncResponseTransformer<GetJobOutputResponse, ReturnT> asyncResponseTransformer) This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.
You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.
A job ID will not expire for at least 24 hours after Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.
For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of
bytes=0-1048575
, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon S3 Glacier The expected size is also returned in the headers from the Get Job Output response.In the case of an archive retrieval job, depending on the byte range you specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.
A job ID does not expire for at least 24 hours after Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output
This is a convenience which creates an instance of the
GetJobOutputRequest.Builder
avoiding the need to create one manually viaGetJobOutputRequest.builder()
- Parameters:
getJobOutputRequest
- AConsumer
that will call methods onGetJobOutputRequest.Builder
to create a request. Provides options for downloading output of an Amazon S3 Glacier job.asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformer
for details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'The job data, either archive data or inventory data.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getJobOutput
default CompletableFuture<GetJobOutputResponse> getJobOutput(GetJobOutputRequest getJobOutputRequest, Path destinationPath) This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.
You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.
A job ID will not expire for at least 24 hours after Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.
For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of
bytes=0-1048575
, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon S3 Glacier The expected size is also returned in the headers from the Get Job Output response.In the case of an archive retrieval job, depending on the byte range you specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.
A job ID does not expire for at least 24 hours after Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output
- Parameters:
getJobOutputRequest
- Provides options for downloading output of an Amazon S3 Glacier job.destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The job data, either archive data or inventory data.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getJobOutput
default CompletableFuture<GetJobOutputResponse> getJobOutput(Consumer<GetJobOutputRequest.Builder> getJobOutputRequest, Path destinationPath) This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.
You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.
A job ID will not expire for at least 24 hours after Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.
For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of
bytes=0-1048575
, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon S3 Glacier The expected size is also returned in the headers from the Get Job Output response.In the case of an archive retrieval job, depending on the byte range you specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.
A job ID does not expire for at least 24 hours after Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output
This is a convenience which creates an instance of the
GetJobOutputRequest.Builder
avoiding the need to create one manually viaGetJobOutputRequest.builder()
- Parameters:
getJobOutputRequest
- AConsumer
that will call methods onGetJobOutputRequest.Builder
to create a request. Provides options for downloading output of an Amazon S3 Glacier job.destinationPath
-Path
to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows 'The job data, either archive data or inventory data.
'.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getVaultAccessPolicy
default CompletableFuture<GetVaultAccessPolicyResponse> getVaultAccessPolicy(GetVaultAccessPolicyRequest getVaultAccessPolicyRequest) This operation retrieves the
access-policy
subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy). If there is no access policy set on the vault, the operation returns a404 Not found
error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.- Parameters:
getVaultAccessPolicyRequest
- Input for GetVaultAccessPolicy.- Returns:
- A Java Future containing the result of the GetVaultAccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getVaultAccessPolicy
default CompletableFuture<GetVaultAccessPolicyResponse> getVaultAccessPolicy(Consumer<GetVaultAccessPolicyRequest.Builder> getVaultAccessPolicyRequest) This operation retrieves the
access-policy
subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy). If there is no access policy set on the vault, the operation returns a404 Not found
error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.
This is a convenience which creates an instance of the
GetVaultAccessPolicyRequest.Builder
avoiding the need to create one manually viaGetVaultAccessPolicyRequest.builder()
- Parameters:
getVaultAccessPolicyRequest
- AConsumer
that will call methods onGetVaultAccessPolicyRequest.Builder
to create a request. Input for GetVaultAccessPolicy.- Returns:
- A Java Future containing the result of the GetVaultAccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getVaultLock
default CompletableFuture<GetVaultLockResponse> getVaultLock(GetVaultLockRequest getVaultLockRequest) This operation retrieves the following attributes from the
lock-policy
subresource set on the specified vault:-
The vault lock policy set on the vault.
-
The state of the vault lock, which is either
InProgess
orLocked
. -
When the lock ID expires. The lock ID is used to complete the vault locking process.
-
When the vault lock was initiated and put into the
InProgress
state.
A vault lock is put into the
InProgress
state by calling InitiateVaultLock. A vault lock is put into theLocked
state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.If there is no vault lock policy set on the vault, the operation returns a
404 Not found
error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies.- Parameters:
getVaultLockRequest
- The input values forGetVaultLock
.- Returns:
- A Java Future containing the result of the GetVaultLock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
getVaultLock
default CompletableFuture<GetVaultLockResponse> getVaultLock(Consumer<GetVaultLockRequest.Builder> getVaultLockRequest) This operation retrieves the following attributes from the
lock-policy
subresource set on the specified vault:-
The vault lock policy set on the vault.
-
The state of the vault lock, which is either
InProgess
orLocked
. -
When the lock ID expires. The lock ID is used to complete the vault locking process.
-
When the vault lock was initiated and put into the
InProgress
state.
A vault lock is put into the
InProgress
state by calling InitiateVaultLock. A vault lock is put into theLocked
state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.If there is no vault lock policy set on the vault, the operation returns a
404 Not found
error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies.
This is a convenience which creates an instance of the
GetVaultLockRequest.Builder
avoiding the need to create one manually viaGetVaultLockRequest.builder()
- Parameters:
getVaultLockRequest
- AConsumer
that will call methods onGetVaultLockRequest.Builder
to create a request. The input values forGetVaultLock
.- Returns:
- A Java Future containing the result of the GetVaultLock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
getVaultNotifications
default CompletableFuture<GetVaultNotificationsResponse> getVaultNotifications(GetVaultNotificationsRequest getVaultNotificationsRequest) This operation retrieves the
notification-configuration
subresource of the specified vault.For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a
404 Not Found
error. For more information about vault notifications, see Configuring Vault Notifications in Amazon S3 Glacier.An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide.
- Parameters:
getVaultNotificationsRequest
- Provides options for retrieving the notification configuration set on an Amazon Glacier vault.- Returns:
- A Java Future containing the result of the GetVaultNotifications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getVaultNotifications
default CompletableFuture<GetVaultNotificationsResponse> getVaultNotifications(Consumer<GetVaultNotificationsRequest.Builder> getVaultNotificationsRequest) This operation retrieves the
notification-configuration
subresource of the specified vault.For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a
404 Not Found
error. For more information about vault notifications, see Configuring Vault Notifications in Amazon S3 Glacier.An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
GetVaultNotificationsRequest.Builder
avoiding the need to create one manually viaGetVaultNotificationsRequest.builder()
- Parameters:
getVaultNotificationsRequest
- AConsumer
that will call methods onGetVaultNotificationsRequest.Builder
to create a request. Provides options for retrieving the notification configuration set on an Amazon Glacier vault.- Returns:
- A Java Future containing the result of the GetVaultNotifications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
initiateJob
This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job.
- Parameters:
initiateJobRequest
- Provides options for initiating an Amazon S3 Glacier job.- Returns:
- A Java Future containing the result of the InitiateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- PolicyEnforcedException Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- InsufficientCapacityException Returned if there is insufficient capacity to process this expedited request. This error only applies to expedited retrievals and not to standard or bulk retrievals.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
initiateJob
default CompletableFuture<InitiateJobResponse> initiateJob(Consumer<InitiateJobRequest.Builder> initiateJobRequest) This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job.
This is a convenience which creates an instance of the
InitiateJobRequest.Builder
avoiding the need to create one manually viaInitiateJobRequest.builder()
- Parameters:
initiateJobRequest
- AConsumer
that will call methods onInitiateJobRequest.Builder
to create a request. Provides options for initiating an Amazon S3 Glacier job.- Returns:
- A Java Future containing the result of the InitiateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- PolicyEnforcedException Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- InsufficientCapacityException Returned if there is insufficient capacity to process this expedited request. This error only applies to expedited retrievals and not to standard or bulk retrievals.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
initiateMultipartUpload
default CompletableFuture<InitiateMultipartUploadResponse> initiateMultipartUpload(InitiateMultipartUploadRequest initiateMultipartUploadRequest) This operation initiates a multipart upload. Amazon S3 Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart).
When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.
Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.
You don't need to know the size of the archive when you start a multipart upload because Amazon S3 Glacier does not require you to specify the overall archive size.
After you complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart upload resource referenced by the ID. Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide.
- Parameters:
initiateMultipartUploadRequest
- Provides options for initiating a multipart upload to an Amazon S3 Glacier vault.- Returns:
- A Java Future containing the result of the InitiateMultipartUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
initiateMultipartUpload
default CompletableFuture<InitiateMultipartUploadResponse> initiateMultipartUpload(Consumer<InitiateMultipartUploadRequest.Builder> initiateMultipartUploadRequest) This operation initiates a multipart upload. Amazon S3 Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart).
When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.
Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.
You don't need to know the size of the archive when you start a multipart upload because Amazon S3 Glacier does not require you to specify the overall archive size.
After you complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart upload resource referenced by the ID. Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
InitiateMultipartUploadRequest.Builder
avoiding the need to create one manually viaInitiateMultipartUploadRequest.builder()
- Parameters:
initiateMultipartUploadRequest
- AConsumer
that will call methods onInitiateMultipartUploadRequest.Builder
to create a request. Provides options for initiating a multipart upload to an Amazon S3 Glacier vault.- Returns:
- A Java Future containing the result of the InitiateMultipartUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
initiateVaultLock
default CompletableFuture<InitiateVaultLockResponse> initiateVaultLock(InitiateVaultLockRequest initiateVaultLockRequest) This operation initiates the vault locking process by doing the following:
-
Installing a vault lock policy on the specified vault.
-
Setting the lock state of vault lock to
InProgress
. -
Returning a lock ID, which is used to complete the vault locking process.
You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.
You must complete the vault locking process within 24 hours after the vault lock enters the
InProgress
state. After the 24 hour window ends, the lock ID expires, the vault automatically exits theInProgress
state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock toLocked
.After a vault lock is in the
Locked
state, you cannot initiate a new vault lock for the vault.You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.
If this operation is called when the vault lock is in the
InProgress
state, the operation returns anAccessDeniedException
error. When the vault lock is in theInProgress
state you must call AbortVaultLock before you can initiate a new vault lock policy.- Parameters:
initiateVaultLockRequest
- The input values forInitiateVaultLock
.- Returns:
- A Java Future containing the result of the InitiateVaultLock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
initiateVaultLock
default CompletableFuture<InitiateVaultLockResponse> initiateVaultLock(Consumer<InitiateVaultLockRequest.Builder> initiateVaultLockRequest) This operation initiates the vault locking process by doing the following:
-
Installing a vault lock policy on the specified vault.
-
Setting the lock state of vault lock to
InProgress
. -
Returning a lock ID, which is used to complete the vault locking process.
You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.
You must complete the vault locking process within 24 hours after the vault lock enters the
InProgress
state. After the 24 hour window ends, the lock ID expires, the vault automatically exits theInProgress
state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock toLocked
.After a vault lock is in the
Locked
state, you cannot initiate a new vault lock for the vault.You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.
If this operation is called when the vault lock is in the
InProgress
state, the operation returns anAccessDeniedException
error. When the vault lock is in theInProgress
state you must call AbortVaultLock before you can initiate a new vault lock policy.
This is a convenience which creates an instance of the
InitiateVaultLockRequest.Builder
avoiding the need to create one manually viaInitiateVaultLockRequest.builder()
- Parameters:
initiateVaultLockRequest
- AConsumer
that will call methods onInitiateVaultLockRequest.Builder
to create a request. The input values forInitiateVaultLock
.- Returns:
- A Java Future containing the result of the InitiateVaultLock operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
listJobs
This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time.
Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.
The List Jobs operation supports pagination. You should always check the response
Marker
field. If there are no more jobs to list, theMarker
field is set tonull
. If there are more jobs to list, theMarker
field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to theMarker
value for that job that you obtained from a previous List Jobs request.You can set a maximum limit for the number of jobs returned in the response by specifying the
limit
parameter in the request. The default limit is 50. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.Additionally, you can filter the jobs list returned by specifying the optional
statuscode
parameter orcompleted
parameter, or both. Using thestatuscode
parameter, you can specify to return only jobs that match either theInProgress
,Succeeded
, orFailed
status. Using thecompleted
parameter, you can specify to return only jobs that were completed (true
) or jobs that were not completed (false
).For more information about using this operation, see the documentation for the underlying REST API List Jobs.
- Parameters:
listJobsRequest
- Provides options for retrieving a job list for an Amazon S3 Glacier vault.- Returns:
- A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobs
default CompletableFuture<ListJobsResponse> listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time.
Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.
The List Jobs operation supports pagination. You should always check the response
Marker
field. If there are no more jobs to list, theMarker
field is set tonull
. If there are more jobs to list, theMarker
field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to theMarker
value for that job that you obtained from a previous List Jobs request.You can set a maximum limit for the number of jobs returned in the response by specifying the
limit
parameter in the request. The default limit is 50. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.Additionally, you can filter the jobs list returned by specifying the optional
statuscode
parameter orcompleted
parameter, or both. Using thestatuscode
parameter, you can specify to return only jobs that match either theInProgress
,Succeeded
, orFailed
status. Using thecompleted
parameter, you can specify to return only jobs that were completed (true
) or jobs that were not completed (false
).For more information about using this operation, see the documentation for the underlying REST API List Jobs.
This is a convenience which creates an instance of the
ListJobsRequest.Builder
avoiding the need to create one manually viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request. Provides options for retrieving a job list for an Amazon S3 Glacier vault.- Returns:
- A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobsPaginator
This is a variant of
listJobs(software.amazon.awssdk.services.glacier.model.ListJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.glacier.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.glacier.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.glacier.model.ListJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.glacier.model.ListJobsResponse response) { //... }; });
Please notice that the configuration of limit 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
listJobs(software.amazon.awssdk.services.glacier.model.ListJobsRequest)
operation.- Parameters:
listJobsRequest
- Provides options for retrieving a job list for an Amazon S3 Glacier vault.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobsPaginator
This is a variant of
listJobs(software.amazon.awssdk.services.glacier.model.ListJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.glacier.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.glacier.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.glacier.model.ListJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.glacier.model.ListJobsResponse response) { //... }; });
Please notice that the configuration of limit 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
listJobs(software.amazon.awssdk.services.glacier.model.ListJobsRequest)
operation.
This is a convenience which creates an instance of the
ListJobsRequest.Builder
avoiding the need to create one manually viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request. Provides options for retrieving a job list for an Amazon S3 Glacier vault.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMultipartUploads
default CompletableFuture<ListMultipartUploadsResponse> listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest) This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.
The List Multipart Uploads operation supports pagination. By default, this operation returns up to 50 multipart uploads in the response. You should always check the response for a
marker
at which to continue the list; if there are no more items themarker
isnull
. To return a list of multipart uploads that begins at a specific upload, set themarker
request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying thelimit
parameter in the request.Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.
- Parameters:
listMultipartUploadsRequest
- Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.- Returns:
- A Java Future containing the result of the ListMultipartUploads operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMultipartUploads
default CompletableFuture<ListMultipartUploadsResponse> listMultipartUploads(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest) This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.
The List Multipart Uploads operation supports pagination. By default, this operation returns up to 50 multipart uploads in the response. You should always check the response for a
marker
at which to continue the list; if there are no more items themarker
isnull
. To return a list of multipart uploads that begins at a specific upload, set themarker
request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying thelimit
parameter in the request.Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
ListMultipartUploadsRequest.Builder
avoiding the need to create one manually viaListMultipartUploadsRequest.builder()
- Parameters:
listMultipartUploadsRequest
- AConsumer
that will call methods onListMultipartUploadsRequest.Builder
to create a request. Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.- Returns:
- A Java Future containing the result of the ListMultipartUploads operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMultipartUploadsPaginator
default ListMultipartUploadsPublisher listMultipartUploadsPaginator(ListMultipartUploadsRequest listMultipartUploadsRequest) This is a variant of
listMultipartUploads(software.amazon.awssdk.services.glacier.model.ListMultipartUploadsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.glacier.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.glacier.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.glacier.model.ListMultipartUploadsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.glacier.model.ListMultipartUploadsResponse response) { //... }; });
Please notice that the configuration of limit 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
listMultipartUploads(software.amazon.awssdk.services.glacier.model.ListMultipartUploadsRequest)
operation.- Parameters:
listMultipartUploadsRequest
- Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMultipartUploadsPaginator
default ListMultipartUploadsPublisher listMultipartUploadsPaginator(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest) This is a variant of
listMultipartUploads(software.amazon.awssdk.services.glacier.model.ListMultipartUploadsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.glacier.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.glacier.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.glacier.model.ListMultipartUploadsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.glacier.model.ListMultipartUploadsResponse response) { //... }; });
Please notice that the configuration of limit 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
listMultipartUploads(software.amazon.awssdk.services.glacier.model.ListMultipartUploadsRequest)
operation.
This is a convenience which creates an instance of the
ListMultipartUploadsRequest.Builder
avoiding the need to create one manually viaListMultipartUploadsRequest.builder()
- Parameters:
listMultipartUploadsRequest
- AConsumer
that will call methods onListMultipartUploadsRequest.Builder
to create a request. Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listParts
This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.
The List Parts operation supports pagination. By default, this operation returns up to 50 uploaded parts in the response. You should always check the response for a
marker
at which to continue the list; if there are no more items themarker
isnull
. To return a list of parts that begins at a specific part, set themarker
request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying thelimit
parameter in the request.An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Parts in the Amazon Glacier Developer Guide.
- Parameters:
listPartsRequest
- Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.- Returns:
- A Java Future containing the result of the ListParts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listParts
default CompletableFuture<ListPartsResponse> listParts(Consumer<ListPartsRequest.Builder> listPartsRequest) This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.
The List Parts operation supports pagination. By default, this operation returns up to 50 uploaded parts in the response. You should always check the response for a
marker
at which to continue the list; if there are no more items themarker
isnull
. To return a list of parts that begins at a specific part, set themarker
request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying thelimit
parameter in the request.An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Parts in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
ListPartsRequest.Builder
avoiding the need to create one manually viaListPartsRequest.builder()
- Parameters:
listPartsRequest
- AConsumer
that will call methods onListPartsRequest.Builder
to create a request. Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.- Returns:
- A Java Future containing the result of the ListParts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPartsPaginator
This is a variant of
listParts(software.amazon.awssdk.services.glacier.model.ListPartsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.glacier.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.glacier.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.glacier.model.ListPartsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.glacier.model.ListPartsResponse response) { //... }; });
Please notice that the configuration of limit 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
listParts(software.amazon.awssdk.services.glacier.model.ListPartsRequest)
operation.- Parameters:
listPartsRequest
- Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPartsPaginator
This is a variant of
listParts(software.amazon.awssdk.services.glacier.model.ListPartsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.glacier.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.glacier.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.glacier.model.ListPartsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.glacier.model.ListPartsResponse response) { //... }; });
Please notice that the configuration of limit 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
listParts(software.amazon.awssdk.services.glacier.model.ListPartsRequest)
operation.
This is a convenience which creates an instance of the
ListPartsRequest.Builder
avoiding the need to create one manually viaListPartsRequest.builder()
- Parameters:
listPartsRequest
- AConsumer
that will call methods onListPartsRequest.Builder
to create a request. Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisionedCapacity
default CompletableFuture<ListProvisionedCapacityResponse> listProvisionedCapacity(ListProvisionedCapacityRequest listProvisionedCapacityRequest) This operation lists the provisioned capacity units for the specified AWS account.
- Parameters:
listProvisionedCapacityRequest
-- Returns:
- A Java Future containing the result of the ListProvisionedCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisionedCapacity
default CompletableFuture<ListProvisionedCapacityResponse> listProvisionedCapacity(Consumer<ListProvisionedCapacityRequest.Builder> listProvisionedCapacityRequest) This operation lists the provisioned capacity units for the specified AWS account.
This is a convenience which creates an instance of the
ListProvisionedCapacityRequest.Builder
avoiding the need to create one manually viaListProvisionedCapacityRequest.builder()
- Parameters:
listProvisionedCapacityRequest
- AConsumer
that will call methods onListProvisionedCapacityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProvisionedCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisionedCapacity
This operation lists the provisioned capacity units for the specified AWS account.
- Returns:
- A Java Future containing the result of the ListProvisionedCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTagsForVault
default CompletableFuture<ListTagsForVaultResponse> listTagsForVault(ListTagsForVaultRequest listTagsForVaultRequest) This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon S3 Glacier Resources.
- Parameters:
listTagsForVaultRequest
- The input value forListTagsForVaultInput
.- Returns:
- A Java Future containing the result of the ListTagsForVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTagsForVault
default CompletableFuture<ListTagsForVaultResponse> listTagsForVault(Consumer<ListTagsForVaultRequest.Builder> listTagsForVaultRequest) This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon S3 Glacier Resources.
This is a convenience which creates an instance of the
ListTagsForVaultRequest.Builder
avoiding the need to create one manually viaListTagsForVaultRequest.builder()
- Parameters:
listTagsForVaultRequest
- AConsumer
that will call methods onListTagsForVaultRequest.Builder
to create a request. The input value forListTagsForVaultInput
.- Returns:
- A Java Future containing the result of the ListTagsForVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVaults
This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.
By default, this operation returns up to 10 items. If there are more vaults to list, the response
marker
field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, themarker
field isnull
. To return a list of vaults that begins at a specific vault, set themarker
request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying thelimit
parameter in the request.An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier and List Vaults in the Amazon Glacier Developer Guide.
- Parameters:
listVaultsRequest
- Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.- Returns:
- A Java Future containing the result of the ListVaults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVaults
default CompletableFuture<ListVaultsResponse> listVaults(Consumer<ListVaultsRequest.Builder> listVaultsRequest) This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.
By default, this operation returns up to 10 items. If there are more vaults to list, the response
marker
field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, themarker
field isnull
. To return a list of vaults that begins at a specific vault, set themarker
request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying thelimit
parameter in the request.An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier and List Vaults in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
ListVaultsRequest.Builder
avoiding the need to create one manually viaListVaultsRequest.builder()
- Parameters:
listVaultsRequest
- AConsumer
that will call methods onListVaultsRequest.Builder
to create a request. Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.- Returns:
- A Java Future containing the result of the ListVaults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVaults
This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.
By default, this operation returns up to 10 items. If there are more vaults to list, the response
marker
field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, themarker
field isnull
. To return a list of vaults that begins at a specific vault, set themarker
request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying thelimit
parameter in the request.An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier and List Vaults in the Amazon Glacier Developer Guide.
- Returns:
- A Java Future containing the result of the ListVaults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVaultsPaginator
This is a variant of
listVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.glacier.paginators.ListVaultsPublisher publisher = client.listVaultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.glacier.paginators.ListVaultsPublisher publisher = client.listVaultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.glacier.model.ListVaultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.glacier.model.ListVaultsResponse response) { //... }; });
Please notice that the configuration of limit 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
listVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVaultsPaginator
This is a variant of
listVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.glacier.paginators.ListVaultsPublisher publisher = client.listVaultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.glacier.paginators.ListVaultsPublisher publisher = client.listVaultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.glacier.model.ListVaultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.glacier.model.ListVaultsResponse response) { //... }; });
Please notice that the configuration of limit 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
listVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest)
operation.- Parameters:
listVaultsRequest
- Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVaultsPaginator
default ListVaultsPublisher listVaultsPaginator(Consumer<ListVaultsRequest.Builder> listVaultsRequest) This is a variant of
listVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.glacier.paginators.ListVaultsPublisher publisher = client.listVaultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.glacier.paginators.ListVaultsPublisher publisher = client.listVaultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.glacier.model.ListVaultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.glacier.model.ListVaultsResponse response) { //... }; });
Please notice that the configuration of limit 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
listVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest)
operation.
This is a convenience which creates an instance of the
ListVaultsRequest.Builder
avoiding the need to create one manually viaListVaultsRequest.builder()
- Parameters:
listVaultsRequest
- AConsumer
that will call methods onListVaultsRequest.Builder
to create a request. Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
purchaseProvisionedCapacity
default CompletableFuture<PurchaseProvisionedCapacityResponse> purchaseProvisionedCapacity(PurchaseProvisionedCapacityRequest purchaseProvisionedCapacityRequest) This operation purchases a provisioned capacity unit for an AWS account.
- Parameters:
purchaseProvisionedCapacityRequest
-- Returns:
- A Java Future containing the result of the PurchaseProvisionedCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- LimitExceededException Returned if the request results in a vault or account limit being exceeded.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
purchaseProvisionedCapacity
default CompletableFuture<PurchaseProvisionedCapacityResponse> purchaseProvisionedCapacity(Consumer<PurchaseProvisionedCapacityRequest.Builder> purchaseProvisionedCapacityRequest) This operation purchases a provisioned capacity unit for an AWS account.
This is a convenience which creates an instance of the
PurchaseProvisionedCapacityRequest.Builder
avoiding the need to create one manually viaPurchaseProvisionedCapacityRequest.builder()
- Parameters:
purchaseProvisionedCapacityRequest
- AConsumer
that will call methods onPurchaseProvisionedCapacityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PurchaseProvisionedCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- LimitExceededException Returned if the request results in a vault or account limit being exceeded.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
purchaseProvisionedCapacity
This operation purchases a provisioned capacity unit for an AWS account.
- Returns:
- A Java Future containing the result of the PurchaseProvisionedCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- LimitExceededException Returned if the request results in a vault or account limit being exceeded.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
removeTagsFromVault
default CompletableFuture<RemoveTagsFromVaultResponse> removeTagsFromVault(RemoveTagsFromVaultRequest removeTagsFromVaultRequest) This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon S3 Glacier Resources. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault.
- Parameters:
removeTagsFromVaultRequest
- The input value forRemoveTagsFromVaultInput
.- Returns:
- A Java Future containing the result of the RemoveTagsFromVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
removeTagsFromVault
default CompletableFuture<RemoveTagsFromVaultResponse> removeTagsFromVault(Consumer<RemoveTagsFromVaultRequest.Builder> removeTagsFromVaultRequest) This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon S3 Glacier Resources. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault.
This is a convenience which creates an instance of the
RemoveTagsFromVaultRequest.Builder
avoiding the need to create one manually viaRemoveTagsFromVaultRequest.builder()
- Parameters:
removeTagsFromVaultRequest
- AConsumer
that will call methods onRemoveTagsFromVaultRequest.Builder
to create a request. The input value forRemoveTagsFromVaultInput
.- Returns:
- A Java Future containing the result of the RemoveTagsFromVault operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setDataRetrievalPolicy
default CompletableFuture<SetDataRetrievalPolicyResponse> setDataRetrievalPolicy(SetDataRetrievalPolicyRequest setDataRetrievalPolicyRequest) This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.
The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.
- Parameters:
setDataRetrievalPolicyRequest
- SetDataRetrievalPolicy input.- Returns:
- A Java Future containing the result of the SetDataRetrievalPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setDataRetrievalPolicy
default CompletableFuture<SetDataRetrievalPolicyResponse> setDataRetrievalPolicy(Consumer<SetDataRetrievalPolicyRequest.Builder> setDataRetrievalPolicyRequest) This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.
The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.
This is a convenience which creates an instance of the
SetDataRetrievalPolicyRequest.Builder
avoiding the need to create one manually viaSetDataRetrievalPolicyRequest.builder()
- Parameters:
setDataRetrievalPolicyRequest
- AConsumer
that will call methods onSetDataRetrievalPolicyRequest.Builder
to create a request. SetDataRetrievalPolicy input.- Returns:
- A Java Future containing the result of the SetDataRetrievalPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setVaultAccessPolicy
default CompletableFuture<SetVaultAccessPolicyResponse> setVaultAccessPolicy(SetVaultAccessPolicyRequest setVaultAccessPolicyRequest) This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the
access-policy
subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.- Parameters:
setVaultAccessPolicyRequest
- SetVaultAccessPolicy input.- Returns:
- A Java Future containing the result of the SetVaultAccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setVaultAccessPolicy
default CompletableFuture<SetVaultAccessPolicyResponse> setVaultAccessPolicy(Consumer<SetVaultAccessPolicyRequest.Builder> setVaultAccessPolicyRequest) This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the
access-policy
subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.
This is a convenience which creates an instance of the
SetVaultAccessPolicyRequest.Builder
avoiding the need to create one manually viaSetVaultAccessPolicyRequest.builder()
- Parameters:
setVaultAccessPolicyRequest
- AConsumer
that will call methods onSetVaultAccessPolicyRequest.Builder
to create a request. SetVaultAccessPolicy input.- Returns:
- A Java Future containing the result of the SetVaultAccessPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setVaultNotifications
default CompletableFuture<SetVaultNotificationsResponse> setVaultNotifications(SetVaultNotificationsRequest setVaultNotificationsRequest) This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.
To configure vault notifications, send a PUT request to the
notification-configuration
subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon S3 Glacier to send notifications to the topic.Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:
-
ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.
-
InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide.
- Parameters:
setVaultNotificationsRequest
- Provides options to configure notifications that will be sent when specific events happen to a vault.- Returns:
- A Java Future containing the result of the SetVaultNotifications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
setVaultNotifications
default CompletableFuture<SetVaultNotificationsResponse> setVaultNotifications(Consumer<SetVaultNotificationsRequest.Builder> setVaultNotificationsRequest) This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.
To configure vault notifications, send a PUT request to the
notification-configuration
subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon S3 Glacier to send notifications to the topic.Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:
-
ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.
-
InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
SetVaultNotificationsRequest.Builder
avoiding the need to create one manually viaSetVaultNotificationsRequest.builder()
- Parameters:
setVaultNotificationsRequest
- AConsumer
that will call methods onSetVaultNotificationsRequest.Builder
to create a request. Provides options to configure notifications that will be sent when specific events happen to a vault.- Returns:
- A Java Future containing the result of the SetVaultNotifications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
uploadArchive
default CompletableFuture<UploadArchiveResponse> uploadArchive(UploadArchiveRequest uploadArchiveRequest, AsyncRequestBody requestBody) This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in the
x-amz-archive-id
header of the response.You must use the archive ID to access your data in Amazon S3 Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.
You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.
Archives are immutable. After you upload an archive, you cannot edit the archive or its description.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.
- Parameters:
uploadArchiveRequest
- Provides options to add an archive to a vault.requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. SeeAsyncRequestBody
for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'The data to upload.
'- Returns:
- A Java Future containing the result of the UploadArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- RequestTimeoutException Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
uploadArchive
default CompletableFuture<UploadArchiveResponse> uploadArchive(Consumer<UploadArchiveRequest.Builder> uploadArchiveRequest, AsyncRequestBody requestBody) This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in the
x-amz-archive-id
header of the response.You must use the archive ID to access your data in Amazon S3 Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.
You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.
Archives are immutable. After you upload an archive, you cannot edit the archive or its description.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
UploadArchiveRequest.Builder
avoiding the need to create one manually viaUploadArchiveRequest.builder()
- Parameters:
uploadArchiveRequest
- AConsumer
that will call methods onUploadArchiveRequest.Builder
to create a request. Provides options to add an archive to a vault.requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. SeeAsyncRequestBody
for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'The data to upload.
'- Returns:
- A Java Future containing the result of the UploadArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- RequestTimeoutException Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
uploadArchive
default CompletableFuture<UploadArchiveResponse> uploadArchive(UploadArchiveRequest uploadArchiveRequest, Path sourcePath) This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in the
x-amz-archive-id
header of the response.You must use the archive ID to access your data in Amazon S3 Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.
You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.
Archives are immutable. After you upload an archive, you cannot edit the archive or its description.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.
- Parameters:
uploadArchiveRequest
- Provides options to add an archive to a vault.sourcePath
-Path
to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'The data to upload.
'- Returns:
- A Java Future containing the result of the UploadArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- RequestTimeoutException Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
uploadArchive
default CompletableFuture<UploadArchiveResponse> uploadArchive(Consumer<UploadArchiveRequest.Builder> uploadArchiveRequest, Path sourcePath) This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in the
x-amz-archive-id
header of the response.You must use the archive ID to access your data in Amazon S3 Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.
You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.
Archives are immutable. After you upload an archive, you cannot edit the archive or its description.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
UploadArchiveRequest.Builder
avoiding the need to create one manually viaUploadArchiveRequest.builder()
- Parameters:
uploadArchiveRequest
- AConsumer
that will call methods onUploadArchiveRequest.Builder
to create a request. Provides options to add an archive to a vault.sourcePath
-Path
to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'The data to upload.
'- Returns:
- A Java Future containing the result of the UploadArchive operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- RequestTimeoutException Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
uploadMultipartPart
default CompletableFuture<UploadMultipartPartResponse> uploadMultipartPart(UploadMultipartPartRequest uploadMultipartPartRequest, AsyncRequestBody requestBody) This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.
Amazon Glacier rejects your upload part request if any of the following conditions is true:
-
SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.
-
Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.
If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.
-
Range does not alignThe byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail.
This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide.
- Parameters:
uploadMultipartPartRequest
- Provides options to upload a part of an archive in a multipart upload operation.requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. SeeAsyncRequestBody
for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'The data to upload.
'- Returns:
- A Java Future containing the result of the UploadMultipartPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- RequestTimeoutException Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
uploadMultipartPart
default CompletableFuture<UploadMultipartPartResponse> uploadMultipartPart(Consumer<UploadMultipartPartRequest.Builder> uploadMultipartPartRequest, AsyncRequestBody requestBody) This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.
Amazon Glacier rejects your upload part request if any of the following conditions is true:
-
SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.
-
Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.
If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.
-
Range does not alignThe byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail.
This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
UploadMultipartPartRequest.Builder
avoiding the need to create one manually viaUploadMultipartPartRequest.builder()
- Parameters:
uploadMultipartPartRequest
- AConsumer
that will call methods onUploadMultipartPartRequest.Builder
to create a request. Provides options to upload a part of an archive in a multipart upload operation.requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The size of the content is expected to be known up front. SeeAsyncRequestBody
for specific details on implementing this interface as well as links to precanned implementations for common scenarios like uploading from a file. The service documentation for the request content is as follows 'The data to upload.
'- Returns:
- A Java Future containing the result of the UploadMultipartPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- RequestTimeoutException Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
uploadMultipartPart
default CompletableFuture<UploadMultipartPartResponse> uploadMultipartPart(UploadMultipartPartRequest uploadMultipartPartRequest, Path sourcePath) This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.
Amazon Glacier rejects your upload part request if any of the following conditions is true:
-
SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.
-
Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.
If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.
-
Range does not alignThe byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail.
This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide.
- Parameters:
uploadMultipartPartRequest
- Provides options to upload a part of an archive in a multipart upload operation.sourcePath
-Path
to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'The data to upload.
'- Returns:
- A Java Future containing the result of the UploadMultipartPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- RequestTimeoutException Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
uploadMultipartPart
default CompletableFuture<UploadMultipartPartResponse> uploadMultipartPart(Consumer<UploadMultipartPartRequest.Builder> uploadMultipartPartRequest, Path sourcePath) This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.
Amazon Glacier rejects your upload part request if any of the following conditions is true:
-
SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.
-
Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.
If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.
-
Range does not alignThe byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail.
This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide.
This is a convenience which creates an instance of the
UploadMultipartPartRequest.Builder
avoiding the need to create one manually viaUploadMultipartPartRequest.builder()
- Parameters:
uploadMultipartPartRequest
- AConsumer
that will call methods onUploadMultipartPartRequest.Builder
to create a request. Provides options to upload a part of an archive in a multipart upload operation.sourcePath
-Path
to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows 'The data to upload.
'- Returns:
- A Java Future containing the result of the UploadMultipartPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
- InvalidParameterValueException Returned if a parameter of the request is incorrectly specified.
- MissingParameterValueException Returned if a required header or parameter is missing from the request.
- RequestTimeoutException Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.
- ServiceUnavailableException Returned if the service cannot complete the request.
- 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.
- GlacierException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
waiter
Create an instance ofGlacierAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
GlacierAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aGlacierAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aGlacierAsyncClient
.
-