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-event-bus-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.2.0
info:
  title: Amazon EventBridge Event Bus 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: Event Bus
paths:
  /#CreateEventBus:
    post:
      operationId: CreateEventBus
      summary: Create Event Bus
      description: Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateEventBusResponse'
        '400':
          description: ConcurrentModificationException; InvalidStateException; LimitExceededException; OperationDisabledException; ResourceAlreadyExistsException; 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.CreateEventBus
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateEventBusRequest'
      tags:
      - Event Bus
  /#DeleteEventBus:
    post:
      operationId: DeleteEventBus
      summary: Delete Event Bus
      description: Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ConcurrentModificationException
          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.DeleteEventBus
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteEventBusRequest'
      tags:
      - Event Bus
  /#DescribeEventBus:
    post:
      operationId: DescribeEventBus
      summary: Describe Event Bus
      description: Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time. To enable your account to receive events from other accounts on its default event bus, use PutPermission. For more information about partner event buses, see CreateEventBus.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeEventBusResponse'
        '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.DescribeEventBus
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeEventBusRequest'
      tags:
      - Event Bus
  /#UpdateEventBus:
    post:
      operationId: UpdateEventBus
      summary: Update Event Bus
      description: Updates the specified event bus.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateEventBusResponse'
        '400':
          description: ConcurrentModificationException; OperationDisabledException; 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.UpdateEventBus
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateEventBusRequest'
      tags:
      - Event Bus
components:
  schemas:
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
        Value:
          type: string
          description: The value for the specified tag key.
      required:
      - Key
      - Value
    CreateEventBusRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the new event bus. Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to. You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.
        EventSourceName:
          type: string
          description: If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
        Description:
          type: string
          description: The event bus description.
        KmsKeyIdentifier:
          type: string
          description: The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus. For more information, see Identify and view keys in the Key Management Service Developer Guide. Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an er
        DeadLetterConfig:
          $ref: '#/components/schemas/DeadLetterConfig'
        LogConfig:
          $ref: '#/components/schemas/LogConfig'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to associate with the event bus.
      required:
      - Name
    DescribeEventBusResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the event bus. Currently, this is always default.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
        Description:
          type: string
          description: The event bus description.
        KmsKeyIdentifier:
          type: string
          description: The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
        DeadLetterConfig:
          $ref: '#/components/schemas/DeadLetterConfig'
        Policy:
          type: string
          description: The policy that enables the external account to send events to your account.
        LogConfig:
          $ref: '#/components/schemas/LogConfig'
        CreationTime:
          type: string
          format: date-time
          description: The time the event bus was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The time the event bus was last modified.
        ManagedBy:
          type: string
          description: If the event bus was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the event bus.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    DeleteEventBusRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the event bus to delete.
      required:
      - Name
    UpdateEventBusRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the event bus.
        KmsKeyIdentifier:
          type: string
          description: The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus. For more information, see Identify and view keys in the Key Management Service Developer Guide. Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an er
        Description:
          type: string
          description: The event bus description.
        DeadLetterConfig:
          $ref: '#/components/schemas/DeadLetterConfig'
        LogConfig:
          $ref: '#/components/schemas/LogConfig'
    InternalException:
      type: object
      properties:
        message:
          type: string
    ConcurrentModificationException:
      type: object
      properties:
        message:
          type: string
    CreateEventBusResponse:
      type: object
      properties:
        EventBusArn:
          type: string
          description: The ARN of the new event bus.
        Description:
          type: string
          description: The event bus description.
        KmsKeyIdentifier:
          type: string
          description: The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
        DeadLetterConfig:
          $ref: '#/components/schemas/DeadLetterConfig'
        LogConfig:
          $ref: '#/components/schemas/LogConfig'
    LogConfig:
      type: object
      properties:
        IncludeDetail:
          type: string
          enum:
          - NONE
          - FULL
          description: Whether EventBridge include detailed event information in the records it generates. Detailed data can be useful for troubleshooting and debugging. This information includes details of the event itself, as well as target details. For more information, see Including detail data in event bus logs in the EventBridge User Guide.
        Level:
          type: string
          enum:
          - 'OFF'
          - ERROR
          - INFO
          - TRACE
          description: The level of logging detail to include. This applies to all log destinations for the event bus. For more information, see Specifying event bus log level in the EventBridge User Guide.
    DeadLetterConfig:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the SQS queue specified as the target for the dead-letter queue.
    DescribeEventBusRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.
    UpdateEventBusResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The event bus Amazon Resource Name (ARN).
        Name:
          type: string
          description: The event bus name.
        KmsKeyIdentifier:
          type: string
          description: The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
        Description:
          type: string
          description: The event bus description.
        DeadLetterConfig:
          $ref: '#/components/schemas/DeadLetterConfig'
        LogConfig:
          $ref: '#/components/schemas/LogConfig'
  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)