# DocumentDescription Describes an AWS Systems Manager document (SSM document). ## Contents ** ApprovedVersion ** The version of the document currently approved for use in the organization. Type: String Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` Required: No ** AttachmentsInformation ** Details about the document attachments, including names, locations, sizes, and so on. Type: Array of [AttachmentInformation](API_AttachmentInformation.md) objects Required: No ** Author ** The user in your organization who created the document. Type: String Required: No ** Category ** The classification of a document to help you identify and categorize its use. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 3 items. Length Constraints: Maximum length of 128. Required: No ** CategoryEnum ** The value that identifies a document's category. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 3 items. Length Constraints: Maximum length of 128. Required: No ** CreatedDate ** The date when the document was created. Type: Timestamp Required: No ** DefaultVersion ** The default version. Type: String Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` Required: No ** Description ** A description of the document. Type: String Required: No ** DisplayName ** 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](API_UpdateDocument.md). Type: String Length Constraints: Maximum length of 1024. Pattern: `^[\w\.\-\:\/ ]*$` Required: No ** DocumentFormat ** The document format, either JSON or YAML. Type: String Valid Values: `YAML | JSON | TEXT` Required: No ** DocumentType ** The type of document. Type: String Valid Values: `Command | Policy | Automation | Session | Package | ApplicationConfiguration | ApplicationConfigurationSchema | DeploymentStrategy | ChangeCalendar | Automation.ChangeTemplate | ProblemAnalysis | ProblemAnalysisTemplate | CloudFormation | ConformancePackTemplate | QuickSetup | ManualApprovalPolicy | AutoApprovalPolicy` Required: No ** DocumentVersion ** The document version. Type: String Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` Required: No ** Hash ** The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated. Type: String Length Constraints: Maximum length of 256. Required: No ** HashType ** The hash type of the document. Valid values include `Sha256` or `Sha1`. Sha1 hashes have been deprecated. Type: String Valid Values: `Sha256 | Sha1` Required: No ** LatestVersion ** The latest version of the document. Type: String Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` Required: No ** Name ** The name of the SSM document. Type: String Pattern: `^[a-zA-Z0-9_\-.:/]{3,128}$` Required: No ** Owner ** The Amazon Web Services user that created the document. Type: String Required: No ** Parameters ** A description of the parameters for a document. Type: Array of [DocumentParameter](API_DocumentParameter.md) objects Required: No ** PendingReviewVersion ** The version of the document that is currently under review. Type: String Pattern: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` Required: No ** PlatformTypes ** The list of operating system (OS) platforms compatible with this SSM document. Type: Array of strings Valid Values: `Windows | Linux | MacOS` Required: No ** Requires ** A list of SSM documents required by a document. For example, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document. Type: Array of [DocumentRequires](API_DocumentRequires.md) objects Array Members: Minimum number of 1 item. Required: No ** ReviewInformation ** Details about the review of a document. Type: Array of [ReviewInformation](API_ReviewInformation.md) objects Array Members: Minimum number of 1 item. Required: No ** ReviewStatus ** The current status of the review. Type: String Valid Values: `APPROVED | NOT_REVIEWED | PENDING | REJECTED` Required: No ** SchemaVersion ** The schema version. Type: String Pattern: `([0-9]+)\.([0-9]+)` Required: No ** Sha1 ** The SHA1 hash of the document, which you can use for verification. Type: String Required: No ** Status ** The status of the SSM document. Type: String Valid Values: `Creating | Active | Updating | Deleting | Failed` Required: No ** StatusInformation ** A message returned by AWS 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." Type: String Required: No ** Tags ** The tags, or metadata, that have been applied to the document. Type: Array of [Tag](API_Tag.md) objects Array Members: Maximum number of 1000 items. Required: No ** TargetType ** The target type which defines the kinds of resources the document can run on. For example, `/AWS::EC2::Instance`. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the * AWS CloudFormation User Guide*. Type: String Length Constraints: Maximum length of 200. Pattern: `^\/[\w\.\-\:\/]*$` Required: No ** VersionName ** The version of the artifact associated with the document. Type: String Pattern: `^[a-zA-Z0-9_\-.]{1,128}$` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-2014-11-06/DocumentDescription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/DocumentDescription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-2014-11-06/DocumentDescription)