POST

/workloads/{WorkloadId}/milestones

http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/milestones

Create a milestone for an existing workload.

Access Token Required: API Key

Path Parameters

WorkloadIdstringrequired

Body Params

MilestoneNamestringrequired

The name of the milestone in a workload. Milestone names must be unique within a workload.

ClientRequestTokenstringrequired

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 Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. </important>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/milestones' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}