The Workloads API from Amazon Well-Architected Tool — 23 operation(s) for workloads.
openapi: 3.0.0
info:
version: '2020-03-31'
x-release: v4
title: AWS Well-Architected Tool ConsolidatedReport#Format Workloads API
description: <fullname>Well-Architected Tool</fullname> <p>This is the <i>Well-Architected Tool API Reference</i>. The WA Tool API provides programmatic access to the <a href="http://aws.amazon.com/well-architected-tool">Well-Architected Tool</a> in the <a href="https://console.aws.amazon.com/wellarchitected">Amazon Web Services Management Console</a>. For information about the Well-Architected Tool, see the <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html">Well-Architected Tool User Guide</a>.</p>
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: wellarchitected
x-aws-signingName: wellarchitected
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/wellarchitected-2020-03-31.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://wellarchitected.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Well-Architected multi-region endpoint
- url: https://wellarchitected.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Well-Architected multi-region endpoint
- url: http://wellarchitected.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Well-Architected endpoint for China (Beijing) and China (Ningxia)
- url: https://wellarchitected.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Well-Architected endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Workloads
paths:
/workloads/{WorkloadId}/associateLenses:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
patch:
operationId: AssociateLenses
description: <p>Associate a lens to a workload.</p> <p>Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.</p> <note> <p> <b>Disclaimer</b> </p> <p>By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement. </p> </note>
responses:
'200':
description: Success
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: WorkloadId
in: path
required: true
description: ''
schema:
type: string
pattern: '[0-9a-f]{32}'
description: The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
minLength: 32
maxLength: 32
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- LensAliases
properties:
LensAliases:
description: <p>List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.</p> <p>Identify a lens using its <a>LensSummary$LensAlias</a>.</p>
type: array
items:
$ref: '#/components/schemas/LensAlias'
minItems: 1
summary: Amazon Well-Architected Tool Associate Lenses
tags:
- Workloads
/workloads/{WorkloadId}/associateProfiles:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
patch:
operationId: AssociateProfiles
description: Associate a profile with a workload.
responses:
'200':
description: Success
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: WorkloadId
in: path
required: true
description: ''
schema:
type: string
pattern: '[0-9a-f]{32}'
description: The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
minLength: 32
maxLength: 32
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ProfileArns
properties:
ProfileArns:
description: The list of profile ARNs to associate with the workload.
type: array
items:
$ref: '#/components/schemas/ProfileArn'
minItems: 1
summary: Amazon Well-Architected Tool Associate Profiles
tags:
- Workloads
/workloads/{WorkloadId}/milestones:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateMilestone
description: Create a milestone for an existing workload.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMilestoneOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: WorkloadId
in: path
required: true
description: ''
schema:
type: string
pattern: '[0-9a-f]{32}'
description: The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
minLength: 32
maxLength: 32
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- MilestoneName
- ClientRequestToken
properties:
MilestoneName:
description: <p>The name of the milestone in a workload.</p> <p>Milestone names must be unique within a workload.</p>
type: string
minLength: 3
maxLength: 100
ClientRequestToken:
description: <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>
type: string
minLength: 1
maxLength: 2048
summary: Amazon Well-Architected Tool Create Milestone
tags:
- Workloads
/workloads:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateWorkload
description: <p>Create a new workload.</p> <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html">Defining a Workload</a> in the <i>Well-Architected Tool User Guide</i>.</p> <important> <p>Either <code>AwsRegions</code>, <code>NonAwsRegions</code>, or both must be specified when creating a workload.</p> <p>You also must specify <code>ReviewOwner</code>, even though the parameter is listed as not being required in the following section. </p> </important>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkloadOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- WorkloadName
- Description
- Environment
- Lenses
- ClientRequestToken
properties:
WorkloadName:
description: <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>
type: string
minLength: 3
maxLength: 100
Description:
description: The description for the workload.
type: string
minLength: 3
maxLength: 250
Environment:
description: The environment for the workload.
type: string
enum:
- PRODUCTION
- PREPRODUCTION
AccountIds:
description: The list of Amazon Web Services account IDs associated with the workload.
type: array
items:
$ref: '#/components/schemas/AwsAccountId'
maxItems: 100
AwsRegions:
description: The list of Amazon Web Services Regions associated with the workload, for example, <code>us-east-2</code>, or <code>ca-central-1</code>.
type: array
items:
$ref: '#/components/schemas/AwsRegion'
maxItems: 50
NonAwsRegions:
description: ' The list of non-Amazon Web Services Regions associated with the workload.'
type: array
items:
$ref: '#/components/schemas/WorkloadNonAwsRegion'
maxItems: 5
PillarPriorities:
description: 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>.
type: array
items:
$ref: '#/components/schemas/PillarId'
ArchitecturalDesign:
description: The URL of the architectural design for the workload.
type: string
pattern: ^(|(https?|ftp):\/\/[^\s/$.?#].[^\s]*)$
maxLength: 2048
ReviewOwner:
description: 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
minLength: 3
maxLength: 255
IndustryType:
description: <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 & Entertainment</code> </p> </li> <li> <p> <code>Mining & Resources</code> </p> </li> <li> <p> <code>Oil & Gas</code> </p> </li> <li> <p> <code>Power & Utilities</code> </p> </li> <li> <p> <code>Professional Services</code> </p> </li> <li> <p> <code>Real Estate & Construction</code> </p> </li> <li> <p> <code>Retail & Wholesale</code> </p> </li> <li> <p> <code>Social Protection</code> </p> </li> <li> <p> <code>Telecommunications</code> </p> </li> <li> <p> <code>Travel, Transportation & Logistics</code> </p> </li> <li> <p> <code>Other</code> </p> </li> </ul>
type: string
maxLength: 100
Industry:
description: The industry for the workload.
type: string
maxLength: 100
Lenses:
description: The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.
type: array
items:
$ref: '#/components/schemas/LensAlias'
Notes:
description: The notes associated with the workload.
type: string
maxLength: 2084
ClientRequestToken:
description: <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>
type: string
minLength: 1
maxLength: 2048
Tags:
description: The tags to be associated with the workload.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
DiscoveryConfig:
description: Discovery configuration associated to the workload.
type: object
properties:
TrustedAdvisorIntegrationStatus:
allOf:
- $ref: '#/components/schemas/TrustedAdvisorIntegrationStatus'
- description: Discovery integration status in respect to Trusted Advisor for the workload.
WorkloadResourceDefinition:
allOf:
- $ref: '#/components/schemas/WorkloadResourceDefinition'
- description: <p>The mode to use for identifying resources associated with the workload.</p> <p>You can specify <code>WORKLOAD_METADATA</code>, <code>APP_REGISTRY</code>, or both.</p>
Applications:
description: List of AppRegistry application ARNs associated to the workload.
type: array
items:
$ref: '#/components/schemas/ApplicationArn'
maxItems: 1
ProfileArns:
description: The list of profile ARNs associated with the workload.
type: array
items:
$ref: '#/components/schemas/ProfileArn'
maxItems: 1
summary: Amazon Well-Architected Tool Create Workload
tags:
- Workloads
/workloads/{WorkloadId}/shares:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateWorkloadShare
description: <p>Create a workload share.</p> <p>The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.</p> <p>If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html">Sharing a workload</a> in the <i>Well-Architected Tool User Guide</i>.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkloadShareOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: WorkloadId
in: path
required: true
description: ''
schema:
type: string
pattern: '[0-9a-f]{32}'
description: The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
minLength: 32
maxLength: 32
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- SharedWith
- PermissionType
- ClientRequestToken
properties:
SharedWith:
description: The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.
type: string
minLength: 12
maxLength: 2048
PermissionType:
description: Permission granted on a share request.
type: string
enum:
- READONLY
- CONTRIBUTOR
ClientRequestToken:
description: <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>
type: string
minLength: 1
maxLength: 2048
summary: Amazon Well-Architected Tool Create Workload Share
tags:
- Workloads
get:
operationId: ListWorkloadShares
description: List the workload shares associated with the workload.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListWorkloadSharesOutput'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: WorkloadId
in: path
required: true
description: ''
schema:
type: string
pattern: '[0-9a-f]{32}'
description: The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
minLength: 32
maxLength: 32
- name: SharedWithPrefix
in: query
required: false
description: The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
schema:
type: string
maxLength: 100
- name: NextToken
in: query
required: false
description: ''
schema:
type: string
description: The token to use to retrieve the next set of results.
- name: MaxResults
in: query
required: false
description: The maximum number of results to return for this request.
schema:
type: integer
minimum: 1
maximum: 50
- name: Status
in: query
required: false
description: ''
schema:
type: string
enum:
- ACCEPTED
- REJECTED
- PENDING
- REVOKED
- EXPIRED
- ASSOCIATING
- ASSOCIATED
- FAILED
description: The status of the share request.
summary: Amazon Well-Architected Tool List Workload Shares
tags:
- Workloads
/workloads/{WorkloadId}#ClientRequestToken:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteWorkload
description: Delete an existing workload.
responses:
'200':
description: Success
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'483':
description: InternalServerException
content:
application/
# --- truncated at 32 KB (148 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-well-architected-tool/refs/heads/main/openapi/amazon-well-architected-tool-workloads-api-openapi.yml