Struct ProgressEvent

#[non_exhaustive]
pub struct ProgressEvent {
    pub type_name: Option<String>,
    pub identifier: Option<String>,
    pub request_token: Option<String>,
    pub hooks_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>,
}

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)

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.

hooks_request_token: Option<String>

The unique token representing the Hooks operation for the 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

impl ProgressEvent

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

The name of the resource type used in the operation.

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.

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.

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

The unique token representing the Hooks operation for the request.

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

The resource operation type.

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.

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

When the resource operation request was initiated.

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

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

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

Any message explaining the current status.

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.

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

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

impl ProgressEvent

pub fn builder() -> ProgressEventBuilder

Creates a new builder-style object to manufacture ProgressEvent.

Trait Implementations

impl Clone for ProgressEvent

fn clone(&self) -> ProgressEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressEvent

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

Formats the value using the given formatter.

impl PartialEq for ProgressEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProgressEvent