Struct HookProgressEvent

#[non_exhaustive]
pub struct HookProgressEvent {
    pub hook_type_name: Option<String>,
    pub hook_type_version_id: Option<String>,
    pub hook_type_arn: Option<String>,
    pub invocation_point: Option<String>,
    pub hook_status: Option<String>,
    pub hook_event_time: Option<DateTime>,
    pub hook_status_message: Option<String>,
    pub failure_mode: Option<String>,
}

Represents the current status of applicable Hooks for a resource operation request. It contains list of Hook invocation information for the resource specified in the request since the same target can invoke multiple Hooks. For more information, see Managing resource operation requests with Amazon Web Services Cloud Control API .

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.

hook_type_name: Option<String>

The type name of the Hook being invoked.

hook_type_version_id: Option<String>

The type version of the Hook being invoked.

hook_type_arn: Option<String>

The ARN of the Hook being invoked.

invocation_point: Option<String>

States whether the Hook is invoked before or after resource provisioning.

hook_status: Option<String>

The status of the Hook invocation. The following are potential statuses:

• HOOK_PENDING: The Hook was added to the invocation plan, but not yet invoked.

• HOOK_IN_PROGRESS: The Hook was invoked, but hasn't completed.

• HOOK_COMPLETE_SUCCEEDED: The Hook invocation is complete with a successful result.

• HOOK_COMPLETE_FAILED: The Hook invocation is complete with a failed result.

• HOOK_FAILED: The Hook invocation didn't complete successfully.

hook_event_time: Option<DateTime>

The time that the Hook invocation request initiated.

hook_status_message: Option<String>

The message explaining the current Hook status.

failure_mode: Option<String>

The failure mode of the invocation. The following are the potential statuses:

• FAIL: This will fail the Hook invocation and the request associated with it.

• WARN: This will fail the Hook invocation, but not the request associated with it.

Implementations

impl HookProgressEvent

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

The type name of the Hook being invoked.

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

The type version of the Hook being invoked.

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

The ARN of the Hook being invoked.

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

States whether the Hook is invoked before or after resource provisioning.

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

The status of the Hook invocation. The following are potential statuses:

• HOOK_PENDING: The Hook was added to the invocation plan, but not yet invoked.

• HOOK_IN_PROGRESS: The Hook was invoked, but hasn't completed.

• HOOK_COMPLETE_SUCCEEDED: The Hook invocation is complete with a successful result.

• HOOK_COMPLETE_FAILED: The Hook invocation is complete with a failed result.

• HOOK_FAILED: The Hook invocation didn't complete successfully.

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

The time that the Hook invocation request initiated.

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

The message explaining the current Hook status.

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

The failure mode of the invocation. The following are the potential statuses:

• FAIL: This will fail the Hook invocation and the request associated with it.

• WARN: This will fail the Hook invocation, but not the request associated with it.

impl HookProgressEvent

pub fn builder() -> HookProgressEventBuilder

Creates a new builder-style object to manufacture HookProgressEvent.

Trait Implementations

impl Clone for HookProgressEvent

fn clone(&self) -> HookProgressEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookProgressEvent

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

Formats the value using the given formatter.

impl PartialEq for HookProgressEvent

fn eq(&self, other: &HookProgressEvent) -> 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 HookProgressEvent