LISTDOCUMENTMETADATAHISTORY()`¶

About ListDocumentMetadataHistory¶

Amazon Web Services Systems Manager Change Manager will no longer be open to new customers starting November 7, 2025. If you would like to use Change Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change.

Information about approval reviews for a version of a change template in Change Manager.

Method Signature¶

METHODS /AWS1/IF_SSM~LISTDOCUMENTMETADATAHISTORY
  IMPORTING
    !IV_NAME TYPE /AWS1/SSMDOCUMENTNAME OPTIONAL
    !IV_DOCUMENTVERSION TYPE /AWS1/SSMDOCUMENTVERSION OPTIONAL
    !IV_METADATA TYPE /AWS1/SSMDOCUMENTMETADATAENUM OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SSMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SSMMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmlstdocmethistory01
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDDOCUMENT
    /AWS1/CX_SSMINVALIDDOCVERSION
    /AWS1/CX_SSMINVALIDNEXTTOKEN
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/SSMDOCUMENTNAME` `/AWS1/SSMDOCUMENTNAME`¶

The name of the change template.

`iv_metadata` `TYPE /AWS1/SSMDOCUMENTMETADATAENUM` `/AWS1/SSMDOCUMENTMETADATAENUM`¶

The type of data for which details are being requested. Currently, the only supported value is DocumentReviews.

Optional arguments:¶

`iv_documentversion` `TYPE /AWS1/SSMDOCUMENTVERSION` `/AWS1/SSMDOCUMENTVERSION`¶

The version of the change template.

`iv_nexttoken` `TYPE /AWS1/SSMNEXTTOKEN` `/AWS1/SSMNEXTTOKEN`¶

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

`iv_maxresults` `TYPE /AWS1/SSMMAXRESULTS` `/AWS1/SSMMAXRESULTS`¶

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmlstdocmethistory01` `/AWS1/CL_SSMLSTDOCMETHISTORY01`¶

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->listdocumentmetadatahistory(
  iv_documentversion = |string|
  iv_maxresults = 123
  iv_metadata = |string|
  iv_name = |string|
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_documentname = lo_result->get_name( ).
  lv_documentversion = lo_result->get_documentversion( ).
  lv_documentauthor = lo_result->get_author( ).
  lo_documentmetadatarespons = lo_result->get_metadata( ).
  IF lo_documentmetadatarespons IS NOT INITIAL.
    LOOP AT lo_documentmetadatarespons->get_reviewerresponse( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_datetime = lo_row_1->get_createtime( ).
        lv_datetime = lo_row_1->get_updatedtime( ).
        lv_reviewstatus = lo_row_1->get_reviewstatus( ).
        LOOP AT lo_row_1->get_comment( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_documentreviewcommentty = lo_row_3->get_type( ).
            lv_documentreviewcomment = lo_row_3->get_content( ).
          ENDIF.
        ENDLOOP.
        lv_reviewer = lo_row_1->get_reviewer( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_SSM=>LISTDOCUMENTMETADATAHISTORY()¶