Skip to content

DeleteDocumentRequest

Source code in docs_src/capo_ssm/types/delete_document_request.py 
16
17
18
19
20
21
22
23
24
25
26
class DeleteDocumentRequest(TypedDict, closed=True):
    name: "capo_ssm.types.document_name.DocumentName"
    """<p>The name of the document.</p>"""
    document_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The version of the document that you want to delete. If not provided, all versions of the document are deleted.</p>"""
    version_name: NotRequired[
        "capo_ssm.types.document_version_name.DocumentVersionName"
    ]
    """<p>The version name of the document that you want to delete. If not provided, all versions of the document are deleted.</p>"""
    force: "capo_ssm.types.boolean.Boolean"
    """<p>Some SSM document types require that you specify a <code>Force</code> flag before you can delete the document. For example, you must specify a <code>Force</code> flag to delete a document of type <code>ApplicationConfigurationSchema</code>. You can restrict access to the <code>Force</code> flag in an Identity and Access Management (IAM) policy.</p>"""

document_version instance-attribute 

document_version: NotRequired[DocumentVersion]

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

force instance-attribute 

force: Boolean

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an Identity and Access Management (IAM) policy.

name instance-attribute 

name: DocumentName

The name of the document.

version_name instance-attribute 

version_name: NotRequired[DocumentVersionName]

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.