Amazon Well-Architected Tool

Amazon Well-Architected Tool Profile Notifications API

The Profile Notifications API from Amazon Well-Architected Tool — 1 operation(s) for profile notifications.

GitHub OpenAPI

Operations 2

GET /profileNotifications List Profile Notifications #
GET /profileNotifications/ Amazon Well-Architected Tool List Profile Notifications #

Documentation

📖
Documentation
https://docs.aws.amazon.com/wellarchitected/latest/userguide/
📖
APIReference
https://docs.aws.amazon.com/wellarchitected/latest/APIReference/
📖
GettingStarted
https://docs.aws.amazon.com/wellarchitected/latest/userguide/getting-started.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-well-architected-tool/openapi/amazon-well-architected-tool-profile-notifications-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/amazon-well-architected-tool/json-schema/well-architected-tool-workload-schema.json

Other Resources

🔗
Pricing
https://aws.amazon.com/well-architected-tool/pricing/
🔗
FAQ
https://aws.amazon.com/well-architected-tool/faqs/
🔗
JSONLD
https://artifacts.apis.io/amazon-well-architected-tool/json-ld/amazon-well-architected-tool-context.jsonld

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-profile-notifications-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

amazon-well-architected-tool-profile-notifications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS Well-Architected Tool Profile Notifications API
  version: '2020-03-31'
  description: Generated from AWS's published Smithy model for AWS Well-Architected Tool. 1 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://wellarchitected.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Profile Notifications
paths:
  /profileNotifications:
    get:
      operationId: ListProfileNotifications
      summary: List Profile Notifications
      description: List profile notifications.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProfileNotificationsOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListProfileNotificationsInput'
      tags:
      - Profile Notifications
  /profileNotifications/:
    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: ListProfileNotifications
      description: List profile notifications.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProfileNotificationsOutput'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: WorkloadId
        in: query
        required: false
        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: 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 Profile Notifications
      tags:
      - Profile Notifications
components:
  schemas:
    ValidationException:
      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
    ListProfileNotificationsOutput:
      type: object
      properties:
        NotificationSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ProfileNotificationSummary'
          description: Notification summaries.
        NextToken:
          type: string
    ProfileNotificationSummary:
      type: object
      properties:
        CurrentProfileVersion:
          type: string
          description: The current profile version.
        LatestProfileVersion:
          type: string
          description: The latest profile version.
        Type:
          type: string
          enum:
          - PROFILE_ANSWERS_UPDATED
          - PROFILE_DELETED
          description: Type of notification.
        ProfileArn:
          type: string
          description: The profile ARN.
        ProfileName:
          type: string
          description: The profile name.
        WorkloadId:
          type: string
        WorkloadName:
          type: string
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
        Message:
          type: string
      required:
      - Name
      - Message
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
        ServiceCode:
          type: string
      required:
      - Message
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListProfileNotificationsInput:
      type: object
      properties:
        WorkloadId:
          type: string
        NextToken:
          type: string
        MaxResults:
          type: integer
    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
    ProfileArn:
      type: string
      pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:profile/[a-z0-9]+
      maxLength: 2084
    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
    ProfileName:
      type: string
      pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$
      minLength: 3
      maxLength: 100
    ProfileNotificationType:
      type: string
      enum:
      - PROFILE_ANSWERS_UPDATED
      - PROFILE_DELETED
    ProfileVersion:
      type: string
      pattern: ^[A-Za-z0-9-]+$
      minLength: 1
      maxLength: 32
    ProfileNotificationSummaries:
      type: array
      items:
        $ref: '#/components/schemas/ProfileNotificationSummary'
  securitySchemes:
    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
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    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-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/wellarchitected/service/2020-03-31/wellarchitected-2020-03-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)