Describe Document Permission

ssm_describe_document_permission

R Documentation

Describes the permissions for a Amazon Web Services Systems Manager document (SSM document)¶

Description¶

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).

Usage¶

ssm_describe_document_permission(Name, PermissionType, MaxResults,
  NextToken)

Arguments¶

Name

[required] The name of the document for which you are the owner.

PermissionType

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

MaxResults

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.

NextToken

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

Value¶

A list with the following syntax:

list(
  AccountIds = list(
    "string"
  ),
  AccountSharingInfoList = list(
    list(
      AccountId = "string",
      SharedDocumentVersion = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_document_permission(
  Name = "string",
  PermissionType = "Share",
  MaxResults = 123,
  NextToken = "string"
)