error.d.ts 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. /**
  2. * A structure containing information about a service or networking error.
  3. */
  4. export type AWSError = Error & {
  5. /**
  6. * A unique short code representing the error that was emitted.
  7. */
  8. code: string;
  9. /**
  10. * A longer human readable error message.
  11. */
  12. message: string;
  13. /**
  14. * Whether the error message is retryable.
  15. */
  16. retryable?: boolean;
  17. /**
  18. * In the case of a request that reached the service, this value contains the response status code.
  19. */
  20. statusCode?: number;
  21. /**
  22. * The date time object when the error occurred.
  23. */
  24. time: Date;
  25. /**
  26. * Set when a networking error occurs to easily identify the endpoint of the request.
  27. */
  28. hostname?: string;
  29. /**
  30. * Set when a networking error occurs to easily identify the region of the request.
  31. */
  32. region?: string;
  33. /**
  34. * Amount of time (in seconds) that the request waited before being resent.
  35. */
  36. retryDelay?: number;
  37. /**
  38. * The unique request ID associated with the response.
  39. */
  40. requestId?: string;
  41. /**
  42. * Second request ID associated with the response from S3.
  43. */
  44. extendedRequestId?: string;
  45. /**
  46. * CloudFront request ID associated with the response.
  47. */
  48. cfId?: string;
  49. /**
  50. * The original error which caused this Error
  51. */
  52. originalError?: Error
  53. }