/AWS1/CL_S3=>LISTBUCKETMETRICSCONFS()

About ListBucketMetricsConfigurations

This operation is not supported for directory buckets.

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 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:GetMetricsConfiguration 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 more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

• PutBucketMetricsConfiguration

• GetBucketMetricsConfiguration

• DeleteBucketMetricsConfiguration

Method Signature

IMPORTING

Required arguments:

iv_bucket TYPE /AWS1/S3_BUCKETNAME /AWS1/S3_BUCKETNAME

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

Optional arguments:

iv_continuationtoken TYPE /AWS1/S3_TOKEN /AWS1/S3_TOKEN

The marker that is used to continue a metrics 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_listbktmetconfsout /AWS1/CL_S3_LISTBKTMETCONFSOUT

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~listbucketmetricsconfs(
  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_istruncated = lo_result->get_istruncated( ).
  lv_token = lo_result->get_continuationtoken( ).
  lv_nexttoken = lo_result->get_nextcontinuationtoken( ).
  LOOP AT lo_result->get_metricsconfigurationlist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_metricsid = lo_row_1->get_id( ).
      lo_metricsfilter = lo_row_1->get_filter( ).
      IF lo_metricsfilter IS NOT INITIAL.
        lv_prefix = lo_metricsfilter->get_prefix( ).
        lo_tag = lo_metricsfilter->get_tag( ).
        IF lo_tag IS NOT INITIAL.
          lv_objectkey = lo_tag->get_key( ).
          lv_value = lo_tag->get_value( ).
        ENDIF.
        lv_accesspointarn = lo_metricsfilter->get_accesspointarn( ).
        lo_metricsandoperator = lo_metricsfilter->get_and( ).
        IF lo_metricsandoperator IS NOT INITIAL.
          lv_prefix = lo_metricsandoperator->get_prefix( ).
          LOOP AT lo_metricsandoperator->get_tags( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_objectkey = lo_row_3->get_key( ).
              lv_value = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_accesspointarn = lo_metricsandoperator->get_accesspointarn( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.