#[non_exhaustive]
pub struct ProgressEvent { pub type_name: Option<String>, pub identifier: Option<String>, pub request_token: Option<String>, pub operation: Option<Operation>, pub operation_status: Option<OperationStatus>, pub event_time: Option<DateTime>, pub resource_model: Option<String>, pub status_message: Option<String>, pub error_code: Option<HandlerErrorCode>, pub retry_after: Option<DateTime>, }
Expand description

Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Fields (Non-exhaustive)§

This struct is marked as 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.
§type_name: Option<String>

The name of the resource type used in the operation.

§identifier: Option<String>

The primary identifier for the resource.

In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

§request_token: Option<String>

The unique token representing this resource operation request.

Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

§operation: Option<Operation>

The resource operation type.

§operation_status: Option<OperationStatus>

The current status of the resource operation request.

  • PENDING: The resource operation hasn't yet started.

  • IN_PROGRESS: The resource operation is currently in progress.

  • SUCCESS: The resource operation has successfully completed.

  • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

  • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

  • CANCEL_COMPLETE: The resource operation has been canceled.

§event_time: Option<DateTime>

When the resource operation request was initiated.

§resource_model: Option<String>

A JSON string containing the resource model, consisting of each resource property and its current value.

§status_message: Option<String>

Any message explaining the current status.

§error_code: Option<HandlerErrorCode>

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

§retry_after: Option<DateTime>

When to next request the status of this resource operation request.

Implementations§

source§

impl ProgressEvent

source

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

The name of the resource type used in the operation.

source

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

The primary identifier for the resource.

In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

source

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

The unique token representing this resource operation request.

Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

source

pub fn operation(&self) -> Option<&Operation>

The resource operation type.

source

pub fn operation_status(&self) -> Option<&OperationStatus>

The current status of the resource operation request.

  • PENDING: The resource operation hasn't yet started.

  • IN_PROGRESS: The resource operation is currently in progress.

  • SUCCESS: The resource operation has successfully completed.

  • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

  • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

  • CANCEL_COMPLETE: The resource operation has been canceled.

source

pub fn event_time(&self) -> Option<&DateTime>

When the resource operation request was initiated.

source

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

A JSON string containing the resource model, consisting of each resource property and its current value.

source

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

Any message explaining the current status.

source

pub fn error_code(&self) -> Option<&HandlerErrorCode>

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

source

pub fn retry_after(&self) -> Option<&DateTime>

When to next request the status of this resource operation request.

source§

impl ProgressEvent

source

pub fn builder() -> ProgressEventBuilder

Creates a new builder-style object to manufacture ProgressEvent.

Trait Implementations§

source§

impl Clone for ProgressEvent

source§

fn clone(&self) -> ProgressEvent

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for ProgressEvent

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for ProgressEvent

source§

fn eq(&self, other: &ProgressEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for ProgressEvent

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more