aws_sdk_codepipeline/client/
start_pipeline_execution.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartPipelineExecution`](crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder::set_name):<br>required: **true**<br><p>The name of the pipeline to start.</p><br>
    ///   - [`variables(PipelineVariable)`](crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder::variables) / [`set_variables(Option<Vec::<PipelineVariable>>)`](crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder::set_variables):<br>required: **false**<br><p>A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match <code>\[A-Za-z0-9@\-_\]+</code>, and the values can be anything except an empty string.</p><br>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder::set_client_request_token):<br>required: **false**<br><p>The system-generated unique ID used to identify a unique execution request.</p><br>
    ///   - [`source_revisions(SourceRevisionOverride)`](crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder::source_revisions) / [`set_source_revisions(Option<Vec::<SourceRevisionOverride>>)`](crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder::set_source_revisions):<br>required: **false**<br><p>A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.</p><br>
    /// - On success, responds with [`StartPipelineExecutionOutput`](crate::operation::start_pipeline_execution::StartPipelineExecutionOutput) with field(s):
    ///   - [`pipeline_execution_id(Option<String>)`](crate::operation::start_pipeline_execution::StartPipelineExecutionOutput::pipeline_execution_id): <p>The unique system-generated ID of the pipeline execution that was started.</p>
    /// - On failure, responds with [`SdkError<StartPipelineExecutionError>`](crate::operation::start_pipeline_execution::StartPipelineExecutionError)
    pub fn start_pipeline_execution(&self) -> crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder {
        crate::operation::start_pipeline_execution::builders::StartPipelineExecutionFluentBuilder::new(self.handle.clone())
    }
}