Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

UpdateDocumentDefaultVersion

Set the default version of a document.

Request Syntax

{
   "DocumentVersion": "string",
   "Name": "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 version of a custom document that you want to set as the default version.

Type: String

Pattern: (^[1-9][0-9]*$)

Required: Yes

Name

The name of a custom document that you want to set as the default version.

Type: String

Pattern: ^[a-zA-Z0-9_\-.]{3,128}$

Required: Yes

Response Syntax

{
   "Description": { 
      "DefaultVersion": "string",
      "Name": "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.

Description

The description of a custom document that you want to set as the default version.

Type: DocumentDefaultVersionDescription 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: 400

InvalidDocument

The specified document does not exist.

HTTP Status Code: 400

InvalidDocumentSchemaVersion

The version of the document schema is not supported.

HTTP Status Code: 400

InvalidDocumentVersion

The document version is not valid or does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: