Skip to content

/AWS1/IF_SQT=>GETQUOTAUTILIZATIONREPORT()

About GetQuotaUtilizationReport

Retrieves the quota utilization report for your Amazon Web Services account. This operation returns paginated results showing your quota usage across all Amazon Web Services services, sorted by utilization percentage in descending order (highest utilization first).

You must first initiate a report using the StartQuotaUtilizationReport operation. The report generation process is asynchronous and may take several seconds to complete. Poll this operation periodically to check the status and retrieve results when the report is ready.

Each report contains up to 1,000 quota records per page. Use the NextToken parameter to retrieve additional pages of results. Reports are automatically deleted after 15 minutes.

Method Signature

METHODS /AWS1/IF_SQT~GETQUOTAUTILIZATIONREPORT
  IMPORTING
    !IV_REPORTID TYPE /AWS1/SQTREPORTID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SQTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SQTMAXRESULTSUTILIZATION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sqtgetquotautilrptrsp
  RAISING
    /AWS1/CX_SQTACCESSDENIEDEX
    /AWS1/CX_SQTILLEGALARGUMENTEX
    /AWS1/CX_SQTNOSUCHRESOURCEEX
    /AWS1/CX_SQTSERVICEEXCEPTION
    /AWS1/CX_SQTTOOMANYREQUESTSEX
    /AWS1/CX_SQTCLIENTEXC
    /AWS1/CX_SQTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_reportid TYPE /AWS1/SQTREPORTID /AWS1/SQTREPORTID

The unique identifier for the quota utilization report. This identifier is returned by the StartQuotaUtilizationReport operation.

Optional arguments:

iv_nexttoken TYPE /AWS1/SQTNEXTTOKEN /AWS1/SQTNEXTTOKEN

A token that indicates the next page of results to retrieve. This token is returned in the response when there are more results available. Omit this parameter for the first request.

iv_maxresults TYPE /AWS1/SQTMAXRESULTSUTILIZATION /AWS1/SQTMAXRESULTSUTILIZATION

The maximum number of results to return per page. The default value is 1,000 and the maximum allowed value is 1,000.

RETURNING

oo_output TYPE REF TO /aws1/cl_sqtgetquotautilrptrsp /AWS1/CL_SQTGETQUOTAUTILRPTRSP

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->getquotautilizationreport(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_reportid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_reportid = lo_result->get_reportid( ).
  lv_reportstatus = lo_result->get_status( ).
  lv_datetime = lo_result->get_generatedat( ).
  lv_totalcount = lo_result->get_totalcount( ).
  LOOP AT lo_result->get_quotas( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_quotacode = lo_row_1->get_quotacode( ).
      lv_servicecode = lo_row_1->get_servicecode( ).
      lv_quotaname = lo_row_1->get_quotaname( ).
      lv_quotametricnamespace = lo_row_1->get_namespace( ).
      lv_utilizationpct = lo_row_1->get_utilization( ).
      lv_defaultvalue = lo_row_1->get_defaultvalue( ).
      lv_appliedvalue = lo_row_1->get_appliedvalue( ).
      lv_servicename = lo_row_1->get_servicename( ).
      lv_quotaadjustable = lo_row_1->get_adjustable( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
  lv_reporterrorcode = lo_result->get_errorcode( ).
  lv_reporterrormessage = lo_result->get_errormessage( ).
ENDIF.