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 &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>
                  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/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
      - name: ClientRequestToken
        in: query
        required: true
        description: ''
        schema:
          type: string
          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>
          minLength: 1
          maxLength: 2048
      summary: Amazon Well-Architected Tool Delete Workload
      tags:
      - Workloads
  /workloads/{WorkloadId}/shares/{ShareId}#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: DeleteWorkloadShare
      description: Delete a workload share.
      responses:
        '200':
          description: Success
        '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: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '484':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '485':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: ShareId
        in: path
        required: true
        description: ''
        schema:
          type: string
          pattern: '[0-9a-f]{32}'
          description: The ID associated with the share.
      - 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: ClientRequestToken
        in: query
        required: true
        description: ''
        schema:
          type: string
          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>
          minLength: 1
          maxLength: 2048
      summary: Amazon Well-Architected Tool Delete Workload Share
      tags:
      - Workloads
  /workloads/{WorkloadId}/disassociateLenses:
    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: DisassociateLenses
      description: <p>Disassociate a lens from a workload.</p> <p>Up to 10 lenses can be disassociated from a workload in a single API operation.</p> <note> <p>The Amazon Web Services Well-Architected Framework lens (<code>wellarchitected</code>) cannot be removed from a workload.</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 Disassociate Lenses
      tags:
      - Workloads
  /workloads/{WorkloadId}/disassociateProfiles:
    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: DisassociateProfiles
      description: Disassociate a profile from 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 disassociate from the workload.
                  type: array
                  items:
                    $ref: '#/components/schemas/ProfileArn'
                  minItems: 1
      summary: Amazon Well-Architected Tool Disassociate Profiles
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}:
    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'
    get:
      operationId: GetAnswer
      description: Get the answer to a specific question in a workload review.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAnswerOutput'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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: LensAlias
        in: path
        required: true
        description: ''
        schema:
          type: string
          description: <p>The alias of the lens.</p> <p>For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p> <p>For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
          minLength: 1
          maxLength: 128
      - name: QuestionId
        in: path
        required: true
        description: ''
        schema:
          type: string
          description: The ID of the question.
          minLength: 1
          maxLength: 128
      - name: MilestoneNumber
        in: query
        required: false
        description: ''
        schema:
          type: integer
          description: <p>The milestone number.</p> <p>A workload can have a maximum of 100 milestones.</p>
          minimum: 1
          maximum: 100
      summary: Amazon Well-Architected Tool Get Answer
      tags:
      - Workloads
    patch:
      operationId: UpdateAnswer
      description: Update the answer to a specific question in a workload review.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAnswerOutput'
        '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
      - name: LensAlias
        in: path
        required: true
        description: ''
        schema:
          type: string
          description: <p>The alias of the lens.</p> <p>For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p> <p>For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
          minLength: 1
          maxLength: 128
      - name: QuestionId
        in: path
        required: true
        description: ''
        schema:
          type: string
          description: The ID of the question.
          minLength: 1
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                SelectedChoices:
                  description: <p>List of selected choice IDs in a question answer.</p> <p>The values entered replace the previously selected choices.</p>
                  type: array
                  items:
                    $ref: '#/components/schemas/ChoiceId'
                ChoiceUpdates:
                  description: A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/ChoiceUpdate'
                Notes:
                  description: The notes associated with the workload.
                  type: string
                  maxLength: 2084
                IsApplicable:
                  description: Defines whether this question is applicable to a lens review.
                  type: boolean
                Reason:
                  description: The reason why a question is not applicable to your workload.
                  type: string
                  enum:
                  - OUT_OF_SCOPE
                  - BUSINESS_PRIORITIES
                  - ARCHITECTURE_CONSTRAINTS
                  - OTHER
                  - NONE
      summary: Amazon Well-Architected Tool Update Answer
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}:
    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'
    get:
      operationId: GetLensReview
      description: Get lens review.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLensReviewOutput'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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: LensAlias
        in: path
        required: true
        description: ''
        schema:
          type: string
          description: <p>The alias of the lens.</p> <p>For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p> <p>For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
          minLength: 1
          maxLength: 128
      - name: MilestoneNumber
        in: query
        required: false
        description: ''
        schema:
          type: integer
          description: <p>The milestone number.</p> <p>A workload can have a maximum of 100 milestones.</p>
          minimum: 1
          maximum: 100
      summary: Amazon Well-Architected Tool Get Lens Review
      tags:
      - Workloads
    patch:
      operationId: UpdateLensReview
      description: Update lens review for a particular workload.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLensReviewOutput'
        '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
      - name: LensAlias
        in: path
        required: true
        description: ''
        schema:
          type: string
          description: <p>The alias of the lens.</p> <p>For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p> <p>For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
          minLength: 1
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                LensNotes:
                  description: The notes associated with the workload.
                  type: string
                  maxLength: 2084
                PillarNotes:
                  description: List of pillar notes of a lens review in a workload.
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/Notes'
      summary: Amazon Well-Architected Tool Update Lens Review
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}/report:
    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'
    get:
      operationId: GetLensReviewReport
      description: Get lens review report.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLensReviewReportOutput'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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: LensAlias
        in: path
        required: true
        description: ''
        schema:
          type: string
          description: <p>The alias of the lens.</p> <p>For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p> <p>For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
          minLength: 1
          maxLength: 128
      - name: MilestoneNumber
        in: query
        required: false
        description: ''
        schema:
          type: integer
          description: <p>The milestone number.</p> <p>A workload can have a maximum of 100 milestones.</p>
          minimum: 1
          maximum: 100
      summary: Amazon Well-Architected Tool Get Lens Review Report
      tags:
      - Workloads
  /workloads/{WorkloadId}/milestones/{MilestoneNumber}:
    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'
    get:
      operationId: GetMilestone
      description: Get a milestone for an existing workload.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMilestoneOutput'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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: MilestoneNumber
        in: path
        required: true
        description: ''
        schema:
          type: integer
          description: <p>The milestone number.</p> <p>A workload can have a maximum of 100 milestones.</p>
          minimum: 1
          maximum: 100
      summary: Amazon Well-Architected Tool Get Milestone
      tags:
      - Workloads
  /workloads/{WorkloadId}:
    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'
    get:
      operationId: GetWorkload
      description: Get an existing workload.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkloadOutput'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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
      summary: Amazon Well-Architected Tool Get Workload
      tags:
      - Workloads
    patch:
      operationId: UpdateWorkload
      description: Update an existing workload.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkloadOutput'
        '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
              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
                IsReviewOwnerUpdateAcknowledged:
                  description: <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>
                  type: boolean
                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 &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>
                  type: string
                  maxLength: 100
                Industry:
                  description: The industry for the workload.
                  type: string
                  maxLength: 100
                Notes:
                  description: The notes associated with the workload.
                  type: string
                  maxLength: 2084
                ImprovementStatus:
                  description: The improvement status for a workload.
                  type: string
                  enum:
                  - NOT_APPLICABLE
                  - NOT_STARTED
                  - IN_PROGRESS
                  - COMPLETE
                  - RISK_ACKNOWLEDGED
                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 to associate to the workload.
                  type: array
                  items:
                    $ref: '#/components/schemas/ApplicationArn'
                  maxItems: 1
      summary: Amazon Well-Architected Tool Update Workload
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers:
    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'
    get:
      operationId: ListAnswers
      description: List of answers for a particular workload and lens.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAnswersOutput'
        '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: LensAlias
        in: path
        required: true
        description: ''
        schema:
          type: string
          description: <p>The alias of the lens.</p> <p>For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p> <p>For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
          minLength: 1
          maxLength: 128
      - name: PillarId
        in: query
        required: false
        description: ''
        schema:
          type: string
          description: <p>The ID used to identify a pillar, for example, <code>security</code>.</p> <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
          minLength: 1
          maxLength: 64
      - name: MilestoneNumber
        in: query
        required: false
        description: ''
        schema:
          type: integer
          description: <p>The milestone number.</p> <p>A workload can have a maximum of 100 milestones.</p>
          minimum: 1
          maximum: 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: QuestionPriority
        in: query
        required: false
        description: The priority of the question.
        schema:
          type: string
          enum:
          - PRIORITIZED
          - NONE
      summary: Amazon Well-Architected Tool List Answers
      tags:
      - Workloads
  /workloads/{WorkloadId}/checks:
    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: ListCheckDetails
      description: List of Trusted Advisor check details by account related to the workload.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCheckDetailsOutput'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - LensArn
              - PillarId
              - QuestionId
              - ChoiceId
              properties:
                NextToken:
                  description: The token to use to retrieve the next set of results.
                  type: string
                MaxResults:
                  description: The maximum number of results to return for this request.
                  type: integer
                  minimum: 1
                  maximum: 50
                LensArn:
                  description: Well-Architected Lens ARN.
                  type: string
                PillarId:
                  description: <p>The ID used to identify a pillar, for example, <code>security</code>.</p> <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
                  type: string
                  minLength: 1
                  maxLength: 64
                QuestionId:
                  description: The ID of the question.
                  type: string
                  minLength: 1
                  maxLength: 128
                ChoiceId:
                  description: The ID of a choice.
                  type: string
                  minLength: 1
                  maxLength: 64
      summary: Amazon Well-Architected Tool List Check Details
      tags:
      - Workloads
  /workloads/{WorkloadId}/checkSummaries:
    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: ListCheckSummaries
      description: List of Trusted Advisor checks summarized for all accounts related to the workload.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCheckSummariesOutput'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - LensArn
              - PillarId
              - QuestionId
              - ChoiceId
              properties:
                NextToken:
                  description: The token to use to retrieve the next set of results.
                  type: string
                MaxResults:
                  description: The maximum number of results to return for this request.
                  type: integer
                  minimum: 1
                  maximum: 50
                LensArn:
                  description: Well-Architected Lens ARN.
                  type: string
                PillarId:
                  description: <p>The ID used to identify a pillar, for example, <code>security</code>.</p> <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
                  type: string
                  minLength: 1
                  maxLength: 64
                QuestionId:
                  description: The ID of the question.
                  type: string
                  minLength: 1
                  maxLength: 128
                ChoiceId:
                  description: The ID of a choice.
                  type: string
                  minLength: 1
                  maxLength: 64
      summary: Amazon Well-Architected Tool List Check Summaries
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements:
    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'
    get:
      operationId: ListLensReviewImprovements
      description: List lens review improvements.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLensReviewImprovementsOutput'
        '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: LensAlias
        in: path
        required: true
        description: ''
        schema:
          type: string
          description: <p>The alias of the lens.</p> <p>For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p> <p>For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
          minLength: 1
          maxLength: 128
      - name: PillarId
        in: query
        required: false
        description: ''
        schema:
          type: string
          description: <p>The ID used to identify a pillar, for example, <code>security</code>.</p> <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
          minLength: 1
          maxLength: 64
      - name: MilestoneNumber
        in: query
        required: false
        description: ''
        schema:
          type: integer
          description: <p>The milestone number.</p> <p>A workload can have a maximum of 100 milestones.</p>
          minimum: 1
          maximum: 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: 100
      - name: QuestionPriority
        in: query
        required: false
        description: The priority of the question.
        schema:
          type: string
          enum:
          - PRIORITIZED
          - NONE
      summary: Amazon Well-Architected Tool List Lens Review Improvements
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews:
    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'
    get:
      operationId: ListLensReviews
      description: List lens reviews for a particular workload.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLensReviewsOutput'
        '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: MilestoneNumber
        in: query
        required: false
        description: ''
        schema:
          type: integer
          description: <p>The milestone number.</p> <p>A workload can have a maximum of 100 milestones.</p>
          minimum: 1
          maximum: 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: ''
        schema:
          type: integer
          description: The maximum number of results to return for this request.
          minimum: 1
          maximum: 50
      summary: Amazon Well-Architected Tool List Lens Reviews
      tags:
      - Workloads
  /workloads/{WorkloadId}/milestonesSummaries:
    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: ListMilestones
      description: List all milestones for an existing workload.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMilestonesOutput'
        '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: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                NextToken:
                  description: The token to use to retrieve the next set of results.
                  type: string
                MaxResults:
                  description: The maximum number of results to return for this request.
                  type: integer
                  minimum: 1
                  maximum: 50
      summary: Amazon Well-Architected Tool List Milestones
      tags:
      - Workloads
  /workloads/{WorkloadId}/shares/{ShareId}:
    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: UpdateWorkloadShare
      description: Update a workload share.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkloadShareOutput'
        '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: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '484':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '485':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: ShareId
        in: path
        required: true
        description: ''
        schema:
          type: string
          pattern: '[0-9a-f]{32}'
          description: The ID associated with the share.
      - 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:
              - PermissionType
              properties:
                PermissionType:
                  description: Permission granted on a share request.
                  type: string
                  enum:
                  - READONLY
                  - CONTRIBUTOR
      summary: Amazon Well-Architected Tool Update Workload Share
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade:
    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'
    put:
      operationId: UpgradeLensReview
      description: Upgrade lens review for a particular 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
      - name: LensAlias
        in: path
        required: true
        description: ''
        schema:
          type: string
          description: <p>The alias of the lens.</p> <p>For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p> <p>For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
          minLength: 1
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - MilestoneName
              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 Upgrade Lens Review
      tags:
      - Workloads
  /workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade:
    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'
    put:
      operationId: UpgradeProfileVersion
      description: Upgrade a profile.
      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
      - name: ProfileArn
        in: path
        required: true
        description: The profile ARN.
        schema:
          type: string
          pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:profile/[a-z0-9]+
          maxLength: 2084
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              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 Upgrade Profile Version
      tags:
      - Workloads
