Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . backupstorage ]



Upload object that can store object metadata String and data blob in single API call using inline chunk field.

See also: AWS API Documentation


--backup-job-id <value>
--object-name <value>
[--metadata-string <value>]
[--inline-chunk <value>]
[--inline-chunk-length <value>]
[--inline-chunk-checksum <value>]
[--inline-chunk-checksum-algorithm <value>]
[--object-checksum <value>]
[--object-checksum-algorithm <value>]
[--throw-on-duplicate | --no-throw-on-duplicate]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--endpoint-url <value>]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]


--backup-job-id (string) Backup job Id for the in-progress backup.

--object-name (string) The name of the Object to be uploaded.

--metadata-string (string) Store user defined metadata like backup checksum, disk ids, restore metadata etc.

--inline-chunk (streaming blob) Inline chunk data to be uploaded.


This argument is of type: streaming blob. Its value must be the path to a file (e.g. path/to/file) and must not be prefixed with file:// or fileb://

--inline-chunk-length (long) Length of the inline chunk data.

--inline-chunk-checksum (string) Inline chunk checksum

--inline-chunk-checksum-algorithm (string) Inline chunk checksum algorithm

--object-checksum (string) object checksum

--object-checksum-algorithm (string) object checksum algorithm

Possible values:


--throw-on-duplicate | --no-throw-on-duplicate (boolean) Throw an exception if Object name is already exist.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.


InlineChunkChecksum -> (string)

Inline chunk checksum

InlineChunkChecksumAlgorithm -> (string)

Inline chunk checksum algorithm

ObjectChecksum -> (string)

object checksum

ObjectChecksumAlgorithm -> (string)

object checksum algorithm