Skip to content

/AWS1/CL_EC2=>DESCRIBESCHEDULEDINSTANCES()

About DescribeScheduledInstances

Describes the specified Scheduled Instances or all your Scheduled Instances.

Method Signature

IMPORTING

Optional arguments:

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

it_filters TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST TT_FILTERLIST

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • platform - The platform (Linux/UNIX or Windows).

iv_maxresults TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

iv_nexttoken TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The token for the next set of results.

it_scheduledinstanceids TYPE /AWS1/CL_EC2SCHDINSTIDREQSET_W=>TT_SCHDDINSTANCEIDREQUESTSET TT_SCHDDINSTANCEIDREQUESTSET

The Scheduled Instance IDs.

io_slotstarttimerange TYPE REF TO /AWS1/CL_EC2SLOTSTRTTIMERANG00 /AWS1/CL_EC2SLOTSTRTTIMERANG00

The time period for the first schedule to start.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2dscschdinstsresult /AWS1/CL_EC2DSCSCHDINSTSRESULT

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->/aws1/if_ec2~describescheduledinstances(
  io_slotstarttimerange = new /aws1/cl_ec2slotstrttimerang00(
    iv_earliesttime = '20150101000000.0000000'
    iv_latesttime = '20150101000000.0000000'
  )
  it_filters = VALUE /aws1/cl_ec2filter=>tt_filterlist(
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_scheduledinstanceids = VALUE /aws1/cl_ec2schdinstidreqset_w=>tt_schddinstanceidrequestset(
    ( new /aws1/cl_ec2schdinstidreqset_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_scheduledinstanceset( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_availabilityzone( ).
      lv_datetime = lo_row_1->get_createdate( ).
      lv_string = lo_row_1->get_hourlyprice( ).
      lv_integer = lo_row_1->get_instancecount( ).
      lv_string = lo_row_1->get_instancetype( ).
      lv_string = lo_row_1->get_networkplatform( ).
      lv_datetime = lo_row_1->get_nextslotstarttime( ).
      lv_string = lo_row_1->get_platform( ).
      lv_datetime = lo_row_1->get_previousslotendtime( ).
      lo_scheduledinstancerecurr = lo_row_1->get_recurrence( ).
      IF lo_scheduledinstancerecurr IS NOT INITIAL.
        lv_string = lo_scheduledinstancerecurr->get_frequency( ).
        lv_integer = lo_scheduledinstancerecurr->get_interval( ).
        LOOP AT lo_scheduledinstancerecurr->get_occurrencedayset( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_integer = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_boolean = lo_scheduledinstancerecurr->get_occurrencerelativetoend( ).
        lv_string = lo_scheduledinstancerecurr->get_occurrenceunit( ).
      ENDIF.
      lv_string = lo_row_1->get_scheduledinstanceid( ).
      lv_integer = lo_row_1->get_slotdurationinhours( ).
      lv_datetime = lo_row_1->get_termenddate( ).
      lv_datetime = lo_row_1->get_termstartdate( ).
      lv_integer = lo_row_1->get_totalschddinstancehours( ).
    ENDIF.
  ENDLOOP.
ENDIF.