Amazon EventBridge

Amazon EventBridge Eventbridge Replay API

The Eventbridge Replay API from Amazon EventBridge — 4 operation(s) for eventbridge replay.

GitHub OpenAPI

Operations 4

POST /#CancelReplay Cancel Replay #
POST /#DescribeReplay Describe Replay #
POST /#ListReplays List Replays #
POST /#StartReplay Start Replay #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-eventbridge/openapi/amazon-eventbridge-replay-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-eventbridge:amazon-eventbridge-replay-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

amazon-eventbridge-replay-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon EventBridge Replay API
  version: '2015-10-07'
  description: Generated from AWS's published Smithy model for Amazon EventBridge. 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://events.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Replay
paths:
  /#CancelReplay:
    post:
      operationId: CancelReplay
      summary: Cancel Replay
      description: Cancels the specified replay.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CancelReplayResponse'
        '400':
          description: ConcurrentModificationException; IllegalStatusException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSEvents.CancelReplay
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CancelReplayRequest'
      tags:
      - Replay
  /#DescribeReplay:
    post:
      operationId: DescribeReplay
      summary: Describe Replay
      description: Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeReplayResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSEvents.DescribeReplay
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeReplayRequest'
      tags:
      - Replay
  /#ListReplays:
    post:
      operationId: ListReplays
      summary: List Replays
      description: Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListReplaysResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSEvents.ListReplays
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListReplaysRequest'
      tags:
      - Replay
  /#StartReplay:
    post:
      operationId: StartReplay
      summary: Start Replay
      description: Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartReplayResponse'
        '500':
          description: InternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalException'
        '400':
          description: InvalidEventPatternException; LimitExceededException; ResourceAlreadyExistsException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidEventPatternException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSEvents.StartReplay
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartReplayRequest'
      tags:
      - Replay
components:
  schemas:
    ListReplaysResponse:
      type: object
      properties:
        Replays:
          type: array
          items:
            $ref: '#/components/schemas/Replay'
          description: An array of Replay objects that contain information about the replay.
        NextToken:
          type: string
          description: A token indicating there are more results available. If there are no more results, no token is included in the response. The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an HTTP 400 InvalidToken error.
    ReplayDestination:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive.
        FilterArns:
          type: array
          items:
            type: string
          description: A list of ARNs for rules to replay events to.
      required:
      - Arn
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    DescribeReplayRequest:
      type: object
      properties:
        ReplayName:
          type: string
          description: The name of the replay to retrieve.
      required:
      - ReplayName
    StartReplayRequest:
      type: object
      properties:
        ReplayName:
          type: string
          description: The name of the replay to start.
        Description:
          type: string
          description: A description for the replay to start.
        EventSourceArn:
          type: string
          description: The ARN of the archive to replay events from.
        EventStartTime:
          type: string
          format: date-time
          description: A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.
        EventEndTime:
          type: string
          format: date-time
          description: A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.
        Destination:
          $ref: '#/components/schemas/ReplayDestination'
      required:
      - ReplayName
      - EventSourceArn
      - EventStartTime
      - EventEndTime
      - Destination
    ConcurrentModificationException:
      type: object
      properties:
        message:
          type: string
    InvalidEventPatternException:
      type: object
      properties:
        message:
          type: string
    StartReplayResponse:
      type: object
      properties:
        ReplayArn:
          type: string
          description: The ARN of the replay.
        State:
          type: string
          enum:
          - STARTING
          - RUNNING
          - CANCELLING
          - COMPLETED
          - CANCELLED
          - FAILED
          description: The state of the replay.
        StateReason:
          type: string
          description: The reason that the replay is in the state.
        ReplayStartTime:
          type: string
          format: date-time
          description: The time at which the replay started.
    DescribeReplayResponse:
      type: object
      properties:
        ReplayName:
          type: string
          description: The name of the replay.
        ReplayArn:
          type: string
          description: The ARN of the replay.
        Description:
          type: string
          description: The description of the replay.
        State:
          type: string
          enum:
          - STARTING
          - RUNNING
          - CANCELLING
          - COMPLETED
          - CANCELLED
          - FAILED
          description: The current state of the replay.
        StateReason:
          type: string
          description: The reason that the replay is in the current state.
        EventSourceArn:
          type: string
          description: The ARN of the archive events were replayed from.
        Destination:
          $ref: '#/components/schemas/ReplayDestination'
        EventStartTime:
          type: string
          format: date-time
          description: The time stamp of the first event that was last replayed from the archive.
        EventEndTime:
          type: string
          format: date-time
          description: The time stamp for the last event that was replayed from the archive.
        EventLastReplayedTime:
          type: string
          format: date-time
          description: The time that the event was last replayed.
        ReplayStartTime:
          type: string
          format: date-time
          description: A time stamp for the time that the replay started.
        ReplayEndTime:
          type: string
          format: date-time
          description: A time stamp for the time that the replay stopped.
    CancelReplayResponse:
      type: object
      properties:
        ReplayArn:
          type: string
          description: The ARN of the replay to cancel.
        State:
          type: string
          enum:
          - STARTING
          - RUNNING
          - CANCELLING
          - COMPLETED
          - CANCELLED
          - FAILED
          description: The current state of the replay.
        StateReason:
          type: string
          description: The reason that the replay is in the current state.
    InternalException:
      type: object
      properties:
        message:
          type: string
    ListReplaysRequest:
      type: object
      properties:
        NamePrefix:
          type: string
          description: A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.
        State:
          type: string
          enum:
          - STARTING
          - RUNNING
          - CANCELLING
          - COMPLETED
          - CANCELLED
          - FAILED
          description: The state of the replay.
        EventSourceArn:
          type: string
          description: The ARN of the archive from which the events are replayed.
        NextToken:
          type: string
          description: The token returned by a previous call, which you can use to retrieve the next set of results. The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an HTTP 400 InvalidToken error.
        Limit:
          type: integer
          description: The maximum number of replays to retrieve.
    Replay:
      type: object
      properties:
        ReplayName:
          type: string
          description: The name of the replay.
        EventSourceArn:
          type: string
          description: The ARN of the archive to replay event from.
        State:
          type: string
          enum:
          - STARTING
          - RUNNING
          - CANCELLING
          - COMPLETED
          - CANCELLED
          - FAILED
          description: The current state of the replay.
        StateReason:
          type: string
          description: A description of why the replay is in the current state.
        EventStartTime:
          type: string
          format: date-time
          description: A time stamp for the time to start replaying events. This is determined by the time in the event as described in Time.
        EventEndTime:
          type: string
          format: date-time
          description: A time stamp for the time to start replaying events. Any event with a creation time prior to the EventEndTime specified is replayed.
        EventLastReplayedTime:
          type: string
          format: date-time
          description: A time stamp for the time that the last event was replayed.
        ReplayStartTime:
          type: string
          format: date-time
          description: A time stamp for the time that the replay started.
        ReplayEndTime:
          type: string
          format: date-time
          description: A time stamp for the time that the replay completed.
    CancelReplayRequest:
      type: object
      properties:
        ReplayName:
          type: string
          description: The name of the replay to cancel.
      required:
      - ReplayName
  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: events
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/eventbridge/service/2015-10-07/eventbridge-2015-10-07.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)