DESCRIBESCALINGPOLICIES()`¶

About DescribeScalingPolicies¶

This API works with the following fleet types: EC2

Retrieves all scaling policies applied to a fleet.

To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE.

Method Signature¶

METHODS /AWS1/IF_GML~DESCRIBESCALINGPOLICIES
  IMPORTING
    !IV_FLEETID TYPE /AWS1/GMLFLEETIDORARN OPTIONAL
    !IV_STATUSFILTER TYPE /AWS1/GMLSCALINGSTATUSTYPE OPTIONAL
    !IV_LIMIT TYPE /AWS1/GMLPOSITIVEINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/GMLNONZEROANDMAXSTRING OPTIONAL
    !IV_LOCATION TYPE /AWS1/GMLLOCATIONSTRINGMODEL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmldescrscapoloutput
  RAISING
    /AWS1/CX_GMLINTERNALSERVICEEX
    /AWS1/CX_GMLINVALIDREQUESTEX
    /AWS1/CX_GMLNOTFOUNDEXCEPTION
    /AWS1/CX_GMLUNAUTHORIZEDEX
    /AWS1/CX_GMLUNSUPPEDREGIONEX
    /AWS1/CX_GMLCLIENTEXC
    /AWS1/CX_GMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_fleetid` `TYPE /AWS1/GMLFLEETIDORARN` `/AWS1/GMLFLEETIDORARN`¶

A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.

Optional arguments:¶

`iv_statusfilter` `TYPE /AWS1/GMLSCALINGSTATUSTYPE` `/AWS1/GMLSCALINGSTATUSTYPE`¶

Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

ACTIVE -- The scaling policy is currently in force.

UPDATEREQUESTED -- A request to update the scaling policy has been received.

UPDATING -- A change is being made to the scaling policy.

DELETEREQUESTED -- A request to delete the scaling policy has been received.

DELETING -- The scaling policy is being deleted.

DELETED -- The scaling policy has been deleted.

ERROR -- An error occurred in creating the policy. It should be removed and recreated.

`iv_limit` `TYPE /AWS1/GMLPOSITIVEINTEGER` `/AWS1/GMLPOSITIVEINTEGER`¶

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

`iv_nexttoken` `TYPE /AWS1/GMLNONZEROANDMAXSTRING` `/AWS1/GMLNONZEROANDMAXSTRING`¶

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

`iv_location` `TYPE /AWS1/GMLLOCATIONSTRINGMODEL` `/AWS1/GMLLOCATIONSTRINGMODEL`¶

The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gmldescrscapoloutput` `/AWS1/CL_GMLDESCRSCAPOLOUTPUT`¶

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->describescalingpolicies(
  iv_fleetid = |string|
  iv_limit = 123
  iv_location = |string|
  iv_nexttoken = |string|
  iv_statusfilter = |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_scalingpolicies( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_fleetid = lo_row_1->get_fleetid( ).
      lv_fleetarn = lo_row_1->get_fleetarn( ).
      lv_nonzeroandmaxstring = lo_row_1->get_name( ).
      lv_scalingstatustype = lo_row_1->get_status( ).
      lv_integer = lo_row_1->get_scalingadjustment( ).
      lv_scalingadjustmenttype = lo_row_1->get_scalingadjustmenttype( ).
      lv_comparisonoperatortype = lo_row_1->get_comparisonoperator( ).
      lv_double = lo_row_1->get_threshold( ).
      lv_positiveinteger = lo_row_1->get_evaluationperiods( ).
      lv_metricname = lo_row_1->get_metricname( ).
      lv_policytype = lo_row_1->get_policytype( ).
      lo_targetconfiguration = lo_row_1->get_targetconfiguration( ).
      IF lo_targetconfiguration IS NOT INITIAL.
        lv_double = lo_targetconfiguration->get_targetvalue( ).
      ENDIF.
      lv_locationupdatestatus = lo_row_1->get_updatestatus( ).
      lv_locationstringmodel = lo_row_1->get_location( ).
    ENDIF.
  ENDLOOP.
  lv_nonzeroandmaxstring = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_GML=>DESCRIBESCALINGPOLICIES()¶