LISTGATEWAYINSTANCES()`¶

About ListGatewayInstances¶

Displays a list of instances associated with the Amazon Web Services account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).

Method Signature¶

METHODS /AWS1/IF_MDX~LISTGATEWAYINSTANCES
  IMPORTING
    !IV_FILTERARN TYPE /AWS1/MDXSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/MDXMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/MDXSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mdxlistgwinstsrsp
  RAISING
    /AWS1/CX_MDXBADREQUESTEX
    /AWS1/CX_MDXCONFLICTEXCEPTION
    /AWS1/CX_MDXINTERNALSERVERER00
    /AWS1/CX_MDXSERVICEUNAVAILEX
    /AWS1/CX_MDXTOOMANYREQUESTSEX
    /AWS1/CX_MDXCLIENTEXC
    /AWS1/CX_MDXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_filterarn` `TYPE /AWS1/MDXSTRING` `/AWS1/MDXSTRING`¶

Filter the list results to display only the instances associated with the selected Gateway ARN.

`iv_maxresults` `TYPE /AWS1/MDXMAXRESULTS` `/AWS1/MDXMAXRESULTS`¶

The maximum number of results to return per API request.

For example, you submit a ListInstances request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.

`iv_nexttoken` `TYPE /AWS1/MDXSTRING` `/AWS1/MDXSTRING`¶

The token that identifies the batch of results that you want to see.

For example, you submit a ListInstances request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken value.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_mdxlistgwinstsrsp` `/AWS1/CL_MDXLISTGWINSTSRSP`¶

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->listgatewayinstances(
  iv_filterarn = |string|
  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_instances( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_gatewayarn( ).
      lv_string = lo_row_1->get_gatewayinstancearn( ).
      lv_string = lo_row_1->get_instanceid( ).
      lv_instancestate = lo_row_1->get_instancestate( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_MDX=>LISTGATEWAYINSTANCES()¶