MODIFYDOCUMENTPERMISSION()`¶

About ModifyDocumentPermission¶

Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

Method Signature¶

METHODS /AWS1/IF_SSM~MODIFYDOCUMENTPERMISSION
  IMPORTING
    !IV_NAME TYPE /AWS1/SSMDOCUMENTNAME OPTIONAL
    !IV_PERMISSIONTYPE TYPE /AWS1/SSMDOCUMENTPERMTYPE OPTIONAL
    !IT_ACCOUNTIDSTOADD TYPE /AWS1/CL_SSMACCOUNTIDLIST_W=>TT_ACCOUNTIDLIST OPTIONAL
    !IT_ACCOUNTIDSTOREMOVE TYPE /AWS1/CL_SSMACCOUNTIDLIST_W=>TT_ACCOUNTIDLIST OPTIONAL
    !IV_SHAREDDOCUMENTVERSION TYPE /AWS1/SSMSHAREDDOCUMENTVERSION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmmodifydocpermrsp
  RAISING
    /AWS1/CX_SSMDOCLIMITEXCEEDED
    /AWS1/CX_SSMDOCUMENTPERMLIMIT
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDDOCUMENT
    /AWS1/CX_SSMINVALIDPERMTYPE
    /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 that you want to share.

`iv_permissiontype` `TYPE /AWS1/SSMDOCUMENTPERMTYPE` `/AWS1/SSMDOCUMENTPERMTYPE`¶

The permission type for the document. The permission type can be Share.

Optional arguments:¶

`it_accountidstoadd` `TYPE /AWS1/CL_SSMACCOUNTIDLIST_W=>TT_ACCOUNTIDLIST` `TT_ACCOUNTIDLIST`¶

The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All. You must specify a value for this parameter or the AccountIdsToRemove parameter.

`it_accountidstoremove` `TYPE /AWS1/CL_SSMACCOUNTIDLIST_W=>TT_ACCOUNTIDLIST` `TT_ACCOUNTIDLIST`¶

The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the AccountIdsToAdd parameter.

`iv_shareddocumentversion` `TYPE /AWS1/SSMSHAREDDOCUMENTVERSION` `/AWS1/SSMSHAREDDOCUMENTVERSION`¶

(Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmmodifydocpermrsp` `/AWS1/CL_SSMMODIFYDOCPERMRSP`¶

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->modifydocumentpermission(
  it_accountidstoadd = VALUE /aws1/cl_ssmaccountidlist_w=>tt_accountidlist(
    ( new /aws1/cl_ssmaccountidlist_w( |string| ) )
  )
  it_accountidstoremove = VALUE /aws1/cl_ssmaccountidlist_w=>tt_accountidlist(
    ( new /aws1/cl_ssmaccountidlist_w( |string| ) )
  )
  iv_name = |string|
  iv_permissiontype = |string|
  iv_shareddocumentversion = |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=>MODIFYDOCUMENTPERMISSION()¶