PATCH

/workloads/{WorkloadId}

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

Update an existing workload.

Access Token Required: API Key

Path Parameters

WorkloadIdstringrequired

Body Params

Notesstring

The notes associated with the workload.

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

Descriptionstring

The description for the workload.

Environmentstring

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 to associate 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>

WorkloadNamestring

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

ImprovementStatusstring

The improvement status for a workload.

ArchitecturalDesignstring

The URL of the architectural design for the workload.

IsReviewOwnerUpdateAcknowledgedboolean

Flag indicating whether the workload owner has acknowledged that the Review owner field is required. If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

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 PATCH \
2     --url 'http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}' \
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}