/ - Amazon Simple Systems Manager (SSM)

Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).

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", "MaxResults": 0, "NextToken": "string" }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Name

string

required

The name of the document for which you are the owner.

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:

MaxResults

integer

optional

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

>= 1<= 200

NextToken

string

optional

The token for the next set of items to return. (You received this token from a previous call.)

Examples

Responses

🟢200Success

application/json

Body

AccountIds

array[string]

optional

The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account or All.

<= 20 items

AccountSharingInfoList

array[object (AccountSharingInfo) {2}]

optional

A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.

AccountId

string

optional

The Amazon Web Services account ID where the current document is shared.

Match pattern:

$\?i$all\|[0-9]\{12\}

SharedDocumentVersion

string

optional

The version of the current document shared with the account.

<= 8 characters

Match pattern:

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

NextToken

string

optional

The token for the next set of items to return. Use this token to get the next set of results.

🟠480InternalServerError

🟠481InvalidDocument

🟠482InvalidNextToken

🟠483InvalidPermissionType

🟠484InvalidDocumentOperation