UpdateTemplate
Updates a migration workflow template.
Request Syntax
POST /template/id
HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"templateDescription": "string
",
"templateName": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- id
-
The ID of the request to update a migration workflow template.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*
Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[-a-zA-Z0-9]*
Required: No
- templateDescription
-
The description of the migration workflow template to update.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 250.
Pattern:
.*
Required: No
- templateName
-
The name of the migration workflow template to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[ a-zA-Z0-9]*
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"tags": {
"string" : "string"
},
"templateArn": "string",
"templateId": "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.
-
The tags added to the migration workflow template.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern:
[a-zA-Z0-9-_ ()]+
Value Length Constraints: Minimum length of 0. Maximum length of 100.
- templateArn
-
The ARN of the migration workflow template being updated. The format for an Migration Hub Orchestrator template ARN is
arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234
. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.Type: String
- templateId
-
The ID of the migration workflow template being updated.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An internal error has occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource is not available.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: