Skip to content

/AWS1/CL_EVBPUTEVENTSREQENTRY

Represents an event to be submitted.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_TIME TYPE /AWS1/EVBEVENTTIME /AWS1/EVBEVENTTIME

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

IV_SOURCE TYPE /AWS1/EVBSTRING /AWS1/EVBSTRING

The source of the event.

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.

IT_RESOURCES TYPE /AWS1/CL_EVBEVENTRESRCLIST_W=>TT_EVENTRESOURCELIST TT_EVENTRESOURCELIST

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

IV_DETAILTYPE TYPE /AWS1/EVBSTRING /AWS1/EVBSTRING

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

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.

IV_DETAIL TYPE /AWS1/EVBSTRING /AWS1/EVBSTRING

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

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.

IV_EVENTBUSNAME TYPE /AWS1/EVBNONPTREBUSNAMEORARN /AWS1/EVBNONPTREBUSNAMEORARN

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.

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.

IV_TRACEHEADER TYPE /AWS1/EVBTRACEHEADER /AWS1/EVBTRACEHEADER

An 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 X-Ray Developer Guide.


Queryable Attributes

Time

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

Accessible with the following methods

Method Description
GET_TIME() Getter for TIME, with configurable default
ASK_TIME() Getter for TIME w/ exceptions if field has no value
HAS_TIME() Determine if TIME has a value

Source

The source of the event.

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.

Accessible with the following methods

Method Description
GET_SOURCE() Getter for SOURCE, with configurable default
ASK_SOURCE() Getter for SOURCE w/ exceptions if field has no value
HAS_SOURCE() Determine if SOURCE has a value

Resources

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

Accessible with the following methods

Method Description
GET_RESOURCES() Getter for RESOURCES, with configurable default
ASK_RESOURCES() Getter for RESOURCES w/ exceptions if field has no value
HAS_RESOURCES() Determine if RESOURCES has a value

DetailType

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

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.

Accessible with the following methods

Method Description
GET_DETAILTYPE() Getter for DETAILTYPE, with configurable default
ASK_DETAILTYPE() Getter for DETAILTYPE w/ exceptions if field has no value
HAS_DETAILTYPE() Determine if DETAILTYPE has a value

Detail

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

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.

Accessible with the following methods

Method Description
GET_DETAIL() Getter for DETAIL, with configurable default
ASK_DETAIL() Getter for DETAIL w/ exceptions if field has no value
HAS_DETAIL() Determine if DETAIL has a value

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.

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.

Accessible with the following methods

Method Description
GET_EVENTBUSNAME() Getter for EVENTBUSNAME, with configurable default
ASK_EVENTBUSNAME() Getter for EVENTBUSNAME w/ exceptions if field has no value
HAS_EVENTBUSNAME() Determine if EVENTBUSNAME has a value

TraceHeader

An 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 X-Ray Developer Guide.

Accessible with the following methods

Method Description
GET_TRACEHEADER() Getter for TRACEHEADER, with configurable default
ASK_TRACEHEADER() Getter for TRACEHEADER w/ exceptions if field has no value
HAS_TRACEHEADER() Determine if TRACEHEADER has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_PUTEVENTSREQUESTENTRYLIST

TYPES TT_PUTEVENTSREQUESTENTRYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_EVBPUTEVENTSREQENTRY WITH DEFAULT KEY
.