Sends custom events to Amazon EventBridge so that they can be matched to rules.
The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the event and any necessary characters and keys of the JSON representation of the event. To learn more, see Calculating PutEvents event entry size in the Amazon EventBridge User Guide
PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807.
Note
PutEvents will only process nested JSON up to 1100 levels deep.
See also: AWS API Documentation
Request Syntax
response = client.put_events( Entries=[ { 'Time': datetime(2015, 1, 1), 'Source': 'string', 'Resources': [ 'string', ], 'DetailType': 'string', 'Detail': 'string', 'EventBusName': 'string', 'TraceHeader': 'string' }, ], EndpointId='string' )Parameters:
Entries (list) –
[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.
EndpointId (string) –
The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is
abcde.veo
.Warning
When using Java, you must include
auth-crt
on the class path.
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.
For each record, the index of the response element is the same as the index in the request array.
(dict) –
Represents the results of an event submitted to an event bus.
If the submission 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.
For information about the errors that are common to all actions, see Common Errors.
EventId (string) –
The ID of the event.
ErrorCode (string) –
The error code that indicates why the event submission failed.
Retryable errors include:
InternalFailure
The request processing has failed because of an unknown error, exception or failure.ThrottlingException
The request was denied due to request throttling.
Non-retryable errors include:
AccessDeniedException
You do not have sufficient access to perform this action.InvalidAccountIdException
The account ID provided is not valid.InvalidArgument
A specified parameter is not valid.MalformedDetail
The JSON provided is not valid.RedactionFailure
Redacting the CloudTrail event failed.NotAuthorizedForSourceException
You do not have permissions to publish events with this source onto this event bus.NotAuthorizedForDetailTypeException
You do not have permissions to publish events with this detail type onto this event bus.
ErrorMessage (string) –
The error message that explains why the event submission failed.
Exceptions
ncG1vNJzZmian6m8dHrAppizp56WxLR6wqikaK5hZLGwr9SmnKeskam2sLqOmqeiZ5yWwaa%2F02ipnp6Vp7Kvr8Roqp6qpp6wpr%2BOnq2epqSofKS4yJ6lrWegqsGgsdWepa2rXp3Brrg%3D