/

The Amazon SSM multi-region endpoint

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

POST

Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.

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 '{
    "Content": "string",
    "Requires": [],
    "Attachments": [],
    "Name": "string",
    "DisplayName": "string",
    "VersionName": "string",
    "DocumentType": "Command",
    "DocumentFormat": "YAML",
    "TargetType": "string",
    "Tags": []
}'

Response Example

200 - Example 1

{
    "DocumentDescription": {
        "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

🟠480DocumentAlreadyExists

🟠481MaxDocumentSizeExceeded

🟠482InternalServerError

🟠483InvalidDocumentContent

🟠484DocumentLimitExceeded

🟠485InvalidDocumentSchemaVersion

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