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: **false**<br><p>Filters results by target type. Currently, only <code>CHANGE_SET</code> and <code>CLOUD_CONTROL</code> are supported filter options.</p> <p>Required when <code>TargetId</code> is specified and cannot be used otherwise.</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: **false**<br><p>Filters results by the unique identifier of the target the Hook was invoked against.</p> <p>For change sets, this is the change set ARN. When the target is a Cloud Control API operation, this value must be the <code>HookRequestToken</code> returned by the Cloud Control API 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> <p>Required when <code>TargetType</code> is specified and cannot be used otherwise.</p><br>
    ///   - [`type_arn(impl Into<String>)`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::type_arn) / [`set_type_arn(Option<String>)`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::set_type_arn):<br>required: **false**<br><p>Filters results by the ARN of the Hook. Can be used alone or in combination with <code>Status</code>.</p><br>
    ///   - [`status(HookStatus)`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::status) / [`set_status(Option<HookStatus>)`](crate::operation::list_hook_results::builders::ListHookResultsFluentBuilder::set_status):<br>required: **false**<br><p>Filters results by the status of Hook invocations. Can only be used in combination with <code>TypeArn</code>. Valid values are:</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><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 target type.</p>
    ///   - [`target_id(Option<String>)`](crate::operation::list_hook_results::ListHookResultsOutput::target_id): <p>The unique identifier of the Hook invocation target.</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())
    }
}