« blib/lib/Paws/IoTAnalytics/CreateDatastoreResponse.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/CreatePipelineResponse.pm »
| 1 | |||
| 2 | package Paws::IoTAnalytics::CreatePipeline; | ||
| 3 | use Moose; | ||
| 4 | has PipelineActivities => (is => 'ro', isa => 'ArrayRef[Paws::IoTAnalytics::PipelineActivity]', traits => ['NameInRequest'], request_name => 'pipelineActivities', required => 1); | ||
| 5 | has PipelineName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pipelineName', required => 1); | ||
| 6 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IoTAnalytics::Tag]', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreatePipeline'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/pipelines'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTAnalytics::CreatePipelineResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::IoTAnalytics::CreatePipeline - Arguments for method CreatePipeline on L<Paws::IoTAnalytics> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreatePipeline on the | ||
| 25 | L<AWS IoT Analytics|Paws::IoTAnalytics> 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 $iotanalytics = Paws->service('IoTAnalytics'); | ||
| 33 | my $CreatePipelineResponse = $iotanalytics->CreatePipeline( | ||
| 34 | PipelineActivities => [ | ||
| 35 | { | ||
| 36 | AddAttributes => { | ||
| 37 | Attributes => { | ||
| 38 | 'MyAttributeName' => 'MyAttributeName' | ||
| 39 | , # key: min: 1, max: 256, value: min: 1, max: 256 | ||
| 40 | }, # min: 1, max: 50 | ||
| 41 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 42 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 43 | }, # OPTIONAL | ||
| 44 | Channel => { | ||
| 45 | ChannelName => 'MyChannelName', # min: 1, max: 128 | ||
| 46 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 47 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 48 | }, # OPTIONAL | ||
| 49 | Datastore => { | ||
| 50 | DatastoreName => 'MyDatastoreName', # min: 1, max: 128 | ||
| 51 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 52 | |||
| 53 | }, # OPTIONAL | ||
| 54 | DeviceRegistryEnrich => { | ||
| 55 | Attribute => 'MyAttributeName', # min: 1, max: 256 | ||
| 56 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 57 | RoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 58 | ThingName => 'MyAttributeName', # min: 1, max: 256 | ||
| 59 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 60 | }, # OPTIONAL | ||
| 61 | DeviceShadowEnrich => { | ||
| 62 | Attribute => 'MyAttributeName', # min: 1, max: 256 | ||
| 63 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 64 | RoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 65 | ThingName => 'MyAttributeName', # min: 1, max: 256 | ||
| 66 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 67 | }, # OPTIONAL | ||
| 68 | Filter => { | ||
| 69 | Filter => 'MyFilterExpression', # min: 1, max: 256 | ||
| 70 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 71 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 72 | }, # OPTIONAL | ||
| 73 | Lambda => { | ||
| 74 | BatchSize => 1, # min: 1, max: 1000 | ||
| 75 | LambdaName => 'MyLambdaName', # min: 1, max: 64 | ||
| 76 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 77 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 78 | }, # OPTIONAL | ||
| 79 | Math => { | ||
| 80 | Attribute => 'MyAttributeName', # min: 1, max: 256 | ||
| 81 | Math => 'MyMathExpression', # min: 1, max: 256 | ||
| 82 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 83 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 84 | }, # OPTIONAL | ||
| 85 | RemoveAttributes => { | ||
| 86 | Attributes => [ | ||
| 87 | 'MyAttributeName', ... # min: 1, max: 256 | ||
| 88 | ], # min: 1, max: 50 | ||
| 89 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 90 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 91 | }, # OPTIONAL | ||
| 92 | SelectAttributes => { | ||
| 93 | Attributes => [ | ||
| 94 | 'MyAttributeName', ... # min: 1, max: 256 | ||
| 95 | ], # min: 1, max: 50 | ||
| 96 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 97 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 98 | }, # OPTIONAL | ||
| 99 | }, | ||
| 100 | ... | ||
| 101 | ], | ||
| 102 | PipelineName => 'MyPipelineName', | ||
| 103 | Tags => [ | ||
| 104 | { | ||
| 105 | Key => 'MyTagKey', # min: 1, max: 256 | ||
| 106 | Value => 'MyTagValue', # min: 1, max: 256 | ||
| 107 | |||
| 108 | }, | ||
| 109 | ... | ||
| 110 | ], # OPTIONAL | ||
| 111 | ); | ||
| 112 | |||
| 113 | # Results: | ||
| 114 | my $PipelineArn = $CreatePipelineResponse->PipelineArn; | ||
| 115 | my $PipelineName = $CreatePipelineResponse->PipelineName; | ||
| 116 | |||
| 117 | # Returns a L<Paws::IoTAnalytics::CreatePipelineResponse> object. | ||
| 118 | |||
| 119 | 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. | ||
| 120 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotanalytics/CreatePipeline> | ||
| 121 | |||
| 122 | =head1 ATTRIBUTES | ||
| 123 | |||
| 124 | |||
| 125 | =head2 B<REQUIRED> PipelineActivities => ArrayRef[L<Paws::IoTAnalytics::PipelineActivity>] | ||
| 126 | |||
| 127 | A list of C<PipelineActivity> objects. Activities perform | ||
| 128 | transformations on your messages, such as removing, renaming or adding | ||
| 129 | message attributes; filtering messages based on attribute values; | ||
| 130 | invoking your Lambda functions on messages for advanced processing; or | ||
| 131 | performing mathematical transformations to normalize device data. | ||
| 132 | |||
| 133 | The list can be 2-25 C<PipelineActivity> objects and must contain both | ||
| 134 | a C<channel> and a C<datastore> activity. Each entry in the list must | ||
| 135 | contain only one activity. For example: | ||
| 136 | |||
| 137 | C<pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, | ||
| 138 | ... ]> | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 B<REQUIRED> PipelineName => Str | ||
| 143 | |||
| 144 | The name of the pipeline. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 Tags => ArrayRef[L<Paws::IoTAnalytics::Tag>] | ||
| 149 | |||
| 150 | Metadata which can be used to manage the pipeline. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head1 SEE ALSO | ||
| 156 | |||
| 157 | This class forms part of L<Paws>, documenting arguments for method CreatePipeline in L<Paws::IoTAnalytics> | ||
| 158 | |||
| 159 | =head1 BUGS and CONTRIBUTIONS | ||
| 160 | |||
| 161 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 162 | |||
| 163 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 164 | |||
| 165 | =cut | ||
| 166 |