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-config-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 Config API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 6 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:
  /quick-connects/{InstanceId}/{QuickConnectId}/config:
    post:
      operationId: UpdateQuickConnectConfig
      summary: Update Quick Connect Config
      description: Updates the configuration settings for the specified quick connect.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/UpdateQuickConnectConfigRequest'
      tags:
      - Config
  /users/{InstanceId}/{UserId}/config:
    post:
      operationId: UpdateUserConfig
      summary: Update User Config
      description: Updates the configuration settings for the specified user, including per-channel auto-accept and after
        contact work (ACW) timeout settings. This operation replaces the UpdateUserPhoneConfig API. While UpdateUserPhoneConfig
        applies the same ACW timeout to all channels, UpdateUserConfig allows you to set different auto-accept and ACW timeout
        values for each channel type.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '409':
          description: ConditionalOperationFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConditionalOperationFailedException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '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/UpdateUserConfigRequest'
      tags:
      - Config
  /connect-instance/{connectInstanceId}/config:
    delete:
      operationId: DeleteConnectInstanceConfig
      summary: Delete Connect Instance Config
      description: Deletes a connect instance config from the specified AWS account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '409':
          description: InvalidStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidStateException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteConnectInstanceConfigRequest'
      tags:
      - Config
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_connect_campaigns: []
    get:
      operationId: GetConnectInstanceConfig
      summary: Get Connect Instance Config
      description: Get the specific Connect instance config.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConnectInstanceConfigResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConnectInstanceConfigRequest'
      tags:
      - Config
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_connect_campaigns: []
  /v2/connect-instance/{connectInstanceId}/config:
    delete:
      operationId: DeleteConnectInstanceConfig
      summary: Delete Connect Instance Config
      description: Deletes a connect instance config from the specified AWS account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '409':
          description: InvalidStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidStateException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectCampaignsDeleteConnectInstanceConfigRequest'
      tags:
      - Config
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_connect_campaigns: []
    get:
      operationId: GetConnectInstanceConfig
      summary: Get Connect Instance Config
      description: Get the specific Connect instance config.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConnectInstanceConfigResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConnectInstanceConfigRequest'
      tags:
      - Config
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_connect_campaigns: []
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
    sigv4_connect_campaigns:
      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-campaigns
  schemas:
    AfterContactWorkConfig:
      type: object
      properties:
        AfterContactWorkTimeLimit:
          type: integer
          description: 'The ACW timeout duration in seconds. Minimum: 1 second. Maximum: 2,000,000 seconds (24 days). Enter
            0 for indefinite ACW time.'
    AfterContactWorkConfigPerChannel:
      type: object
      properties:
        Channel:
          type: string
          enum:
          - VOICE
          - CHAT
          - TASK
          - EMAIL
          description: 'The channel for this ACW timeout configuration. Valid values: VOICE, CHAT, TASK, EMAIL.'
        AfterContactWorkConfig:
          $ref: '#/components/schemas/AfterContactWorkConfig'
        AgentFirstCallbackAfterContactWorkConfig:
          $ref: '#/components/schemas/AfterContactWorkConfig'
      required:
      - Channel
      - AfterContactWorkConfig
    AutoAcceptConfig:
      type: object
      properties:
        Channel:
          type: string
          enum:
          - VOICE
          - CHAT
          - TASK
          - EMAIL
          description: 'The channel for this auto-accept configuration. Valid values: VOICE, CHAT, TASK, EMAIL.'
        AutoAccept:
          type: boolean
          description: Indicates whether auto-accept is enabled for this channel. When enabled, available agents are automatically
            connected to contacts from this channel.
        AgentFirstCallbackAutoAccept:
          type: boolean
          description: Indicates whether auto-accept is enabled for agent-first callbacks. This setting only applies to the
            VOICE channel.
      required:
      - Channel
      - AutoAccept
    ConditionalOperationFailedException:
      type: object
      properties:
        Message:
          type: string
    ConnectCampaignsAccessDeniedException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsDeleteConnectInstanceConfigRequest:
      type: object
      properties:
        connectInstanceId:
          type: string
        campaignDeletionPolicy:
          type: string
      required:
      - connectInstanceId
    ConnectCampaignsEncryptionConfig:
      type: object
      properties:
        enabled:
          type: boolean
        encryptionType:
          type: string
        keyArn:
          type: string
      required:
      - enabled
    ConnectCampaignsInternalServerException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsThrottlingException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsValidationException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    DeleteConnectInstanceConfigRequest:
      type: object
      properties:
        connectInstanceId:
          type: string
      required:
      - connectInstanceId
    FlowQuickConnectConfig:
      type: object
      properties:
        ContactFlowId:
          type: string
          description: The contact flow ID for the quick connect configuration.
      required:
      - ContactFlowId
    GetConnectInstanceConfigRequest:
      type: object
      properties:
        connectInstanceId:
          type: string
      required:
      - connectInstanceId
    GetConnectInstanceConfigResponse:
      type: object
      properties:
        connectInstanceConfig:
          $ref: '#/components/schemas/InstanceConfig'
    InstanceConfig:
      type: object
      properties:
        connectInstanceId:
          type: string
        serviceLinkedRoleArn:
          type: string
        encryptionConfig:
          $ref: '#/components/schemas/ConnectCampaignsEncryptionConfig'
      required:
      - connectInstanceId
      - serviceLinkedRoleArn
      - encryptionConfig
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    InvalidStateException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    PersistentConnectionConfig:
      type: object
      properties:
        Channel:
          type: string
          enum:
          - VOICE
          - CHAT
          - TASK
          - EMAIL
          description: Configuration settings for persistent connection. Only VOICE is supported for this data type.
        PersistentConnection:
          type: boolean
          description: Indicates whether persistent connection is enabled. When enabled, the agent's connection is maintained
            after a call ends, enabling subsequent calls to connect faster.
      required:
      - Channel
      - PersistentConnection
    PhoneNumberConfig:
      type: object
      properties:
        Channel:
          type: string
          enum:
          - VOICE
          - CHAT
          - TASK
          - EMAIL
          description: The channel for this phone number configuration. Only VOICE is supported for this data type.
        PhoneType:
          type: string
          enum:
          - SOFT_PHONE
          - DESK_PHONE
          description: 'The phone type. Valid values: SOFT_PHONE, DESK_PHONE.'
        PhoneNumber:
          type: string
          description: The phone number for the user's desk phone.
      required:
      - Channel
      - PhoneType
    PhoneNumberQuickConnectConfig:
      type: object
      properties:
        PhoneNumber:
          type: string
          description: The phone number in E.164 format.
      required:
      - PhoneNumber
    QueueQuickConnectConfig:
      type: object
      properties:
        QueueId:
          type: string
          description: The identifier for the queue.
        ContactFlowId:
          type: string
          description: The identifier of the flow.
      required:
      - QueueId
      - ContactFlowId
    QuickConnectConfig:
      type: object
      properties:
        QuickConnectType:
          type: string
          enum:
          - USER
          - QUEUE
          - PHONE_NUMBER
          - FLOW
          description: 'The type of quick connect. In the Connect Customer admin website, when you create a quick connect,
            you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).'
        UserConfig:
          $ref: '#/components/schemas/UserQuickConnectConfig'
        QueueConfig:
          $ref: '#/components/schemas/QueueQuickConnectConfig'
        PhoneConfig:
          $ref: '#/components/schemas/PhoneNumberQuickConnectConfig'
        FlowConfig:
          $ref: '#/components/schemas/FlowQuickConnectConfig'
      required:
      - QuickConnectType
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    UpdateQuickConnectConfigRequest:
      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.
        QuickConnectId:
          type: string
          description: The identifier for the quick connect.
        QuickConnectConfig:
          $ref: '#/components/schemas/QuickConnectConfig'
      required:
      - InstanceId
      - QuickConnectId
      - QuickConnectConfig
    UpdateUserConfigRequest:
      type: object
      properties:
        AutoAcceptConfigs:
          type: array
          items:
            $ref: '#/components/schemas/AutoAcceptConfig'
          description: The list of auto-accept configuration settings for each channel. When auto-accept is enabled for a
            channel, available agents are automatically connected to contacts from that channel without needing to manually
            accept. Auto-accept connects agents to contacts in less than one second.
        AfterContactWorkConfigs:
          type: array
          items:
            $ref: '#/components/schemas/AfterContactWorkConfigPerChannel'
          description: The list of after contact work (ACW) timeout configuration settings for each channel. ACW timeout specifies
            how many seconds agents have for after contact work, such as entering notes about the contact. The minimum setting
            is 1 second, and the maximum is 2,000,000 seconds (24 days). Enter 0 for an indefinite amount of time, meaning
            agents must manually choose to end ACW.
        PhoneNumberConfigs:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberConfig'
          description: The list of phone number configuration settings for each channel.
        PersistentConnectionConfigs:
          type: array
          items:
            $ref: '#/components/schemas/PersistentConnectionConfig'
          description: The list of persistent connection configuration settings for each channel.
        VoiceEnhancementConfigs:
          type: array
          items:
            $ref: '#/components/schemas/VoiceEnhancementConfig'
          description: The list of voice enhancement configuration settings for each channel.
        UserId:
          type: string
          description: The identifier of the user account.
        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.
      required:
      - UserId
      - InstanceId
    UserQuickConnectConfig:
      type: object
      properties:
        UserId:
          type: string
          description: The identifier of the user.
        ContactFlowId:
          type: string
          description: The identifier of the flow.
      required:
      - UserId
      - ContactFlowId
    VoiceEnhancementConfig:
      type: object
      properties:
        Channel:
          type: string
          enum:
          - VOICE
          - CHAT
          - TASK
          - EMAIL
          description: The channel for this voice enhancement configuration. Only VOICE is supported for this data type.
        VoiceEnhancementMode:
          type: string
          enum:
          - VOICE_ISOLATION
          - NOISE_SUPPRESSION
          - NONE
          description: The voice enhancement mode.
      required:
      - Channel
      - VoiceEnhancementMode
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connect/service/2017-08-08/connect-2017-08-08.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcampaigns/service/2021-01-30/connectcampaigns-2021-01-30.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcampaignsv2/service/2024-04-23/connectcampaignsv2-2024-04-23.json