/AWS1/IF_RSH=>DESCRIBEUSAGELIMITS()

About DescribeUsageLimits

Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:

• If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned.

• If usage limit identifier is provided, then the corresponding usage limit object is returned.

• If cluster identifier is provided, then all usage limit objects for the specified cluster are returned.

• If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned.

Method Signature

METHODS /AWS1/IF_RSH~DESCRIBEUSAGELIMITS
  IMPORTING
    !IV_USAGELIMITID TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_CLUSTERIDENTIFIER TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_FEATURETYPE TYPE /AWS1/RSHUSAGELIMITFEATURETYPE OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/RSHINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/RSHSTRING OPTIONAL
    !IT_TAGKEYS TYPE /AWS1/CL_RSHTAGKEYLIST_W=>TT_TAGKEYLIST OPTIONAL
    !IT_TAGVALUES TYPE /AWS1/CL_RSHTAGVALUELIST_W=>TT_TAGVALUELIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rshusagelimitlist
  RAISING
    /AWS1/CX_RSHCLUSTNOTFOUNDFAULT
    /AWS1/CX_RSHUNSUPPORTEDOPFAULT
    /AWS1/CX_RSHCLIENTEXC
    /AWS1/CX_RSHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_usagelimitid TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The identifier of the usage limit to describe.

iv_clusteridentifier TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The identifier of the cluster for which you want to describe usage limits.

iv_featuretype TYPE /AWS1/RSHUSAGELIMITFEATURETYPE /AWS1/RSHUSAGELIMITFEATURETYPE

The feature type for which you want to describe usage limits.

iv_maxrecords TYPE /AWS1/RSHINTEGEROPTIONAL /AWS1/RSHINTEGEROPTIONAL

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

iv_marker TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

it_tagkeys TYPE /AWS1/CL_RSHTAGKEYLIST_W=>TT_TAGKEYLIST TT_TAGKEYLIST

A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.

it_tagvalues TYPE /AWS1/CL_RSHTAGVALUELIST_W=>TT_TAGVALUELIST TT_TAGVALUELIST

A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.

RETURNING

oo_output TYPE REF TO /aws1/cl_rshusagelimitlist /AWS1/CL_RSHUSAGELIMITLIST

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->describeusagelimits(
  it_tagkeys = VALUE /aws1/cl_rshtagkeylist_w=>tt_tagkeylist(
    ( new /aws1/cl_rshtagkeylist_w( |string| ) )
  )
  it_tagvalues = VALUE /aws1/cl_rshtagvaluelist_w=>tt_tagvaluelist(
    ( new /aws1/cl_rshtagvaluelist_w( |string| ) )
  )
  iv_clusteridentifier = |string|
  iv_featuretype = |string|
  iv_marker = |string|
  iv_maxrecords = 123
  iv_usagelimitid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_usagelimits( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_usagelimitid( ).
      lv_string = lo_row_1->get_clusteridentifier( ).
      lv_usagelimitfeaturetype = lo_row_1->get_featuretype( ).
      lv_usagelimitlimittype = lo_row_1->get_limittype( ).
      lv_long = lo_row_1->get_amount( ).
      lv_usagelimitperiod = lo_row_1->get_period( ).
      lv_usagelimitbreachaction = lo_row_1->get_breachaction( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_key( ).
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_marker( ).
ENDIF.