« blib/lib/Paws/DataPipeline/PollForTaskOutput.pm
↑ Summary
blib/lib/Paws/DataPipeline/PutPipelineDefinitionOutput.pm »
| 1 | |||
| 2 | package Paws::DataPipeline::PutPipelineDefinition; | ||
| 3 | use Moose; | ||
| 4 | has ParameterObjects => (is => 'ro', isa => 'ArrayRef[Paws::DataPipeline::ParameterObject]', traits => ['NameInRequest'], request_name => 'parameterObjects' ); | ||
| 5 | has ParameterValues => (is => 'ro', isa => 'ArrayRef[Paws::DataPipeline::ParameterValue]', traits => ['NameInRequest'], request_name => 'parameterValues' ); | ||
| 6 | has PipelineId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pipelineId' , required => 1); | ||
| 7 | has PipelineObjects => (is => 'ro', isa => 'ArrayRef[Paws::DataPipeline::PipelineObject]', traits => ['NameInRequest'], request_name => 'pipelineObjects' , required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutPipelineDefinition'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DataPipeline::PutPipelineDefinitionOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::DataPipeline::PutPipelineDefinition - Arguments for method PutPipelineDefinition on L<Paws::DataPipeline> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method PutPipelineDefinition on the | ||
| 25 | L<AWS Data Pipeline|Paws::DataPipeline> service. Use the attributes of this class | ||
| 26 | as arguments to method PutPipelineDefinition. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutPipelineDefinition. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $datapipeline = Paws->service('DataPipeline'); | ||
| 33 | my $PutPipelineDefinitionOutput = $datapipeline->PutPipelineDefinition( | ||
| 34 | PipelineId => 'Myid', | ||
| 35 | PipelineObjects => [ | ||
| 36 | { | ||
| 37 | Fields => [ | ||
| 38 | { | ||
| 39 | Key => 'MyfieldNameString', # min: 1, max: 256 | ||
| 40 | RefValue => 'MyfieldNameString', # min: 1, max: 256 | ||
| 41 | StringValue => 'MyfieldStringValue', # max: 10240; OPTIONAL | ||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], | ||
| 45 | Id => 'Myid', # min: 1, max: 1024 | ||
| 46 | Name => 'Myid', # min: 1, max: 1024 | ||
| 47 | |||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], | ||
| 51 | ParameterObjects => [ | ||
| 52 | { | ||
| 53 | Attributes => [ | ||
| 54 | { | ||
| 55 | Key => 'MyattributeNameString', # min: 1, max: 256 | ||
| 56 | StringValue => 'MyattributeValueString', # max: 10240 | ||
| 57 | |||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], | ||
| 61 | Id => 'MyfieldNameString', # min: 1, max: 256 | ||
| 62 | |||
| 63 | }, | ||
| 64 | ... | ||
| 65 | ], # OPTIONAL | ||
| 66 | ParameterValues => [ | ||
| 67 | { | ||
| 68 | Id => 'MyfieldNameString', # min: 1, max: 256 | ||
| 69 | StringValue => 'MyfieldStringValue', # max: 10240; OPTIONAL | ||
| 70 | |||
| 71 | }, | ||
| 72 | ... | ||
| 73 | ], # OPTIONAL | ||
| 74 | ); | ||
| 75 | |||
| 76 | # Results: | ||
| 77 | my $Errored = $PutPipelineDefinitionOutput->Errored; | ||
| 78 | my $ValidationErrors = $PutPipelineDefinitionOutput->ValidationErrors; | ||
| 79 | my $ValidationWarnings = $PutPipelineDefinitionOutput->ValidationWarnings; | ||
| 80 | |||
| 81 | # Returns a L<Paws::DataPipeline::PutPipelineDefinitionOutput> object. | ||
| 82 | |||
| 83 | 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. | ||
| 84 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datapipeline/PutPipelineDefinition> | ||
| 85 | |||
| 86 | =head1 ATTRIBUTES | ||
| 87 | |||
| 88 | |||
| 89 | =head2 ParameterObjects => ArrayRef[L<Paws::DataPipeline::ParameterObject>] | ||
| 90 | |||
| 91 | The parameter objects used with the pipeline. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 ParameterValues => ArrayRef[L<Paws::DataPipeline::ParameterValue>] | ||
| 96 | |||
| 97 | The parameter values used with the pipeline. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> PipelineId => Str | ||
| 102 | |||
| 103 | The ID of the pipeline. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> PipelineObjects => ArrayRef[L<Paws::DataPipeline::PipelineObject>] | ||
| 108 | |||
| 109 | The objects that define the pipeline. These objects overwrite the | ||
| 110 | existing pipeline definition. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head1 SEE ALSO | ||
| 116 | |||
| 117 | This class forms part of L<Paws>, documenting arguments for method PutPipelineDefinition in L<Paws::DataPipeline> | ||
| 118 | |||
| 119 | =head1 BUGS and CONTRIBUTIONS | ||
| 120 | |||
| 121 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 122 | |||
| 123 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 124 | |||
| 125 | =cut | ||
| 126 |