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

GetWorkload

Get an existing workload.

Request Syntax


GET /workloads/WorkloadId HTTP/1.1

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

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "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"
   }
}

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.

Workload

A workload return object.

Type: Workload object

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