Skip to content

DocumentVersionInfo

Source code in docs_src/capo_ssm/types/document_version_info.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
class DocumentVersionInfo(TypedDict, closed=True):
    name: NotRequired["capo_ssm.types.document_name.DocumentName"]
    """<p>The document name.</p>"""
    display_name: NotRequired[
        "capo_ssm.types.document_display_name.DocumentDisplayName"
    ]
    """<p>The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see <a>UpdateDocument</a>.</p>"""
    document_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The document version.</p>"""
    version_name: NotRequired[
        "capo_ssm.types.document_version_name.DocumentVersionName"
    ]
    """<p>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>"""
    created_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date the document was created.</p>"""
    is_default_version: "capo_ssm.types.boolean.Boolean"
    """<p>An identifier for the default version of the document.</p>"""
    document_format: NotRequired["capo_ssm.types.document_format.DocumentFormat"]
    """<p>The document format, either JSON or YAML.</p>"""
    status: NotRequired["capo_ssm.types.document_status.DocumentStatus"]
    """<p>The status of the SSM document, such as <code>Creating</code>, <code>Active</code>, <code>Failed</code>, and <code>Deleting</code>.</p>"""
    status_information: NotRequired[
        "capo_ssm.types.document_status_information.DocumentStatusInformation"
    ]
    """<p>A message returned by Amazon Web Services Systems Manager that explains the <code>Status</code> value. For example, a <code>Failed</code> status might be explained by the <code>StatusInformation</code> message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."</p>"""
    review_status: NotRequired["capo_ssm.types.review_status.ReviewStatus"]
    """<p>The current status of the approval review for the latest version of the document.</p>"""

created_date instance-attribute 

created_date: NotRequired[DateTime]

The date the document was created.

display_name instance-attribute 

display_name: NotRequired[DocumentDisplayName]

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

document_format instance-attribute 

document_format: NotRequired[DocumentFormat]

The document format, either JSON or YAML.

document_version instance-attribute 

document_version: NotRequired[DocumentVersion]

The document version.

is_default_version instance-attribute 

is_default_version: Boolean

An identifier for the default version of the document.

name instance-attribute 

name: NotRequired[DocumentName]

The document name.

review_status instance-attribute 

review_status: NotRequired[ReviewStatus]

The current status of the approval review for the latest version of the document.

status instance-attribute 

status: NotRequired[DocumentStatus]

The status of the SSM document, such as Creating, Active, Failed, and Deleting.

status_information instance-attribute 

status_information: NotRequired[DocumentStatusInformation]

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

version_name instance-attribute 

version_name: NotRequired[DocumentVersionName]

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.