ssm_modify_document_permission: Shares a Systems Manager document publicly or privately

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

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

Usage

1
2
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 AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

AccountIdsToRemove

The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.

SharedDocumentVersion

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

Value

An empty list.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
svc$modify_document_permission(
  Name = "string",
  PermissionType = "Share",
  AccountIdsToAdd = list(
    "string"
  ),
  AccountIdsToRemove = list(
    "string"
  ),
  SharedDocumentVersion = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.