Skip to content

/AWS1/IF_S3=>PUTOBJECTLEGALHOLD()

About PutObjectLegalHold

This operation is not supported for directory buckets.

Applies a legal hold configuration to the specified object. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Method Signature

METHODS /AWS1/IF_S3~PUTOBJECTLEGALHOLD
  IMPORTING
    !IV_BUCKET TYPE /AWS1/S3_BUCKETNAME OPTIONAL
    !IV_KEY TYPE /AWS1/S3_OBJECTKEY OPTIONAL
    !IO_LEGALHOLD TYPE REF TO /AWS1/CL_S3_OBJLOCKLEGALHOLD OPTIONAL
    !IV_REQUESTPAYER TYPE /AWS1/S3_REQUESTPAYER OPTIONAL
    !IV_VERSIONID TYPE /AWS1/S3_OBJECTVERSIONID OPTIONAL
    !IV_CONTENTMD5 TYPE /AWS1/S3_CONTENTMD5 OPTIONAL
    !IV_CHECKSUMALGORITHM TYPE /AWS1/S3_CHECKSUMALGORITHM OPTIONAL
    !IV_EXPECTEDBUCKETOWNER TYPE /AWS1/S3_ACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3_putobjlegalholdout
  RAISING
    /AWS1/CX_S3_CLIENTEXC
    /AWS1/CX_S3_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_bucket TYPE /AWS1/S3_BUCKETNAME /AWS1/S3_BUCKETNAME

The bucket name containing the object that you want to place a legal hold on.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

iv_key TYPE /AWS1/S3_OBJECTKEY /AWS1/S3_OBJECTKEY

The key name for the object that you want to place a legal hold on.

Optional arguments:

io_legalhold TYPE REF TO /AWS1/CL_S3_OBJLOCKLEGALHOLD /AWS1/CL_S3_OBJLOCKLEGALHOLD

Container element for the legal hold configuration you want to apply to the specified object.

iv_requestpayer TYPE /AWS1/S3_REQUESTPAYER /AWS1/S3_REQUESTPAYER

RequestPayer

iv_versionid TYPE /AWS1/S3_OBJECTVERSIONID /AWS1/S3_OBJECTVERSIONID

The version ID of the object that you want to place a legal hold on.

iv_contentmd5 TYPE /AWS1/S3_CONTENTMD5 /AWS1/S3_CONTENTMD5

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

iv_checksumalgorithm TYPE /AWS1/S3_CHECKSUMALGORITHM /AWS1/S3_CHECKSUMALGORITHM

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

iv_expectedbucketowner TYPE /AWS1/S3_ACCOUNTID /AWS1/S3_ACCOUNTID

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

RETURNING

oo_output TYPE REF TO /aws1/cl_s3_putobjlegalholdout /AWS1/CL_S3_PUTOBJLEGALHOLDOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->putobjectlegalhold(
  io_legalhold = new /aws1/cl_s3_objlocklegalhold( |string| )
  iv_bucket = |string|
  iv_checksumalgorithm = |string|
  iv_contentmd5 = |string|
  iv_expectedbucketowner = |string|
  iv_key = |string|
  iv_requestpayer = |string|
  iv_versionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_requestcharged = lo_result->get_requestcharged( ).
ENDIF.