Skip to content

Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately

Description

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.

Usage

ssm_modify_document_permission(Name, PermissionType, AccountIdsToAdd,
  AccountIdsToRemove, SharedDocumentVersion)

Arguments

  • Name

    [required] The name of the document that you want to share.

  • PermissionType

    [required] The permission type for the document. The permission type can be Share.

  • AccountIdsToAdd

    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.

  • AccountIdsToRemove

    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.

  • SharedDocumentVersion

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

Value

An empty list.

Request syntax

svc$modify_document_permission(
  Name = "string",
  PermissionType = "Share",
  AccountIdsToAdd = list(
    "string"
  ),
  AccountIdsToRemove = list(
    "string"
  ),
  SharedDocumentVersion = "string"
)