Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can click “Customize cookies” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To continue without accepting these cookies, click “Continue without accepting.” To make more detailed choices or learn more, click “Customize cookies.”

Skip to content

/AWS1/CL_GML=>DESCRIBECOMPUTE()

About DescribeCompute

Retrieves properties for a specific compute resource in an Amazon GameLift fleet. You can list all computes in a fleet by calling ListCompute.

Request options

Provide the fleet ID and compute name. The compute name varies depending on the type of fleet.

  • For a compute in a managed EC2 fleet, provide an instance ID. Each instance in the fleet is a compute.

  • For a compute in a managed container fleet, provide a compute name. In a container fleet, each game server container group on a fleet instance is assigned a compute name.

  • For a compute in an Anywhere fleet, provide a registered compute name. Anywhere fleet computes are created when you register a hosting resource with the fleet.

Results

If successful, this operation returns details for the requested compute resource. Depending on the fleet's compute type, the result includes the following information:

  • For a managed EC2 fleet, this operation returns information about the EC2 instance.

  • For an Anywhere fleet, this operation returns information about the registered compute.

Method Signature

IMPORTING

Required arguments:

iv_fleetid TYPE /AWS1/GMLFLEETIDORARN /AWS1/GMLFLEETIDORARN

A unique identifier for the fleet that the compute belongs to. You can use either the fleet ID or ARN value.

iv_computename TYPE /AWS1/GMLCOMPUTENAMEORARN /AWS1/GMLCOMPUTENAMEORARN

The unique identifier of the compute resource to retrieve properties for. For a managed container fleet or Anywhere fleet, use a compute name. For an EC2 fleet, use an instance ID. To retrieve a fleet's compute identifiers, call ListCompute.

RETURNING

oo_output TYPE REF TO /aws1/cl_gmldescrcomputeoutput /AWS1/CL_GMLDESCRCOMPUTEOUTPUT

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_gml~describecompute(
  iv_computename = |string|
  iv_fleetid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_compute = lo_result->get_compute( ).
  IF lo_compute IS NOT INITIAL.
    lv_fleetid = lo_compute->get_fleetid( ).
    lv_fleetarn = lo_compute->get_fleetarn( ).
    lv_computename = lo_compute->get_computename( ).
    lv_computearn = lo_compute->get_computearn( ).
    lv_ipaddress = lo_compute->get_ipaddress( ).
    lv_dnsname = lo_compute->get_dnsname( ).
    lv_computestatus = lo_compute->get_computestatus( ).
    lv_locationstringmodel = lo_compute->get_location( ).
    lv_timestamp = lo_compute->get_creationtime( ).
    lv_operatingsystem = lo_compute->get_operatingsystem( ).
    lv_ec2instancetype = lo_compute->get_type( ).
    lv_gameliftservicesdkendpo = lo_compute->get_gameliftservicesdkendpt( ).
    lv_gameliftagentendpointou = lo_compute->get_gameliftagentendpoint( ).
    lv_instanceid = lo_compute->get_instanceid( ).
    LOOP AT lo_compute->get_containerattributes( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_nonzeroand128maxasciist = lo_row_1->get_containername( ).
        lv_nonemptystring = lo_row_1->get_containerruntimeid( ).
      ENDIF.
    ENDLOOP.
    lv_containergroupdefinitio = lo_compute->get_gameservercontainergrd00( ).
  ENDIF.
ENDIF.