/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Describes the specified Amazon Web Services Systems Manager document (SSM document).

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Name": "string",
    "DocumentVersion": "string",
    "VersionName": "string"
}'

Response Example

200 - Example 1

{
    "Document": {
        "Sha1": "string",
        "Hash": "string",
        "HashType": "Sha256",
        "Name": "string",
        "DisplayName": "string",
        "VersionName": "string",
        "Owner": "string",
        "CreatedDate": "string",
        "Status": "Creating",
        "StatusInformation": "string",
        "DocumentVersion": "string",
        "Description": "string",
        "Parameters": [],
        "PlatformTypes": [],
        "DocumentType": "Command",
        "SchemaVersion": "string",
        "LatestVersion": "string",
        "DefaultVersion": "string",
        "DocumentFormat": "YAML",
        "TargetType": "string",
        "Tags": [],
        "AttachmentsInformation": [],
        "Requires": [],
        "Author": "string",
        "ReviewInformation": [],
        "ApprovedVersion": "string",
        "PendingReviewVersion": "string",
        "ReviewStatus": "APPROVED",
        "Category": [],
        "CategoryEnum": []
    }
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480InternalServerError

🟠481InvalidDocument

🟠482InvalidDocumentVersion

Modified at 2023-08-15 10:32:32