GetWorkloadDeploymentPattern - AWS Launch Wizard


Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.

Request Syntax

POST /getWorkloadDeploymentPattern HTTP/1.1 Content-type: application/json { "deploymentPatternName": "string", "workloadName": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The name of the deployment pattern.

Type: String

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

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

Required: Yes


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 { "workloadDeploymentPattern": { "deploymentPatternName": "string", "description": "string", "displayName": "string", "specifications": [ { "allowedValues": [ "string" ], "conditionals": [ { "comparator": "string", "name": "string", "value": "string" } ], "description": "string", "name": "string", "required": "string" } ], "status": "string", "statusMessage": "string", "workloadName": "string", "workloadVersionName": "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.


Details about the workload deployment pattern.

Type: WorkloadDeploymentPatternData object


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


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


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

HTTP Status Code: 404


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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: