« blib/lib/Paws/CodePipeline/StopExecutionTrigger.pm
↑ Summary
blib/lib/Paws/CodePipeline/StopPipelineExecutionOutput.pm »
| 1 | |||
| 2 | package Paws::CodePipeline::StopPipelineExecution; | ||
| 3 | use Moose; | ||
| 4 | has Abandon => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'abandon' ); | ||
| 5 | has PipelineExecutionId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pipelineExecutionId' , required => 1); | ||
| 6 | has PipelineName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pipelineName' , required => 1); | ||
| 7 | has Reason => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'reason' ); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StopPipelineExecution'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodePipeline::StopPipelineExecutionOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CodePipeline::StopPipelineExecution - Arguments for method StopPipelineExecution on L<Paws::CodePipeline> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method StopPipelineExecution on the | ||
| 25 | L<AWS CodePipeline|Paws::CodePipeline> service. Use the attributes of this class | ||
| 26 | as arguments to method StopPipelineExecution. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StopPipelineExecution. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $codepipeline = Paws->service('CodePipeline'); | ||
| 33 | my $StopPipelineExecutionOutput = $codepipeline->StopPipelineExecution( | ||
| 34 | PipelineExecutionId => 'MyPipelineExecutionId', | ||
| 35 | PipelineName => 'MyPipelineName', | ||
| 36 | Abandon => 1, # OPTIONAL | ||
| 37 | Reason => 'MyStopPipelineExecutionReason', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $PipelineExecutionId = $StopPipelineExecutionOutput->PipelineExecutionId; | ||
| 42 | |||
| 43 | # Returns a L<Paws::CodePipeline::StopPipelineExecutionOutput> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codepipeline/StopPipelineExecution> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Abandon => Bool | ||
| 52 | |||
| 53 | Use this option to stop the pipeline execution by abandoning, rather | ||
| 54 | than finishing, in-progress actions. | ||
| 55 | |||
| 56 | This option can lead to failed or out-of-sequence tasks. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> PipelineExecutionId => Str | ||
| 61 | |||
| 62 | The ID of the pipeline execution to be stopped in the current stage. | ||
| 63 | Use the C<GetPipelineState> action to retrieve the current | ||
| 64 | pipelineExecutionId. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> PipelineName => Str | ||
| 69 | |||
| 70 | The name of the pipeline to stop. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 Reason => Str | ||
| 75 | |||
| 76 | Use this option to enter comments, such as the reason the pipeline was | ||
| 77 | stopped. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, documenting arguments for method StopPipelineExecution in L<Paws::CodePipeline> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |