get-object-retention

Retrieves an object’s retention settings.

See also: GET Object Retention

Synopsis

get-object-retention
  --bucket <value>
  --key <value>
  [--version-id <value>]
  [--cli-input-json <value>]

Options

--bucket (string)

The bucket containing the object whose retention settings you want to retrieve.

--key (string)

The key name for the object whose retention settings you want to retrieve.

--version-id (string)

The version ID for the object whose retention settings you want to retrieve.

--cli-input-json (string)

Operates a service or services based on the provided JSON string. If other arguments are provided on the command line, the CLI values override the JSON-provided values. You cannot pass arbitrary binary values using a JSON-provided value, because the string is taken literally.

Output

Retention -> (structure)

The container element for an object’s retention settings.

Mode -> (string)

Indicates the retention mode for the specified object; for example, GOVERNANCE or COMPLIANCE.

RetainUntilDate -> (timestamp)

The date this object lock retention expires.