modify_document_permission

modify_document_permission(**kwargs)

Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

See also: AWS API Documentation

Request Syntax

response = client.modify_document_permission(
    Name='string',
    PermissionType='Share',
    AccountIdsToAdd=[
        'string',
    ],
    AccountIdsToRemove=[
        'string',
    ],
    SharedDocumentVersion='string'
)

Parameters

• Name (string) --

  [REQUIRED]

  The name of the document that you want to share.

• PermissionType (string) --

  [REQUIRED]

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

• AccountIdsToAdd (list) --

  The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All .

  • (string) --
• AccountIdsToRemove (list) --

  The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All . This action has a higher priority than AccountIdsToAdd . If you specify an ID to add and the same ID to remove, the system removes access to the document.

  • (string) --
• SharedDocumentVersion (string) -- (Optional) The version of the document to share. If it isn't specified, the system choose the Default version to share.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• SSM.Client.exceptions.InternalServerError
• SSM.Client.exceptions.InvalidDocument
• SSM.Client.exceptions.InvalidPermissionType
• SSM.Client.exceptions.DocumentPermissionLimit
• SSM.Client.exceptions.DocumentLimitExceeded