restore-object

Prev Next

Available in Classic and VPC

Restore an object so that the object stored in the Deep Archive Class can be accessed.

Commands

The command statement is as follows:

aws s3api restore-object --bucket <value> --key <value>

Parameter

The following describes the parameters.

Parameter Type Required Description Restrictions
--bucket <value> string Y Bucket where the object is stored -
--key <value> string Y Name (key value) of the object to restore -
--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.
--version-id <value> string N When restoring a specific version of an object in a bucket with version control enabled, specify the version ID. -
--restore-request <value> string N Specify the options when restoring. Days: number of days to store restored copies in 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. -

Permission

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

Examples

This section describes an example of calling and responding to the restore-object command.

Restore object

Call examples

When you specify the object to be restored and call the command, a copy of the object is created in the Standard Class. You can check the recovery status and recovery expiration date by querying the object with head-object. The following is a call example.

aws s3api restore-object --bucket bucket-a --key img/image2.png --restore-request Days=10 \
--endpoint-url=https://kr.ncloudstorage.com