Skip to content

/AWS1/IF_FRM=>LISTSTACKINSTANCES()

About ListStackInstances

Returns summary information about stack instances that are associated with the specified StackSet. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.

Method Signature

METHODS /AWS1/IF_FRM~LISTSTACKINSTANCES
  IMPORTING
    !IV_STACKSETNAME TYPE /AWS1/FRMSTACKSETNAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/FRMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/FRMMAXRESULTS OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_FRMSTACKINSTFILTER=>TT_STACKINSTANCEFILTERS OPTIONAL
    !IV_STACKINSTANCEACCOUNT TYPE /AWS1/FRMACCOUNT OPTIONAL
    !IV_STACKINSTANCEREGION TYPE /AWS1/FRMREGION OPTIONAL
    !IV_CALLAS TYPE /AWS1/FRMCALLAS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmliststackinstsout
  RAISING
    /AWS1/CX_FRMSTACKSETNOTFOUNDEX
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_stacksetname TYPE /AWS1/FRMSTACKSETNAME /AWS1/FRMSTACKSETNAME

The name or unique ID of the StackSet that you want to list stack instances for.

Optional arguments:

iv_nexttoken TYPE /AWS1/FRMNEXTTOKEN /AWS1/FRMNEXTTOKEN

The token for the next set of items to return. (You received this token from a previous call.)

iv_maxresults TYPE /AWS1/FRMMAXRESULTS /AWS1/FRMMAXRESULTS

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

it_filters TYPE /AWS1/CL_FRMSTACKINSTFILTER=>TT_STACKINSTANCEFILTERS TT_STACKINSTANCEFILTERS

The filter to apply to stack instances

iv_stackinstanceaccount TYPE /AWS1/FRMACCOUNT /AWS1/FRMACCOUNT

The name of the Amazon Web Services account that you want to list stack instances for.

iv_stackinstanceregion TYPE /AWS1/FRMREGION /AWS1/FRMREGION

The name of the Region where you want to list stack instances.

iv_callas TYPE /AWS1/FRMCALLAS /AWS1/FRMCALLAS

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_frmliststackinstsout /AWS1/CL_FRMLISTSTACKINSTSOUT

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->liststackinstances(
  it_filters = VALUE /aws1/cl_frmstackinstfilter=>tt_stackinstancefilters(
    (
      new /aws1/cl_frmstackinstfilter(
        iv_name = |string|
        iv_values = |string|
      )
    )
  )
  iv_callas = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_stackinstanceaccount = |string|
  iv_stackinstanceregion = |string|
  iv_stacksetname = |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_summaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_stacksetid = lo_row_1->get_stacksetid( ).
      lv_region = lo_row_1->get_region( ).
      lv_account = lo_row_1->get_account( ).
      lv_stackid = lo_row_1->get_stackid( ).
      lv_stackinstancestatus = lo_row_1->get_status( ).
      lv_reason = lo_row_1->get_statusreason( ).
      lo_stackinstancecomprehens = lo_row_1->get_stackinstancestatus( ).
      IF lo_stackinstancecomprehens IS NOT INITIAL.
        lv_stackinstancedetailedst = lo_stackinstancecomprehens->get_detailedstatus( ).
      ENDIF.
      lv_organizationalunitid = lo_row_1->get_organizationalunitid( ).
      lv_stackdriftstatus = lo_row_1->get_driftstatus( ).
      lv_timestamp = lo_row_1->get_lastdriftchecktimestamp( ).
      lv_clientrequesttoken = lo_row_1->get_lastoperationid( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.