get-object-legal-hold

Available in Classic and VPC

Get the legal hold status set on an Ncloud Storage object.

Commands

The command statement is as follows:

aws s3api get-object-legal-hold --bucket <value> --key <value> [--options]

Parameter

The following describes the parameters.

Parameter	Type	Required	Description	Restrictions
--bucket <value>	string	Y	Target bucket where the object is stored	-
--key <value>	string	Y	Name of the object for which you want to check the legal hold status	-
--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	Specify the version ID of the object for which you want to check the legal hold status.	-
--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.	-

Permissions

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

Examples

This section describes examples of calls and responses for the get-object-legal-hold command.

Get legal hold status

Call examples

You can use the get-object-legal-hold command to retrieve the legal hold status set on an object. The following is a call example.

aws s3api get-object-legal-hold --bucket bucket-a --key object.csv --endpoint-url=https://kr.ncloudstorage.com

Response example

The response example is as follows:

{
    "LegalHold": {
        "Status": "ON"
    }
}

Related commands

Related commands are as follows:

Documentation Index