/AWS1/IF_ASC=>DESCRIBESCALINGACTIVITIES()

About DescribeScalingActivities

Gets information about the scaling activities in the account and Region.

When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verify a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

If the scaling event succeeds, the value of the StatusCode element in the response is Successful. If an attempt to launch instances failed, the StatusCode value is Failed or Cancelled and the StatusMessage element in the response indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Method Signature

METHODS /AWS1/IF_ASC~DESCRIBESCALINGACTIVITIES
  IMPORTING
    !IT_ACTIVITYIDS TYPE /AWS1/CL_ASCACTIVITYIDS_W=>TT_ACTIVITYIDS OPTIONAL
    !IV_AUTOSCALINGGROUPNAME TYPE /AWS1/ASCXMLSTRINGMAXLEN255 OPTIONAL
    !IV_INCLUDEDELETEDGROUPS TYPE /AWS1/ASCINCLUDEDELETEDGROUPS OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/ASCMAXRECORDS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ASCXMLSTRING OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_ASCFILTER=>TT_FILTERS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ascactivitiestype
  RAISING
    /AWS1/CX_ASCINVALIDNEXTTOKEN
    /AWS1/CX_ASCRESRCCONTIONFAULT
    /AWS1/CX_ASCCLIENTEXC
    /AWS1/CX_ASCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

it_activityids TYPE /AWS1/CL_ASCACTIVITYIDS_W=>TT_ACTIVITYIDS TT_ACTIVITYIDS

The activity IDs of the desired scaling activities. If unknown activity IDs are requested, they are ignored with no error. Only activities started within the last six weeks can be returned regardless of the activity IDs specified. If other filters are specified with the request, only results matching all filter criteria can be returned.

Array Members: Maximum number of 50 IDs.

iv_autoscalinggroupname TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255

The name of the Auto Scaling group.

Omitting this property performs an account-wide operation, which can result in slower or timed-out requests.

iv_includedeletedgroups TYPE /AWS1/ASCINCLUDEDELETEDGROUPS /AWS1/ASCINCLUDEDELETEDGROUPS

Indicates whether to include scaling activity from deleted Auto Scaling groups.

iv_maxrecords TYPE /AWS1/ASCMAXRECORDS /AWS1/ASCMAXRECORDS

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

iv_nexttoken TYPE /AWS1/ASCXMLSTRING /AWS1/ASCXMLSTRING

The token for the next set of items to return. (You received this token from a previous call.)

it_filters TYPE /AWS1/CL_ASCFILTER=>TT_FILTERS TT_FILTERS

One or more filters to limit the results based on specific criteria. The following filters are supported:

• StartTimeLowerBound - The earliest scaling activities to return based on the activity start time. Scaling activities with a start time earlier than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified.

• StartTimeUpperBound - The latest scaling activities to return based on the activity start time. Scaling activities with a start time later than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified.

• Status - The StatusCode value of the scaling activity. This filter can only be used in combination with the AutoScalingGroupName parameter. For valid StatusCode values, see Activity in the Amazon EC2 Auto Scaling API Reference.

StartTimeLowerBound and StartTimeUpperBound accept ISO 8601 formatted timestamps. Timestamps without a timezone offset are assumed to be UTC.

• 2000-01-18T08:15:00Z

• 2000-01-18T16:15:00+08:00

RETURNING

oo_output TYPE REF TO /aws1/cl_ascactivitiestype /AWS1/CL_ASCACTIVITIESTYPE

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->describescalingactivities(
  it_activityids = VALUE /aws1/cl_ascactivityids_w=>tt_activityids(
    ( new /aws1/cl_ascactivityids_w( |string| ) )
  )
  it_filters = VALUE /aws1/cl_ascfilter=>tt_filters(
    (
      new /aws1/cl_ascfilter(
        it_values = VALUE /aws1/cl_ascvalues_w=>tt_values(
          ( new /aws1/cl_ascvalues_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_autoscalinggroupname = |string|
  iv_includedeletedgroups = ABAP_TRUE
  iv_maxrecords = 123
  iv_nexttoken = |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_activities( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_xmlstring = lo_row_1->get_activityid( ).
      lv_xmlstringmaxlen255 = lo_row_1->get_autoscalinggroupname( ).
      lv_xmlstring = lo_row_1->get_description( ).
      lv_xmlstringmaxlen1023 = lo_row_1->get_cause( ).
      lv_timestamptype = lo_row_1->get_starttime( ).
      lv_timestamptype = lo_row_1->get_endtime( ).
      lv_scalingactivitystatusco = lo_row_1->get_statuscode( ).
      lv_xmlstringmaxlen255 = lo_row_1->get_statusmessage( ).
      lv_progress = lo_row_1->get_progress( ).
      lv_xmlstring = lo_row_1->get_details( ).
      lv_autoscalinggroupstate = lo_row_1->get_autoscalinggroupstate( ).
      lv_resourcename = lo_row_1->get_autoscalinggrouparn( ).
    ENDIF.
  ENDLOOP.
  lv_xmlstring = lo_result->get_nexttoken( ).
ENDIF.

To describe the scaling activities for an Auto Scaling group

This example describes the scaling activities for the specified Auto Scaling group.

DATA(lo_result) = lo_client->describescalingactivities( iv_autoscalinggroupname = |my-auto-scaling-group| ) .