v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141381,185842.7 KB

Updates one or more values for an SSM document.

post/#X-Amz-Target=AmazonSSM.UpdateDocument

Headers

X-Amz-Target'AmazonSSM.UpdateDocument' required

Request body

Contentstring required

A valid JSON or YAML string.

Namestring required

The name of the SSM document that you want to update.

DisplayNamestring

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

VersionNamestring

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

DocumentVersionstring
<p>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <code>$LATEST</code> variable.</p> <note> <p>If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p> </note>
DocumentFormat'YAML' | 'JSON' | 'TEXT'

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

TargetTypestring

Specify a new target type for the document.

Response

Success