CreateWorkload - AWS Well-Architected Tool

CreateWorkload

Create a new workload.

The owner of a workload can share the workload with other AWS accounts and IAM users in the same AWS Region. Only the owner of a workload can delete it.

For more information, see Defining a Workload in the AWS Well-Architected Tool User Guide.

Request Syntax

POST /workloads HTTP/1.1 Content-type: application/json { "AccountIds": [ "string" ], "ArchitecturalDesign": "string", "AwsRegions": [ "string" ], "ClientRequestToken": "string", "Description": "string", "Environment": "string", "Industry": "string", "IndustryType": "string", "Lenses": [ "string" ], "NonAwsRegions": [ "string" ], "Notes": "string", "PillarPriorities": [ "string" ], "ReviewOwner": "string", "Tags": { "string" : "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.

AccountIds

The list of AWS account IDs associated with the workload.

Type: Array of strings

Array Members: Maximum number of 100 items.

Pattern: [0-9]{12}

Required: No

ArchitecturalDesign

The URL of the architectural design for the workload.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

AwsRegions

The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Maximum length of 100.

Required: No

ClientRequestToken

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

Important

This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

Type: String

Required: Yes

Description

The description for the workload.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 250.

Required: Yes

Environment

The environment for the workload.

Type: String

Valid Values: PRODUCTION | PREPRODUCTION

Required: Yes

Industry

The industry for the workload.

Type: String

Length Constraints: Maximum length of 100.

Required: No

IndustryType

The industry type for the workload.

If specified, must be one of the following:

  • Agriculture

  • Automobile

  • Defense

  • Design and Engineering

  • Digital Advertising

  • Education

  • Environmental Protection

  • Financial Services

  • Gaming

  • General Public Services

  • Healthcare

  • Hospitality

  • InfoTech

  • Justice and Public Safety

  • Life Sciences

  • Manufacturing

  • Media & Entertainment

  • Mining & Resources

  • Oil & Gas

  • Power & Utilities

  • Professional Services

  • Real Estate & Construction

  • Retail & Wholesale

  • Social Protection

  • Telecommunications

  • Travel, Transportation & Logistics

  • Other

Type: String

Length Constraints: Maximum length of 100.

Required: No

Lenses

The list of lenses associated with the workload. Each lens is identified by its LensSummary:LensAlias.

Type: Array of strings

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

Required: Yes

NonAwsRegions

The list of non-AWS Regions associated with the workload.

Type: Array of strings

Array Members: Maximum number of 5 items.

Length Constraints: Minimum length of 3. Maximum length of 25.

Required: No

Notes

The notes associated with the workload.

Type: String

Length Constraints: Maximum length of 2084.

Required: No

PillarPriorities

The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary:PillarId.

Type: Array of strings

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

Required: No

ReviewOwner

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Required: Yes

Tags

The tags to be associated with the workload.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

WorkloadName

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

Type: String

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "WorkloadArn": "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.

WorkloadArn

The ARN for the workload.

Type: String

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

ConflictException

The resource already exists.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

ServiceQuotaExceededException

The user has reached their resource quota.

HTTP Status Code: 402

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: