POST

/workloads

http://wellarchitected.{region}.amazonaws.com/workloads

Create a new workload. The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it. For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html">Defining a Workload</a> in the Well-Architected Tool User Guide. <important> Either <code>AwsRegions</code>, <code>NonAwsRegions</code>, or both must be specified when creating a workload. You also must specify <code>ReviewOwner</code>, even though the parameter is listed as not being required in the following section. </important>

Access Token Required: API Key

Body Params

Tagsobject

The tags to be associated with the workload.

Notesstring

The notes associated with the workload.

Lensesarrayrequired

The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.

Industrystring

The industry for the workload.

AccountIdsarray

The list of Amazon Web Services account IDs associated with the workload.

AwsRegionsarray

The list of Amazon Web Services Regions associated with the workload, for example, <code>us-east-2</code>, or <code>ca-central-1</code>.

Descriptionstringrequired

The description for the workload.

Environmentstringrequired

The environment for the workload.

ReviewOwnerstring

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

Applicationsarray

List of AppRegistry application ARNs associated to the workload.

IndustryTypestring

The industry type for the workload. If specified, must be one of the following: <ul> <li> <code>Agriculture</code> </li> <li> <code>Automobile</code> </li> <li> <code>Defense</code> </li> <li> <code>Design and Engineering</code> </li> <li> <code>Digital Advertising</code> </li> <li> <code>Education</code> </li> <li> <code>Environmental Protection</code> </li> <li> <code>Financial Services</code> </li> <li> <code>Gaming</code> </li> <li> <code>General Public Services</code> </li> <li> <code>Healthcare</code> </li> <li> <code>Hospitality</code> </li> <li> <code>InfoTech</code> </li> <li> <code>Justice and Public Safety</code> </li> <li> <code>Life Sciences</code> </li> <li> <code>Manufacturing</code> </li> <li> <code>Media & Entertainment</code> </li> <li> <code>Mining & Resources</code> </li> <li> <code>Oil & Gas</code> </li> <li> <code>Power & Utilities</code> </li> <li> <code>Professional Services</code> </li> <li> <code>Real Estate & Construction</code> </li> <li> <code>Retail & Wholesale</code> </li> <li> <code>Social Protection</code> </li> <li> <code>Telecommunications</code> </li> <li> <code>Travel, Transportation & Logistics</code> </li> <li> <code>Other</code> </li> </ul>

WorkloadNamestringrequired

The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

NonAwsRegionsarray

The list of non-Amazon Web Services Regions associated with the workload.

DiscoveryConfigobject

Discovery configuration associated to the workload.

PillarPrioritiesarray

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

ClientRequestTokenstringrequired

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 the original request 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 Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. </important>

ArchitecturalDesignstring

The URL of the architectural design for the workload.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://wellarchitected.{region}.amazonaws.com/workloads' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}