LISTBUCKETINVENTORYCONFS()`¶

About ListBucketInventoryConfigurations¶

This operation is not supported for directory buckets.

Returns a list of S3 Inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory

The following operations are related to ListBucketInventoryConfigurations:

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_bucket` `TYPE /AWS1/S3_BUCKETNAME` `/AWS1/S3_BUCKETNAME`¶

The name of the bucket containing the inventory configurations to retrieve.

Optional arguments:¶

`iv_continuationtoken` `TYPE /AWS1/S3_TOKEN` `/AWS1/S3_TOKEN`¶

The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

`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_listbktinvconfsout` `/AWS1/CL_S3_LISTBKTINVCONFSOUT`¶

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->/aws1/if_s3~listbucketinventoryconfs(
  iv_bucket = |string|
  iv_continuationtoken = |string|
  iv_expectedbucketowner = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_token = lo_result->get_continuationtoken( ).
  LOOP AT lo_result->get_inventoryconflist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_inventorydestination = lo_row_1->get_destination( ).
      IF lo_inventorydestination IS NOT INITIAL.
        lo_inventorys3bucketdestin = lo_inventorydestination->get_s3bucketdestination( ).
        IF lo_inventorys3bucketdestin IS NOT INITIAL.
          lv_accountid = lo_inventorys3bucketdestin->get_accountid( ).
          lv_bucketname = lo_inventorys3bucketdestin->get_bucket( ).
          lv_inventoryformat = lo_inventorys3bucketdestin->get_format( ).
          lv_prefix = lo_inventorys3bucketdestin->get_prefix( ).
          lo_inventoryencryption = lo_inventorys3bucketdestin->get_encryption( ).
          IF lo_inventoryencryption IS NOT INITIAL.
            lo_sses3 = lo_inventoryencryption->get_sses3( ).
            IF lo_sses3 IS NOT INITIAL.
            ENDIF.
            lo_ssekms = lo_inventoryencryption->get_ssekms( ).
            IF lo_ssekms IS NOT INITIAL.
              lv_ssekmskeyid = lo_ssekms->get_keyid( ).
            ENDIF.
          ENDIF.
        ENDIF.
      ENDIF.
      lv_isenabled = lo_row_1->get_isenabled( ).
      lo_inventoryfilter = lo_row_1->get_filter( ).
      IF lo_inventoryfilter IS NOT INITIAL.
        lv_prefix = lo_inventoryfilter->get_prefix( ).
      ENDIF.
      lv_inventoryid = lo_row_1->get_id( ).
      lv_inventoryincludedobject = lo_row_1->get_includedobjectversions( ).
      LOOP AT lo_row_1->get_optionalfields( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_inventoryoptionalfield = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lo_inventoryschedule = lo_row_1->get_schedule( ).
      IF lo_inventoryschedule IS NOT INITIAL.
        lv_inventoryfrequency = lo_inventoryschedule->get_frequency( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_istruncated = lo_result->get_istruncated( ).
  lv_nexttoken = lo_result->get_nextcontinuationtoken( ).
ENDIF.

/AWS1/CL_S3=>LISTBUCKETINVENTORYCONFS()¶