Skip to main content

ISQSBatchResultErrorEntry

Interface in AWS.SQS

Interface for batch result error entries.

Properties

Code

property Code: string

An error code representing why the action failed on this entry.

Common error codes include:

  • InvalidBatchEntryId – The entry ID doesn't meet specification requirements
  • MessageNotInflight – The message is not currently in flight
  • ReceiptHandleIsInvalid – The receipt handle is malformed or expired
  • InvalidParameterValue – One or more parameters contain invalid values

Id

property Id: string

The identifier of an entry in the batch request that failed.

This corresponds to the Id field specified in the original batch request entry that encountered an error during processing. Use this identifier to correlate failed entries with the original request entries.

Message

property Message: string

A human-readable message explaining why the action failed on this entry.

This field provides additional context beyond the error code to help diagnose the specific cause of the failure. The message may be empty for some error conditions where the error code provides sufficient information.

SenderFault

property SenderFault: Boolean

Specifies whether the error happened due to the caller of the batch API action.

When True, indicates the error was caused by invalid input from the client (sender fault). When False, indicates the error was due to a service-side issue. Sender faults typically include invalid parameters, malformed data, or exceeded quotas. Service faults may include temporary unavailability or internal processing errors.