Struct aws_sdk_cloudcontrol::types::ProgressEvent
source · #[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
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
impl ProgressEvent
sourcepub fn identifier(&self) -> Option<&str>
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
.
sourcepub fn request_token(&self) -> Option<&str>
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.
sourcepub fn operation_status(&self) -> Option<&OperationStatus>
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.
sourcepub fn event_time(&self) -> Option<&DateTime>
pub fn event_time(&self) -> Option<&DateTime>
When the resource operation request was initiated.
sourcepub fn resource_model(&self) -> Option<&str>
pub fn resource_model(&self) -> Option<&str>
A JSON string containing the resource model, consisting of each resource property and its current value.
sourcepub fn status_message(&self) -> Option<&str>
pub fn status_message(&self) -> Option<&str>
Any message explaining the current status.
sourcepub fn error_code(&self) -> Option<&HandlerErrorCode>
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.
sourcepub fn retry_after(&self) -> Option<&DateTime>
pub fn retry_after(&self) -> Option<&DateTime>
When to next request the status of this resource operation request.
source§impl ProgressEvent
impl ProgressEvent
sourcepub fn builder() -> ProgressEventBuilder
pub fn builder() -> ProgressEventBuilder
Creates a new builder-style object to manufacture ProgressEvent
.
Trait Implementations§
source§impl Clone for ProgressEvent
impl Clone for ProgressEvent
source§fn clone(&self) -> ProgressEvent
fn clone(&self) -> ProgressEvent
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ProgressEvent
impl Debug for ProgressEvent
source§impl PartialEq for ProgressEvent
impl PartialEq for ProgressEvent
source§fn eq(&self, other: &ProgressEvent) -> bool
fn eq(&self, other: &ProgressEvent) -> bool
self
and other
values to be equal, and is used
by ==
.