[ 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe document permissions

The following describe-document-permission example displays permission details about a Systems Manager document that is shared publicly.

aws ssm describe-document-permission \
    --name "Example" \
    --permission-type "Share"

Output:

{
    "AccountIds": [
        "all"
    ],
    "AccountSharingInfoList": [
        {
            "AccountId": "all",
            "SharedDocumentVersion": "$DEFAULT"
        }
    ]
}

For more information, see Share a Systems Manager Document in the AWS Systems Manager User Guide.

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