Struct aws_sdk_ssm::error::DescribeDocumentError

#[non_exhaustive]
pub struct DescribeDocumentError {
    pub kind: DescribeDocumentErrorKind,
    /* private fields */
}

Error type for the DescribeDocument 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: DescribeDocumentErrorKind

Kind of error that occurred.

Implementations

impl DescribeDocumentError

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

Creates a new DescribeDocumentError.

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

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

Examples found in repository

src/operation_deser.rs (line 3571)

pub fn parse_describe_document_error(
    response: &http::Response<bytes::Bytes>,
) -> std::result::Result<crate::output::DescribeDocumentOutput, crate::error::DescribeDocumentError>
{
    let generic = crate::json_deser::parse_http_generic_error(response)
        .map_err(crate::error::DescribeDocumentError::unhandled)?;
    let error_code = match generic.code() {
        Some(code) => code,
        None => return Err(crate::error::DescribeDocumentError::unhandled(generic)),
    };

    let _error_message = generic.message().map(|msg| msg.to_owned());
    Err(match error_code {
        "InternalServerError" => crate::error::DescribeDocumentError {
            meta: generic,
            kind: crate::error::DescribeDocumentErrorKind::InternalServerError({
                #[allow(unused_mut)]
                let mut tmp = {
                    #[allow(unused_mut)]
                    let mut output = crate::error::internal_server_error::Builder::default();
                    let _ = response;
                    output = crate::json_deser::deser_structure_crate_error_internal_server_error_json_err(response.body().as_ref(), output).map_err(crate::error::DescribeDocumentError::unhandled)?;
                    output.build()
                };
                if tmp.message.is_none() {
                    tmp.message = _error_message;
                }
                tmp
            }),
        },
        "InvalidDocument" => {
            crate::error::DescribeDocumentError {
                meta: generic,
                kind: crate::error::DescribeDocumentErrorKind::InvalidDocument({
                    #[allow(unused_mut)]
                    let mut tmp = {
                        #[allow(unused_mut)]
                        let mut output = crate::error::invalid_document::Builder::default();
                        let _ = response;
                        output = crate::json_deser::deser_structure_crate_error_invalid_document_json_err(response.body().as_ref(), output).map_err(crate::error::DescribeDocumentError::unhandled)?;
                        output.build()
                    };
                    if tmp.message.is_none() {
                        tmp.message = _error_message;
                    }
                    tmp
                }),
            }
        }
        "InvalidDocumentVersion" => crate::error::DescribeDocumentError {
            meta: generic,
            kind: crate::error::DescribeDocumentErrorKind::InvalidDocumentVersion({
                #[allow(unused_mut)]
                let mut tmp = {
                    #[allow(unused_mut)]
                    let mut output = crate::error::invalid_document_version::Builder::default();
                    let _ = response;
                    output = crate::json_deser::deser_structure_crate_error_invalid_document_version_json_err(response.body().as_ref(), output).map_err(crate::error::DescribeDocumentError::unhandled)?;
                    output.build()
                };
                if tmp.message.is_none() {
                    tmp.message = _error_message;
                }
                tmp
            }),
        },
        _ => crate::error::DescribeDocumentError::generic(generic),
    })
}

pub fn generic(err: Error) -> Self

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

Examples found in repository

src/operation_deser.rs (line 3629)

pub fn parse_describe_document_error(
    response: &http::Response<bytes::Bytes>,
) -> std::result::Result<crate::output::DescribeDocumentOutput, crate::error::DescribeDocumentError>
{
    let generic = crate::json_deser::parse_http_generic_error(response)
        .map_err(crate::error::DescribeDocumentError::unhandled)?;
    let error_code = match generic.code() {
        Some(code) => code,
        None => return Err(crate::error::DescribeDocumentError::unhandled(generic)),
    };

    let _error_message = generic.message().map(|msg| msg.to_owned());
    Err(match error_code {
        "InternalServerError" => crate::error::DescribeDocumentError {
            meta: generic,
            kind: crate::error::DescribeDocumentErrorKind::InternalServerError({
                #[allow(unused_mut)]
                let mut tmp = {
                    #[allow(unused_mut)]
                    let mut output = crate::error::internal_server_error::Builder::default();
                    let _ = response;
                    output = crate::json_deser::deser_structure_crate_error_internal_server_error_json_err(response.body().as_ref(), output).map_err(crate::error::DescribeDocumentError::unhandled)?;
                    output.build()
                };
                if tmp.message.is_none() {
                    tmp.message = _error_message;
                }
                tmp
            }),
        },
        "InvalidDocument" => {
            crate::error::DescribeDocumentError {
                meta: generic,
                kind: crate::error::DescribeDocumentErrorKind::InvalidDocument({
                    #[allow(unused_mut)]
                    let mut tmp = {
                        #[allow(unused_mut)]
                        let mut output = crate::error::invalid_document::Builder::default();
                        let _ = response;
                        output = crate::json_deser::deser_structure_crate_error_invalid_document_json_err(response.body().as_ref(), output).map_err(crate::error::DescribeDocumentError::unhandled)?;
                        output.build()
                    };
                    if tmp.message.is_none() {
                        tmp.message = _error_message;
                    }
                    tmp
                }),
            }
        }
        "InvalidDocumentVersion" => crate::error::DescribeDocumentError {
            meta: generic,
            kind: crate::error::DescribeDocumentErrorKind::InvalidDocumentVersion({
                #[allow(unused_mut)]
                let mut tmp = {
                    #[allow(unused_mut)]
                    let mut output = crate::error::invalid_document_version::Builder::default();
                    let _ = response;
                    output = crate::json_deser::deser_structure_crate_error_invalid_document_version_json_err(response.body().as_ref(), output).map_err(crate::error::DescribeDocumentError::unhandled)?;
                    output.build()
                };
                if tmp.message.is_none() {
                    tmp.message = _error_message;
                }
                tmp
            }),
        },
        _ => crate::error::DescribeDocumentError::generic(generic),
    })
}

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.

Examples found in repository

src/error.rs (line 12715)

    fn code(&self) -> Option<&str> {
        DescribeDocumentError::code(self)
    }

pub fn is_internal_server_error(&self) -> bool

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

pub fn is_invalid_document(&self) -> bool

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

pub fn is_invalid_document_version(&self) -> bool

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

Trait Implementations

impl CreateUnhandledError for DescribeDocumentError

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

Creates an unhandled error variant with the given source.

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)>

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, demand: &mut Demand<'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