Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443255183.8 KB

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 Defining a Workload in the Well-Architected Tool User Guide.

Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload.

You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.

post/workloads

Request body

WorkloadNamestring required
<p>The name of the workload.</p> <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.</p>
Descriptionstring required

The description for the workload.

Environment'PRODUCTION' | 'PREPRODUCTION' required

The environment for the workload.

AccountIdsAwsAccountId[]

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

AwsRegionsAwsRegion[]

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

NonAwsRegionsWorkloadNonAwsRegion[]

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

PillarPrioritiesPillarId[]

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>.

ArchitecturalDesignstring

The URL of the architectural design 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.

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

The industry for the workload.

LensesLensAlias[] required

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

Notesstring

The notes associated with the workload.

ClientRequestTokenstring required
<p>A unique case-sensitive string used to ensure that this request is idempotent (executes only once).</p> <p>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.</p> <important> <p>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.</p> </important>
Tagsobject

The tags to be associated with the workload.

ApplicationsApplicationArn[]

List of AppRegistry application ARNs associated to the workload.

Response

Success

WorkloadIdstring

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

WorkloadArnstring

The ARN for the workload.