« blib/lib/Paws/CodePipeline/PipelineDeclaration.pm
↑ Summary
blib/lib/Paws/CodePipeline/PipelineExecutionSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodePipeline::PipelineExecution; | ||
| 3 | use Moose; | ||
| 4 | has ArtifactRevisions => (is => 'ro', isa => 'ArrayRef[Paws::CodePipeline::ArtifactRevision]', request_name => 'artifactRevisions', traits => ['NameInRequest']); | ||
| 5 | has PipelineExecutionId => (is => 'ro', isa => 'Str', request_name => 'pipelineExecutionId', traits => ['NameInRequest']); | ||
| 6 | has PipelineName => (is => 'ro', isa => 'Str', request_name => 'pipelineName', traits => ['NameInRequest']); | ||
| 7 | has PipelineVersion => (is => 'ro', isa => 'Int', request_name => 'pipelineVersion', traits => ['NameInRequest']); | ||
| 8 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 9 | has StatusSummary => (is => 'ro', isa => 'Str', request_name => 'statusSummary', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CodePipeline::PipelineExecution | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::CodePipeline::PipelineExecution object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { ArtifactRevisions => $value, ..., StatusSummary => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodePipeline::PipelineExecution object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->ArtifactRevisions | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Represents information about an execution of a pipeline. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ArtifactRevisions => ArrayRef[L<Paws::CodePipeline::ArtifactRevision>] | ||
| 47 | |||
| 48 | A list of C<ArtifactRevision> objects included in a pipeline execution. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 PipelineExecutionId => Str | ||
| 52 | |||
| 53 | The ID of the pipeline execution. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 PipelineName => Str | ||
| 57 | |||
| 58 | The name of the pipeline with the specified pipeline execution. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 PipelineVersion => Int | ||
| 62 | |||
| 63 | The version number of the pipeline with the specified pipeline | ||
| 64 | execution. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Status => Str | ||
| 68 | |||
| 69 | The status of the pipeline execution. | ||
| 70 | |||
| 71 | =over | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | Cancelled: The pipelineE<rsquo>s definition was updated before the | ||
| 76 | pipeline execution could be completed. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | InProgress: The pipeline execution is currently running. | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | Stopped: The pipeline execution was manually stopped. For more | ||
| 85 | information, see Stopped Executions | ||
| 86 | (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped). | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | Stopping: The pipeline execution received a request to be manually | ||
| 91 | stopped. Depending on the selected stop mode, the execution is either | ||
| 92 | completing or abandoning in-progress actions. For more information, see | ||
| 93 | Stopped Executions | ||
| 94 | (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped). | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | Succeeded: The pipeline execution was completed successfully. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | Superseded: While this pipeline execution was waiting for the next | ||
| 103 | stage to be completed, a newer pipeline execution advanced and | ||
| 104 | continued through the pipeline instead. For more information, see | ||
| 105 | Superseded Executions | ||
| 106 | (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded). | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | Failed: The pipeline execution was not completed successfully. | ||
| 111 | |||
| 112 | =back | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 StatusSummary => Str | ||
| 117 | |||
| 118 | A summary that contains a description of the pipeline execution status. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head1 SEE ALSO | ||
| 123 | |||
| 124 | This class forms part of L<Paws>, describing an object used in L<Paws::CodePipeline> | ||
| 125 | |||
| 126 | =head1 BUGS and CONTRIBUTIONS | ||
| 127 | |||
| 128 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 129 | |||
| 130 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 131 | |||
| 132 | =cut | ||
| 133 |