DocumentIdentifier ¶

class DocumentIdentifier(TypedDict, closed=True):
    name: NotRequired["capo_ssm.types.document_arn.DocumentARN"]
    """<p>The name of the SSM document.</p>"""
    created_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date the SSM document was created.</p>"""
    display_name: NotRequired[
        "capo_ssm.types.document_display_name.DocumentDisplayName"
    ]
    """<p>An optional field where you can specify a friendly name for 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>"""
    owner: NotRequired["capo_ssm.types.document_owner.DocumentOwner"]
    """<p>The Amazon Web Services user that created the 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>"""
    platform_types: NotRequired["capo_ssm.types.platform_type_list.PlatformTypeList"]
    """<p>The operating system platform. </p>"""
    document_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The document version.</p>"""
    document_type: NotRequired["capo_ssm.types.document_type.DocumentType"]
    """<p>The document type.</p>"""
    schema_version: NotRequired[
        "capo_ssm.types.document_schema_version.DocumentSchemaVersion"
    ]
    """<p>The schema version.</p>"""
    document_format: NotRequired["capo_ssm.types.document_format.DocumentFormat"]
    """<p>The document format, either JSON or YAML.</p>"""
    target_type: NotRequired["capo_ssm.types.target_type.TargetType"]
    """<p>The target type which defines the kinds of resources the document can run on. For example, <code>/AWS::EC2::Instance</code>. For a list of valid resource types, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>. </p>"""
    tags: NotRequired["capo_ssm.types.tag_list.TagList"]
    """<p>The tags, or metadata, that have been applied to the document.</p>"""
    requires: NotRequired["capo_ssm.types.document_requires_list.DocumentRequiresList"]
    """<p>A list of SSM documents required by a document. For example, an <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document.</p>"""
    review_status: NotRequired["capo_ssm.types.review_status.ReviewStatus"]
    """<p>The current status of a document review.</p>"""
    author: NotRequired["capo_ssm.types.document_author.DocumentAuthor"]
    """<p>The user in your organization who created the document.</p>"""