aws_sdk_cloudformation/client/

list_hook_results.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListHookResults`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`target_type(ListHookResultsTargetType)`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::target_type) / [`set_target_type(Option<ListHookResultsTargetType>)`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::set_target_type):<br>required: **true**<br><p>The type of operation being targeted by the Hook.</p><br>
    ///   - [`target_id(impl Into<String>)`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::target_id) / [`set_target_id(Option<String>)`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::set_target_id):<br>required: **true**<br><p>The logical ID of the target the operation is acting on by the Hook. If the target is a change set, it's the ARN of the change set.</p> <p>If the target is a Cloud Control API operation, this will be the <code>HookRequestToken</code> returned by the Cloud Control API operation request. For more information on the <code>HookRequestToken</code>, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ProgressEvent.html">ProgressEvent</a>.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::set_next_token):<br>required: **false**<br><p>A string that identifies the next page of events that you want to retrieve.</p><br>
    /// - On success, responds with [`ListHookResultsOutput`](crate::operation::list_hook_results::ListHookResultsOutput) with field(s):
    ///   - [`target_type(Option<ListHookResultsTargetType>)`](crate::operation::list_hook_results::ListHookResultsOutput::target_type): <p>The type of operation being targeted by the Hook.</p>
    ///   - [`target_id(Option<String>)`](crate::operation::list_hook_results::ListHookResultsOutput::target_id): <p>The logical ID of the target the operation is acting on by the Hook. If the target is a change set, it's the ARN of the change set.</p> <p>If the target is a Cloud Control API operation, this will be the <code>HooksRequestToken</code> returned by the Cloud Control API operation request. For more information on the <code>HooksRequestToken</code>, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ProgressEvent.html">ProgressEvent</a>.</p>
    ///   - [`hook_results(Option<Vec::<HookResultSummary>>)`](crate::operation::list_hook_results::ListHookResultsOutput::hook_results): <p>A list of <code>HookResultSummary</code> structures that provides the status and Hook status reason for each Hook invocation for the specified target.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_hook_results::ListHookResultsOutput::next_token): <p>Pagination token, <code>null</code> or empty if no more results.</p>
    /// - On failure, responds with [`SdkError<ListHookResultsError>`](crate::operation::list_hook_results::ListHookResultsError)
    pub fn list_hook_results(&self) -> crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder {
        crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::new(self.handle.clone())
    }
}