Amazon Simple Systems Manager (SSM)

{'MaxResults': 'integer', 'NextToken': 'string'}

{'NextToken': 'string'}

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

Request Syntax

client.describe_document_permission(
    Name='string',
    PermissionType='Share',
    MaxResults=123,
    NextToken='string'
)

type Name

string

param Name

[REQUIRED]

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

type PermissionType

string

param PermissionType

[REQUIRED]

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

type MaxResults

integer

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

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'AccountIds': [
        'string',
    ],
    'AccountSharingInfoList': [
        {
            'AccountId': 'string',
            'SharedDocumentVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

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

    • (dict) --

      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.

  • NextToken (string) --

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