Amazon Connect Connect Applications API

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

GitHub OpenAPI

Operations 5

POST /applications Create Application #
GET /applications List Applications #
DELETE /applications/{Arn} Delete Application #
GET /applications/{Arn} Get Application #
PATCH /applications/{Arn} Update Application #

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-connect:amazon-connect-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.

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

OpenAPI Specification

amazon-connect-applications-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Connect Service Applications API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 5 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://app-integrations.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /applications:
    post:
      operationId: CreateApplication
      summary: Create Application
      description: Creates and persists an Application resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApplicationResponse'
              example:
                Id: 98542c53-e8ac-4570-9c85-c6552c8d9c5e
                Arn: arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
        '400':
          description: InvalidRequestException; UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppIntegrationsInvalidRequestException'
        '429':
          description: ResourceQuotaExceededException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceQuotaExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApplicationRequest'
            example:
              Name: My Application
              Namespace: myapplication
              Description: My first application.
              ApplicationSourceConfig:
                ExternalUrlConfig:
                  AccessUrl: https://example.com
      tags:
      - Applications
    get:
      operationId: ListApplications
      summary: List Applications
      description: Lists applications in the account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListApplicationsResponse'
              example:
                Applications:
                - Id: 98542c53-e8ac-4570-9c85-c6552c8d9c5e
                  Arn: arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e
                  Name: My Application
                  Namespace: myapplication
                NextToken: abc
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppIntegrationsInvalidRequestException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListApplicationsRequest'
            example:
              MaxResults: 1
      tags:
      - Applications
  /applications/{Arn}:
    delete:
      operationId: DeleteApplication
      summary: Delete Application
      description: Deletes an application. If the application has associations, you must delete them first. Alternatively,
        use the force option to delete the application and remove its associations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApplicationResponse'
              example: {}
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppIntegrationsInvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppIntegrationsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteApplicationRequest'
            example:
              Arn: arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e
      tags:
      - Applications
    get:
      operationId: GetApplication
      summary: Get Application
      description: Get an Application resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApplicationResponse'
              example:
                Name: My Application
                Namespace: myapplication
                Description: My first application.
                ApplicationSourceConfig:
                  ExternalUrlConfig:
                    AccessUrl: https://example.com
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServiceError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppIntegrationsInvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppIntegrationsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetApplicationRequest'
            example:
              Arn: arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e
      tags:
      - Applications
    patch:
      operationId: UpdateApplication
      summary: Update Application
      description: Updates and persists an Application resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApplicationResponse'
              example: {}
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServiceError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceError'
        '400':
          description: InvalidRequestException; UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppIntegrationsInvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppIntegrationsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateApplicationRequest'
            example:
              Arn: arn:aws:app-integrations:us-west-2:0123456789012:application/98542c53-e8ac-4570-9c85-c6552c8d9c5e
              Name: My New Application Name
      tags:
      - Applications