components:
  schemas:
    HelpfulResourceUrl:
      type: string
      description: <p>The helpful resource URL.</p> <p>For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.</p> <p>For custom lenses, this is the helpful resource URL for a question and is only provided if <code>HelpfulResourceDisplayText</code> was specified for the question.</p>
      minLength: 1
      maxLength: 2048
    ChoiceId:
      type: string
      description: The ID of a choice.
      minLength: 1
      maxLength: 64
    AnswerSummary:
      type: object
      properties:
        QuestionId:
          $ref: '#/components/schemas/QuestionId'
        PillarId:
          $ref: '#/components/schemas/PillarId'
        QuestionTitle:
          $ref: '#/components/schemas/QuestionTitle'
        Choices:
          $ref: '#/components/schemas/Choices'
        SelectedChoices:
          $ref: '#/components/schemas/SelectedChoices'
        ChoiceAnswerSummaries:
          allOf:
          - $ref: '#/components/schemas/ChoiceAnswerSummaries'
          - description: A list of selected choices to a question in your workload.
        IsApplicable:
          $ref: '#/components/schemas/IsApplicable'
        Risk:
          $ref: '#/components/schemas/Risk'
        Reason:
          allOf:
          - $ref: '#/components/schemas/AnswerReason'
          - description: The reason why a choice is non-applicable to a question in your workload.
        QuestionType:
          allOf:
          - $ref: '#/components/schemas/QuestionType'
          - description: The type of the question.
      description: An answer summary of a lens review in a workload.
    PillarReviewSummaries:
      type: array
      description: List of pillar review summaries of lens review in a workload.
      items:
        $ref: '#/components/schemas/PillarReviewSummary'
    ChoiceNotes:
      type: string
      maxLength: 250
    QuestionTitle:
      type: string
      description: The title of the question.
      minLength: 1
      maxLength: 512
    IsReviewOwnerUpdateAcknowledged:
      type: boolean
    SelectedChoices:
      type: array
      description: <p>List of selected choice IDs in a question answer.</p> <p>The values entered replace the previously selected choices.</p>
      items:
        $ref: '#/components/schemas/ChoiceId'
    ShareId:
      type: string
      pattern: '[0-9a-f]{32}'
      description: The ID associated with the share.
    MilestoneName:
      type: string
      description: <p>The name of the milestone in a workload.</p> <p>Milestone names must be unique within a workload.</p>
      minLength: 3
      maxLength: 100
    GetWorkloadOutput:
      type: object
      properties:
        Workload:
          $ref: '#/components/schemas/Workload'
      description: Output of a get workload call.
    CheckDetails:
      type: array
      items:
        $ref: '#/components/schemas/CheckDetail'
    ChoiceAnswerSummaries:
      type: array
      items:
        $ref: '#/components/schemas/ChoiceAnswerSummary'
    PillarName:
      type: string
      description: The name of the pillar.
      minLength: 1
      maxLength: 128
    WorkloadLenses:
      type: array
      description: The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.
      items:
        $ref: '#/components/schemas/LensAlias'
    ChoiceContentUrl:
      type: string
      minLength: 1
      maxLength: 1024
    ChoiceContent:
      type: object
      properties:
        DisplayText:
          allOf:
          - $ref: '#/components/schemas/ChoiceContentDisplayText'
          - description: The display text for the choice content.
        Url:
          allOf:
          - $ref: '#/components/schemas/ChoiceContentUrl'
          - description: The URL for the choice content.
      description: The choice content.
    AccessDeniedException: {}
    CreateMilestoneOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        MilestoneNumber:
          $ref: '#/components/schemas/MilestoneNumber'
      description: Output of a create milestone call.
    ListLensReviewImprovementsOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        MilestoneNumber:
          $ref: '#/components/schemas/MilestoneNumber'
        LensAlias:
          $ref: '#/components/schemas/LensAlias'
        LensArn:
          allOf:
          - $ref: '#/components/schemas/LensArn'
          - description: The ARN for the lens.
        ImprovementSummaries:
          $ref: '#/components/schemas/ImprovementSummaries'
        NextToken:
          $ref: '#/components/schemas/NextToken'
      description: Output of a list lens review improvements call.
    ChoiceAnswer:
      type: object
      properties:
        ChoiceId:
          $ref: '#/components/schemas/ChoiceId'
        Status:
          allOf:
          - $ref: '#/components/schemas/ChoiceStatus'
          - description: The status of a choice.
        Reason:
          allOf:
          - $ref: '#/components/schemas/ChoiceReason'
          - description: The reason why a choice is non-applicable to a question in your workload.
        Notes:
          allOf:
          - $ref: '#/components/schemas/ChoiceNotes'
          - description: The notes associated with a choice.
      description: A choice that has been answered on a question in your workload.
    WorkloadShare:
      type: object
      properties:
        ShareId:
          $ref: '#/components/schemas/ShareId'
        SharedBy:
          $ref: '#/components/schemas/AwsAccountId'
        SharedWith:
          $ref: '#/components/schemas/SharedWith'
        PermissionType:
          $ref: '#/components/schemas/PermissionType'
        Status:
          $ref: '#/components/schemas/ShareStatus'
        WorkloadName:
          $ref: '#/components/schemas/WorkloadName'
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
      description: A workload share return object.
    ConflictException: {}
    WorkloadAwsRegions:
      type: array
      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>.
      items:
        $ref: '#/components/schemas/AwsRegion'
      maxItems: 50
    ProfileArn:
      type: string
      pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:profile/[a-z0-9]+
      maxLength: 2084
    CreateWorkloadOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        WorkloadArn:
          $ref: '#/components/schemas/WorkloadArn'
      description: Output of a create workload call.
    StatusMessage:
      type: string
      minLength: 1
      maxLength: 512
    GetLensReviewOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        MilestoneNumber:
          $ref: '#/components/schemas/MilestoneNumber'
        LensReview:
          $ref: '#/components/schemas/LensReview'
      description: Output of a get lens review call.
    Choice:
      type: object
      properties:
        ChoiceId:
          $ref: '#/components/schemas/ChoiceId'
        Title:
          $ref: '#/components/schemas/ChoiceTitle'
        Description:
          $ref: '#/components/schemas/ChoiceDescription'
        HelpfulResource:
          allOf:
          - $ref: '#/components/schemas/ChoiceContent'
          - description: <p>The helpful resource (both text and URL) for a particular choice.</p> <p>This field only applies to custom lenses. Each choice can have only one helpful resource.</p>
        ImprovementPlan:
          allOf:
          - $ref: '#/components/schemas/ChoiceContent'
          - description: <p>The improvement plan (both text and URL) for a particular choice.</p> <p>This field only applies to custom lenses. Each choice can have only one improvement plan.</p>
        AdditionalResources:
          allOf:
          - $ref: '#/components/schemas/AdditionalResourcesList'
          - description: '<p>The additional resources for a choice in a custom lens.</p> <p>A choice can have up to two additional resources: one of type <code>HELPFUL_RESOURCE</code>, one of type <code>IMPROVEMENT_PLAN</code>, or both.</p>'
      description: A choice available to answer question.
    AdditionalResources:
      type: object
      properties:
        Type:
          allOf:
          - $ref: '#/components/schemas/AdditionalResourceType'
          - description: Type of additional resource for a custom lens.
        Content:
          allOf:
          - $ref: '#/components/schemas/Urls'
          - description: The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.
      description: <p>The choice level additional resources for a custom lens.</p> <p>This field does not apply to Amazon Web Services official lenses.</p>
    ListCheckDetailsOutput:
      type: object
      properties:
        CheckDetails:
          allOf:
          - $ref: '#/components/schemas/CheckDetails'
          - description: The details about the Trusted Advisor checks related to the Well-Architected best practice.
        NextToken:
          $ref: '#/components/schemas/NextToken'
    ListLensReviewsOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        MilestoneNumber:
          $ref: '#/components/schemas/MilestoneNumber'
        LensReviewSummaries:
          $ref: '#/components/schemas/LensReviewSummaries'
        NextToken:
          $ref: '#/components/schemas/NextToken'
      description: Output of a list lens reviews call.
    ProfileVersion:
      type: string
      pattern: ^[A-Za-z0-9-]+$
      minLength: 1
      maxLength: 32
    LensReviewSummaries:
      type: array
      description: List of lens summaries of lens reviews of a workload.
      items:
        $ref: '#/components/schemas/LensReviewSummary'
    CheckName:
      type: string
    ValidationException: {}
    CheckSummary:
      type: object
      properties:
        Id:
          allOf:
          - $ref: '#/components/schemas/CheckId'
          - description: Trusted Advisor check ID.
        Name:
          allOf:
          - $ref: '#/components/schemas/CheckName'
          - description: Trusted Advisor check name.
        Provider:
          allOf:
          - $ref: '#/components/schemas/CheckProvider'
          - description: Provider of the check related to the best practice.
        Description:
          allOf:
          - $ref: '#/components/schemas/CheckDescription'
          - description: Trusted Advisor check description.
        UpdatedAt:
          $ref: '#/components/schemas/Timestamp'
        LensArn:
          allOf:
          - $ref: '#/components/schemas/LensArn'
          - description: Well-Architected Lens ARN associated to the check.
        PillarId:
          $ref: '#/components/schemas/PillarId'
        QuestionId:
          $ref: '#/components/schemas/QuestionId'
        ChoiceId:
          $ref: '#/components/schemas/ChoiceId'
        Status:
          allOf:
          - $ref: '#/components/schemas/CheckStatus'
          - description: Status associated to the check.
        AccountSummary:
          allOf:
          - $ref: '#/components/schemas/AccountSummary'
          - description: Account summary associated to the check.
      description: Trusted Advisor check summary.
    PillarId:
      type: string
      description: <p>The ID used to identify a pillar, for example, <code>security</code>.</p> <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
      minLength: 1
      maxLength: 64
    UpdateWorkloadOutput:
      type: object
      properties:
        Workload:
          $ref: '#/components/schemas/Workload'
      description: Output of an update workload call.
    CreateWorkloadShareOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        ShareId:
          $ref: '#/components/schemas/ShareId'
      description: Input for Create Workload Share
    QuestionId:
      type: string
      description: The ID of the question.
      minLength: 1
      maxLength: 128
    LensVersion:
      type: string
      minLength: 1
      maxLength: 32
    WorkloadShareSummaries:
      type: array
      description: A list of workload share summaries.
      items:
        $ref: '#/components/schemas/WorkloadShareSummary'
    ChoiceTitle:
      type: string
      description: The title of a choice.
      minLength: 1
      maxLength: 512
    WorkloadImprovementStatus:
      type: string
      enum:
      - NOT_APPLICABLE
      - NOT_STARTED
      - IN_PROGRESS
      - COMPLETE
      - RISK_ACKNOWLEDGED
      description: The improvement status for a workload.
    AccountSummary:
      type: object
      description: Account summary for a Well-Architected best practice in relation to Trusted Advisor checks.
      additionalProperties:
        $ref: '#/components/schemas/CheckStatusCount'
    WorkloadId:
      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
    LensAlias:
      type: string
      description: <p>The alias of the lens.</p> <p>For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p> <p>For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
      minLength: 1
      maxLength: 128
    CheckProvider:
      type: string
      enum:
      - TRUSTED_ADVISOR
    ListCheckSummariesOutput:
      type: object
      properties:
        CheckSummaries:
          allOf:
          - $ref: '#/components/schemas/CheckSummaries'
          - description: List of Trusted Advisor summaries related to the Well-Architected best practice.
        NextToken:
          $ref: '#/components/schemas/NextToken'
    AdditionalResourcesList:
      type: array
      items:
        $ref: '#/components/schemas/AdditionalResources'
    Urls:
      type: array
      items:
        $ref: '#/components/schemas/ChoiceContent'
    LensReviewReport:
      type: object
      properties:
        LensAlias:
          $ref: '#/components/schemas/LensAlias'
        LensArn:
          allOf:
          - $ref: '#/components/schemas/LensArn'
          - description: The ARN for the lens.
        Base64String:
          $ref: '#/components/schemas/Base64String'
      description: A report of a lens review.
    MilestoneSummary:
      type: object
      properties:
        MilestoneNumber:
          $ref: '#/components/schemas/MilestoneNumber'
        MilestoneName:
          $ref: '#/components/schemas/MilestoneName'
        RecordedAt:
          $ref: '#/components/schemas/Timestamp'
        WorkloadSummary:
          $ref: '#/components/schemas/WorkloadSummary'
      description: A milestone summary return object.
    WorkloadReviewOwner:
      type: string
      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.
      minLength: 3
      maxLength: 255
    Milestone:
      type: object
      properties:
        MilestoneNumber:
          $ref: '#/components/schemas/MilestoneNumber'
        MilestoneName:
          $ref: '#/components/schemas/MilestoneName'
        RecordedAt:
          $ref: '#/components/schemas/Timestamp'
        Workload:
          $ref: '#/components/schemas/Workload'
      description: A milestone return object.
    AdditionalResourceType:
      type: string
      enum:
      - HELPFUL_RESOURCE
      - IMPROVEMENT_PLAN
    ChoiceImprovementPlans:
      type: array
      items:
        $ref: '#/components/schemas/ChoiceImprovementPlan'
    WorkloadSummary:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        WorkloadArn:
          $ref: '#/components/schemas/WorkloadArn'
        WorkloadName:
          $ref: '#/components/schemas/WorkloadName'
        Owner:
          $ref: '#/components/schemas/AwsAccountId'
        UpdatedAt:
          $ref: '#/components/schemas/Timestamp'
        Lenses:
          $ref: '#/components/schemas/WorkloadLenses'
        RiskCounts:
          $ref: '#/components/schemas/RiskCounts'
        ImprovementStatus:
          $ref: '#/components/schemas/WorkloadImprovementStatus'
        Profiles:
          allOf:
          - $ref: '#/components/schemas/WorkloadProfiles'
          - description: Profile associated with a workload.
        PrioritizedRiskCounts:
          $ref: '#/components/schemas/RiskCounts'
      description: A workload summary return object.
    ImprovementPlanUrl:
      type: string
      description: <p>The improvement plan URL for a question in an Amazon Web Services official lenses.</p> <p>This value is only available if the question has been answered.</p> <p>This value does not apply to custom lenses.</p>
      minLength: 1
      maxLength: 2048
    Answer:
      type: object
      properties:
        QuestionId:
          $ref: '#/components/schemas/QuestionId'
        PillarId:
          $ref: '#/components/schemas/PillarId'
        QuestionTitle:
          $ref: '#/components/schemas/QuestionTitle'
        QuestionDescription:
          $ref: '#/components/schemas/QuestionDescription'
        ImprovementPlanUrl:
          $ref: '#/components/schemas/ImprovementPlanUrl'
        HelpfulResourceUrl:
          $ref: '#/components/schemas/HelpfulResourceUrl'
        HelpfulResourceDisplayText:
          allOf:
          - $ref: '#/components/schemas/DisplayText'
          - description: <p>The helpful resource text to be displayed for a custom lens.</p> <p>This field does not apply to Amazon Web Services official lenses.</p>
        Choices:
          $ref: '#/components/schemas/Choices'
        SelectedChoices:
          $ref: '#/components/schemas/SelectedChoices'
        ChoiceAnswers:
          allOf:
          - $ref: '#/components/schemas/ChoiceAnswers'
          - description: A list of selected choices to a question in your workload.
        IsApplicable:
          $ref: '#/components/schemas/IsApplicable'
        Risk:
          $ref: '#/components/schemas/Risk'
        Notes:
          $ref: '#/components/schemas/Notes'
        Reason:
          allOf:
          - $ref: '#/components/schemas/AnswerReason'
          - description: The reason why the question is not applicable to your workload.
      description: An answer of the question.
    WorkloadArchitecturalDesign:
      type: string
      pattern: ^(|(https?|ftp):\/\/[^\s/$.?#].[^\s]*)$
      description: The URL of the architectural design for the workload.
      maxLength: 2048
    RiskCounts:
      type: object
      description: A map from risk names to the count of how many questions have that rating.
      additionalProperties:
        $ref: '#/components/schemas/Count'
    ImprovementSummaries:
      type: array
      description: List of improvement summaries of lens review in a workload.
      items:
        $ref: '#/components/schemas/ImprovementSummary'
    WorkloadArn:
      type: string
      description: The ARN for the workload.
    Count:
      type: integer
      description: A non-negative integer that denotes how many.
      minimum: 0
    ListWorkloadSharesOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        WorkloadShareSummaries:
          $ref: '#/components/schemas/WorkloadShareSummaries'
        NextToken:
          $ref: '#/components/schemas/NextToken'
      description: Input for List Workload Share
    ChoiceImprovementPlan:
      type: object
      properties:
        ChoiceId:
          $ref: '#/components/schemas/ChoiceId'
        DisplayText:
          allOf:
          - $ref: '#/components/schemas/DisplayText'
          - description: The display text for the improvement plan.
        ImprovementPlanUrl:
          $ref: '#/components/schemas/ImprovementPlanUrl'
      description: The choice level improvement plan.
    QuestionDescription:
      type: string
      description: The description of the question.
      minLength: 1
      maxLength: 1024
    WorkloadDescription:
      type: string
      description: The description for the workload.
      minLength: 3
      maxLength: 250
    CheckDescription:
      type: string
    WorkloadPillarPriorities:
      type: array
      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>.
      items:
        $ref: '#/components/schemas/PillarId'
    WorkloadAccountIds:
      type: array
      description: The list of Amazon Web Services account IDs associated with the workload.
      items:
        $ref: '#/components/schemas/AwsAccountId'
      maxItems: 100
    UpdateWorkloadShareOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        WorkloadShare:
          $ref: '#/components/schemas/WorkloadShare'
      description: Input for Update Workload Share
    DisplayText:
      type: string
      minLength: 1
      maxLength: 64
    AnswerSummaries:
      type: array
      description: List of answer summaries of lens review in a workload.
      items:
        $ref: '#/components/schemas/AnswerSummary'
    IsApplicable:
      type: boolean
      description: Defines whether this question is applicable to a lens review.
    CheckDetail:
      type: object
      properties:
        Id:
          allOf:
          - $ref: '#/components/schemas/CheckId'
          - description: Trusted Advisor check ID.
        Name:
          allOf:
          - $ref: '#/components/schemas/CheckName'
          - description: Trusted Advisor check name.
        Description:
          allOf:
          - $ref: '#/components/schemas/CheckDescription'
          - description: Trusted Advisor check description.
        Provider:
          allOf:
          - $ref: '#/components/schemas/CheckProvider'
          - description: Provider of the check related to the best practice.
        LensArn:
          allOf:
          - $ref: '#/components/schemas/LensArn'
          - description: Well-Architected Lens ARN associated to the check.
        PillarId:
          $ref: '#/components/schemas/PillarId'
        QuestionId:
          $ref: '#/components/schemas/QuestionId'
        ChoiceId:
          $ref: '#/components/schemas/ChoiceId'
        Status:
          allOf:
          - $ref: '#/components/schemas/CheckStatus'
          - description: Status associated to the check.
        AccountId:
          $ref: '#/components/schemas/AwsAccountId'
        FlaggedResources:
          allOf:
          - $ref: '#/components/schemas/FlaggedResources'
          - description: Count of flagged resources associated to the check.
        Reason:
          allOf:
          - $ref: '#/components/schemas/CheckFailureReason'
          - description: Reason associated to the check.
        UpdatedAt:
          $ref: '#/components/schemas/Timestamp'
      description: Account details for a Well-Architected best practice in relation to Trusted Advisor checks.
    ThrottlingException: {}
    AwsRegion:
      type: string
      description: An Amazon Web Services Region, for example, <code>us-west-2</code> or <code>ap-northeast-1</code>.
      maxLength: 100
    NextToken:
      type: string
      description: The token to use to retrieve the next set of results.
    WorkloadName:
      type: string
      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>
      minLength: 3
      maxLength: 100
    ServiceQuotaExceededException: {}
    ChoiceContentDisplayText:
      type: string
      minLength: 1
      maxLength: 1024
    ImprovementSummary:
      type: object
      properties:
        QuestionId:
          $ref: '#/components/schemas/QuestionId'
        PillarId:
          $ref: '#/components/schemas/PillarId'
        QuestionTitle:
          $ref: '#/components/schemas/QuestionTitle'
        Risk:
          $ref: '#/components/schemas/Risk'
        ImprovementPlanUrl:
          $ref: '#/components/schemas/ImprovementPlanUrl'
        ImprovementPlans:
          allOf:
          - $ref: '#/components/schemas/ChoiceImprovementPlans'
          - description: The improvement plan details.
      description: An improvement summary of a lens review in a workload.
    UpdateAnswerOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        LensAlias:
          $ref: '#/components/schemas/LensAlias'
        LensArn:
          allOf:
          - $ref: '#/components/schemas/LensArn'
          - description: The ARN for the lens.
        Answer:
          $ref: '#/components/schemas/Answer'
      description: Output of a update answer call.
    Choices:
      type: array
      description: List of choices available for a question.
      items:
        $ref: '#/components/schemas/Choice'
    Timestamp:
      type: string
      description: The date and time recorded.
      format: date-time
    LensReview:
      type: object
      properties:
        LensAlias:
          $ref: '#/components/schemas/LensAlias'
        LensArn:
          allOf:
          - $ref: '#/components/schemas/LensArn'
          - description: The ARN for the lens.
        LensVersion:
          allOf:
          - $ref: '#/components/schemas/LensVersion'
          - description: The version of the lens.
        LensName:
          $ref: '#/components/schemas/LensName'
        LensStatus:
          allOf:
          - $ref: '#/components/schemas/LensStatus'
          - description: The status of the lens.
        PillarReviewSummaries:
          $ref: '#/components/schemas/PillarReviewSummaries'
        UpdatedAt:
          $ref: '#/components/schemas/Timestamp'
        Notes:
          $ref: '#/components/schemas/Notes'
        RiskCounts:
          $ref: '#/components/schemas/RiskCounts'
        NextToken:
          $ref: '#/components/schemas/NextToken'
        Profiles:
          allOf:
          - $ref: '#/components/schemas/WorkloadProfiles'
          - description: The profiles associated with the workload.
        PrioritizedRiskCounts:
          $ref: '#/components/schemas/RiskCounts'
      description: A lens review of a question.
    ListMilestonesOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        MilestoneSummaries:
          $ref: '#/components/schemas/MilestoneSummaries'
        NextToken:
          $ref: '#/components/schemas/NextToken'
      description: Output of a list milestones call.
    WorkloadProfiles:
      type: array
      items:
        $ref: '#/components/schemas/WorkloadProfile'
      maxItems: 1
    LensName:
      type: string
      description: The full name of the lens.
      minLength: 1
      maxLength: 128
    MilestoneNumber:
      type: integer
      description: <p>The milestone number.</p> <p>A workload can have a maximum of 100 milestones.</p>
      minimum: 1
      maximum: 100
    CheckStatus:
      type: string
      enum:
      - OKAY
      - WARNING
      - ERROR
      - NOT_AVAILABLE
      - FETCH_FAILED
    Notes:
      type: string
      description: The notes associated with the workload.
      maxLength: 2084
    DefinitionType:
      type: string
      enum:
      - WORKLOAD_METADATA
      - APP_REGISTRY
    WorkloadApplications:
      type: array
      items:
        $ref: '#/components/schemas/ApplicationArn'
      maxItems: 1
    ChoiceUpdate:
      type: object
      required:
      - Status
      properties:
        Status:
          allOf:
          - $ref: '#/components/schemas/ChoiceStatus'
          - description: The status of a choice.
        Reason:
          allOf:
          - $ref: '#/components/schemas/ChoiceReason'
          - description: The reason why a choice is non-applicable to a question in your workload.
        Notes:
          allOf:
          - $ref: '#/components/schemas/ChoiceNotes'
          - description: The notes associated with a choice.
      description: A list of choices to be updated.
    QuestionType:
      type: string
      enum:
      - PRIORITIZED
      - NON_PRIORITIZED
    ListAnswersOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        MilestoneNumber:
          $ref: '#/components/schemas/MilestoneNumber'
        LensAlias:
          $ref: '#/components/schemas/LensAlias'
        LensArn:
          allOf:
          - $ref: '#/components/schemas/LensArn'
          - description: The ARN for the lens.
        AnswerSummaries:
          $ref: '#/components/schemas/AnswerSummaries'
        NextToken:
          $ref: '#/components/schemas/NextToken'
      description: Output of a list answers call.
    WorkloadIndustry:
      type: string
      description: The industry for the workload.
      maxLength: 100
    CheckFailureReason:
      type: string
      enum:
      - ASSUME_ROLE_ERROR
      - ACCESS_DENIED
      - UNKNOWN_ERROR
      - PREMIUM_SUPPORT_REQUIRED
    GetMilestoneOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        Milestone:
          $ref: '#/components/schemas/Milestone'
      description: Output of a get milestone call.
    PermissionType:
      type: string
      enum:
      - READONLY
      - CONTRIBUTOR
      description: Permission granted on a share request.
    ChoiceAnswerSummary:
      type: object
      properties:
        ChoiceId:
          $ref: '#/components/schemas/ChoiceId'
        Status:
          allOf:
          - $ref: '#/components/schemas/ChoiceStatus'
          - description: The status of a choice.
        Reason:
          allOf:
          - $ref: '#/components/schemas/ChoiceReason'
          - description: The reason why a choice is non-applicable to a question in your workload.
      description: A choice summary that has been answered on a question in your workload.
    ChoiceReason:
      type: string
      enum:
      - OUT_OF_SCOPE
      - BUSINESS_PRIORITIES
      - ARCHITECTURE_CONSTRAINTS
      - OTHER
      - NONE
    WorkloadNonAwsRegions:
      type: array
      description: ' The list of non-Amazon Web Services Regions associated with the workload.'
      items:
        $ref: '#/components/schemas/WorkloadNonAwsRegion'
      maxItems: 5
    Workload:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        WorkloadArn:
          $ref: '#/components/schemas/WorkloadArn'
        WorkloadName:
          $ref: '#/components/schemas/WorkloadName'
        Description:
          $ref: '#/components/schemas/WorkloadDescription'
        Environment:
          $ref: '#/components/schemas/WorkloadEnvironment'
        UpdatedAt:
          $ref: '#/components/schemas/Timestamp'
        AccountIds:
          $ref: '#/components/schemas/WorkloadAccountIds'
        AwsRegions:
          $ref: '#/components/schemas/WorkloadAwsRegions'
        NonAwsRegions:
          $ref: '#/components/schemas/WorkloadNonAwsRegions'
        ArchitecturalDesign:
          $ref: '#/components/schemas/WorkloadArchitecturalDesign'
        ReviewOwner:
          $ref: '#/components/schemas/WorkloadReviewOwner'
        ReviewRestrictionDate:
          $ref: '#/components/schemas/Timestamp'
        IsReviewOwnerUpdateAcknowledged:
          allOf:
          - $ref: '#/components/schemas/IsReviewOwnerUpdateAcknowledged'
          - description: <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>
        IndustryType:
          $ref: '#/components/schemas/WorkloadIndustryType'
        Industry:
          $ref: '#/components/schemas/WorkloadIndustry'
        Notes:
          $ref: '#/components/schemas/Notes'
        ImprovementStatus:
          $ref: '#/components/schemas/WorkloadImprovementStatus'
        RiskCounts:
          $ref: '#/components/schemas/RiskCounts'
        PillarPriorities:
          $ref: '#/components/schemas/WorkloadPillarPriorities'
        Lenses:
          $ref: '#/components/schemas/WorkloadLenses'
        Owner:
          $ref: '#/components/schemas/AwsAccountId'
        ShareInvitationId:
          allOf:
          - $ref: '#/components/schemas/ShareInvitationId'
          - description: The ID assigned to the share invitation.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagMap'
          - description: The tags associated with the workload.
        DiscoveryConfig:
          allOf:
          - $ref: '#/components/schemas/WorkloadDiscoveryConfig'
          - description: Discovery configuration associated to the workload.
        Applications:
          allOf:
          - $ref: '#/components/schemas/WorkloadApplications'
          - description: List of AppRegistry application ARNs associated to the workload.
        Profiles:
          allOf:
          - $ref: '#/components/schemas/WorkloadProfiles'
          - description: Profile associated with a workload.
        PrioritizedRiskCounts:
          $ref: '#/components/schemas/RiskCounts'
      description: A workload return object.
    ChoiceDescription:
      type: string
      description: The description of a choice.
      minLength: 1
      maxLength: 1024
    CheckSummaries:
      type: array
      items:
        $ref: '#/components/schemas/CheckSummary'
    Risk:
      type: string
      enum:
      - UNANSWERED
      - HIGH
      - MEDIUM
      - NONE
      - NOT_APPLICABLE
      description: The risk for a given workload, lens review, pillar, or question.
    ResourceNotFoundException: {}
    WorkloadDiscoveryConfig:
      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>
      description: Discovery configuration associated to the workload.
    TagMap:
      type: object
      minProperties: 1
      maxProperties: 50
      additionalProperties:
        $ref: '#/components/schemas/TagValue'
    AnswerReason:
      type: string
      enum:
      - OUT_OF_SCOPE
      - BUSINESS_PRIORITIES
      - ARCHITECTURE_CONSTRAINTS
      - OTHER
      - NONE
    ShareStatus:
      type: string
      enum:
      - ACCEPTED
      - REJECTED
      - PENDING
      - REVOKED
      - EXPIRED
      - ASSOCIATING
      - ASSOCIATED
      - FAILED
      description: The status of the share request.
    SharedWith:
      type: string
      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.
      minLength: 12
      maxLength: 2048
    Base64String:
      type: string
      description: <p>The Base64-encoded string representation of a lens review report.</p> <p>This data can be used to create a PDF file.</p> <p>Only returned by <a>GetConsolidatedReport</a> when <code>PDF</code> format is requested.</p>
    TrustedAdvisorIntegrationStatus:
      type: string
      enum:
      - ENABLED
      - DISABLED
    TagValue:
      type: string
      minLength: 0
      maxLength: 256
    AwsAccountId:
      type: string
      pattern: '[0-9]{12}'
      description: An Amazon Web Services account ID.
      minLength: 12
      maxLength: 12
    FlaggedResources:
      type: integer
      minimum: 1
      maximum: 9999
    CheckStatusCount:
      type: integer
      minimum: 1
      maximum: 101
    LensReviewSummary:
      type: object
      properties:
        LensAlias:
          $ref: '#/components/schemas/LensAlias'
        LensArn:
          allOf:
          - $ref: '#/components/schemas/LensArn'
          - description: The ARN for the lens.
        LensVersion:
          allOf:
          - $ref: '#/components/schemas/LensVersion'
          - description: The version of the lens.
        LensName:
          $ref: '#/components/schemas/LensName'
        LensStatus:
          allOf:
          - $ref: '#/components/schemas/LensStatus'
          - description: The status of the lens.
        UpdatedAt:
          $ref: '#/components/schemas/Timestamp'
        RiskCounts:
          $ref: '#/components/schemas/RiskCounts'
        Profiles:
          allOf:
          - $ref: '#/components/schemas/WorkloadProfiles'
          - description: The profiles associated with the workload.
        PrioritizedRiskCounts:
          $ref: '#/components/schemas/RiskCounts'
      description: A lens review summary of a workload.
    WorkloadIndustryType:
      type: string
      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 &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>
      maxLength: 100
    WorkloadEnvironment:
      type: string
      enum:
      - PRODUCTION
      - PREPRODUCTION
      description: The environment for the workload.
    ShareInvitationId:
      type: string
      pattern: '[0-9a-f]{32}'
    WorkloadNonAwsRegion:
      type: string
      minLength: 3
      maxLength: 25
    WorkloadShareSummary:
      type: object
      properties:
        ShareId:
          $ref: '#/components/schemas/ShareId'
        SharedWith:
          $ref: '#/components/schemas/SharedWith'
        PermissionType:
          $ref: '#/components/schemas/PermissionType'
        Status:
          $ref: '#/components/schemas/ShareStatus'
        StatusMessage:
          allOf:
          - $ref: '#/components/schemas/StatusMessage'
          - description: Optional message to compliment the Status field.
      description: A workload share summary return object.
    ApplicationArn:
      type: string
      pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+
      maxLength: 2084
    InternalServerException: {}
    UpdateLensReviewOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        LensReview:
          $ref: '#/components/schemas/LensReview'
      description: Output of a update lens review call.
    WorkloadResourceDefinition:
      type: array
      items:
        $ref: '#/components/schemas/DefinitionType'
    GetLensReviewReportOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        MilestoneNumber:
          $ref: '#/components/schemas/MilestoneNumber'
        LensReviewReport:
          $ref: '#/components/schemas/LensReviewReport'
      description: Output of a get lens review report call.
    LensStatus:
      type: string
      enum:
      - CURRENT
      - NOT_CURRENT
      - DEPRECATED
      - DELETED
      - UNSHARED
    LensArn:
      type: string
    CheckId:
      type: string
    ChoiceAnswers:
      type: array
      items:
        $ref: '#/components/schemas/ChoiceAnswer'
    MilestoneSummaries:
      type: array
      description: A list of milestone summaries.
      items:
        $ref: '#/components/schemas/MilestoneSummary'
    PillarReviewSummary:
      type: object
      properties:
        PillarId:
          $ref: '#/components/schemas/PillarId'
        PillarName:
          $ref: '#/components/schemas/PillarName'
        Notes:
          $ref: '#/components/schemas/Notes'
        RiskCounts:
          $ref: '#/components/schemas/RiskCounts'
        PrioritizedRiskCounts:
          $ref: '#/components/schemas/RiskCounts'
      description: A pillar review summary of a lens review.
    WorkloadProfile:
      type: object
      properties:
        ProfileArn:
          allOf:
          - $ref: '#/components/schemas/ProfileArn'
          - description: The profile ARN.
        ProfileVersion:
          allOf:
          - $ref: '#/components/schemas/ProfileVersion'
          - description: The profile version.
      description: The profile associated with a workload.
    GetAnswerOutput:
      type: object
      properties:
        WorkloadId:
          $ref: '#/components/schemas/WorkloadId'
        MilestoneNumber:
          $ref: '#/components/schemas/MilestoneNumber'
        LensAlias:
          $ref: '#/components/schemas/LensAlias'
        LensArn:
          allOf:
          - $ref: '#/components/schemas/LensArn'
          - description: The ARN for the lens.
        Answer:
          $ref: '#/components/schemas/Answer'
      description: Output of a get answer call.
    ChoiceStatus:
      type: string
      enum:
      - SELECTED
      - NOT_APPLICABLE
      - UNSELECTED
  parameters:
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/wellarchitected/
x-hasEquivalentPaths: true