InitiateMultipartUploadRequest Class

Container for the parameters to the InitiateMultipartUpload operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Glacier.AmazonGlacierRequest
      Amazon.Glacier.Model.InitiateMultipartUploadRequest

Namespace: Amazon.Glacier.Model
Assembly: AWSSDK.Glacier.dll
Version: 3.x.y.z

Syntax

public class InitiateMultipartUploadRequest : AmazonGlacierRequest
         IAmazonWebServiceRequest

The InitiateMultipartUploadRequest type exposes the following members

Constructors

	Name	Description
	InitiateMultipartUploadRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	InitiateMultipartUploadRequest(string, string, Int64)	Instantiates InitiateMultipartUploadRequest with the parameterized properties
	InitiateMultipartUploadRequest(string, string, string, Int64)	Instantiates InitiateMultipartUploadRequest with the parameterized properties

Properties

Name	Type	Description
AccountId	System.String	Gets and sets the property AccountId. The `AccountId` value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '`-`' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
ArchiveDescription	System.String	Gets and sets the property ArchiveDescription. The archive description that you are uploading in parts. 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 (4096 MB).
PartSize	System.Int64	Gets and sets the property PartSize. The size of each part except the last, in bytes. The last part can be smaller than this part size.
VaultName	System.String	Gets and sets the property VaultName. The name of the vault.

Examples

The example initiates a multipart upload to a vault named my-vault with a part size of 1 MiB (1024 x 1024 bytes) per file.

To initiate a multipart upload


var client = new AmazonGlacierClient();
var response = client.InitiateMultipartUpload(new InitiateMultipartUploadRequest 
{
    AccountId = "-",
    PartSize = "1048576",
    VaultName = "my-vault"
});

string location = response.Location;
string uploadId = response.UploadId;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5