Amazon EventBridge Eventbridge Connection API
The Eventbridge Connection API from Amazon EventBridge — 5 operation(s) for eventbridge connection.
The Eventbridge Connection API from Amazon EventBridge — 5 operation(s) for eventbridge connection.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-eventbridge:amazon-eventbridge-connection-api"
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.
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: 3.2.0
info:
title: Amazon EventBridge Connection API
version: '2015-10-07'
description: Generated from AWS's published Smithy model for Amazon EventBridge. 5 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: Connection
paths:
/#CreateConnection:
post:
operationId: CreateConnection
summary: Create Connection
description: Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint. For more information, see Connections for endpoint targets in the Amazon EventBridge User Guide.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateConnectionResponse'
'400':
description: AccessDeniedException; LimitExceededException; ResourceAlreadyExistsException; ResourceNotFoundException; ThrottlingException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'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.CreateConnection
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateConnectionRequest'
tags:
- Connection
/#DeleteConnection:
post:
operationId: DeleteConnection
summary: Delete Connection
description: Deletes a connection.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteConnectionResponse'
'400':
description: ConcurrentModificationException; 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.DeleteConnection
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteConnectionRequest'
tags:
- Connection
/#DescribeConnection:
post:
operationId: DescribeConnection
summary: Describe Connection
description: Retrieves details about a connection.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeConnectionResponse'
'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.DescribeConnection
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeConnectionRequest'
tags:
- Connection
/#ListConnections:
post:
operationId: ListConnections
summary: List Connections
description: Retrieves a list of connections from the account.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListConnectionsResponse'
'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.ListConnections
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListConnectionsRequest'
tags:
- Connection
/#UpdateConnection:
post:
operationId: UpdateConnection
summary: Update Connection
description: Updates settings for a connection.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateConnectionResponse'
'400':
description: AccessDeniedException; ConcurrentModificationException; LimitExceededException; ResourceNotFoundException; ThrottlingException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'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.UpdateConnection
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateConnectionRequest'
tags:
- Connection
components:
schemas:
CreateConnectionRequest:
type: object
properties:
Name:
type: string
description: The name for the connection to create.
Description:
type: string
description: A description for the connection to create.
AuthorizationType:
type: string
enum:
- BASIC
- OAUTH_CLIENT_CREDENTIALS
- API_KEY
description: The type of authorization to use for the connection. OAUTH tokens are refreshed when a 401 or 407 response is returned.
AuthParameters:
$ref: '#/components/schemas/CreateConnectionAuthRequestParameters'
InvocationConnectivityParameters:
$ref: '#/components/schemas/ConnectivityResourceParameters'
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 this connection. 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 the connection. For more information, see Identify and view keys in the Key Management Service Developer Guide.
required:
- Name
- AuthorizationType
- AuthParameters
DescribeConnectionRequest:
type: object
properties:
Name:
type: string
description: The name of the connection to retrieve.
required:
- Name
DeleteConnectionRequest:
type: object
properties:
Name:
type: string
description: The name of the connection to delete.
required:
- Name
ConnectionAuthResponseParameters:
type: object
properties:
BasicAuthParameters:
$ref: '#/components/schemas/ConnectionBasicAuthResponseParameters'
OAuthParameters:
$ref: '#/components/schemas/ConnectionOAuthResponseParameters'
ApiKeyAuthParameters:
$ref: '#/components/schemas/ConnectionApiKeyAuthResponseParameters'
InvocationHttpParameters:
$ref: '#/components/schemas/ConnectionHttpParameters'
ConnectivityParameters:
$ref: '#/components/schemas/DescribeConnectionConnectivityParameters'
UpdateConnectionOAuthRequestParameters:
type: object
properties:
ClientParameters:
$ref: '#/components/schemas/UpdateConnectionOAuthClientRequestParameters'
AuthorizationEndpoint:
type: string
description: The URL to the authorization endpoint when OAuth is specified as the authorization type.
HttpMethod:
type: string
enum:
- GET
- POST
- PUT
description: The method used to connect to the HTTP endpoint.
OAuthHttpParameters:
$ref: '#/components/schemas/ConnectionHttpParameters'
DescribeConnectionResourceParameters:
type: object
properties:
ResourceConfigurationArn:
type: string
description: The Amazon Resource Name (ARN) of the resource configuration for the private API.
ResourceAssociationArn:
type: string
description: For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. For more information, see Managing service network resource associations for connections in the Amazon EventBridge User Guide .
required:
- ResourceConfigurationArn
- ResourceAssociationArn
ListConnectionsResponse:
type: object
properties:
Connections:
type: array
items:
$ref: '#/components/schemas/Connection'
description: An array of connections objects that include details about the connections.
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.
UpdateConnectionApiKeyAuthRequestParameters:
type: object
properties:
ApiKeyName:
type: string
description: The name of the API key to use for authorization.
ApiKeyValue:
type: string
description: The value associated with the API key to use for authorization.
CreateConnectionAuthRequestParameters:
type: object
properties:
BasicAuthParameters:
$ref: '#/components/schemas/CreateConnectionBasicAuthRequestParameters'
OAuthParameters:
$ref: '#/components/schemas/CreateConnectionOAuthRequestParameters'
ApiKeyAuthParameters:
$ref: '#/components/schemas/CreateConnectionApiKeyAuthRequestParameters'
InvocationHttpParameters:
$ref: '#/components/schemas/ConnectionHttpParameters'
ConnectivityParameters:
$ref: '#/components/schemas/ConnectivityResourceParameters'
ListConnectionsRequest:
type: object
properties:
NamePrefix:
type: string
description: A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.
ConnectionState:
type: string
enum:
- CREATING
- UPDATING
- DELETING
- AUTHORIZED
- DEAUTHORIZED
- AUTHORIZING
- DEAUTHORIZING
- ACTIVE
- FAILED_CONNECTIVITY
description: The state of the connection.
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 connections to return.
UpdateConnectionResponse:
type: object
properties:
ConnectionArn:
type: string
description: The ARN of the connection that was updated.
ConnectionState:
type: string
enum:
- CREATING
- UPDATING
- DELETING
- AUTHORIZED
- DEAUTHORIZED
- AUTHORIZING
- DEAUTHORIZING
- ACTIVE
- FAILED_CONNECTIVITY
description: The state of the connection that was updated.
CreationTime:
type: string
format: date-time
description: A time stamp for the time that the connection was created.
LastModifiedTime:
type: string
format: date-time
description: A time stamp for the time that the connection was last modified.
LastAuthorizedTime:
type: string
format: date-time
description: A time stamp for the time that the connection was last authorized.
CreateConnectionApiKeyAuthRequestParameters:
type: object
properties:
ApiKeyName:
type: string
description: The name of the API key to use for authorization.
ApiKeyValue:
type: string
description: The value for the API key to use for authorization.
required:
- ApiKeyName
- ApiKeyValue
UpdateConnectionAuthRequestParameters:
type: object
properties:
BasicAuthParameters:
$ref: '#/components/schemas/UpdateConnectionBasicAuthRequestParameters'
OAuthParameters:
$ref: '#/components/schemas/UpdateConnectionOAuthRequestParameters'
ApiKeyAuthParameters:
$ref: '#/components/schemas/UpdateConnectionApiKeyAuthRequestParameters'
InvocationHttpParameters:
$ref: '#/components/schemas/ConnectionHttpParameters'
ConnectivityParameters:
$ref: '#/components/schemas/ConnectivityResourceParameters'
ConnectionOAuthResponseParameters:
type: object
properties:
ClientParameters:
$ref: '#/components/schemas/ConnectionOAuthClientResponseParameters'
AuthorizationEndpoint:
type: string
description: The URL to the HTTP endpoint that authorized the request.
HttpMethod:
type: string
enum:
- GET
- POST
- PUT
description: The method used to connect to the HTTP endpoint.
OAuthHttpParameters:
$ref: '#/components/schemas/ConnectionHttpParameters'
ConnectionQueryStringParameter:
type: object
properties:
Key:
type: string
description: The key for a query string parameter.
Value:
type: string
description: The value associated with the key for the query string parameter.
IsValueSecret:
type: boolean
description: Specifies whether the value is secret.
ConnectionBasicAuthResponseParameters:
type: object
properties:
Username:
type: string
description: The user name to use for Basic authorization.
CreateConnectionOAuthRequestParameters:
type: object
properties:
ClientParameters:
$ref: '#/components/schemas/CreateConnectionOAuthClientRequestParameters'
AuthorizationEndpoint:
type: string
description: The URL to the authorization endpoint when OAuth is specified as the authorization type.
HttpMethod:
type: string
enum:
- GET
- POST
- PUT
description: The method to use for the authorization request.
OAuthHttpParameters:
$ref: '#/components/schemas/ConnectionHttpParameters'
required:
- ClientParameters
- AuthorizationEndpoint
- HttpMethod
ConnectionApiKeyAuthResponseParameters:
type: object
properties:
ApiKeyName:
type: string
description: The name of the header to use for the APIKeyValue used for authorization.
ResourceNotFoundException:
type: object
properties:
message:
type: string
ConnectivityResourceConfigurationArn:
type: object
properties:
ResourceConfigurationArn:
type: string
description: The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.
required:
- ResourceConfigurationArn
ConcurrentModificationException:
type: object
properties:
message:
type: string
ConnectionBodyParameter:
type: object
properties:
Key:
type: string
description: The key for the parameter.
Value:
type: string
description: The value associated with the key.
IsValueSecret:
type: boolean
description: Specifies whether the value is secret.
CreateConnectionBasicAuthRequestParameters:
type: object
properties:
Username:
type: string
description: The user name to use for Basic authorization.
Password:
type: string
description: The password associated with the user name to use for Basic authorization.
required:
- Username
- Password
Connection:
type: object
properties:
ConnectionArn:
type: string
description: The ARN of the connection.
Name:
type: string
description: The name of the connection.
ConnectionState:
type: string
enum:
- CREATING
- UPDATING
- DELETING
- AUTHORIZED
- DEAUTHORIZED
- AUTHORIZING
- DEAUTHORIZING
- ACTIVE
- FAILED_CONNECTIVITY
description: The state of the connection.
StateReason:
type: string
description: The reason that the connection is in the connection state.
AuthorizationType:
type: string
enum:
- BASIC
- OAUTH_CLIENT_CREDENTIALS
- API_KEY
description: The authorization type specified for the connection. OAUTH tokens are refreshed when a 401 or 407 response is returned.
CreationTime:
type: string
format: date-time
description: A time stamp for the time that the connection was created.
LastModifiedTime:
type: string
format: date-time
description: A time stamp for the time that the connection was last modified.
LastAuthorizedTime:
type: string
format: date-time
description: A time stamp for the time that the connection was last authorized.
DescribeConnectionConnectivityParameters:
type: object
properties:
ResourceParameters:
$ref: '#/components/schemas/DescribeConnectionResourceParameters'
required:
- ResourceParameters
DescribeConnectionResponse:
type: object
properties:
ConnectionArn:
type: string
description: The ARN of the connection retrieved.
Name:
type: string
description: The name of the connection retrieved.
Description:
type: string
description: The description for the connection retrieved.
InvocationConnectivityParameters:
$ref: '#/components/schemas/DescribeConnectionConnectivityParameters'
ConnectionState:
type: string
enum:
- CREATING
- UPDATING
- DELETING
- AUTHORIZED
- DEAUTHORIZED
- AUTHORIZING
- DEAUTHORIZING
- ACTIVE
- FAILED_CONNECTIVITY
description: The state of the connection retrieved.
StateReason:
type: string
description: The reason that the connection is in the current connection state.
AuthorizationType:
type: string
enum:
- BASIC
- OAUTH_CLIENT_CREDENTIALS
- API_KEY
description: The type of authorization specified for the connection.
SecretArn:
type: string
description: The ARN of the secret created from the authorization parameters specified for the connection.
KmsKeyIdentifier:
type: string
description: The identifier of the KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified. For more information, see Encrypting connections in the Amazon EventBridge User Guide.
AuthParameters:
$ref: '#/components/schemas/ConnectionAuthResponseParameters'
CreationTime:
type: string
format: date-time
description: A time stamp for the time that the connection was created.
LastModifiedTime:
type: string
format: date-time
description: A time stamp for the time that the connection was last modified.
LastAuthorizedTime:
type: string
format: date-time
description: A time stamp for the time that the connection was last authorized.
CreateConnectionResponse:
type: object
properties:
ConnectionArn:
type: string
description: The ARN of the connection that was created by the request.
ConnectionState:
type: string
enum:
- CREATING
- UPDATING
- DELETING
- AUTHORIZED
- DEAUTHORIZED
- AUTHORIZING
- DEAUTHORIZING
- ACTIVE
- FAILED_CONNECTIVITY
description: The state of the connection that was created by the request.
CreationTime:
type: string
format: date-time
description: A time stamp for the time that the connection was created.
LastModifiedTime:
type: string
format: date-time
description: A time stamp for the time that the connection was last updated.
ConnectivityResourceParameters:
type: object
properties:
ResourceParameters:
$ref: '#/components/schemas/ConnectivityResourceConfigurationArn'
required:
- ResourceParameters
ConnectionHttpParameters:
type: object
properties:
HeaderParameters:
type: array
items:
$ref: '#/components/schemas/ConnectionHeaderParameter'
description: Any additional header parameters for the connection.
QueryStringParameters:
type: array
items:
$ref: '#/components/schemas/ConnectionQueryStringParameter'
description: Any additional query string parameters for the connection.
BodyParameters:
type: array
items:
$ref: '#/components/schemas/ConnectionBodyParameter'
description: Any additional body string parameters for the connection.
UpdateConnectionRequest:
type: object
properties:
Name:
type: string
description: The name of the connection to update.
Description:
type: string
description: A description for the connection.
AuthorizationType:
type: string
enum:
- BASIC
- OAUTH_CLIENT_CREDENTIALS
- API_KEY
description: The type of authorization to use for the connection.
AuthParameters:
$ref: '#/components/schemas/UpdateConnectionAuthRequestParameters'
InvocationConnectivityParameters:
$ref: '#/components/schemas/ConnectivityResourceParameters'
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 this connection. 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 the connection. For more information, see Identify and view keys in the Key Management Service Developer Guide.
required:
- Name
UpdateConnectionOAuthClientRequestParameters:
type: object
properties:
ClientID:
type: string
description: The client ID to use for OAuth authorization.
ClientSecret:
type: string
description: The client secret assciated with the client ID to use for OAuth authorization.
ConnectionOAuthClientResponseParameters:
type: object
properties:
ClientID:
type: string
description: The client ID associated with the response to the connection request.
AccessDeniedException:
type: object
properties:
message:
type: string
InternalException:
type: object
properties:
message:
type: string
DeleteConnectionResponse:
type: object
properties:
ConnectionArn:
type: string
description: The ARN of the connection that was deleted.
ConnectionState:
type: string
enum:
- CREATING
- UPDATING
- DELETING
- AUTHORIZED
- DEAUTHORIZED
- AUTHORIZING
- DEAUTHORIZING
- ACTIVE
- FAILED_CONNECTIVITY
description: The state of the connection before it was deleted.
CreationTime:
type: string
format: date-time
description: A time stamp for the time that the connection was created.
LastModifiedTime:
type: string
format: date-time
description: A time stamp for the time that the connection was last modified before it was deleted.
LastAuthorizedTime:
type: string
format: date-time
description: A time stamp for the time that the connection was last authorized before it wa deleted.
UpdateConnectionBasicAuthRequestParameters:
type: object
properties:
Username:
type: string
description: The user name to use for Basic authorization.
Password:
type: string
description: The password associated with the user name to use for Basic authorization.
ConnectionHeaderParameter:
type: object
properties:
Key:
type: string
description: The key for the parameter.
Value:
type: string
description: The value associated with the key.
IsValueSecret:
type: boolean
description: Specifies whether the value is a secret.
CreateConnectionOAuthClientRequestParameters:
type: object
properties:
ClientID:
type: string
description: The client ID to use for OAuth authorization for the connection.
ClientSecret:
type: string
description: The client secret associated with the client ID to use for OAuth authorization for the connection.
required:
- ClientID
- ClientSecret
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)