Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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.

Length Constraints: Fixed length of 32.

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" ],
         "Applications": [ "string" ],
         "ArchitecturalDesign": "string",
         "AwsRegions": [ "string" ],
         "Description": "string",
         "DiscoveryConfig": { 
            "TrustedAdvisorIntegrationStatus": "string",
            "WorkloadResourceDefinition": [ "string" ]
         },
         "Environment": "string",
         "ImprovementStatus": "string",
         "Industry": "string",
         "IndustryType": "string",
         "IsReviewOwnerUpdateAcknowledged": boolean,
         "JiraConfiguration": { 
            "IssueManagementStatus": "string",
            "IssueManagementType": "string",
            "JiraProjectKey": "string",
            "StatusMessage": "string"
         },
         "Lenses": [ "string" ],
         "NonAwsRegions": [ "string" ],
         "Notes": "string",
         "Owner": "string",
         "PillarPriorities": [ "string" ],
         "PrioritizedRiskCounts": { 
            "string" : number 
         },
         "Profiles": [ 
            { 
               "ProfileArn": "string",
               "ProfileVersion": "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

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.

Message: Description of the error.

HTTP Status Code: 403

InternalServerException

There is a problem with the AWS Well-Architected Tool API service.

Message: Description of the error.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

Message: Description of the error.
ResourceId: Identifier of the resource affected.
ResourceType: Type of the resource affected.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

Message: Description of the error.
QuotaCode: Service Quotas requirement to identify originating quota.
ServiceCode: Service Quotas requirement to identify originating service.

HTTP Status Code: 429

ValidationException

The user input is not valid.

Fields: The fields that caused the error, if applicable.
Message: Description of the error.
Reason: The reason why the request failed validation.

HTTP Status Code: 400