GetMilestone - AWS Well-Architected Tool

GetMilestone

Get a milestone for an existing workload.

Request Syntax

GET /workloads/WorkloadId/milestones/MilestoneNumber HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MilestoneNumber

The milestone number.

A workload can have a maximum of 100 milestones.

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

Required: Yes

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 does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Milestone": { "MilestoneName": "string", "MilestoneNumber": number, "RecordedAt": number, "Workload": { "AccountIds": [ "string" ], "ArchitecturalDesign": "string", "AwsRegions": [ "string" ], "Description": "string", "Environment": "string", "ImprovementStatus": "string", "Industry": "string", "IndustryType": "string", "IsReviewOwnerUpdateAcknowledged": boolean, "Lenses": [ "string" ], "NonAwsRegions": [ "string" ], "Notes": "string", "Owner": "string", "PillarPriorities": [ "string" ], "ReviewOwner": "string", "ReviewRestrictionDate": number, "RiskCounts": { "string" : number }, "ShareInvitationId": "string", "Tags": { "string" : "string" }, "UpdatedAt": number, "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "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.

Milestone

A milestone return object.

Type: Milestone object

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: