Amazon Well-Architected Tool Profile Template API

openapi: 3.2.0
info:
  version: '2020-03-31'
  x-release: v4
  title: AWS Well-Architected Tool Profile Template API
  description: 'Well-Architected Tool

    This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.'
  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: Profile Template
paths:
  /profileTemplate:
    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: GetProfileTemplate
      description: Get profile template.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProfileTemplateOutput'
        '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: []
      summary: Amazon Well-Architected Tool Get Profile Template
      tags:
      - Profile Template
components:
  schemas:
    MinSelectedProfileChoices:
      type: integer
      minimum: 0
    QuestionTitle:
      type: string
      description: The title of the question.
      minLength: 1
      maxLength: 512
    ChoiceDescription:
      type: string
      description: The description of a choice.
      minLength: 1
      maxLength: 1024
    InternalServerException: {}
    QuestionId:
      type: string
      description: The ID of the question.
      minLength: 1
      maxLength: 128
    ValidationException: {}
    ProfileName:
      type: string
      pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$
      minLength: 3
      maxLength: 100
    ProfileTemplateChoice:
      type: object
      properties:
        ChoiceId:
          $ref: '#/components/schemas/ChoiceId'
        ChoiceTitle:
          $ref: '#/components/schemas/ChoiceTitle'
        ChoiceDescription:
          $ref: '#/components/schemas/ChoiceDescription'
      description: A profile template choice.
    TemplateQuestions:
      type: array
      items:
        $ref: '#/components/schemas/ProfileTemplateQuestion'
    ProfileTemplateQuestion:
      type: object
      properties:
        QuestionId:
          $ref: '#/components/schemas/QuestionId'
        QuestionTitle:
          $ref: '#/components/schemas/QuestionTitle'
        QuestionDescription:
          $ref: '#/components/schemas/QuestionDescription'
        QuestionChoices:
          allOf:
          - $ref: '#/components/schemas/ProfileTemplateQuestionChoices'
          - description: The question choices.
        MinSelectedChoices:
          allOf:
          - $ref: '#/components/schemas/MinSelectedProfileChoices'
          - description: The minimum number of choices selected.
        MaxSelectedChoices:
          allOf:
          - $ref: '#/components/schemas/MaxSelectedProfileChoices'
          - description: The maximum number of choices selected.
      description: A profile template question.
    MaxSelectedProfileChoices:
      type: integer
      minimum: 0
    ChoiceId:
      type: string
      description: The ID of a choice.
      minLength: 1
      maxLength: 64
    Timestamp:
      type: string
      description: The date and time recorded.
      format: date-time
    QuestionDescription:
      type: string
      description: The description of the question.
      minLength: 1
      maxLength: 1024
    ThrottlingException: {}
    ResourceNotFoundException: {}
    ChoiceTitle:
      type: string
      description: The title of a choice.
      minLength: 1
      maxLength: 512
    GetProfileTemplateOutput:
      type: object
      properties:
        ProfileTemplate:
          allOf:
          - $ref: '#/components/schemas/ProfileTemplate'
          - description: The profile template.
    ProfileTemplateQuestionChoices:
      type: array
      items:
        $ref: '#/components/schemas/ProfileTemplateChoice'
    AccessDeniedException: {}
    ProfileTemplate:
      type: object
      properties:
        TemplateName:
          allOf:
          - $ref: '#/components/schemas/ProfileName'
          - description: The name of the profile template.
        TemplateQuestions:
          allOf:
          - $ref: '#/components/schemas/TemplateQuestions'
          - description: Profile template questions.
        CreatedAt:
          $ref: '#/components/schemas/Timestamp'
        UpdatedAt:
          $ref: '#/components/schemas/Timestamp'
      description: The profile template.
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    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-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
  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