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.

For information on calculating event batch size, see Calculating EventBridge PutEvents event entry size in the EventBridge User Guide.

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.
  
  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.
- 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.
  
  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.
- Detail (string) –
  
  A valid JSON string. There is no other schema imposed. The JSON string 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.

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 results for each event entry the partner submitted in this request. If the event was successfully submitted, 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.
  
  For each record, the index of the response element is the same as the index in the request array.
  - (dict) –
    
    The result of an event entry the partner submitted in this request. If the event was successfully submitted, 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.
    - 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