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

GetWorkload

Returns information about a workload.

Request Syntax


POST /getWorkload HTTP/1.1
Content-type: application/json

{
   "workloadName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

workloadName

The name of the workload.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[A-Za-z][a-zA-Z0-9-_]*$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "workload": { 
      "description": "string",
      "displayName": "string",
      "documentationUrl": "string",
      "iconUrl": "string",
      "status": "string",
      "statusMessage": "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

Information about the workload.

Type: WorkloadData object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

HTTP Status Code: 500

ResourceNotFoundException

The specified workload or deployment resource can't be found.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400