EventBridge / Client / put_partner_events

put_partner_events#

EventBridge.Client.put_partner_events(**kwargs)#

This is used by SaaS partners to write events to a customer’s partner event bus. Amazon Web Services customers do not use this operation.

See also: AWS API Documentation

Request Syntax

response = client.put_partner_events(
    Entries=[
        {
            'Time': datetime(2015, 1, 1),
            'Source': 'string',
            'Resources': [
                'string',
            ],
            'DetailType': 'string',
            'Detail': 'string'
        },
    ]
)
Parameters:

Entries (list) –

[REQUIRED]

The list of events to write to the event bus.

  • (dict) –

    The details about an event generated by an SaaS partner.

    • Time (datetime) –

      The date and time of the event.

    • Source (string) –

      The event source that is generating the entry.

    • Resources (list) –

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

      • (string) –

    • DetailType (string) –

      A free-form string, with a maximum of 128 characters, 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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • FailedEntryCount (integer) –

      The number of events from this operation that could not be written to the partner event bus.

    • Entries (list) –

      The list of events from this operation that were successfully written to the partner event bus.

      • (dict) –

        Represents an event that a partner tried to generate, but failed.

        • 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.

Exceptions

  • EventBridge.Client.exceptions.InternalException

  • EventBridge.Client.exceptions.OperationDisabledException