aws_sdk_cloudformation/client/

get_hook_result.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetHookResult`](crate::operation::get_hook_result::builders::GetHookResultFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`hook_result_id(impl Into<String>)`](crate::operation::get_hook_result::builders::GetHookResultFluentBuilder::hook_result_id) / [`set_hook_result_id(Option<String>)`](crate::operation::get_hook_result::builders::GetHookResultFluentBuilder::set_hook_result_id):<br>required: **false**<br><p>The unique identifier (ID) of the Hook invocation result that you want details about. You can get the ID from the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListHookResults.html">ListHookResults</a> operation.</p><br>
    /// - On success, responds with [`GetHookResultOutput`](crate::operation::get_hook_result::GetHookResultOutput) with field(s):
    ///   - [`hook_result_id(Option<String>)`](crate::operation::get_hook_result::GetHookResultOutput::hook_result_id): <p>The unique identifier of the Hook result.</p>
    ///   - [`invocation_point(Option<HookInvocationPoint>)`](crate::operation::get_hook_result::GetHookResultOutput::invocation_point): <p>The specific point in the provisioning process where the Hook is invoked.</p>
    ///   - [`failure_mode(Option<HookFailureMode>)`](crate::operation::get_hook_result::GetHookResultOutput::failure_mode): <p>The failure mode of the invocation.</p>
    ///   - [`type_name(Option<String>)`](crate::operation::get_hook_result::GetHookResultOutput::type_name): <p>The name of the Hook that was invoked.</p>
    ///   - [`original_type_name(Option<String>)`](crate::operation::get_hook_result::GetHookResultOutput::original_type_name): <p>The original public type name of the Hook when an alias is used.</p> <p>For example, if you activate <code>AWS::Hooks::GuardHook</code> with alias <code>MyCompany::Custom::GuardHook</code>, then <code>TypeName</code> will be <code>MyCompany::Custom::GuardHook</code> and <code>OriginalTypeName</code> will be <code>AWS::Hooks::GuardHook</code>.</p>
    ///   - [`type_version_id(Option<String>)`](crate::operation::get_hook_result::GetHookResultOutput::type_version_id): <p>The version identifier of the Hook that was invoked.</p>
    ///   - [`type_configuration_version_id(Option<String>)`](crate::operation::get_hook_result::GetHookResultOutput::type_configuration_version_id): <p>The version identifier of the Hook configuration data that was used during invocation.</p>
    ///   - [`type_arn(Option<String>)`](crate::operation::get_hook_result::GetHookResultOutput::type_arn): <p>The Amazon Resource Name (ARN) of the Hook.</p>
    ///   - [`status(Option<HookStatus>)`](crate::operation::get_hook_result::GetHookResultOutput::status): <p>The status of the Hook invocation. The following statuses are possible:</p> <ul>  <li>   <p><code>HOOK_IN_PROGRESS</code>: The Hook is currently running.</p></li>  <li>   <p><code>HOOK_COMPLETE_SUCCEEDED</code>: The Hook completed successfully.</p></li>  <li>   <p><code>HOOK_COMPLETE_FAILED</code>: The Hook completed but failed validation.</p></li>  <li>   <p><code>HOOK_FAILED</code>: The Hook encountered an error during execution.</p></li> </ul>
    ///   - [`hook_status_reason(Option<String>)`](crate::operation::get_hook_result::GetHookResultOutput::hook_status_reason): <p>A message that provides additional details about the Hook invocation status.</p>
    ///   - [`invoked_at(Option<DateTime>)`](crate::operation::get_hook_result::GetHookResultOutput::invoked_at): <p>The timestamp when the Hook was invoked.</p>
    ///   - [`target(Option<HookTarget>)`](crate::operation::get_hook_result::GetHookResultOutput::target): <p>Information about the target of the Hook invocation.</p>
    ///   - [`annotations(Option<Vec::<Annotation>>)`](crate::operation::get_hook_result::GetHookResultOutput::annotations): <p>A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.</p>
    /// - On failure, responds with [`SdkError<GetHookResultError>`](crate::operation::get_hook_result::GetHookResultError)
    pub fn get_hook_result(&self) -> crate::operation::get_hook_result::builders::GetHookResultFluentBuilder {
        crate::operation::get_hook_result::builders::GetHookResultFluentBuilder::new(self.handle.clone())
    }
}