ListMilestones - AWS Well-Architected Tool

ListMilestones

List all milestones for an existing workload.

Request Syntax

POST /workloads/WorkloadId/milestonesSummaries HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "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.

Pattern: [0-9a-f]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return for this request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

The token to use to retrieve the next set of results.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "MilestoneSummaries": [ { "MilestoneName": "string", "MilestoneNumber": number, "RecordedAt": number, "WorkloadSummary": { "ImprovementStatus": "string", "Lenses": [ "string" ], "Owner": "string", "RiskCounts": { "string" : number }, "UpdatedAt": number, "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "string" } } ], "NextToken": "string", "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.

MilestoneSummaries

A list of milestone summaries.

Type: Array of MilestoneSummary objects

NextToken

The token to use to retrieve the next set of results.

Type: String

WorkloadId

The ID assigned to the workload. This ID is unique within an AWS Region.

Type: String

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

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

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: