Describes the specified AWS Systems Manager document (SSM document).
Request Syntax
{
"DocumentVersion": "string",
"Name": "string",
"VersionName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DocumentVersion
-
The document version for which you want information. Can be a specific version or the default version.
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: Yes
- VersionName
-
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.
Type: String
Pattern:
^[a-zA-Z0-9_\-.]{1,128}$Required: No
Response Syntax
{
"Document": {
"ApprovedVersion": "string",
"AttachmentsInformation": [
{
"Name": "string"
}
],
"Author": "string",
"Category": [ "string" ],
"CategoryEnum": [ "string" ],
"CreatedDate": number,
"DefaultVersion": "string",
"Description": "string",
"DisplayName": "string",
"DocumentFormat": "string",
"DocumentType": "string",
"DocumentVersion": "string",
"Hash": "string",
"HashType": "string",
"LatestVersion": "string",
"Name": "string",
"Owner": "string",
"Parameters": [
{
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"Type": "string"
}
],
"PendingReviewVersion": "string",
"PlatformTypes": [ "string" ],
"Requires": [
{
"Name": "string",
"RequireType": "string",
"Version": "string",
"VersionName": "string"
}
],
"ReviewInformation": [
{
"ReviewedTime": number,
"Reviewer": "string",
"Status": "string"
}
],
"ReviewStatus": "string",
"SchemaVersion": "string",
"Sha1": "string",
"Status": "string",
"StatusInformation": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TargetType": "string",
"VersionName": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Document
-
Information about the SSM document.
Type: DocumentDescription object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidDocument
-
The specified SSM document doesn't exist.
HTTP Status Code: 400
- InvalidDocumentVersion
-
The document version isn't valid or doesn't exist.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DescribeDocument.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeDocument
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T182134Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 23
{
"Name": "Example"
}Sample Response
{
"Document": {
"CreatedDate": 1585061514.204,
"DefaultVersion": "1",
"Description": "Example",
"DocumentFormat": "YAML",
"DocumentType": "Automation",
"DocumentVersion": "1",
"DisplayName": "ExampleDoc",
"Hash": "68b196e538f5a895f87a0cc15eb74614021f44b47329aa95ccc0f4f71EXAMPLE",
"HashType": "Sha256",
"LatestVersion": "1",
"Name": "Example",
"Owner": "111122223333",
"Parameters": [
{
"DefaultValue": "",
"Description": "(Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.",
"Name": "AutomationAssumeRole",
"Type": "String"
},
{
"DefaultValue": "",
"Description": "(Required) The Instance Id to create an image of.",
"Name": "InstanceId",
"Type": "String"
}
],
"PlatformTypes": [
"Windows",
"Linux"
],
"SchemaVersion": "0.3",
"Status": "Active",
"Tags": []
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
