/AWS1/IF_S3=>GETBUCKETMETRICSCONF()

About GetBucketMetricsConfiguration

This operation is not supported for directory buckets.

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

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 information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to GetBucketMetricsConfiguration:

• PutBucketMetricsConfiguration

• DeleteBucketMetricsConfiguration

• ListBucketMetricsConfigurations

• Monitoring Metrics with Amazon CloudWatch

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~GETBUCKETMETRICSCONF
  IMPORTING
    !IV_BUCKET TYPE /AWS1/S3_BUCKETNAME OPTIONAL
    !IV_ID TYPE /AWS1/S3_METRICSID OPTIONAL
    !IV_EXPECTEDBUCKETOWNER TYPE /AWS1/S3_ACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3_getbktmetconfout
  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 name of the bucket containing the metrics configuration to retrieve.

iv_id TYPE /AWS1/S3_METRICSID /AWS1/S3_METRICSID

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

Optional arguments:

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_getbktmetconfout /AWS1/CL_S3_GETBKTMETCONFOUT

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->getbucketmetricsconf(
  iv_bucket = |string|
  iv_expectedbucketowner = |string|
  iv_id = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_metricsconfiguration = lo_result->get_metricsconfiguration( ).
  IF lo_metricsconfiguration IS NOT INITIAL.
    lv_metricsid = lo_metricsconfiguration->get_id( ).
    lo_metricsfilter = lo_metricsconfiguration->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.
          lo_row_1 = lo_row.
          IF lo_row_1 IS NOT INITIAL.
            lv_objectkey = lo_row_1->get_key( ).
            lv_value = lo_row_1->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_accesspointarn = lo_metricsandoperator->get_accesspointarn( ).
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.