Skip to content

GetDocumentRequest

Source code in docs_src/capo_ssm/types/get_document_request.py 
16
17
18
19
20
21
22
23
24
25
26
class GetDocumentRequest(TypedDict, closed=True):
    name: "capo_ssm.types.document_arn.DocumentARN"
    """<p>The name of the SSM document.</p>"""
    version_name: NotRequired[
        "capo_ssm.types.document_version_name.DocumentVersionName"
    ]
    """<p>An optional field specifying the version of the artifact associated 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 document version for which you want information.</p>"""
    document_format: NotRequired["capo_ssm.types.document_format.DocumentFormat"]
    """<p>Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.</p>"""

document_format instance-attribute 

document_format: NotRequired[DocumentFormat]

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

document_version instance-attribute 

document_version: NotRequired[DocumentVersion]

The document version for which you want information.

name instance-attribute 

name: DocumentARN

The name of the SSM document.

version_name instance-attribute 

version_name: NotRequired[DocumentVersionName]

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