Struct StopPipelineExecutionInput

#[non_exhaustive]
pub struct StopPipelineExecutionInput {
    pub pipeline_name: Option<String>,
    pub pipeline_execution_id: Option<String>,
    pub abandon: Option<bool>,
    pub reason: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pipeline_name: Option<String>

The name of the pipeline to stop.

pipeline_execution_id: Option<String>

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

abandon: Option<bool>

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

reason: Option<String>

Use this option to enter comments, such as the reason the pipeline was stopped.

Implementations

impl StopPipelineExecutionInput

pub fn pipeline_name(&self) -> Option<&str>

The name of the pipeline to stop.

pub fn pipeline_execution_id(&self) -> Option<&str>

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

pub fn abandon(&self) -> Option<bool>

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

pub fn reason(&self) -> Option<&str>

Use this option to enter comments, such as the reason the pipeline was stopped.

impl StopPipelineExecutionInput

pub fn builder() -> StopPipelineExecutionInputBuilder

Creates a new builder-style object to manufacture StopPipelineExecutionInput.

Trait Implementations

impl Clone for StopPipelineExecutionInput

fn clone(&self) -> StopPipelineExecutionInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StopPipelineExecutionInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StopPipelineExecutionInput

fn eq(&self, other: &StopPipelineExecutionInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StopPipelineExecutionInput