« blib/lib/Paws/DataPipeline/AddTagsOutput.pm
↑ Summary
blib/lib/Paws/DataPipeline/CreatePipelineOutput.pm »
| 1 | |||
| 2 | package Paws::DataPipeline::CreatePipeline; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description' ); | ||
| 5 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name' , required => 1); | ||
| 6 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DataPipeline::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 7 | has UniqueId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'uniqueId' , required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreatePipeline'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DataPipeline::CreatePipelineOutput'); | ||
| 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::CreatePipeline - Arguments for method CreatePipeline on L<Paws::DataPipeline> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreatePipeline on the | ||
| 25 | L<AWS Data Pipeline|Paws::DataPipeline> service. Use the attributes of this class | ||
| 26 | as arguments to method CreatePipeline. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreatePipeline. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $datapipeline = Paws->service('DataPipeline'); | ||
| 33 | my $CreatePipelineOutput = $datapipeline->CreatePipeline( | ||
| 34 | Name => 'Myid', | ||
| 35 | UniqueId => 'Myid', | ||
| 36 | Description => 'Mystring', # OPTIONAL | ||
| 37 | Tags => [ | ||
| 38 | { | ||
| 39 | Key => 'MytagKey', # min: 1, max: 128 | ||
| 40 | Value => 'MytagValue', # max: 256 | ||
| 41 | |||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $PipelineId = $CreatePipelineOutput->PipelineId; | ||
| 49 | |||
| 50 | # Returns a L<Paws::DataPipeline::CreatePipelineOutput> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datapipeline/CreatePipeline> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Description => Str | ||
| 59 | |||
| 60 | The description for the pipeline. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Name => Str | ||
| 65 | |||
| 66 | The name for the pipeline. You can use the same name for multiple | ||
| 67 | pipelines associated with your AWS account, because AWS Data Pipeline | ||
| 68 | assigns each pipeline a unique pipeline identifier. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 Tags => ArrayRef[L<Paws::DataPipeline::Tag>] | ||
| 73 | |||
| 74 | A list of tags to associate with the pipeline at creation. Tags let you | ||
| 75 | control access to pipelines. For more information, see Controlling User | ||
| 76 | Access to Pipelines | ||
| 77 | (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) | ||
| 78 | in the I<AWS Data Pipeline Developer Guide>. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> UniqueId => Str | ||
| 83 | |||
| 84 | A unique identifier. This identifier is not the same as the pipeline | ||
| 85 | identifier assigned by AWS Data Pipeline. You are responsible for | ||
| 86 | defining the format and ensuring the uniqueness of this identifier. You | ||
| 87 | use this parameter to ensure idempotency during repeated calls to | ||
| 88 | C<CreatePipeline>. For example, if the first call to C<CreatePipeline> | ||
| 89 | does not succeed, you can pass in the same unique identifier and | ||
| 90 | pipeline name combination on a subsequent call to C<CreatePipeline>. | ||
| 91 | C<CreatePipeline> ensures that if a pipeline already exists with the | ||
| 92 | same name and unique identifier, a new pipeline is not created. | ||
| 93 | Instead, you'll receive the pipeline identifier from the previous | ||
| 94 | attempt. The uniqueness of the name and unique identifier combination | ||
| 95 | is scoped to the AWS account or IAM user credentials. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, documenting arguments for method CreatePipeline in L<Paws::DataPipeline> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |