DESCRIBECAPACITYRESVTOPOLOGY()`¶

About DescribeCapacityReservationTopology¶

Describes a tree-based hierarchy that represents the physical host placement of your pending or active Capacity Reservations within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your capacity within the Amazon Web Services network before it is launched and use this information to allocate capacity together to support your tightly coupled workloads.

Capacity Reservation topology is supported for specific instance types only. For more information, see Prerequisites for Amazon EC2 instance topology in the Amazon EC2 User Guide.

The Amazon EC2 API follows an eventual consistency model due to the distributed nature of the system supporting it. As a result, when you call the DescribeCapacityReservationTopology API command immediately after launching instances, the response might return a null value for capacityBlockId because the data might not have fully propagated across all subsystems. For more information, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.

For more information, see Amazon EC2 topology in the Amazon EC2 User Guide.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBECAPACITYRESVTOPOLOGY
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DSCCAPRSVTOPOLOGYMA00 OPTIONAL
    !IT_CAPACITYRESERVATIONIDS TYPE /AWS1/CL_EC2CAPRESERVATIONID00=>TT_CAPACITYRESERVATIONIDSET OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2dsccaprsvtopolog01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

Checks whether you have the required permissions for the operation, 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.

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

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

`iv_maxresults` `TYPE /AWS1/EC2DSCCAPRSVTOPOLOGYMA00` `/AWS1/EC2DSCCAPRSVTOPOLOGYMA00`¶

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.

You can't specify this parameter and the Capacity Reservation IDs parameter in the same request.

Default: 10

`it_capacityreservationids` `TYPE /AWS1/CL_EC2CAPRESERVATIONID00=>TT_CAPACITYRESERVATIONIDSET` `TT_CAPACITYRESERVATIONIDSET`¶

The Capacity Reservation IDs.

Default: Describes all your Capacity Reservations.

Constraints: Maximum 100 explicitly specified Capacity Reservation IDs.

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

The filters.

availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the Capacity Reservation is in.

instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d). You can use the wildcard to match zero or more characters, or the ? wildcard to match zero or one character.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2dsccaprsvtopolog01` `/AWS1/CL_EC2DSCCAPRSVTOPOLOG01`¶

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->describecapacityresvtopology(
  it_capacityreservationids = VALUE /aws1/cl_ec2capreservationid00=>tt_capacityreservationidset(
    ( new /aws1/cl_ec2capreservationid00( |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.
  lv_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_capacityreservations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_capacityreservationid( ).
      lv_string = lo_row_1->get_capacityblockid( ).
      lv_string = lo_row_1->get_state( ).
      lv_string = lo_row_1->get_instancetype( ).
      lv_string = lo_row_1->get_groupname( ).
      LOOP AT lo_row_1->get_networknodes( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_availabilityzoneid( ).
      lv_string = lo_row_1->get_availabilityzone( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_EC2=>DESCRIBECAPACITYRESVTOPOLOGY()¶