Skip to content

/AWS1/CL_FRM=>GETTEMPLATESUMMARY()

About GetTemplateSummary

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned.

Method Signature

IMPORTING

Optional arguments:

iv_templatebody TYPE /AWS1/FRMTEMPLATEBODY /AWS1/FRMTEMPLATEBODY

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

iv_templateurl TYPE /AWS1/FRMTEMPLATEURL /AWS1/FRMTEMPLATEURL

The URL of a file containing the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

iv_stackname TYPE /AWS1/FRMSTACKNAMEORID /AWS1/FRMSTACKNAMEORID

The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

iv_stacksetname TYPE /AWS1/FRMSTACKSETNAMEORID /AWS1/FRMSTACKSETNAMEORID

The name or unique ID of the stack set from which the stack was created.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

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 stack sets 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.

io_templatesummaryconfig TYPE REF TO /AWS1/CL_FRMTMPLSUMMARYCONFIG /AWS1/CL_FRMTMPLSUMMARYCONFIG

Specifies options for the GetTemplateSummary API action.

RETURNING

oo_output TYPE REF TO /aws1/cl_frmgettmplsummoutput /AWS1/CL_FRMGETTMPLSUMMOUTPUT

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_frm~gettemplatesummary(
  io_templatesummaryconfig = new /aws1/cl_frmtmplsummaryconfig( ABAP_TRUE )
  iv_callas = |string|
  iv_stackname = |string|
  iv_stacksetname = |string|
  iv_templatebody = |string|
  iv_templateurl = |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_parameters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_parameterkey = lo_row_1->get_parameterkey( ).
      lv_parametervalue = lo_row_1->get_defaultvalue( ).
      lv_parametertype = lo_row_1->get_parametertype( ).
      lv_noecho = lo_row_1->get_noecho( ).
      lv_description = lo_row_1->get_description( ).
      lo_parameterconstraints = lo_row_1->get_parameterconstraints( ).
      IF lo_parameterconstraints IS NOT INITIAL.
        LOOP AT lo_parameterconstraints->get_allowedvalues( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_allowedvalue = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_description = lo_result->get_description( ).
  LOOP AT lo_result->get_capabilities( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_capability = lo_row_5->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_capabilitiesreason = lo_result->get_capabilitiesreason( ).
  LOOP AT lo_result->get_resourcetypes( ) into lo_row_6.
    lo_row_7 = lo_row_6.
    IF lo_row_7 IS NOT INITIAL.
      lv_resourcetype = lo_row_7->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_version = lo_result->get_version( ).
  lv_metadata = lo_result->get_metadata( ).
  LOOP AT lo_result->get_declaredtransforms( ) into lo_row_8.
    lo_row_9 = lo_row_8.
    IF lo_row_9 IS NOT INITIAL.
      lv_transformname = lo_row_9->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_resourceidsummaries( ) into lo_row_10.
    lo_row_11 = lo_row_10.
    IF lo_row_11 IS NOT INITIAL.
      lv_resourcetype = lo_row_11->get_resourcetype( ).
      LOOP AT lo_row_11->get_logicalresourceids( ) into lo_row_12.
        lo_row_13 = lo_row_12.
        IF lo_row_13 IS NOT INITIAL.
          lv_logicalresourceid = lo_row_13->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_11->get_resourceidentifiers( ) into lo_row_14.
        lo_row_15 = lo_row_14.
        IF lo_row_15 IS NOT INITIAL.
          lv_resourceidentifierprope = lo_row_15->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lo_warnings = lo_result->get_warnings( ).
  IF lo_warnings IS NOT INITIAL.
    LOOP AT lo_warnings->get_unrecognizedresrctypes( ) into lo_row_6.
      lo_row_7 = lo_row_6.
      IF lo_row_7 IS NOT INITIAL.
        lv_resourcetype = lo_row_7->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.