PutEventsRequestEntry - Amazon EventBridge
ContentsSee Also

PutEventsRequestEntry

Represents an event to be submitted.

Contents

Detail

A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.

Note

Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

Type: String

Required: No

DetailType

Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

Note

Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

Type: String

Required: No

EventBusName

The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.

Note

If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the other Region based on the endpoint referenced by the EndpointId. Specifying the event bus ARN is preferred.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: (arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[\.\-_A-Za-z0-9]+

Required: No

Resources

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

Type: Array of strings

Length Constraints: Maximum length of 2048.

Required: No

Source

The source of the event.

Note

Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

Type: String

Required: No

Time

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

Type: Timestamp

Required: No

TraceHeader

An AWS X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.

To learn more about X-Ray trace headers, see Tracing header in the AWS X-Ray Developer Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: