PutObjectLegalHold

PutObjectLegalHold #

Overview #

Applies a Legal Hold configuration to the specified object.

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

Method #

PUTOBJECTLEGALHOLD

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_key(Key in AWS) (Required)

    The key name for the object that you want to place a Legal Hold on.

  • i_versionid(versionId in AWS)

    The version ID of the object that you want to place a Legal Hold on.

  • i_status(Status in AWS)

    ndicates whether the specified object has a Legal Hold in place.

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

    Confirms that the requester knows that they will be charged for the request.

  • 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.


Example #

DATA: lo_s3               TYPE REF TO /lnkc/cl_sdk_aws_s3,
      lv_http_status      TYPE i,
      lt_response_headers TYPE tihttpnvp,
      lv_response_content TYPE string.

  TRY.
      CREATE OBJECT lo_s3
        EXPORTING
          i_user_name         = 'user_awsconnector'
          i_access_key        = 'acces_key_value'
          i_secret_access_key = 'secret_acceskey_value'.
  ENDTRY.


  TRY.
        CALL METHOD lo_s3->putobjectlegalhold
          EXPORTING
            i_bucket_name      = 'i_bucket_name'
            i_region           = 'i_region'
            i_key              = 'i_key'
*           i_versionid        =
            i_status           = 'i_status'
            i_xamzrequestpayer = '_xamzrequestpayer'
          IMPORTING
            e_http_status      = lv_http_status
            e_response_headers = lt_response_headers
            e_response_content = lv_response_content.
        .
      CATCH /lnkc/cx_sdk_aws .
        " Error Message
  ENDTRY.