Amazon Connect Connect Subscriptions API

The Connect Subscriptions API from Amazon Connect — 1 operation(s) for connect subscriptions.

GitHub OpenAPI

Operations 3

DELETE /domains/{DomainName}/segment-definitions/{SegmentDefinitionName}/subscriptions Delete Segment Subscription #
GET /domains/{DomainName}/segment-definitions/{SegmentDefinitionName}/subscriptions Get Segment Subscription #
PUT /domains/{DomainName}/segment-definitions/{SegmentDefinitionName}/subscriptions Put Segment Subscription #

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-subscriptions-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-subscriptions-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Connect Service Subscriptions 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://profile.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /domains/{DomainName}/segment-definitions/{SegmentDefinitionName}/subscriptions:
    delete:
      operationId: DeleteSegmentSubscription
      summary: Delete Segment Subscription
      description: Deletes a segment subscription for membership events. All active event notifications for this segment are
        stopped.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSegmentSubscriptionResponse'
        '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/DeleteSegmentSubscriptionRequest'
      tags:
      - Subscriptions
    get:
      operationId: GetSegmentSubscription
      summary: Get Segment Subscription
      description: Returns the current subscription configuration, execution schedule, and status for segment membership events.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSegmentSubscriptionResponse'
        '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/GetSegmentSubscriptionRequest'
      tags:
      - Subscriptions
    put:
      operationId: PutSegmentSubscription
      summary: Put Segment Subscription
      description: Creates or updates a segment subscription for membership events. When a subscription is created, an initial
        snapshot is taken and the system begins monitoring for membership changes. You can optionally set a schedule configuration
        interval to control how often membership snapshots are run. The interval can be from 1 to 24 hours. If not set, the
        interval defaults to 24 hours. Scheduled snapshots run on a best-effort basis. If a scheduled snapshot takes longer
        than the configured interval, the next scheduled run does not start until the in-progress snapshot completes, so a
        run might be delayed or skipped and is not guaranteed to occur at exactly the requested time. For Classic segments,
        membership events are generated from these scheduled snapshots and also in near real-time as profile attribute changes
        occur. For SQL segments, membership events are generated only from the scheduled snapshots.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutSegmentSubscriptionResponse'
        '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/PutSegmentSubscriptionRequest'
      tags:
      - Subscriptions
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
    DeleteSegmentSubscriptionRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        SegmentDefinitionName:
          type: string
          description: The unique name of the segment definition.
      required:
      - DomainName
      - SegmentDefinitionName
    DeleteSegmentSubscriptionResponse:
      type: object
      properties:
        Message:
          type: string
          description: A confirmation message indicating the subscription was deleted successfully.
    GetSegmentSubscriptionRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        SegmentDefinitionName:
          type: string
          description: The unique name of the segment definition.
      required:
      - DomainName
      - SegmentDefinitionName
    GetSegmentSubscriptionResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - STARTING
          - RUNNING
          - STOPPED
          - FAILED
          description: 'The current lifecycle status of the subscription. The following are valid values: STARTING: Initial
            snapshot is in progress. RUNNING: Notifications are active and running. STOPPED: Notifications have been stopped.
            FAILED: Notifications failed (for example, the Amazon Kinesis data stream became inaccessible).'
        Message:
          type: string
          description: A status message providing additional context, such as a failure reason.
        ScheduleConfiguration:
          $ref: '#/components/schemas/ScheduleConfiguration'
        ScheduledExecutions:
          $ref: '#/components/schemas/ScheduledExecutions'
        StartedAt:
          type: string
          format: date-time
          description: The timestamp of when the subscription was first started.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The timestamp of the most recent configuration change.
    ProfileInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ProfileResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    PutSegmentSubscriptionRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        SegmentDefinitionName:
          type: string
          description: The unique name of the segment definition.
        ScheduleConfiguration:
          $ref: '#/components/schemas/ScheduleConfiguration'
      required:
      - DomainName
      - SegmentDefinitionName
    PutSegmentSubscriptionResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - STARTING
          - RUNNING
          - STOPPED
          - FAILED
          description: 'The current lifecycle status of the subscription. The following are valid values: STARTING: Initial
            snapshot is in progress. RUNNING: Notifications are active and running. STOPPED: Notifications have been stopped.
            FAILED: Notifications failed (for example, the Amazon Kinesis data stream became inaccessible).'
        ScheduleConfiguration:
          $ref: '#/components/schemas/ScheduleConfiguration'
        StartedAt:
          type: string
          format: date-time
          description: The timestamp of when the subscription was started.
    ScheduleConfiguration:
      type: object
      properties:
        Interval:
          type: integer
          description: The interval between scheduled executions.
        Unit:
          type: string
          enum:
          - HOURLY
          description: 'The unit for the interval. The following are valid values: HOURLY: The interval is measured in hours.'
      required:
      - Interval
    ScheduledExecutions:
      type: object
      properties:
        NextExecutedAt:
          type: string
          format: date-time
          description: The timestamp of the next scheduled execution.
        LastExecutedAt:
          type: string
          format: date-time
          description: The timestamp of the last successful scheduled execution.
    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)