NAME

Paws::CodePipeline::StopPipelineExecution - Arguments for method StopPipelineExecution on Paws::CodePipeline

DESCRIPTION

This class represents the parameters used for calling the method StopPipelineExecution on the AWS CodePipeline service. Use the attributes of this class as arguments to method StopPipelineExecution.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StopPipelineExecution.

SYNOPSIS

    my $codepipeline = Paws->service('CodePipeline');
    my $StopPipelineExecutionOutput = $codepipeline->StopPipelineExecution(
      PipelineExecutionId => 'MyPipelineExecutionId',
      PipelineName        => 'MyPipelineName',
      Abandon             => 1,                                  # OPTIONAL
      Reason              => 'MyStopPipelineExecutionReason',    # OPTIONAL
    );
    # Results:
    my $PipelineExecutionId = $StopPipelineExecutionOutput->PipelineExecutionId;
    # Returns a L<Paws::CodePipeline::StopPipelineExecutionOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/codepipeline/StopPipelineExecution>

ATTRIBUTES

Abandon => 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.

REQUIRED PipelineExecutionId => Str

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

REQUIRED PipelineName => Str

The name of the pipeline to stop.

Reason => Str

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>