Package software.amazon.awssdk.services.glacier

Interface GlacierClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface GlacierClient
extends AwsClient
    Service client for accessing Amazon Glacier. This can be created using the static builder() method.

    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.

    • Method Detail

      • completeMultipartUpload

        default CompleteMultipartUploadResponse completeMultipartUpload​(CompleteMultipartUploadRequest completeMultipartUploadRequest)
                                                         throws ResourceNotFoundException,
                                                                InvalidParameterValueException,
                                                                MissingParameterValueException,
                                                                ServiceUnavailableException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                GlacierException

        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:
        Result of the CompleteMultipartUpload operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • completeMultipartUpload

        default CompleteMultipartUploadResponse completeMultipartUpload​(Consumer<CompleteMultipartUploadRequest.Builder> completeMultipartUploadRequest)
                                                         throws ResourceNotFoundException,
                                                                InvalidParameterValueException,
                                                                MissingParameterValueException,
                                                                ServiceUnavailableException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                GlacierException

        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 via CompleteMultipartUploadRequest.builder()

        Parameters:
        completeMultipartUploadRequest - A Consumer that will call methods on CompleteMultipartUploadRequest.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:
        Result of the CompleteMultipartUpload operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • deleteArchive

        default DeleteArchiveResponse deleteArchive​(DeleteArchiveRequest deleteArchiveRequest)
                                     throws ResourceNotFoundException,
                                            InvalidParameterValueException,
                                            MissingParameterValueException,
                                            ServiceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            GlacierException

        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:
        Result of the DeleteArchive operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • describeJob

        default DescribeJobResponse describeJob​(DescribeJobRequest describeJobRequest)
                                 throws ResourceNotFoundException,
                                        InvalidParameterValueException,
                                        MissingParameterValueException,
                                        ServiceUnavailableException,
                                        AwsServiceException,
                                        SdkClientException,
                                        GlacierException

        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:
        Result of the DescribeJob operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • getJobOutput

        default <ReturnT> ReturnT getJobOutput​(GetJobOutputRequest getJobOutputRequest,
                                       ResponseTransformer<GetJobOutputResponse,​ReturnT> responseTransformer)
                                throws ResourceNotFoundException,
                                       InvalidParameterValueException,
                                       MissingParameterValueException,
                                       ServiceUnavailableException,
                                       AwsServiceException,
                                       SdkClientException,
                                       GlacierException

        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.
        responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetJobOutputResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned 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:
        The transformed result of the ResponseTransformer.
        Throws:
        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.
        AwsServiceException

      • getJobOutput

        default <ReturnT> ReturnT getJobOutput​(Consumer<GetJobOutputRequest.Builder> getJobOutputRequest,
                                       ResponseTransformer<GetJobOutputResponse,​ReturnT> responseTransformer)
                                throws ResourceNotFoundException,
                                       InvalidParameterValueException,
                                       MissingParameterValueException,
                                       ServiceUnavailableException,
                                       AwsServiceException,
                                       SdkClientException,
                                       GlacierException

        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 via GetJobOutputRequest.builder()

        Parameters:
        getJobOutputRequest - A Consumer that will call methods on GetJobOutputRequest.Builder to create a request. Provides options for downloading output of an Amazon S3 Glacier job.
        responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetJobOutputResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned 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:
        The transformed result of the ResponseTransformer.
        Throws:
        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.
        AwsServiceException

      • getJobOutput

        default GetJobOutputResponse getJobOutput​(GetJobOutputRequest getJobOutputRequest,
                                          Path destinationPath)
                                   throws ResourceNotFoundException,
                                          InvalidParameterValueException,
                                          MissingParameterValueException,
                                          ServiceUnavailableException,
                                          AwsServiceException,
                                          SdkClientException,
                                          GlacierException

        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:
        The transformed result of the ResponseTransformer.
        Throws:
        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.
        AwsServiceException
        See Also:
        getJobOutput(GetJobOutputRequest, ResponseTransformer)

      • getJobOutput

        default GetJobOutputResponse getJobOutput​(Consumer<GetJobOutputRequest.Builder> getJobOutputRequest,
                                          Path destinationPath)
                                   throws ResourceNotFoundException,
                                          InvalidParameterValueException,
                                          MissingParameterValueException,
                                          ServiceUnavailableException,
                                          AwsServiceException,
                                          SdkClientException,
                                          GlacierException

        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 via GetJobOutputRequest.builder()

        Parameters:
        getJobOutputRequest - A Consumer that will call methods on GetJobOutputRequest.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:
        The transformed result of the ResponseTransformer.
        Throws:
        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.
        AwsServiceException
        See Also:
        getJobOutput(GetJobOutputRequest, ResponseTransformer)

      • getJobOutput

        default ResponseInputStream<GetJobOutputResponse> getJobOutput​(GetJobOutputRequest getJobOutputRequest)
                                                        throws ResourceNotFoundException,
                                                               InvalidParameterValueException,
                                                               MissingParameterValueException,
                                                               ServiceUnavailableException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               GlacierException

        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.
        Returns:
        A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

        The job data, either archive data or inventory data.

        '.
        Throws:
        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.
        AwsServiceException
        See Also:
        #getObject(getJobOutput, ResponseTransformer)

      • getJobOutput

        default ResponseInputStream<GetJobOutputResponse> getJobOutput​(Consumer<GetJobOutputRequest.Builder> getJobOutputRequest)
                                                        throws ResourceNotFoundException,
                                                               InvalidParameterValueException,
                                                               MissingParameterValueException,
                                                               ServiceUnavailableException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               GlacierException

        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 via GetJobOutputRequest.builder()

        Parameters:
        getJobOutputRequest - A Consumer that will call methods on GetJobOutputRequest.Builder to create a request. Provides options for downloading output of an Amazon S3 Glacier job.
        Returns:
        A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

        The job data, either archive data or inventory data.

        '.
        Throws:
        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.
        AwsServiceException
        See Also:
        #getObject(getJobOutput, ResponseTransformer)

      • getJobOutputAsBytes

        default ResponseBytes<GetJobOutputResponse> getJobOutputAsBytes​(GetJobOutputRequest getJobOutputRequest)
                                                         throws ResourceNotFoundException,
                                                                InvalidParameterValueException,
                                                                MissingParameterValueException,
                                                                ServiceUnavailableException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                GlacierException

        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.
        Returns:
        A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

        The job data, either archive data or inventory data.

        '.
        Throws:
        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.
        AwsServiceException
        See Also:
        #getObject(getJobOutput, ResponseTransformer)

      • getJobOutputAsBytes

        default ResponseBytes<GetJobOutputResponse> getJobOutputAsBytes​(Consumer<GetJobOutputRequest.Builder> getJobOutputRequest)
                                                         throws ResourceNotFoundException,
                                                                InvalidParameterValueException,
                                                                MissingParameterValueException,
                                                                ServiceUnavailableException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                GlacierException

        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 via GetJobOutputRequest.builder()

        Parameters:
        getJobOutputRequest - A Consumer that will call methods on GetJobOutputRequest.Builder to create a request. Provides options for downloading output of an Amazon S3 Glacier job.
        Returns:
        A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

        The job data, either archive data or inventory data.

        '.
        Throws:
        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.
        AwsServiceException
        See Also:
        #getObject(getJobOutput, ResponseTransformer)

      • initiateMultipartUpload

        default InitiateMultipartUploadResponse initiateMultipartUpload​(InitiateMultipartUploadRequest initiateMultipartUploadRequest)
                                                         throws ResourceNotFoundException,
                                                                InvalidParameterValueException,
                                                                MissingParameterValueException,
                                                                ServiceUnavailableException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                GlacierException

        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:
        Result of the InitiateMultipartUpload operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • initiateVaultLock

        default InitiateVaultLockResponse initiateVaultLock​(InitiateVaultLockRequest initiateVaultLockRequest)
                                             throws ResourceNotFoundException,
                                                    InvalidParameterValueException,
                                                    MissingParameterValueException,
                                                    ServiceUnavailableException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    GlacierException

        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 the InProgress 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 to Locked.

        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 an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy.

        Parameters:
        initiateVaultLockRequest - The input values for InitiateVaultLock.
        Returns:
        Result of the InitiateVaultLock operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • listJobs

        default ListJobsResponse listJobs​(ListJobsRequest listJobsRequest)
                           throws ResourceNotFoundException,
                                  InvalidParameterValueException,
                                  MissingParameterValueException,
                                  ServiceUnavailableException,
                                  AwsServiceException,
                                  SdkClientException,
                                  GlacierException

        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, the Marker field is set to null. If there are more jobs to list, the Marker 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 the Marker 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 or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed 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:
        Result of the ListJobs operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • listJobs

        default ListJobsResponse listJobs​(Consumer<ListJobsRequest.Builder> listJobsRequest)
                           throws ResourceNotFoundException,
                                  InvalidParameterValueException,
                                  MissingParameterValueException,
                                  ServiceUnavailableException,
                                  AwsServiceException,
                                  SdkClientException,
                                  GlacierException

        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, the Marker field is set to null. If there are more jobs to list, the Marker 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 the Marker 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 or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed 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 via ListJobsRequest.builder()

        Parameters:
        listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request. Provides options for retrieving a job list for an Amazon S3 Glacier vault.
        Returns:
        Result of the ListJobs operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • listJobsPaginator

        default ListJobsIterable listJobsPaginator​(ListJobsRequest listJobsRequest)
                                    throws ResourceNotFoundException,
                                           InvalidParameterValueException,
                                           MissingParameterValueException,
                                           ServiceUnavailableException,
                                           AwsServiceException,
                                           SdkClientException,
                                           GlacierException

        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, the Marker field is set to null. If there are more jobs to list, the Marker 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 the Marker 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 or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed 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 variant of listJobs(software.amazon.awssdk.services.glacier.model.ListJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

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

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

        1) Using a Stream 
         
 software.amazon.awssdk.services.glacier.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.glacier.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
     for (software.amazon.awssdk.services.glacier.model.ListJobsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.glacier.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException

      • listJobsPaginator

        default ListJobsIterable listJobsPaginator​(Consumer<ListJobsRequest.Builder> listJobsRequest)
                                    throws ResourceNotFoundException,
                                           InvalidParameterValueException,
                                           MissingParameterValueException,
                                           ServiceUnavailableException,
                                           AwsServiceException,
                                           SdkClientException,
                                           GlacierException

        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, the Marker field is set to null. If there are more jobs to list, the Marker 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 the Marker 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 or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed 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 variant of listJobs(software.amazon.awssdk.services.glacier.model.ListJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

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

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

        1) Using a Stream 
         
 software.amazon.awssdk.services.glacier.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.glacier.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
     for (software.amazon.awssdk.services.glacier.model.ListJobsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.glacier.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

        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 via ListJobsRequest.builder()

        Parameters:
        listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request. Provides options for retrieving a job list for an Amazon S3 Glacier vault.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException

      • listMultipartUploads

        default ListMultipartUploadsResponse listMultipartUploads​(ListMultipartUploadsRequest listMultipartUploadsRequest)
                                                   throws ResourceNotFoundException,
                                                          InvalidParameterValueException,
                                                          MissingParameterValueException,
                                                          ServiceUnavailableException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          GlacierException

        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 the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker 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 the limit 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:
        Result of the ListMultipartUploads operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • listMultipartUploadsPaginator

        default ListMultipartUploadsIterable listMultipartUploadsPaginator​(ListMultipartUploadsRequest listMultipartUploadsRequest)
                                                            throws ResourceNotFoundException,
                                                                   InvalidParameterValueException,
                                                                   MissingParameterValueException,
                                                                   ServiceUnavailableException,
                                                                   AwsServiceException,
                                                                   SdkClientException,
                                                                   GlacierException

        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 the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker 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 the limit 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 variant of listMultipartUploads(software.amazon.awssdk.services.glacier.model.ListMultipartUploadsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

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

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

        1) Using a Stream 
         
 software.amazon.awssdk.services.glacier.paginators.ListMultipartUploadsIterable responses = client.listMultipartUploadsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.glacier.paginators.ListMultipartUploadsIterable responses = client
             .listMultipartUploadsPaginator(request);
     for (software.amazon.awssdk.services.glacier.model.ListMultipartUploadsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.glacier.paginators.ListMultipartUploadsIterable responses = client.listMultipartUploadsPaginator(request);
 responses.iterator().forEachRemaining(....);

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException

      • listMultipartUploadsPaginator

        default ListMultipartUploadsIterable listMultipartUploadsPaginator​(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest)
                                                            throws ResourceNotFoundException,
                                                                   InvalidParameterValueException,
                                                                   MissingParameterValueException,
                                                                   ServiceUnavailableException,
                                                                   AwsServiceException,
                                                                   SdkClientException,
                                                                   GlacierException

        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 the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker 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 the limit 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 variant of listMultipartUploads(software.amazon.awssdk.services.glacier.model.ListMultipartUploadsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

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

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

        1) Using a Stream 
         
 software.amazon.awssdk.services.glacier.paginators.ListMultipartUploadsIterable responses = client.listMultipartUploadsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.glacier.paginators.ListMultipartUploadsIterable responses = client
             .listMultipartUploadsPaginator(request);
     for (software.amazon.awssdk.services.glacier.model.ListMultipartUploadsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.glacier.paginators.ListMultipartUploadsIterable responses = client.listMultipartUploadsPaginator(request);
 responses.iterator().forEachRemaining(....);

        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 via ListMultipartUploadsRequest.builder()

        Parameters:
        listMultipartUploadsRequest - A Consumer that will call methods on ListMultipartUploadsRequest.Builder to create a request. Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException

      • listParts

        default ListPartsResponse listParts​(ListPartsRequest listPartsRequest)
                             throws ResourceNotFoundException,
                                    InvalidParameterValueException,
                                    MissingParameterValueException,
                                    ServiceUnavailableException,
                                    AwsServiceException,
                                    SdkClientException,
                                    GlacierException

        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 the marker is null. To return a list of parts that begins at a specific part, set the marker 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 the limit 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:
        Result of the ListParts operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • listPartsPaginator

        default ListPartsIterable listPartsPaginator​(ListPartsRequest listPartsRequest)
                                      throws ResourceNotFoundException,
                                             InvalidParameterValueException,
                                             MissingParameterValueException,
                                             ServiceUnavailableException,
                                             AwsServiceException,
                                             SdkClientException,
                                             GlacierException

        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 the marker is null. To return a list of parts that begins at a specific part, set the marker 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 the limit 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 variant of listParts(software.amazon.awssdk.services.glacier.model.ListPartsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

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

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

        1) Using a Stream 
         
 software.amazon.awssdk.services.glacier.paginators.ListPartsIterable responses = client.listPartsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.glacier.paginators.ListPartsIterable responses = client.listPartsPaginator(request);
     for (software.amazon.awssdk.services.glacier.model.ListPartsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.glacier.paginators.ListPartsIterable responses = client.listPartsPaginator(request);
 responses.iterator().forEachRemaining(....);

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException

      • listPartsPaginator

        default ListPartsIterable listPartsPaginator​(Consumer<ListPartsRequest.Builder> listPartsRequest)
                                      throws ResourceNotFoundException,
                                             InvalidParameterValueException,
                                             MissingParameterValueException,
                                             ServiceUnavailableException,
                                             AwsServiceException,
                                             SdkClientException,
                                             GlacierException

        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 the marker is null. To return a list of parts that begins at a specific part, set the marker 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 the limit 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 variant of listParts(software.amazon.awssdk.services.glacier.model.ListPartsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

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

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

        1) Using a Stream 
         
 software.amazon.awssdk.services.glacier.paginators.ListPartsIterable responses = client.listPartsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.glacier.paginators.ListPartsIterable responses = client.listPartsPaginator(request);
     for (software.amazon.awssdk.services.glacier.model.ListPartsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.glacier.paginators.ListPartsIterable responses = client.listPartsPaginator(request);
 responses.iterator().forEachRemaining(....);

        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 via ListPartsRequest.builder()

        Parameters:
        listPartsRequest - A Consumer that will call methods on ListPartsRequest.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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException

      • listVaults

        default ListVaultsResponse listVaults​(ListVaultsRequest listVaultsRequest)
                               throws ResourceNotFoundException,
                                      InvalidParameterValueException,
                                      MissingParameterValueException,
                                      ServiceUnavailableException,
                                      AwsServiceException,
                                      SdkClientException,
                                      GlacierException

        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, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker 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 the limit 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:
        Result of the ListVaults operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • listVaultsPaginator

        default ListVaultsIterable listVaultsPaginator()
                                        throws ResourceNotFoundException,
                                               InvalidParameterValueException,
                                               MissingParameterValueException,
                                               ServiceUnavailableException,
                                               AwsServiceException,
                                               SdkClientException,
                                               GlacierException

        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, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker 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 the limit 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 variant of listVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

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

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

        1) Using a Stream 
         
 software.amazon.awssdk.services.glacier.paginators.ListVaultsIterable responses = client.listVaultsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.glacier.paginators.ListVaultsIterable responses = client.listVaultsPaginator(request);
     for (software.amazon.awssdk.services.glacier.model.ListVaultsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.glacier.paginators.ListVaultsIterable responses = client.listVaultsPaginator(request);
 responses.iterator().forEachRemaining(....);

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        listVaultsPaginator(ListVaultsRequest)

      • listVaultsPaginator

        default ListVaultsIterable listVaultsPaginator​(ListVaultsRequest listVaultsRequest)
                                        throws ResourceNotFoundException,
                                               InvalidParameterValueException,
                                               MissingParameterValueException,
                                               ServiceUnavailableException,
                                               AwsServiceException,
                                               SdkClientException,
                                               GlacierException

        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, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker 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 the limit 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 variant of listVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

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

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

        1) Using a Stream 
         
 software.amazon.awssdk.services.glacier.paginators.ListVaultsIterable responses = client.listVaultsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.glacier.paginators.ListVaultsIterable responses = client.listVaultsPaginator(request);
     for (software.amazon.awssdk.services.glacier.model.ListVaultsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.glacier.paginators.ListVaultsIterable responses = client.listVaultsPaginator(request);
 responses.iterator().forEachRemaining(....);

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException

      • listVaultsPaginator

        default ListVaultsIterable listVaultsPaginator​(Consumer<ListVaultsRequest.Builder> listVaultsRequest)
                                        throws ResourceNotFoundException,
                                               InvalidParameterValueException,
                                               MissingParameterValueException,
                                               ServiceUnavailableException,
                                               AwsServiceException,
                                               SdkClientException,
                                               GlacierException

        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, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker 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 the limit 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 variant of listVaults(software.amazon.awssdk.services.glacier.model.ListVaultsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

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

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

        1) Using a Stream 
         
 software.amazon.awssdk.services.glacier.paginators.ListVaultsIterable responses = client.listVaultsPaginator(request);
 responses.stream().forEach(....);
        2) Using For loop 
         {
     @code
     software.amazon.awssdk.services.glacier.paginators.ListVaultsIterable responses = client.listVaultsPaginator(request);
     for (software.amazon.awssdk.services.glacier.model.ListVaultsResponse response : responses) {
         // do something;
     }
 }
        3) Use iterator directly 
         
 software.amazon.awssdk.services.glacier.paginators.ListVaultsIterable responses = client.listVaultsPaginator(request);
 responses.iterator().forEachRemaining(....);

        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 via ListVaultsRequest.builder()

        Parameters:
        listVaultsRequest - A Consumer that will call methods on ListVaultsRequest.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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException

      • setVaultNotifications

        default SetVaultNotificationsResponse setVaultNotifications​(SetVaultNotificationsRequest setVaultNotificationsRequest)
                                                     throws ResourceNotFoundException,
                                                            InvalidParameterValueException,
                                                            MissingParameterValueException,
                                                            ServiceUnavailableException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            GlacierException

        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:
        Result of the SetVaultNotifications operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • uploadArchive

        default UploadArchiveResponse uploadArchive​(UploadArchiveRequest uploadArchiveRequest,
                                            RequestBody requestBody)
                                     throws ResourceNotFoundException,
                                            InvalidParameterValueException,
                                            MissingParameterValueException,
                                            RequestTimeoutException,
                                            ServiceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            GlacierException

        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 - The content to send to the service. A RequestBody can be created using one of several factory methods for various sources of data. For example, to create a request body from a file you can do the following. 
         RequestBody.fromFile(new File("myfile.txt"))
        See documentation in RequestBody for additional details and which sources of data are supported. The service documentation for the request content is as follows '

        The data to upload.

        '
        Returns:
        Result of the UploadArchive operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • uploadArchive

        default UploadArchiveResponse uploadArchive​(Consumer<UploadArchiveRequest.Builder> uploadArchiveRequest,
                                            RequestBody requestBody)
                                     throws ResourceNotFoundException,
                                            InvalidParameterValueException,
                                            MissingParameterValueException,
                                            RequestTimeoutException,
                                            ServiceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            GlacierException

        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 via UploadArchiveRequest.builder()

        Parameters:
        uploadArchiveRequest - A Consumer that will call methods on UploadArchiveRequest.Builder to create a request. Provides options to add an archive to a vault.
        requestBody - The content to send to the service. A RequestBody can be created using one of several factory methods for various sources of data. For example, to create a request body from a file you can do the following. 
         RequestBody.fromFile(new File("myfile.txt"))
        See documentation in RequestBody for additional details and which sources of data are supported. The service documentation for the request content is as follows '

        The data to upload.

        '
        Returns:
        Result of the UploadArchive operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • uploadArchive

        default UploadArchiveResponse uploadArchive​(UploadArchiveRequest uploadArchiveRequest,
                                            Path sourcePath)
                                     throws ResourceNotFoundException,
                                            InvalidParameterValueException,
                                            MissingParameterValueException,
                                            RequestTimeoutException,
                                            ServiceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            GlacierException

        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:
        Result of the UploadArchive operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        uploadArchive(UploadArchiveRequest, RequestBody)

      • uploadArchive

        default UploadArchiveResponse uploadArchive​(Consumer<UploadArchiveRequest.Builder> uploadArchiveRequest,
                                            Path sourcePath)
                                     throws ResourceNotFoundException,
                                            InvalidParameterValueException,
                                            MissingParameterValueException,
                                            RequestTimeoutException,
                                            ServiceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            GlacierException

        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 via UploadArchiveRequest.builder()

        Parameters:
        uploadArchiveRequest - A Consumer that will call methods on UploadArchiveRequest.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:
        Result of the UploadArchive operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        uploadArchive(UploadArchiveRequest, RequestBody)

      • uploadMultipartPart

        default UploadMultipartPartResponse uploadMultipartPart​(UploadMultipartPartRequest uploadMultipartPartRequest,
                                                        RequestBody requestBody)
                                                 throws ResourceNotFoundException,
                                                        InvalidParameterValueException,
                                                        MissingParameterValueException,
                                                        RequestTimeoutException,
                                                        ServiceUnavailableException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        GlacierException

        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 - The content to send to the service. A RequestBody can be created using one of several factory methods for various sources of data. For example, to create a request body from a file you can do the following. 
         RequestBody.fromFile(new File("myfile.txt"))
        See documentation in RequestBody for additional details and which sources of data are supported. The service documentation for the request content is as follows '

        The data to upload.

        '
        Returns:
        Result of the UploadMultipartPart operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • uploadMultipartPart

        default UploadMultipartPartResponse uploadMultipartPart​(Consumer<UploadMultipartPartRequest.Builder> uploadMultipartPartRequest,
                                                        RequestBody requestBody)
                                                 throws ResourceNotFoundException,
                                                        InvalidParameterValueException,
                                                        MissingParameterValueException,
                                                        RequestTimeoutException,
                                                        ServiceUnavailableException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        GlacierException

        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 via UploadMultipartPartRequest.builder()

        Parameters:
        uploadMultipartPartRequest - A Consumer that will call methods on UploadMultipartPartRequest.Builder to create a request. Provides options to upload a part of an archive in a multipart upload operation.
        requestBody - The content to send to the service. A RequestBody can be created using one of several factory methods for various sources of data. For example, to create a request body from a file you can do the following. 
         RequestBody.fromFile(new File("myfile.txt"))
        See documentation in RequestBody for additional details and which sources of data are supported. The service documentation for the request content is as follows '

        The data to upload.

        '
        Returns:
        Result of the UploadMultipartPart operation returned by the service.
        Throws:
        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.
        AwsServiceException

      • uploadMultipartPart

        default UploadMultipartPartResponse uploadMultipartPart​(UploadMultipartPartRequest uploadMultipartPartRequest,
                                                        Path sourcePath)
                                                 throws ResourceNotFoundException,
                                                        InvalidParameterValueException,
                                                        MissingParameterValueException,
                                                        RequestTimeoutException,
                                                        ServiceUnavailableException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        GlacierException

        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:
        Result of the UploadMultipartPart operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        uploadMultipartPart(UploadMultipartPartRequest, RequestBody)

      • uploadMultipartPart

        default UploadMultipartPartResponse uploadMultipartPart​(Consumer<UploadMultipartPartRequest.Builder> uploadMultipartPartRequest,
                                                        Path sourcePath)
                                                 throws ResourceNotFoundException,
                                                        InvalidParameterValueException,
                                                        MissingParameterValueException,
                                                        RequestTimeoutException,
                                                        ServiceUnavailableException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        GlacierException

        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 via UploadMultipartPartRequest.builder()

        Parameters:
        uploadMultipartPartRequest - A Consumer that will call methods on UploadMultipartPartRequest.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:
        Result of the UploadMultipartPart operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        uploadMultipartPart(UploadMultipartPartRequest, RequestBody)

      • waiter

        default GlacierWaiter waiter()
        Create an instance of GlacierWaiter 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 GlacierWaiter