GetObjectRetention

GetObjectRetention #

Overview #

Retrieves an object’s retention settings.

AWS API Reference: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html

Method #

GETOBJECTRETENTION

Import Parameters #

The request uses the following import parameters.

  • i_bucket_name (bucket in AWS) (Required)

    Name of the bucket.

  • i_region (Required)

    AWS Region of the Amazon S3 Bucket.

  • i_x_amz_request_payer (x-amz-request-payer in AWS)

    Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests.

  • i_x_amz_expected_b_owner (x-amz-expected-bucket-owner in AWS)

    The account id of the expected bucket owner.


Export Parameters #

This method use the following export parameters:

  • e_http_status

    HTTP Status code.

  • e_response_headers

    Returns information about the request in format Name/Value pair values.

  • e_response_content

    Response content in string format.

  • e_mode (Mode in AWS)

    Indicates the Retention mode for the specified object.

    Valid Values: GOVERNANCE | COMPLIANCE

  • e_retainuntildate (RetainUntilDate in AWS)

    The date on which this Object Lock Retention will expire.