View a markdown version of this page

HTTP targets: API Gateway and API destinations - Amazon EventBridge
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

HTTP targets: API Gateway and API destinations

To call an HTTP endpoint, set TargetArn either to an API Gateway execute-api ARN, such as arn:aws:execute-api:us-east-1:111122223333:a1b2c3d4e5/prod/POST/orders, or to an EventBridge API destination ARN for any other HTTPS endpoint with its connection's credentials, and add HttpParameters. The request body is the transformed event.

Parameters

ParameterWhat it sets
PathParameterValuesValues for path variables in the endpoint, in order
HeaderParametersHTTP headers to add
QueryStringParametersQuery string parameters to add
InvocationTimeoutSecondsHow long EventBridge waits for the response, 1 to 30 seconds, default 30

Delivery role

For an API Gateway endpoint, the role needs execute-api:Invoke on the method's ARN. For an API destination, the role needs events:InvokeApiDestination on the API destination.

Batching and payload

One HTTP request carries the batch as a JSON array unless MaxBatchSize is 1. A response outside the 2xx range is a failed delivery. See Batching deliveries to a target.