Skip to content

ModifyDocumentPermissionRequest

Source code in docs_src/capo_ssm/types/modify_document_permission_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class ModifyDocumentPermissionRequest(TypedDict, closed=True):
    name: "capo_ssm.types.document_name.DocumentName"
    """<p>The name of the document that you want to share.</p>"""
    permission_type: "capo_ssm.types.document_permission_type.DocumentPermissionType"
    """<p>The permission type for the document. The permission type can be <i>Share</i>.</p>"""
    account_ids_to_add: NotRequired["capo_ssm.types.account_id_list.AccountIdList"]
    """<p>The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>. You must specify a value for this parameter or the <code>AccountIdsToRemove</code> parameter.</p>"""
    account_ids_to_remove: NotRequired["capo_ssm.types.account_id_list.AccountIdList"]
    """<p>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 <i>All</i>. This action has a higher priority than <code>AccountIdsToAdd</code>. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the <code>AccountIdsToAdd</code> parameter.</p>"""
    shared_document_version: NotRequired[
        "capo_ssm.types.shared_document_version.SharedDocumentVersion"
    ]
    """<p>(Optional) The version of the document to share. If it isn't specified, the system choose the <code>Default</code> version to share.</p>"""

account_ids_to_add instance-attribute 

account_ids_to_add: NotRequired[AccountIdList]

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. You must specify a value for this parameter or the AccountIdsToRemove parameter.

account_ids_to_remove instance-attribute 

account_ids_to_remove: NotRequired[AccountIdList]

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. You must specify a value for this parameter or the AccountIdsToAdd parameter.

name instance-attribute 

name: DocumentName

The name of the document that you want to share.

permission_type instance-attribute 

permission_type: DocumentPermissionType

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

shared_document_version instance-attribute 

shared_document_version: NotRequired[SharedDocumentVersion]

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