Skip to content

DescribeDocumentRequest

Source code in docs_src/capo_ssm/types/describe_document_request.py
class DescribeDocumentRequest(TypedDict, closed=True):
    name: "capo_ssm.types.document_arn.DocumentARN"
    """<p>The name of the SSM document.</p> <note> <p>If you're calling a shared SSM document from a different Amazon Web Services account, <code>Name</code> is the full Amazon Resource Name (ARN) of the document.</p> </note>"""
    document_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The document version for which you want information. Can be a specific version or the default version.</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 instance-attribute

document_version: NotRequired[DocumentVersion]

The document version for which you want information. Can be a specific version or the default version.

name instance-attribute

The name of the SSM document.

If you're calling a shared SSM document from a different Amazon Web Services account, Name is the full Amazon Resource Name (ARN) of the 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.