/ - Amazon Simple Systems Manager (SSM)

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.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Name": "string", "PermissionType": "Share", "AccountIdsToAdd": [], "AccountIdsToRemove": [], "SharedDocumentVersion": "string" }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Name

string

required

The name of the document that you want to share.

Match pattern:

^[a-zA-Z0-9_\-.]{3,128}$

PermissionType

enum<string>

required

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

Allowed value:

AccountIdsToAdd

array[string]

optional

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.

<= 20 items

AccountIdsToRemove

array[string]

optional

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.

<= 20 items

SharedDocumentVersion

string

optional

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

<= 8 characters

Match pattern:

([$]LATEST|[$]DEFAULT|[$]ALL)

Examples

/

Request

Responses