Skip to content

UpdateDocumentRequest

Source code in docs_src/capo_ssm/types/update_document_request.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class UpdateDocumentRequest(TypedDict, closed=True):
    content: "capo_ssm.types.document_content.DocumentContent"
    """<p>A valid JSON or YAML string.</p>"""
    attachments: NotRequired[
        "capo_ssm.types.attachments_source_list.AttachmentsSourceList"
    ]
    """<p>A list of key-value pairs that describe attachments to a version of a document.</p>"""
    name: "capo_ssm.types.document_name.DocumentName"
    """<p>The name of the SSM document that you want to update.</p>"""
    display_name: NotRequired[
        "capo_ssm.types.document_display_name.DocumentDisplayName"
    ]
    """<p>The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.</p>"""
    version_name: NotRequired[
        "capo_ssm.types.document_version_name.DocumentVersionName"
    ]
    """<p>An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>"""
    document_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <code>$LATEST</code> variable.</p> <note> <p>If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p> </note>"""
    document_format: NotRequired["capo_ssm.types.document_format.DocumentFormat"]
    """<p>Specify the document format for the new document version. The document format can be JSON, YAML, or TEXT. JSON is the default format.</p>"""
    target_type: NotRequired["capo_ssm.types.target_type.TargetType"]
    """<p>Specify a new target type for the document.</p>"""

attachments instance-attribute 

attachments: NotRequired[AttachmentsSourceList]

A list of key-value pairs that describe attachments to a version of a document.

content instance-attribute 

content: DocumentContent

A valid JSON or YAML string.

display_name instance-attribute 

display_name: NotRequired[DocumentDisplayName]

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

document_format instance-attribute 

document_format: NotRequired[DocumentFormat]

Specify the document format for the new document version. The document format can be JSON, YAML, or TEXT. JSON is the default format.

document_version instance-attribute 

document_version: NotRequired[DocumentVersion]

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

name instance-attribute 

name: DocumentName

The name of the SSM document that you want to update.

target_type instance-attribute 

target_type: NotRequired[TargetType]

Specify a new target type for the document.

version_name instance-attribute 

version_name: NotRequired[DocumentVersionName]

An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.