Enum DescribeDocumentError 

#[non_exhaustive]
pub enum DescribeDocumentError {
    InternalServerError(InternalServerError),
    InvalidDocument(InvalidDocument),
    InvalidDocumentVersion(InvalidDocumentVersion),
    Unhandled(Unhandled),
}

Error type for the DescribeDocumentError operation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InternalServerError(InternalServerError)

An error occurred on the server side.

InvalidDocument(InvalidDocument)

The specified SSM document doesn't exist.

InvalidDocumentVersion(InvalidDocumentVersion)

The document version isn't valid or doesn't exist.

Unhandled(Unhandled)

👎Deprecated: Matching Unhandled directly is not forwards compatible. Instead, match using a variable wildcard pattern and check .code():    err if err.code() == Some("SpecificExceptionCode") => { /* handle the error */ } See ProvideErrorMetadata for what information is available for the error.

An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).

Implementations

impl DescribeDocumentError

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

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

pub fn generic(err: ErrorMetadata) -> Self

Creates the DescribeDocumentError::Unhandled variant from an ErrorMetadata.

pub fn meta(&self) -> &ErrorMetadata

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

pub fn is_internal_server_error(&self) -> bool

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

pub fn is_invalid_document(&self) -> bool

Returns true if the error kind is DescribeDocumentError::InvalidDocument.

pub fn is_invalid_document_version(&self) -> bool

Returns true if the error kind is DescribeDocumentError::InvalidDocumentVersion.

Trait Implementations

impl CreateUnhandledError for DescribeDocumentError

fn create_unhandled_error( source: Box<dyn Error + Send + Sync + 'static>, meta: Option<ErrorMetadata>, ) -> Self

Creates an unhandled error variant with the given source and error metadata.

impl Debug for DescribeDocumentError

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

Formats the value using the given formatter.

impl Display for DescribeDocumentError

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

Formats the value using the given formatter.

impl Error for DescribeDocumentError

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

Returns the lower-level source of this error, if any.

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

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<DescribeDocumentError> for Error

fn from(err: DescribeDocumentError) -> Self

Converts to this type from the input type.

impl ProvideErrorKind for DescribeDocumentError

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

impl ProvideErrorMetadata for DescribeDocumentError

fn meta(&self) -> &ErrorMetadata

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

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

Returns the error code if it’s available.

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

Returns the error message, if there is one.

impl RequestId for DescribeDocumentError

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

Returns the request ID, or None if the service could not be reached.