Amazon Connect Connect Event Streams API

The Connect Event Streams API from Amazon Connect — 2 operation(s) for connect event streams.

GitHub OpenAPI

Operations 4

POST /domains/{DomainName}/event-streams/{EventStreamName} Create Event Stream #
DELETE /domains/{DomainName}/event-streams/{EventStreamName} Delete Event Stream #
GET /domains/{DomainName}/event-streams/{EventStreamName} Get Event Stream #
GET /domains/{DomainName}/event-streams List Event Streams #

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-event-streams-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-event-streams-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Connect Service Event Streams API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 4 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://profile.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /domains/{DomainName}/event-streams/{EventStreamName}:
    post:
      operationId: CreateEventStream
      summary: Create Event Stream
      description: Creates an event stream, which is a subscription to real-time events, such as when profiles are created
        and updated through Connect Customer Customer Profiles. Each event stream can be associated with only one Kinesis
        Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEventStreamResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEventStreamRequest'
      tags:
      - Event Streams
    delete:
      operationId: DeleteEventStream
      summary: Delete Event Stream
      description: Disables and deletes the specified event stream.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEventStreamResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEventStreamRequest'
      tags:
      - Event Streams
    get:
      operationId: GetEventStream
      summary: Get Event Stream
      description: Returns information about the specified event stream in a specific domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEventStreamResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetEventStreamRequest'
      tags:
      - Event Streams
  /domains/{DomainName}/event-streams:
    get:
      operationId: ListEventStreams
      summary: List Event Streams
      description: Returns a list of all the event streams in a specific domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEventStreamsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEventStreamsRequest'
      tags:
      - Event Streams
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: profile
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    CreateEventStreamRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        Uri:
          type: string
          description: The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name
        EventStreamName:
          type: string
          description: The name of the event stream.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - DomainName
      - Uri
      - EventStreamName
    CreateEventStreamResponse:
      type: object
      properties:
        EventStreamArn:
          type: string
          description: A unique identifier for the event stream.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - EventStreamArn
    DeleteEventStreamRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        EventStreamName:
          type: string
          description: The name of the event stream
      required:
      - DomainName
      - EventStreamName
    DeleteEventStreamResponse:
      type: object
      properties: {}
    DestinationSummary:
      type: object
      properties:
        Uri:
          type: string
          description: The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name.
        Status:
          type: string
          enum:
          - HEALTHY
          - UNHEALTHY
          description: The status of enabling the Kinesis stream as a destination for export.
        UnhealthySince:
          type: string
          format: date-time
          description: The timestamp when the status last changed to UNHEALHY.
      required:
      - Uri
      - Status
    EventStreamDestinationDetails:
      type: object
      properties:
        Uri:
          type: string
          description: The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name.
        Status:
          type: string
          enum:
          - HEALTHY
          - UNHEALTHY
          description: The status of enabling the Kinesis stream as a destination for export.
        UnhealthySince:
          type: string
          format: date-time
          description: The timestamp when the status last changed to UNHEALHY.
        Message:
          type: string
          description: The human-readable string that corresponds to the error or success while enabling the streaming destination.
      required:
      - Uri
      - Status
    EventStreamSummary:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        EventStreamName:
          type: string
          description: The name of the event stream.
        EventStreamArn:
          type: string
          description: A unique identifier for the event stream.
        State:
          type: string
          enum:
          - RUNNING
          - STOPPED
          description: The operational state of destination stream for export.
        StoppedSince:
          type: string
          format: date-time
          description: The timestamp when the State changed to STOPPED.
        DestinationSummary:
          $ref: '#/components/schemas/DestinationSummary'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - DomainName
      - EventStreamName
      - EventStreamArn
      - State
    GetEventStreamRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        EventStreamName:
          type: string
          description: The name of the event stream provided during create operations.
      required:
      - DomainName
      - EventStreamName
    GetEventStreamResponse:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        EventStreamArn:
          type: string
          description: A unique identifier for the event stream.
        CreatedAt:
          type: string
          format: date-time
          description: The timestamp of when the export was created.
        State:
          type: string
          enum:
          - RUNNING
          - STOPPED
          description: The operational state of destination stream for export.
        StoppedSince:
          type: string
          format: date-time
          description: The timestamp when the State changed to STOPPED.
        DestinationDetails:
          $ref: '#/components/schemas/EventStreamDestinationDetails'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - DomainName
      - EventStreamArn
      - CreatedAt
      - State
      - DestinationDetails
    ListEventStreamsRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        NextToken:
          type: string
          description: Identifies the next page of results to return.
        MaxResults:
          type: integer
          description: The maximum number of objects returned per page.
      required:
      - DomainName
    ListEventStreamsResponse:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/EventStreamSummary'
          description: Contains summary information about an EventStream.
        NextToken:
          type: string
          description: Identifies the next page of results to return.
    ProfileInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ProfileResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)