Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443255183.8 KB

Update an existing workload.

patch/workloads/{WorkloadId}

Path parameters

WorkloadIdstring required

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

Request body

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

The description for the workload.

Environment'PRODUCTION' | 'PREPRODUCTION'

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.

IsReviewOwnerUpdateAcknowledgedboolean
<p>Flag indicating whether the workload owner has acknowledged that the <i>Review owner</i> field is required.</p> <p>If a <b>Review owner</b> is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.</p>
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.

Notesstring

The notes associated with the workload.

ImprovementStatus'NOT_APPLICABLE' | 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETE' | 'RISK_ACKNOWLEDGED'

The improvement status for a workload.

ApplicationsApplicationArn[]

List of AppRegistry application ARNs to associate to the workload.

Response

Success