Amazon Q

Amazon Q Applications API

The Applications API from Amazon Q — 2 operation(s) for applications.

GitHub OpenAPI

Operations 5

GET /applications List Applications #
POST /applications Create Application #
GET /applications/{applicationId} Get Application #
DELETE /applications/{applicationId} Delete Application #
PUT /applications/{applicationId} Update Application #

Documentation

📖
Documentation
https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/
📖
Authentication
https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/security-iam.html
📖
APIReference
https://docs.aws.amazon.com/amazonq/latest/api-reference/Welcome.html
📖
GettingStarted
https://aws.amazon.com/q/business/getting-started/
📖
Documentation
https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html
📖
RateLimits
https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/quotas-regions.html
📖
Documentation
https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/
📖
Authentication
https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/security-iam.html
📖
GettingStarted
https://aws.amazon.com/q/developer/getting-started/
📖
Documentation
https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/what-is.html
📖
RateLimits
https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/quotas.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-q/openapi/amazon-q-applications-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/aws/amazon-q-developer-cli

Other Resources

🔗
Pricing
https://aws.amazon.com/q/business/pricing/
🔗
Features
https://aws.amazon.com/q/business/features/
🔗
CLI
https://docs.aws.amazon.com/cli/latest/reference/qbusiness/
🔗
SDKs
https://aws.amazon.com/tools/
🔗
ChangeLog
https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/doc-history.html
🔗
Pricing
https://aws.amazon.com/q/developer/pricing/
🔗
Features
https://aws.amazon.com/q/developer/features/
🔗
ChangeLog
https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/doc-history.html

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-q:amazon-q-applications-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-q-applications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Q Applications API
  version: '1.0'
  description: 'Operations tagged Applications across 2 of this provider''s published API definitions: amazon-q-openapi.yml, amazon-q-applications-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://qbusiness.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- sigv4: []
tags:
- name: Applications
paths:
  /applications:
    get:
      operationId: ListApplications
      summary: List Applications
      description: Lists Amazon Q Business applications.
      tags:
      - Applications
      parameters:
      - name: maxResults
        in: query
        schema:
          type: integer
      - name: nextToken
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
    post:
      operationId: CreateApplication
      summary: Create Application
      description: Creates an Amazon Q Business application.
      tags:
      - Applications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - displayName
              properties:
                displayName:
                  type: string
                description:
                  type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
    servers:
    - url: https://qbusiness.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
          description: AWS region
  /applications/{applicationId}:
    get:
      operationId: GetApplication
      summary: Get Application
      description: Gets information about an Amazon Q Business application.
      tags:
      - Applications
      parameters:
      - name: applicationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
    delete:
      operationId: DeleteApplication
      summary: Delete Application
      description: Deletes an Amazon Q Business application.
      tags:
      - Applications
      parameters:
      - name: applicationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
    put:
      operationId: UpdateApplication
      summary: Update Application
      description: Updates an existing Amazon Q Business application. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApplicationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '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/UpdateApplicationRequest'
      tags:
      - Applications
    servers:
    - url: https://qbusiness.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
          description: AWS region
components:
  schemas:
    Application:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the Amazon Q application.
        displayName:
          type: string
          description: The name of the Amazon Q application.
        status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - FAILED
          - UPDATING
          description: The status of the Amazon Q application.
        createdAt:
          type: string
          format: date-time
          description: The date and time the application was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time the application was last updated.
    UpdateApplicationRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application.
        identityCenterInstanceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
        displayName:
          type: string
          description: A name for the Amazon Q Business application.
        description:
          type: string
          description: A description for the Amazon Q Business application.
        roleArn:
          type: string
          description: An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
        attachmentsConfiguration:
          $ref: '#/components/schemas/AttachmentsConfiguration'
        qAppsConfiguration:
          $ref: '#/components/schemas/QAppsConfiguration'
        personalizationConfiguration:
          $ref: '#/components/schemas/PersonalizationConfiguration'
        autoSubscriptionConfiguration:
          $ref: '#/components/schemas/AutoSubscriptionConfiguration'
      required:
      - applicationId
    AutoSubscriptionConfiguration:
      type: object
      properties:
        autoSubscribe:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
        defaultSubscriptionType:
          type: string
          enum:
          - Q_LITE
          - Q_BUSINESS
          description: Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.
      required:
      - autoSubscribe
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ConflictException.
        resourceId:
          type: string
          description: The identifier of the resource affected.
        resourceType:
          type: string
          description: The type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The field name where the invalid entry was detected.
        message:
          type: string
          description: A message about the validation exception.
      required:
      - name
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ResourceNotFoundException.
        resourceId:
          type: string
          description: The identifier of the resource affected.
        resourceType:
          type: string
          description: The type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    PersonalizationConfiguration:
      type: object
      properties:
        personalizationControlMode:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
      required:
      - personalizationControlMode
    UpdateApplicationResponse:
      type: object
      properties: {}
    AttachmentsConfiguration:
      type: object
      properties:
        attachmentsControlMode:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Status information about whether file upload functionality is activated or deactivated for your end user.
      required:
      - attachmentsControlMode
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: The message describing the ValidationException.
        reason:
          type: string
          enum:
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - UNKNOWN_OPERATION
          description: The reason for the ValidationException.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The input field(s) that failed validation.
      required:
      - message
      - reason
    QAppsConfiguration:
      type: object
      properties:
        qAppsControlMode:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Status information about whether end users can create and use Amazon Q Apps in the web experience.
      required:
      - qAppsControlMode
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4
x-refined-from:
- amazon-q-openapi.yml
- amazon-q-applications-api-openapi.yml