Amazon Well-Architected Tool

Amazon Well-Architected Tool Global Settings API

The Global Settings API from Amazon Well-Architected Tool — 1 operation(s) for global settings.

Documentation GitHub OpenAPI

Operations 2

PATCH /global-settings Amazon Well-Architected Tool Update Global Settings #

GET /global-settings Get Global Settings #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-well-architected-tool:amazon-well-architected-tool-global-settings-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Well Architected Tool Global Settings API
  version: '2020-03-31'
  x-refined-note:
  - x-apiClientRegistration differs across the merged source definitions and was not carried
  - x-apisguru-categories differs across the merged source definitions and was not carried
  - x-aws-signingName differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  - x-preferred differs across the merged source definitions and was not carried
  - x-providerName differs across the merged source definitions and was not carried
  - x-release differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  description: 'Operations tagged Global Settings across 2 of this provider''s published API definitions: amazon-well-architected-tool-openapi-original.yaml, amazon-well-architected-tool-global-settings-api-openapi.yml. Each path carries the servers of the definition it was published in.'
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)
tags:
- name: Global Settings
paths:
  /global-settings:
    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: UpdateGlobalSettings
      description: Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
      responses:
        '200':
          description: Success
        '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: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                OrganizationSharingStatus:
                  description: The status of organization sharing settings.
                  type: string
                  enum:
                  - ENABLED
                  - DISABLED
                DiscoveryIntegrationStatus:
                  description: The status of discovery support settings.
                  type: string
                  enum:
                  - ENABLED
                  - DISABLED
      summary: Amazon Well-Architected Tool Update Global Settings
      tags:
      - Global Settings
      security:
      - hmac: []
    get:
      operationId: GetGlobalSettings
      summary: Get Global Settings
      description: Global settings for all workloads.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGlobalSettingsOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException_2'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException_2'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException_2'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException_2'
      requestBody:
        content:
          application/json:
            schema:
              type: string
      tags:
      - Global Settings
      security:
      - hmac: []
    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)
components:
  schemas:
    ValidationException: {}
    InternalServerException: {}
    ThrottlingException: {}
    AccessDeniedException: {}
    ConflictException: {}
    ValidationException_2:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - UNKNOWN_OPERATION
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - OTHER
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
      required:
      - Message
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
        Message:
          type: string
      required:
      - Name
      - Message
    InternalServerException_2:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ThrottlingException_2:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
        ServiceCode:
          type: string
      required:
      - Message
    AccessDeniedException_2:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    GetGlobalSettingsOutput:
      type: object
      properties:
        OrganizationSharingStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Amazon Web Services Organizations sharing status.
        DiscoveryIntegrationStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Discovery integration status.
        JiraConfiguration:
          $ref: '#/components/schemas/AccountJiraConfigurationOutput'
    AccountJiraConfigurationOutput:
      type: object
      properties:
        IntegrationStatus:
          type: string
          enum:
          - CONFIGURED
          - NOT_CONFIGURED
          description: 'Account-level: Configuration status of the Jira integration.'
        IssueManagementStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: 'Account-level: Jira issue management status.'
        IssueManagementType:
          type: string
          enum:
          - AUTO
          - MANUAL
          description: 'Account-level: Jira issue management type.'
        Subdomain:
          type: string
          description: 'Account-level: Jira subdomain URL.'
        JiraProjectKey:
          type: string
          description: 'Account-level: Jira project key to sync workloads to.'
        StatusMessage:
          type: string
          description: 'Account-level: Status message on configuration of the Jira integration.'
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      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-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      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
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: wellarchitected
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/wellarchitected/
x-refined-from:
- amazon-well-architected-tool-openapi-original.yaml
- amazon-well-architected-tool-global-settings-api-openapi.yml
x-hasEquivalentPaths: true

Amazon Well-Architected Tool Global Settings API

Operations 2

Documentation

Specifications

Schemas & Data

Other Resources