create-multipart-upload

Prev Next

Available in Classic and VPC

Start a multipart upload to upload a large object and return an upload ID. This upload ID is used to connect and combine all parts of a specific multipart upload.

Commands

The command statement is as follows:

aws s3api create-multipart-upload --bucket <value> --endpoint-url <value> --key <value> [--options]

Parameter

The following describes the parameters.

Parameter Type Required Description Restrictions
--bucket <value> string Y Specify the bucket for uploading large objects using multipart upload. -
--endpoint-url <value> string Y Specify the default URL for command calls. It is only available for the KR Region. See Ncloud Storage overview for call domain information.
--key <value> string Y Specify the name (key value) of the object to upload. -
--cache-control <value> string N Set caching behavior. -
--content-disposition <value> string N Specify representation information for the object. -
--content-encoding <value> string N Set content encoding. -
--content-language <value> string N Set content language. -
--content-type <value> string N Define explicit content type. -
--metadata <value> string N Set up metadata to store with the object. -
--storage-class <value> string N Specify the storage class for storing the object. Available options
  • STANDARD
  • DEEP_ARCHIVE
  • * Default: Store in the Standard class.
--cli-input-json | --cli-input-yaml string N Enter arguments from the provided json or yaml string. You can't specify json and yaml together.
--generate-cli-skeleton <value> integer N Create a parameter template that can be used as input later without executing the API command. -
--debug boolean N Use debug logging. -
--no-verify-ssl boolean N Redefine the default behavior for validating SSL certificates. -
--no-paginate boolean N Disable automatic pagination, call only the first page for results. -
--output <value> string N Specify the format of response results. Available options
  • json
  • text
  • table
  • yaml
  • yaml-stream
--query <value> string N JMESPath query to use for filtering response data -
--profile <value> string N Use a specific profile in the credentials file. -
--region <value> string N Specify the Region. Only KR is supported.
--color <value> string N Set output color. Available options
  • on
  • off
  • auto
--no-sign-request boolean N Disable credential loading. -
--ca-bundle <value> string N Specify the CA certificate to use when verifying SSL certificates. -
--cli-read-timeout <value> int N Maximum read time; entering 0 changes it to a blocked status instead of a timeout. It is set to 60 seconds by default.
--cli-connect-timeout <value> int N Maximum connection time; entering 0 changes it to a blocked status instead of a timeout. It is set to 60 seconds by default.
--no-cli-pager boolean N Disable the CLI pager for response values. -
--cli-auto-prompt boolean N Enable automatic prompting for CLI input parameters. -
--no-cli-auto-prompt boolean N Disable automatic prompting for CLI input parameters. -
--sse-customer-algorithm string N User encryption algorithm (AES256) -
--sse-customer-key string N User-provided encryption key -
--sse-customer-key-md5 string N User-provided encryption key's MD5 value -

Permission

If a sub account user wants to use this command, they need the Change/putObject action permission.

Examples

This section describes an example of calling and responding to the create-multipart-upload command.

Multipart upload

Call examples

If you specify the bucket and object name for uploading a large object and call the command, the upload ID for the multipart upload is returned. The following is a call example.

aws s3api create-multipart-upload --endpoint-url=http://kr.ncloudstorage.com --bucket bucket-a --key 'multipart/01'

Response example

The response example is as follows:

{
    "Bucket": "bucket-a",
    "Key": "multipart/01",
    "UploadId": "a1b23c4d-e56f-78gh-9101-1ij2k345l789"
}

Related commands

Related commands are as follows: