Amazon EventBridge

{'Entries': {'TraceHeader': 'string'}}

Sends custom events to Amazon EventBridge so that they can be matched to rules.

See also: AWS API Documentation

Request Syntax

client.put_events(
    Entries=[
        {
            'Time': datetime(2015, 1, 1),
            'Source': 'string',
            'Resources': [
                'string',
            ],
            'DetailType': 'string',
            'Detail': 'string',
            'EventBusName': 'string',
            'TraceHeader': 'string'
        },
    ]
)

type Entries

list

param Entries

[REQUIRED]

The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

• (dict) --

  Represents an event to be submitted.

  • Time (datetime) --

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

  • Source (string) --

    The source of the event.

  • Resources (list) --

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

    • (string) --

  • DetailType (string) --

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

  • Detail (string) --

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

  • EventBusName (string) --

    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.

  • TraceHeader (string) --

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

rtype

dict

returns

Response Syntax

{
    'FailedEntryCount': 123,
    'Entries': [
        {
            'EventId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • FailedEntryCount (integer) --

    The number of failed entries.

  • Entries (list) --

    The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

    • (dict) --

      Represents an event that failed to be submitted.

      • EventId (string) --

        The ID of the event.

      • ErrorCode (string) --

        The error code that indicates why the event submission failed.

      • ErrorMessage (string) --

        The error message that explains why the event submission failed.