get-object-legal-hold¶
Description¶
Gets an object's current Legal Hold status.
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
Synopsis¶
get-object-legal-hold
--bucket <value>
--key <value>
[--version-id <value>]
[--request-payer <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
Options¶
--bucket (string)
The bucket containing the object whose Legal Hold status you want to retrieve.
--key (string)
The key name for the object whose Legal Hold status you want to retrieve.
--version-id (string)
The version ID of the object whose Legal Hold status you want to retrieve.
--request-payer (string)
Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
Possible values:
- requester
--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.
See 'aws help' for descriptions of global parameters.
Output¶
LegalHold -> (structure)
The current Legal Hold status for the specified object.
Status -> (string)
Indicates whether the specified object has a Legal Hold in place.