Amazon EventBridge
API Reference (API Version 2015-10-07)

PutPartnerEvents

This is used by SaaS partners to write events to a customer's partner event bus.

Note

AWS customers do not use this operation. Instead, AWS customers can use PutEvents to write custom events from their own applications to an event bus.

Request Syntax

{ "Entries": [ { "Detail": "string", "DetailType": "string", "Resources": [ "string" ], "Source": "string", "Time": number } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Entries

The list of events to write to the event bus.

Type: Array of PutPartnerEventsRequestEntry objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: Yes

Response Syntax

{ "Entries": [ { "ErrorCode": "string", "ErrorMessage": "string", "EventId": "string" } ], "FailedEntryCount": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Entries

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

Type: Array of PutPartnerEventsResultEntry objects

FailedEntryCount

The number of events from this operation that couldn't be written to the partner event bus.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

Example

Puts two events to a customer's event bus.

The following is an example of a PutPartnerEvents request and response.

Sample Request

POST / HTTP/1.1 Host: events.<region>.<domain> x-amz-Date: <Date> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature> User-Agent: <UserAgentString> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Connection: Keep-Alive X-Amz-Target: AWSEvents.PutPartnerEvents { "Entries": [ { "Source":"aws.partner/examplecompany.com/123456/tickets", "Detail":"{ \"key1\": \"value1\", \"key2\": \"value2\" }", "Resources":[ "resource1", "resource2" ], "DetailType":"myDetailType" }, { "Source":"aws.partner/examplecompany.com/123456/tickets", "Detail":"{ \"key1\": \"value1\", \"key2\": \"value2\" }", "Resources":[ "resource1", "resource2" ], "DetailType":"myDetailType" } ] }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "FailedEntryCount": 0, "Entries": [ { "EventId": "11710aed-b79e-4468-a20b-bb3c0c3b4860" }, { "EventId": "d804d26a-88db-4b66-9eaf-9a11c708ae82" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: