create-multipart-upload

Available in Classic and VPC

Start a multipart upload to upload a large object of 5 GB or more and create an upload ID.

Note

For a Sub Account user to execute this command, they must have the Change/PutObject action permission.

Syntax

The create-multipart-upload syntax is as follows:

aws s3api create-multipart-upload \
    --bucket <bucket> \
    --key <key> \
    [--cache-control <cache-control>] \
    [--content-disposition <content-disposition>] \
    [--content-encoding <content-encoding>] \
    [--content-language <content-language>] \
    [--content-type <content-type>] \
    [--metadata <metadata>] \
    [--storage-class <storage-class>] \
    [--server-side-encryption <server-side-encryption>] \
    [--sse-customer-algorithm <sse-customer-algorithm>] \
    [--sse-customer-key <sse-customer-key>] \
    [--sse-customer-key-md5 <sse-customer-key-md5>] \
    [--object-lock-mode <object-lock-mode>] \
    [--object-lock-retain-until-date <object-lock-retain-until-date>] \
    [--object-lock-legal-hold-status <object-lock-legal-hold-status>] \
    --endpoint-url <endpoint-url>

Options

This section describes the options available when running create-multipart-upload.

Required options

The following options are required for create-multipart-upload.

Options	Type	Required	Description
`--bucket`	String	Required	Bucket name
`--key`	String	Required	Object name

Optional options

These are the optional options for create-multipart-upload. Options that are not specified will use their default values.

Options	Type	Required	Description
`--cache-control`	String	Optional	Caching behavior
`--content-disposition`	String	Optional	Display format of requested data
`--content-encoding`	String	Optional	Encoding format of requested data
`--content-language`	String	Optional	Request data language
`--content-type`	String	Optional	Request data format.
`--metadata`	String	Optional	Metadata to be stored with the object
`--storage-class`	String	Optional	Storage class `STANDARD` (default) \| `ONEZONE_IA` \| `DEEP_ARCHIVE` `STANDARD`: Standard Class `ONEZONE_IA`: One Zone-IA (Infrequent Access) Class `DEEP_ARCHIVE`: Archive Class
`--server-side-encryption`	String	Optional	Server-side encryption method `AES256` \| `aws:kms` `AES256`: SSE-S3 (server management key) `aws:kms`: SSE-KMS (KMS management key)
`--sse-customer-algorithm`	String	Optional	User encryption algorithm (AES256)
`--sse-customer-key`	String	Optional	User-provided encryption key
`--sse-customer-key-md5`	String	Optional	User-provided encryption key's MD5 value
`--object-lock-mode`	String	Optional	Object retention mode `GOVERNANCE` \| `COMPLIANCE` `GOVERNANCE`: Can be bypassed with special permissions. `COMPLIANCE`: No one can bypass it. Specify with `--object-lock-retain-until-date`. Available only in buckets with object lock enabled.
`--object-lock-retain-until-date`	String	Optional	Object retention expiration date ISO 8601 format. Specify with `--object-lock-mode`. Available only in buckets with object lock enabled.
`--object-lock-legal-hold-status`	String	Optional	Legal hold status `ON` \| `OFF` Available only in buckets with object lock enabled

Common options

For information about the options common to all aws subcommands, see Ncloud Storage options.

Examples

If the request to start a multipart upload is successful, an upload identification information is returned for use in subsequent steps.

Command

The command example is as follows:

aws s3api create-multipart-upload --bucket my-test-bucket \
    --key large.bin \
    --endpoint-url=https://kr.ncloudstorage.com

Output

The output example is as follows:

{
    "ServerSideEncryption": "AES256",
    "Bucket": "my-test-bucket",
    "Key": "large.bin",
    "UploadId": "11111111-2222-3333-4444-555555555554"
}

Related commands

Related commands are as follows: