Class: Aws::EventBridge::Types::PutEventsResultEntry

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eventbridge/types.rb

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

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#error_codeString

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.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
# File 'lib/aws-sdk-eventbridge/types.rb', line 3641

class PutEventsResultEntry < Struct.new(
  :event_id,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

The error message that explains why the event submission failed.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
# File 'lib/aws-sdk-eventbridge/types.rb', line 3641

class PutEventsResultEntry < Struct.new(
  :event_id,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#event_idString

The ID of the event.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
# File 'lib/aws-sdk-eventbridge/types.rb', line 3641

class PutEventsResultEntry < Struct.new(
  :event_id,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end