Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141381,185842.7 KB

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 <i>All</i> as the account ID.

post/#X-Amz-Target=AmazonSSM.ModifyDocumentPermission

Headers

X-Amz-Target'AmazonSSM.ModifyDocumentPermission' required

Request body

Namestring required

The name of the document that you want to share.

PermissionType'Share' required

The permission type for the document. The permission type can be <i>Share</i>.

AccountIdsToAddAccountId[]

The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>.

AccountIdsToRemoveAccountId[]

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 <i>All</i>. This action has a higher priority than <i>AccountIdsToAdd</i>. If you specify an ID to add and the same ID to remove, the system removes access to the document.

SharedDocumentVersionstring

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

Response

Success

ModifyDocumentPermissionResponse required