class Amazonite::EventBridge::PutEventsResultEntry

Overview

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.

Included Modules

Defined in:

eventbridge/put_events_result_entry.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(event_id : String | Nil = nil, error_code : String | Nil = nil, error_message : String | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def error_code : String | Nil #

The error code that indicates why the event submission failed.

Retryable errors include:

  • [InternalFailure](https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html)

The request processing has failed because of an unknown error, exception or failure.

  • [ThrottlingException](https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html)

The request was denied due to request throttling.

Non-retryable errors include:

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.


[View source]
def error_code=(error_code : String | Nil) #

The error code that indicates why the event submission failed.

Retryable errors include:

  • [InternalFailure](https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html)

The request processing has failed because of an unknown error, exception or failure.

  • [ThrottlingException](https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html)

The request was denied due to request throttling.

Non-retryable errors include:

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.


[View source]
def error_message : String | Nil #

The error message that explains why the event submission failed.


[View source]
def error_message=(error_message : String | Nil) #

The error message that explains why the event submission failed.


[View source]
def event_id : String | Nil #

The ID of the event.


[View source]
def event_id=(event_id : String | Nil) #

The ID of the event.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def validate! : Nil #

[View source]