components:
  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: app-integrations
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    AppIntegrationsInvalidRequestException:
      type: object
      properties:
        Message:
          type: string
    AppIntegrationsResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ApplicationConfig:
      type: object
      properties:
        ContactHandling:
          $ref: '#/components/schemas/ContactHandling'
    ApplicationSourceConfig:
      type: object
      properties:
        ExternalUrlConfig:
          $ref: '#/components/schemas/ExternalUrlConfig'
    ApplicationSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Application.
        Id:
          type: string
          description: A unique identifier for the Application.
        Name:
          type: string
          description: The name of the application.
        Namespace:
          type: string
          description: The namespace of the application.
        CreatedTime:
          type: string
          format: date-time
          description: The time when the application was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The time when the application was last modified.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where the application was last modified.
        IsService:
          type: boolean
          description: Indicates whether the application is a service.
        ApplicationType:
          type: string
          enum:
          - STANDARD
          - SERVICE
          - MCP_SERVER
          - A2A_SERVER
          description: The type of application.
    AuthConfig:
      type: object
      properties:
        AuthType:
          type: string
          enum:
          - API_KEY
          - CONNECT_JWT
          description: 'The type of authentication that Connect Customer uses to call the external application endpoint. You
            must specify an authentication type for A2A_SERVER applications. Valid values: API_KEY: Connect Customer sends
            an API key that is stored in the Secrets Manager secret that you specify in CredentialProviderIdentifier. CONNECT_JWT:
            Connect Customer issues a short-lived, signed JSON Web Token (JWT). This authentication type doesn''t require
            a stored credential.'
        CredentialProviderIdentifier:
          type: string
          description: The ARN of the Secrets Manager secret that stores the credentials. The secret must be accessible to
            Connect Customer. You must specify this ARN when AuthType is API_KEY. Don't specify it when AuthType is CONNECT_JWT.
        AudienceOverride:
          type: string
          description: The value that Connect Customer uses as the audience (aud) claim of the JSON Web Token (JWT) that it
            issues. You can specify this parameter only when AuthType is CONNECT_JWT. If you don't specify it, the audience
            is the AccessUrl of the application. The value can't contain connect.amazonaws.com.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    ContactHandling:
      type: object
      properties:
        Scope:
          type: string
          enum:
          - CROSS_CONTACTS
          - PER_CONTACT
          description: Indicates whether the application refreshes for each contact or refreshes only with each new browser
            session.
    CreateApplicationRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the application.
        Namespace:
          type: string
          description: The namespace of the application.
        Description:
          type: string
          description: The description of the application.
        ApplicationSourceConfig:
          $ref: '#/components/schemas/ApplicationSourceConfig'
        Subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
          description: The events that the application subscribes.
        Publications:
          type: array
          items:
            $ref: '#/components/schemas/Publication'
          description: The events that the application publishes.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
            provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making
            retries safe with idempotent APIs.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
            "key2":"value2"} }.'
        Permissions:
          type: array
          items:
            type: string
          description: The configuration of events or requests that the application has access to.
        IsService:
          type: boolean
          description: Indicates whether the application is a service.
        InitializationTimeout:
          type: integer
          description: The maximum time in milliseconds allowed to establish a connection with the workspace.
        ApplicationConfig:
          $ref: '#/components/schemas/ApplicationConfig'
        IframeConfig:
          $ref: '#/components/schemas/IframeConfig'
        ApplicationType:
          type: string
          enum:
          - STANDARD
          - SERVICE
          - MCP_SERVER
          - A2A_SERVER
          description: The type of application.
        AuthConfig:
          $ref: '#/components/schemas/AuthConfig'
      required:
      - Name
      - Namespace
      - ApplicationSourceConfig
    CreateApplicationResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Application.
        Id:
          type: string
          description: A unique identifier for the Application.
    DeleteApplicationRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Application.
        Force:
          type: boolean
          description: Specifies whether to delete the application even if it still has application associations. If true,
            the operation removes the application and its associations. If false or absent, the delete fails when associations
            exist. Setting this parameter to true permanently removes all of the application's associations. Doing so might
            impact other resources that rely on and reference the application. This action can't be undone.
      required:
      - Arn
    DeleteApplicationResponse:
      type: object
      properties: {}
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    ExternalUrlConfig:
      type: object
      properties:
        AccessUrl:
          type: string
          description: The URL to access the application.
        ApprovedOrigins:
          type: array
          items:
            type: string
          description: Additional URLs to allow list if different than the access URL.
      required:
      - AccessUrl
    GetApplicationRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Application.
      required:
      - Arn
    GetApplicationResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Application.
        Id:
          type: string
          description: A unique identifier for the Application.
        Name:
          type: string
          description: The name of the application.
        Namespace:
          type: string
          description: The namespace of the application.
        Description:
          type: string
          description: The description of the application.
        ApplicationSourceConfig:
          $ref: '#/components/schemas/ApplicationSourceConfig'
        Subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
          description: The events that the application subscribes.
        Publications:
          type: array
          items:
            $ref: '#/components/schemas/Publication'
          description: The events that the application publishes.
        CreatedTime:
          type: string
          format: date-time
          description: The created time of the Application.
        LastModifiedTime:
          type: string
          format: date-time
          description: The last modified time of the Application.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where the application was last modified.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
            "key2":"value2"} }.'
        Permissions:
          type: array
          items:
            type: string
          description: The configuration of events or requests that the application has access to.
        IsService:
          type: boolean
          description: Indicates whether the application is a service.
        InitializationTimeout:
          type: integer
          description: The maximum time in milliseconds allowed to establish a connection with the workspace.
        ApplicationConfig:
          $ref: '#/components/schemas/ApplicationConfig'
        IframeConfig:
          $ref: '#/components/schemas/IframeConfig'
        ApplicationType:
          type: string
          enum:
          - STANDARD
          - SERVICE
          - MCP_SERVER
          - A2A_SERVER
          description: The type of application.
        AuthConfig:
          $ref: '#/components/schemas/AuthConfig'
    IframeConfig:
      type: object
      properties:
        Allow:
          type: array
          items:
            type: string
          description: The list of features that are allowed in the iframe.
        Sandbox:
          type: array
          items:
            type: string
          description: The list of sandbox attributes for the iframe.
    InternalServiceError:
      type: object
      properties:
        Message:
          type: string
    ListApplicationsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The token for the next set of results. Use the value returned in the previous response in the next
            request to retrieve the next set of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return per page.
        ApplicationType:
          type: string
          enum:
          - STANDARD
          - SERVICE
          - MCP_SERVER
          - A2A_SERVER
          description: The type of application.
    ListApplicationsResponse:
      type: object
      properties:
        Applications:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationSummary'
          description: The Applications associated with this account.
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
    Publication:
      type: object
      properties:
        Event:
          type: string
          description: The name of the publication.
        Schema:
          type: string
          description: The JSON schema of the publication event.
        Description:
          type: string
          description: The description of the publication.
      required:
      - Event
      - Schema
    ResourceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    Subscription:
      type: object
      properties:
        Event:
          type: string
          description: The name of the subscription.
        Description:
          type: string
          description: The description of the subscription.
      required:
      - Event
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateApplicationRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Application.
        Name:
          type: string
          description: The name of the application.
        Description:
          type: string
          description: The description of the application.
        ApplicationSourceConfig:
          $ref: '#/components/schemas/ApplicationSourceConfig'
        Subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
          description: The events that the application subscribes.
        Publications:
          type: array
          items:
            $ref: '#/components/schemas/Publication'
          description: The events that the application publishes.
        Permissions:
          type: array
          items:
            type: string
          description: The configuration of events or requests that the application has access to.
        IsService:
          type: boolean
          description: Indicates whether the application is a service.
        InitializationTimeout:
          type: integer
          description: The maximum time in milliseconds allowed to establish a connection with the workspace.
        ApplicationConfig:
          $ref: '#/components/schemas/ApplicationConfig'
        IframeConfig:
          $ref: '#/components/schemas/IframeConfig'
        ApplicationType:
          type: string
          enum:
          - STANDARD
          - SERVICE
          - MCP_SERVER
          - A2A_SERVER
          description: The type of application.
        AuthConfig:
          $ref: '#/components/schemas/AuthConfig'
      required:
      - Arn
    UpdateApplicationResponse:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/appintegrations/service/2020-07-29/appintegrations-2020-07-29.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)