GETDOCUMENT()`¶

About GetDocument¶

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

Method Signature¶

METHODS /AWS1/IF_SSM~GETDOCUMENT
  IMPORTING
    !IV_NAME TYPE /AWS1/SSMDOCUMENTARN OPTIONAL
    !IV_VERSIONNAME TYPE /AWS1/SSMDOCUMENTVERSIONNAME OPTIONAL
    !IV_DOCUMENTVERSION TYPE /AWS1/SSMDOCUMENTVERSION OPTIONAL
    !IV_DOCUMENTFORMAT TYPE /AWS1/SSMDOCUMENTFORMAT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmgetdocumentresult
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDDOCUMENT
    /AWS1/CX_SSMINVALIDDOCVERSION
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/SSMDOCUMENTARN` `/AWS1/SSMDOCUMENTARN`¶

The name of the SSM document.

Optional arguments:¶

`iv_versionname` `TYPE /AWS1/SSMDOCUMENTVERSIONNAME` `/AWS1/SSMDOCUMENTVERSIONNAME`¶

An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document and can't be changed.

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

The document version for which you want information.

`iv_documentformat` `TYPE /AWS1/SSMDOCUMENTFORMAT` `/AWS1/SSMDOCUMENTFORMAT`¶

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmgetdocumentresult` `/AWS1/CL_SSMGETDOCUMENTRESULT`¶

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->getdocument(
  iv_documentformat = |string|
  iv_documentversion = |string|
  iv_name = |string|
  iv_versionname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_documentarn = lo_result->get_name( ).
  lv_datetime = lo_result->get_createddate( ).
  lv_documentdisplayname = lo_result->get_displayname( ).
  lv_documentversionname = lo_result->get_versionname( ).
  lv_documentversion = lo_result->get_documentversion( ).
  lv_documentstatus = lo_result->get_status( ).
  lv_documentstatusinformati = lo_result->get_statusinformation( ).
  lv_documentcontent = lo_result->get_content( ).
  lv_documenttype = lo_result->get_documenttype( ).
  lv_documentformat = lo_result->get_documentformat( ).
  LOOP AT lo_result->get_requires( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_documentarn = lo_row_1->get_name( ).
      lv_documentversion = lo_row_1->get_version( ).
      lv_requiretype = lo_row_1->get_requiretype( ).
      lv_documentversionname = lo_row_1->get_versionname( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_attachmentscontent( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_attachmentname = lo_row_3->get_name( ).
      lv_contentlength = lo_row_3->get_size( ).
      lv_attachmenthash = lo_row_3->get_hash( ).
      lv_attachmenthashtype = lo_row_3->get_hashtype( ).
      lv_attachmenturl = lo_row_3->get_url( ).
    ENDIF.
  ENDLOOP.
  lv_reviewstatus = lo_result->get_reviewstatus( ).
ENDIF.

/AWS1/IF_SSM=>GETDOCUMENT()¶