aws_sdk_datapipeline/client/
set_status.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SetStatus`](crate::operation::set_status::builders::SetStatusFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`pipeline_id(impl Into<String>)`](crate::operation::set_status::builders::SetStatusFluentBuilder::pipeline_id) / [`set_pipeline_id(Option<String>)`](crate::operation::set_status::builders::SetStatusFluentBuilder::set_pipeline_id):<br>required: **true**<br><p>The ID of the pipeline that contains the objects.</p><br>
    ///   - [`object_ids(impl Into<String>)`](crate::operation::set_status::builders::SetStatusFluentBuilder::object_ids) / [`set_object_ids(Option<Vec::<String>>)`](crate::operation::set_status::builders::SetStatusFluentBuilder::set_object_ids):<br>required: **true**<br><p>The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.</p><br>
    ///   - [`status(impl Into<String>)`](crate::operation::set_status::builders::SetStatusFluentBuilder::status) / [`set_status(Option<String>)`](crate::operation::set_status::builders::SetStatusFluentBuilder::set_status):<br>required: **true**<br><p>The status to be set on all the objects specified in <code>objectIds</code>. For components, use <code>PAUSE</code> or <code>RESUME</code>. For instances, use <code>TRY_CANCEL</code>, <code>RERUN</code>, or <code>MARK_FINISHED</code>.</p><br>
    /// - On success, responds with [`SetStatusOutput`](crate::operation::set_status::SetStatusOutput)
    /// - On failure, responds with [`SdkError<SetStatusError>`](crate::operation::set_status::SetStatusError)
    pub fn set_status(&self) -> crate::operation::set_status::builders::SetStatusFluentBuilder {
        crate::operation::set_status::builders::SetStatusFluentBuilder::new(self.handle.clone())
    }
}