LISTSTACKSETS()`¶

About ListStackSets¶

Returns summary information about StackSets that are associated with the user.

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

[Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed StackSets in your Amazon Web Services account.
[Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all StackSets in the management account.
[Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all StackSets with service-managed permissions in the management account.

Method Signature¶

METHODS /AWS1/IF_FRM~LISTSTACKSETS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/FRMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/FRMMAXRESULTS OPTIONAL
    !IV_STATUS TYPE /AWS1/FRMSTACKSETSTATUS OPTIONAL
    !IV_CALLAS TYPE /AWS1/FRMCALLAS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmliststacksetsout
  RAISING
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

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.

`iv_status` `TYPE /AWS1/FRMSTACKSETSTATUS` `/AWS1/FRMSTACKSETSTATUS`¶

The status of the StackSets that you want to get summary information about.

`iv_callas` `TYPE /AWS1/FRMCALLAS` `/AWS1/FRMCALLAS`¶

[Service-managed permissions] Specifies whether you are acting as an account administrator in the 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_frmliststacksetsout` `/AWS1/CL_FRMLISTSTACKSETSOUT`¶

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->liststacksets(
  iv_callas = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_status = |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_stacksetname = lo_row_1->get_stacksetname( ).
      lv_stacksetid = lo_row_1->get_stacksetid( ).
      lv_description = lo_row_1->get_description( ).
      lv_stacksetstatus = lo_row_1->get_status( ).
      lo_autodeployment = lo_row_1->get_autodeployment( ).
      IF lo_autodeployment IS NOT INITIAL.
        lv_autodeploymentnullable = lo_autodeployment->get_enabled( ).
        lv_retainstacksonaccountre = lo_autodeployment->get_retainstacksonacremoval( ).
      ENDIF.
      lv_permissionmodels = lo_row_1->get_permissionmodel( ).
      lv_stackdriftstatus = lo_row_1->get_driftstatus( ).
      lv_timestamp = lo_row_1->get_lastdriftchecktimestamp( ).
      lo_managedexecution = lo_row_1->get_managedexecution( ).
      IF lo_managedexecution IS NOT INITIAL.
        lv_managedexecutionnullabl = lo_managedexecution->get_active( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_FRM=>LISTSTACKSETS()¶