ListObjectVersions

ListObjectVersions #

Overview #

Returns metadata about all versions of the objects in a bucket.

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

Method #

LISTOBJECTVERSIONS

Import Parameters #

The request uses the following import parameters.

  • i_bucket_name (bucket in AWS) (Required)

    Name of the bucket to create.

  • i_region (Required)

    AWS Region of the Amazon S3 Bucket.

  • i_delimiter (delimiter)

    A delimiter is a character that you specify to group keys.

  • i_encodingtype (encoding-type)

    Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use.

  • i_keymarker (key-marker)

    Specifies the key to start with when listing objects in a bucket.

  • i_maxkeys (max-keys)

    Sets the maximum number of keys returned in the response.

  • i_prefix (prefix)

    Use this parameter to select only those keys that begin with the specified prefix.

  • i_versionidmarker (version-id-marker)

    Specifies the object version you want to start listing from.

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

    The account id of the expected bucket owner.


Export Parameters #

This method use the following export parameters:

  • e_istruncated (IsTruncated in AWS)

    Indicates whether the returned list of analytics configurations is complete.

  • e_nextkeymarker(NextKeyMarker)

    When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria.

  • e_nextversionidmarkerr(NextVersionIdMarker)

    When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria.

  • 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->listobjectversions
          EXPORTING
            i_bucket_name            = 'i_bucket_name'
            i_region                 = 'i_region'
            i_delimiter              = 'i_delimiter'
*           i_encodingtype           =
*           i_keymarker              =
*           i_maxkeys                =
            i_prefix                 = 'i_prefix'
*           i_versionidmarker        =
            i_x_amz_expected_b_owner = 'i_x_amz_expected_b_owner'
          IMPORTING
*           e_istruncated            =
*           e_nextkeymarker          =
*           e_nextversionidmarkerr   =
            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.