Amazon Connect Connect Use Cases API

The Connect Use Cases API from Amazon Connect — 2 operation(s) for connect use cases.

Documentation GitHub OpenAPI

Operations 3

PUT /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases Create Use Case #

GET /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases List Use Cases #

DELETE /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId} Delete Use Case #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-connect/openapi/amazon-connect-use-cases-api-openapi.yml

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-use-cases-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.1.0
info:
  title: Amazon Connect Service Use Cases API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 3 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://connect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases:
    put:
      operationId: CreateUseCase
      summary: Create Use Case
      description: Creates a use case for an integration association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUseCaseResponse'
        '409':
          description: DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUseCaseRequest'
      tags:
      - Use Cases
    get:
      operationId: ListUseCases
      summary: List Use Cases
      description: Lists the use cases for the integration association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUseCasesResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListUseCasesRequest'
      tags:
      - Use Cases
  /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}:
    delete:
      operationId: DeleteUseCase
      summary: Delete Use Case
      description: Deletes a use case from an integration association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteUseCaseRequest'
      tags:
      - Use Cases
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: connect
  schemas:
    CreateUseCaseRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        IntegrationAssociationId:
          type: string
          description: The identifier for the integration association.
        UseCaseType:
          type: string
          enum:
          - RULES_EVALUATION
          - CONNECT_CAMPAIGNS
          description: The type of use case to associate to the integration association. Each integration association can
            have only one of each use case type.
        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"} }.'
      required:
      - InstanceId
      - IntegrationAssociationId
      - UseCaseType
    CreateUseCaseResponse:
      type: object
      properties:
        UseCaseId:
          type: string
          description: The identifier of the use case.
        UseCaseArn:
          type: string
          description: The Amazon Resource Name (ARN) for the use case.
    DeleteUseCaseRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        IntegrationAssociationId:
          type: string
          description: The identifier for the integration association.
        UseCaseId:
          type: string
          description: The identifier for the use case.
      required:
      - InstanceId
      - IntegrationAssociationId
      - UseCaseId
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the request.
        Reason:
          $ref: '#/components/schemas/InvalidRequestExceptionReason'
    InvalidRequestExceptionReason:
      type: object
      properties:
        AttachedFileInvalidRequestExceptionReason:
          type: string
          enum:
          - INVALID_FILE_SIZE
          - INVALID_FILE_TYPE
          - INVALID_FILE_NAME
          description: Reason why the StartAttachedFiledUpload request was invalid.
      description: Exactly one member is set.
    ListUseCasesRequest:
      type: object
      properties:
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        IntegrationAssociationId:
          type: string
          description: The identifier for the integration association.
        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.
      required:
      - InstanceId
      - IntegrationAssociationId
    ListUseCasesResponse:
      type: object
      properties:
        UseCaseSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/UseCase'
          description: The use cases.
        NextToken:
          type: string
          description: If there are additional results, this is the token for the next set of results.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UseCase:
      type: object
      properties:
        UseCaseId:
          type: string
          description: The identifier for the use case.
        UseCaseArn:
          type: string
          description: The Amazon Resource Name (ARN) for the use case.
        UseCaseType:
          type: string
          enum:
          - RULES_EVALUATION
          - CONNECT_CAMPAIGNS
          description: The type of use case to associate to the integration association. Each integration association can
            have only one of each use case type.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)