DocumentDescription ¶

class DocumentDescription(TypedDict, closed=True):
    sha1: NotRequired["capo_ssm.types.document_sha1.DocumentSha1"]
    """<p>The SHA1 hash of the document, which you can use for verification.</p>"""
    hash: NotRequired["capo_ssm.types.document_hash.DocumentHash"]
    """<p>The Sha256 or Sha1 hash created by the system when the document was created. </p> <note> <p>Sha1 hashes have been deprecated.</p> </note>"""
    hash_type: NotRequired["capo_ssm.types.document_hash_type.DocumentHashType"]
    """<p>The hash type of the document. Valid values include <code>Sha256</code> or <code>Sha1</code>.</p> <note> <p>Sha1 hashes have been deprecated.</p> </note>"""
    name: NotRequired["capo_ssm.types.document_arn.DocumentARN"]
    """<p>The name of the SSM document.</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>"""
    version_name: NotRequired[
        "capo_ssm.types.document_version_name.DocumentVersionName"
    ]
    """<p>The version of the artifact associated with the document.</p>"""
    owner: NotRequired["capo_ssm.types.document_owner.DocumentOwner"]
    """<p>The Amazon Web Services user that created the document.</p>"""
    created_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date when the document was created.</p>"""
    status: NotRequired["capo_ssm.types.document_status.DocumentStatus"]
    """<p>The status of the SSM document.</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>"""
    document_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The document version.</p>"""
    description: NotRequired[
        "capo_ssm.types.description_in_document.DescriptionInDocument"
    ]
    """<p>A description of the document. </p>"""
    parameters: NotRequired[
        "capo_ssm.types.document_parameter_list.DocumentParameterList"
    ]
    """<p>A description of the parameters for a document.</p>"""
    platform_types: NotRequired["capo_ssm.types.platform_type_list.PlatformTypeList"]
    """<p>The list of operating system (OS) platforms compatible with this SSM document. </p>"""
    document_type: NotRequired["capo_ssm.types.document_type.DocumentType"]
    """<p>The type of document.</p>"""
    schema_version: NotRequired[
        "capo_ssm.types.document_schema_version.DocumentSchemaVersion"
    ]
    """<p>The schema version.</p>"""
    latest_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The latest version of the document.</p>"""
    default_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The default 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>"""
    attachments_information: NotRequired[
        "capo_ssm.types.attachment_information_list.AttachmentInformationList"
    ]
    """<p>Details about the document attachments, including names, locations, sizes, and so on.</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>"""
    author: NotRequired["capo_ssm.types.document_author.DocumentAuthor"]
    """<p>The user in your organization who created the document.</p>"""
    review_information: NotRequired[
        "capo_ssm.types.review_information_list.ReviewInformationList"
    ]
    """<p>Details about the review of a document.</p>"""
    approved_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The version of the document currently approved for use in the organization.</p>"""
    pending_review_version: NotRequired[
        "capo_ssm.types.document_version.DocumentVersion"
    ]
    """<p>The version of the document that is currently under review.</p>"""
    review_status: NotRequired["capo_ssm.types.review_status.ReviewStatus"]
    """<p>The current status of the review.</p>"""
    category: NotRequired["capo_ssm.types.category_list.CategoryList"]
    """<p>The classification of a document to help you identify and categorize its use.</p>"""
    category_enum: NotRequired["capo_ssm.types.category_enum_list.CategoryEnumList"]
    """<p>The value that identifies a document's category.</p>"""