DESCRIBECAPACITYBLOCKS()`¶

About DescribeCapacityBlocks¶

Describes details about Capacity Blocks in the Amazon Web Services Region that you're currently using.

Method Signature¶

IMPORTING¶

Optional arguments:¶

`it_capacityblockids` `TYPE /AWS1/CL_EC2CAPACITYBLOCKIDS_W=>TT_CAPACITYBLOCKIDS` `TT_CAPACITYBLOCKIDS`¶

The IDs of the Capacity Blocks.

`iv_nexttoken` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The token to use to retrieve the next page of results.

`iv_maxresults` `TYPE /AWS1/EC2DSCCAPBLOCKSMAXRSS` `/AWS1/EC2DSCCAPBLOCKSMAXRSS`¶

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

`it_filters` `TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

One or more filters.

capacity-block-id - The ID of the Capacity Block.

ultraserver-type - The Capacity Block type. The type can be instances or ultraservers.

availability-zone - The Availability Zone of the Capacity Block.

start-date - The date and time at which the Capacity Block was started.

end-date - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

create-date - The date and time at which the Capacity Block was created.

state - The state of the Capacity Block (active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed).

tags - The tags assigned to the Capacity Block.

`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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2descrcapblocksrslt` `/AWS1/CL_EC2DESCRCAPBLOCKSRSLT`¶

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~describecapacityblocks(
  it_capacityblockids = VALUE /aws1/cl_ec2capacityblockids_w=>tt_capacityblockids(
    ( new /aws1/cl_ec2capacityblockids_w( |string| ) )
  )
  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|
      )
    )
  )
  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.
  LOOP AT lo_result->get_capacityblocks( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_capacityblockid = lo_row_1->get_capacityblockid( ).
      lv_string = lo_row_1->get_ultraservertype( ).
      lv_string = lo_row_1->get_availabilityzone( ).
      lv_string = lo_row_1->get_availabilityzoneid( ).
      LOOP AT lo_row_1->get_capacityreservationids( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_capacityreservationid = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_milliseconddatetime = lo_row_1->get_startdate( ).
      lv_milliseconddatetime = lo_row_1->get_enddate( ).
      lv_milliseconddatetime = lo_row_1->get_createdate( ).
      lv_capacityblockresourcest = lo_row_1->get_state( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_string = lo_row_5->get_key( ).
          lv_string = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/CL_EC2=>DESCRIBECAPACITYBLOCKS()¶