DELETEDOCUMENT()`¶

About DeleteDocument¶

Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.

Method Signature¶

METHODS /AWS1/IF_SSM~DELETEDOCUMENT
  IMPORTING
    !IV_NAME TYPE /AWS1/SSMDOCUMENTNAME OPTIONAL
    !IV_DOCUMENTVERSION TYPE /AWS1/SSMDOCUMENTVERSION OPTIONAL
    !IV_VERSIONNAME TYPE /AWS1/SSMDOCUMENTVERSIONNAME OPTIONAL
    !IV_FORCE TYPE /AWS1/SSMBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmdeletedocresult
  RAISING
    /AWS1/CX_SSMASSOCDINSTANCES
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDDOCUMENT
    /AWS1/CX_SSMINVALIDDOCUMENTOP
    /AWS1/CX_SSMTOOMANYUPDATES
    /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 document.

Optional arguments:¶

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

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

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

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

`iv_force` `TYPE /AWS1/SSMBOOLEAN` `/AWS1/SSMBOOLEAN`¶

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an Identity and Access Management (IAM) policy.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmdeletedocresult` `/AWS1/CL_SSMDELETEDOCRESULT`¶

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->deletedocument(
  iv_documentversion = |string|
  iv_force = ABAP_TRUE
  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.
ENDIF.

/AWS1/IF_SSM=>DELETEDOCUMENT()¶