Skip to content

PutEventsRequestEntry

Source code in docs_src/capo_cloudwatch_events/types/put_events_request_entry.py
class PutEventsRequestEntry(TypedDict, closed=True):
    time: NotRequired["capo_cloudwatch_events.types.event_time.EventTime"]
    """<p>The time stamp of the event, per <a href="https://www.rfc-editor.org/rfc/rfc3339.txt">RFC3339</a>. If no time stamp is provided, the time stamp of the <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html">PutEvents</a> call is used.</p>"""
    source: NotRequired["capo_cloudwatch_events.types.string.String"]
    """<p>The source of the event.</p>"""
    resources: NotRequired[
        "capo_cloudwatch_events.types.event_resource_list.EventResourceList"
    ]
    """<p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.</p>"""
    detail_type: NotRequired["capo_cloudwatch_events.types.string.String"]
    """<p>Free-form string used to decide what fields to expect in the event detail.</p>"""
    detail: NotRequired["capo_cloudwatch_events.types.string.String"]
    """<p>A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.</p>"""
    event_bus_name: NotRequired[
        "capo_cloudwatch_events.types.non_partner_event_bus_name_or_arn.NonPartnerEventBusNameOrArn"
    ]
    """<p>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.</p>"""
    trace_header: NotRequired["capo_cloudwatch_events.types.trace_header.TraceHeader"]
    """<p>An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.</p> <p>To learn more about X-Ray trace headers, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader">Tracing header</a> in the X-Ray Developer Guide.</p>"""

detail instance-attribute

detail: NotRequired[String]

A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.

detail_type instance-attribute

detail_type: NotRequired[String]

Free-form string used to decide what fields to expect in the event detail.

event_bus_name instance-attribute

event_bus_name: NotRequired[NonPartnerEventBusNameOrArn]

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.

resources instance-attribute

resources: NotRequired[EventResourceList]

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

source instance-attribute

source: NotRequired[String]

The source of the event.

time instance-attribute

time: NotRequired[EventTime]

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

trace_header instance-attribute

trace_header: NotRequired[TraceHeader]

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