Amazon EventBridge Event Buses API

openapi: 3.2.0
info:
  title: Amazon Eventbridge Event Buses API
  version: '2015-10-07'
  description: 'Operations tagged Event Buses across 2 of this provider''s published API definitions: amazon-eventbridge-openapi.yml, amazon-eventbridge-event-buses-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://events.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-central-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-northeast-1
tags:
- name: Event Buses
  description: Operations for managing event buses.
paths:
  /?CreateEventBus:
    post:
      operationId: CreateEventBus
      summary: Amazon EventBridge Create Event Bus
      description: Creates a new event bus within your account.
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target-CreateEventBus'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateEventBusRequest'
            examples:
              CreateEventBusRequestExample:
                summary: Default CreateEventBus request
                x-microcks-default: true
                value:
                  Name: example-name
                  EventSourceName: example-name
                  Tags: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEventBusResponse'
              examples:
                CreateEventBus200Example:
                  summary: Default CreateEventBus 200 response
                  x-microcks-default: true
                  value:
                    EventBusArn: arn:aws:service:us-east-1:123456789012:resource/example
        '400':
          description: Bad request
        '500':
          description: Internal server error
      tags:
      - Event Buses
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - aws_sigv4: []
    servers:
    - url: https://events.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - eu-west-1
          - eu-west-2
          - eu-central-1
          - ap-southeast-1
          - ap-southeast-2
          - ap-northeast-1
  /?DescribeEventBus:
    post:
      operationId: DescribeEventBus
      summary: Amazon EventBridge Describe Event Bus
      description: Displays details about an event bus in your account, including the default event bus.
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target-DescribeEventBus'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeEventBusRequest'
            examples:
              DescribeEventBusRequestExample:
                summary: Default DescribeEventBus request
                x-microcks-default: true
                value:
                  Name: example-name
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeEventBusResponse'
              examples:
                DescribeEventBus200Example:
                  summary: Default DescribeEventBus 200 response
                  x-microcks-default: true
                  value:
                    Name: example-name
                    Arn: arn:aws:service:us-east-1:123456789012:resource/example
                    Policy: example
        '400':
          description: Bad request
        '500':
          description: Internal server error
      tags:
      - Event Buses
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - aws_sigv4: []
    servers:
    - url: https://events.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - eu-west-1
          - eu-west-2
          - eu-central-1
          - ap-southeast-1
          - ap-southeast-2
          - ap-northeast-1
  /?ListEventBuses:
    post:
      operationId: ListEventBuses
      summary: Amazon EventBridge List Event Buses
      description: Lists all the event buses in your account, including the default event bus.
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target-ListEventBuses'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListEventBusesRequest'
            examples:
              ListEventBusesRequestExample:
                summary: Default ListEventBuses request
                x-microcks-default: true
                value:
                  NamePrefix: example-name
                  NextToken: example
                  Limit: 1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEventBusesResponse'
              examples:
                ListEventBuses200Example:
                  summary: Default ListEventBuses 200 response
                  x-microcks-default: true
                  value:
                    EventBuses: []
                    NextToken: example
        '400':
          description: Bad request
        '500':
          description: Internal server error
      tags:
      - Event Buses
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - aws_sigv4: []
    servers:
    - url: https://events.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - eu-west-1
          - eu-west-2
          - eu-central-1
          - ap-southeast-1
          - ap-southeast-2
          - ap-northeast-1
  /?DeleteEventBus:
    post:
      operationId: DeleteEventBus
      summary: Amazon EventBridge Delete Event Bus
      description: Deletes the specified custom event bus or partner event bus. The default event bus cannot be deleted.
      parameters:
      - $ref: '#/components/parameters/X-Amz-Target-DeleteEventBus'
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteEventBusRequest'
            examples:
              DeleteEventBusRequestExample:
                summary: Default DeleteEventBus request
                x-microcks-default: true
                value:
                  Name: example-name
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '500':
          description: Internal server error
      tags:
      - Event Buses
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - aws_sigv4: []
    servers:
    - url: https://events.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - eu-west-1
          - eu-west-2
          - eu-central-1
          - ap-southeast-1
          - ap-southeast-2
          - ap-northeast-1
  /#ListEventBuses:
    post:
      operationId: post#ListEventBuses
      summary: List Event Buses
      description: Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListEventBusesResponse_2'
        '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.ListEventBuses
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListEventBusesRequest_2'
      tags:
      - Event Buses
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: ListEventBuses
    servers:
    - url: https://events.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    ListEventBusesRequest:
      type: object
      properties:
        NamePrefix:
          type: string
        NextToken:
          type: string
        Limit:
          type: integer
    CreateEventBusRequest:
      type: object
      properties:
        Name:
          type: string
        EventSourceName:
          type: string
        Tags:
          type: array
          items:
            type: object
            properties:
              Key:
                type: string
              Value:
                type: string
      required:
      - Name
    DescribeEventBusResponse:
      type: object
      properties:
        Name:
          type: string
        Arn:
          type: string
        Policy:
          type: string
    DeleteEventBusRequest:
      type: object
      properties:
        Name:
          type: string
      required:
      - Name
    CreateEventBusResponse:
      type: object
      properties:
        EventBusArn:
          type: string
    EventBus:
      type: object
      properties:
        Name:
          type: string
          description: The name of the event bus.
        Arn:
          type: string
          description: The ARN of the event bus.
        Policy:
          type: string
          description: The permissions policy of the event bus.
    ListEventBusesResponse:
      type: object
      properties:
        EventBuses:
          type: array
          items:
            $ref: '#/components/schemas/EventBus'
        NextToken:
          type: string
    DescribeEventBusRequest:
      type: object
      properties:
        Name:
          type: string
    ListEventBusesRequest_2:
      type: object
      properties:
        NamePrefix:
          type: string
          description: Specifying this limits the results to only those event buses with names that start with the specified prefix.
        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: Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
    ListEventBusesResponse_2:
      type: object
      properties:
        EventBuses:
          type: array
          items:
            $ref: '#/components/schemas/EventBus_2'
          description: This list of event buses.
        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.
    InternalException:
      type: object
      properties:
        message:
          type: string
    EventBus_2:
      type: object
      properties:
        Name:
          type: string
          description: The name of the event bus.
        Arn:
          type: string
          description: The ARN of the event bus.
        Description:
          type: string
          description: The event bus description.
        Policy:
          type: string
          description: The permissions policy of the event bus, describing which other Amazon Web Services accounts can write events to this event bus.
        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.
  parameters:
    X-Amz-Target-ListEventBuses:
      name: X-Amz-Target
      in: header
      required: true
      schema:
        type: string
        enum:
        - AWSEvents.ListEventBuses
    X-Amz-Target-DeleteEventBus:
      name: X-Amz-Target
      in: header
      required: true
      schema:
        type: string
        enum:
        - AWSEvents.DeleteEventBus
    X-Amz-Target-DescribeEventBus:
      name: X-Amz-Target
      in: header
      required: true
      schema:
        type: string
        enum:
        - AWSEvents.DescribeEventBus
    X-Amz-Target-CreateEventBus:
      name: X-Amz-Target
      in: header
      required: true
      schema:
        type: string
        enum:
        - AWSEvents.CreateEventBus
  securitySchemes:
    aws_sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication.
    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-refined-from:
- amazon-eventbridge-openapi.yml
- amazon-eventbridge-event-buses-api-openapi.yml