Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ssm ]

describe-document-permission

Description

Describes the permissions for a Systems Manager 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 AWS account ID) or publicly (All ).

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-document-permission
--name <value>
--permission-type <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

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

--permission-type (string)

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

Possible values:

  • Share

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To get the permissions of a document

This example lists all the versions for a document.

Command:

aws ssm describe-document-permission --name "RunShellScript" --permission-type "Share"

Output:

{
  "AccountIds": [
      "all"
  ]
}

Output

AccountIds -> (list)

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

(string)

AccountSharingInfoList -> (list)

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

(structure)

Information includes the AWS account ID where the current document is shared and the version shared with that account.

AccountId -> (string)

The AWS account ID where the current document is shared.

SharedDocumentVersion -> (string)

The version of the current document shared with the account.