« blib/lib/Paws/DataPipeline/CreatePipelineOutput.pm
↑ Summary
blib/lib/Paws/DataPipeline/DeactivatePipelineOutput.pm »
| 1 | |||
| 2 | package Paws::DataPipeline::DeactivatePipeline; | ||
| 3 | use Moose; | ||
| 4 | has CancelActive => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'cancelActive' ); | ||
| 5 | has PipelineId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pipelineId' , required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeactivatePipeline'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DataPipeline::DeactivatePipelineOutput'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::DataPipeline::DeactivatePipeline - Arguments for method DeactivatePipeline on L<Paws::DataPipeline> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DeactivatePipeline on the | ||
| 23 | L<AWS Data Pipeline|Paws::DataPipeline> service. Use the attributes of this class | ||
| 24 | as arguments to method DeactivatePipeline. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeactivatePipeline. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $datapipeline = Paws->service('DataPipeline'); | ||
| 31 | my $DeactivatePipelineOutput = $datapipeline->DeactivatePipeline( | ||
| 32 | PipelineId => 'Myid', | ||
| 33 | CancelActive => 1, # OPTIONAL | ||
| 34 | ); | ||
| 35 | |||
| 36 | 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. | ||
| 37 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datapipeline/DeactivatePipeline> | ||
| 38 | |||
| 39 | =head1 ATTRIBUTES | ||
| 40 | |||
| 41 | |||
| 42 | =head2 CancelActive => Bool | ||
| 43 | |||
| 44 | Indicates whether to cancel any running objects. The default is true, | ||
| 45 | which sets the state of any running objects to C<CANCELED>. If this | ||
| 46 | value is false, the pipeline is deactivated after all running objects | ||
| 47 | finish. | ||
| 48 | |||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> PipelineId => Str | ||
| 52 | |||
| 53 | The ID of the pipeline. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head1 SEE ALSO | ||
| 59 | |||
| 60 | This class forms part of L<Paws>, documenting arguments for method DeactivatePipeline in L<Paws::DataPipeline> | ||
| 61 | |||
| 62 | =head1 BUGS and CONTRIBUTIONS | ||
| 63 | |||
| 64 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 65 | |||
| 66 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 67 | |||
| 68 | =cut | ||
| 69 |