Struct aws_sdk_textract::error::StartDocumentAnalysisError

#[non_exhaustive]
pub struct StartDocumentAnalysisError {
    pub kind: StartDocumentAnalysisErrorKind,
    // some fields omitted
}

Error type for the StartDocumentAnalysis operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: StartDocumentAnalysisErrorKind

Kind of error that occurred.

Implementations

impl StartDocumentAnalysisError

pub fn new(kind: StartDocumentAnalysisErrorKind, meta: Error) -> Self

Creates a new StartDocumentAnalysisError.

pub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self

Creates the StartDocumentAnalysisError::Unhandled variant from any error type.

pub fn generic(err: Error) -> Self

Creates the StartDocumentAnalysisError::Unhandled variant from a aws_smithy_types::Error.

pub fn message(&self) -> Option<&str>

Returns the error message if one is available.

pub fn meta(&self) -> &Error

Returns error metadata, which includes the error code, message, request ID, and potentially additional information.

pub fn request_id(&self) -> Option<&str>

Returns the request ID if it’s available.

pub fn code(&self) -> Option<&str>

Returns the error code if it’s available.

pub fn is_access_denied_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::AccessDeniedException.

pub fn is_bad_document_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::BadDocumentException.

pub fn is_document_too_large_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::DocumentTooLargeException.

pub fn is_idempotent_parameter_mismatch_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::IdempotentParameterMismatchException.

pub fn is_internal_server_error(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::InternalServerError.

pub fn is_invalid_kms_key_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::InvalidKmsKeyException.

pub fn is_invalid_parameter_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::InvalidParameterException.

pub fn is_invalid_s3_object_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::InvalidS3ObjectException.

pub fn is_limit_exceeded_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::LimitExceededException.

pub fn is_provisioned_throughput_exceeded_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::ProvisionedThroughputExceededException.

pub fn is_throttling_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::ThrottlingException.

pub fn is_unsupported_document_exception(&self) -> bool

Returns true if the error kind is StartDocumentAnalysisErrorKind::UnsupportedDocumentException.

Trait Implementations

impl Debug for StartDocumentAnalysisError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for StartDocumentAnalysisError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for StartDocumentAnalysisError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl ProvideErrorKind for StartDocumentAnalysisError

fn code(&self) -> Option<&str>

Returns the code for this error if one exists

fn retryable_error_kind(&self) -> Option<ErrorKind>

Returns the ErrorKind when the error is modeled as retryable