CreateMilestone
Create a milestone for an existing workload.
Request Syntax
POST /workloads/WorkloadId/milestones HTTP/1.1
Content-type: application/json
{
"ClientRequestToken": "string",
"MilestoneName": "string"
}URI Request Parameters
The request uses the following URI parameters.
- WorkloadId
-
The ID assigned to the workload. This ID is unique within an AWS Region.
Length Constraints: Fixed length of 32.
Pattern:
[0-9a-f]{32}Required: Yes
Request Body
The request accepts the following data in JSON format.
- ClientRequestToken
-
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.
Important
This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
- MilestoneName
-
The name of the milestone in a workload.
Milestone names must be unique within a workload.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 100.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"MilestoneNumber": number,
"WorkloadId": "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.
- MilestoneNumber
-
The milestone number.
A workload can have a maximum of 100 milestones.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
- WorkloadId
-
The ID assigned to the workload. This ID is unique within an AWS Region.
Type: String
Length Constraints: Fixed length of 32.
Pattern:
[0-9a-f]{32}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
User does not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The resource has already been processed, was deleted, or is too large.
HTTP Status Code: 409
- InternalServerException
-
There is a problem with the AWS Well-Architected Tool API service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource was not found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The user has reached their resource quota.
HTTP Status Code: 402
- ThrottlingException
-
Request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The user input is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
