« blib/lib/Paws/IoTAnalytics/RetentionPeriod.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/RunPipelineActivityResponse.pm »
| 1 | |||
| 2 | package Paws::IoTAnalytics::RunPipelineActivity; | ||
| 3 | use Moose; | ||
| 4 | has Payloads => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'payloads', required => 1); | ||
| 5 | has PipelineActivity => (is => 'ro', isa => 'Paws::IoTAnalytics::PipelineActivity', traits => ['NameInRequest'], request_name => 'pipelineActivity', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RunPipelineActivity'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/pipelineactivities/run'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTAnalytics::RunPipelineActivityResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IoTAnalytics::RunPipelineActivity - Arguments for method RunPipelineActivity on L<Paws::IoTAnalytics> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method RunPipelineActivity on the | ||
| 24 | L<AWS IoT Analytics|Paws::IoTAnalytics> service. Use the attributes of this class | ||
| 25 | as arguments to method RunPipelineActivity. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RunPipelineActivity. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $iotanalytics = Paws->service('IoTAnalytics'); | ||
| 32 | my $RunPipelineActivityResponse = $iotanalytics->RunPipelineActivity( | ||
| 33 | Payloads => [ 'BlobMessagePayload', ... ], | ||
| 34 | PipelineActivity => { | ||
| 35 | AddAttributes => { | ||
| 36 | Attributes => { | ||
| 37 | 'MyAttributeName' => 'MyAttributeName' | ||
| 38 | , # key: min: 1, max: 256, value: min: 1, max: 256 | ||
| 39 | }, # min: 1, max: 50 | ||
| 40 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 41 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 42 | }, # OPTIONAL | ||
| 43 | Channel => { | ||
| 44 | ChannelName => 'MyChannelName', # min: 1, max: 128 | ||
| 45 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 46 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 47 | }, # OPTIONAL | ||
| 48 | Datastore => { | ||
| 49 | DatastoreName => 'MyDatastoreName', # min: 1, max: 128 | ||
| 50 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 51 | |||
| 52 | }, # OPTIONAL | ||
| 53 | DeviceRegistryEnrich => { | ||
| 54 | Attribute => 'MyAttributeName', # min: 1, max: 256 | ||
| 55 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 56 | RoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 57 | ThingName => 'MyAttributeName', # min: 1, max: 256 | ||
| 58 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 59 | }, # OPTIONAL | ||
| 60 | DeviceShadowEnrich => { | ||
| 61 | Attribute => 'MyAttributeName', # min: 1, max: 256 | ||
| 62 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 63 | RoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 64 | ThingName => 'MyAttributeName', # min: 1, max: 256 | ||
| 65 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 66 | }, # OPTIONAL | ||
| 67 | Filter => { | ||
| 68 | Filter => 'MyFilterExpression', # min: 1, max: 256 | ||
| 69 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 70 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 71 | }, # OPTIONAL | ||
| 72 | Lambda => { | ||
| 73 | BatchSize => 1, # min: 1, max: 1000 | ||
| 74 | LambdaName => 'MyLambdaName', # min: 1, max: 64 | ||
| 75 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 76 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 77 | }, # OPTIONAL | ||
| 78 | Math => { | ||
| 79 | Attribute => 'MyAttributeName', # min: 1, max: 256 | ||
| 80 | Math => 'MyMathExpression', # min: 1, max: 256 | ||
| 81 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 82 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 83 | }, # OPTIONAL | ||
| 84 | RemoveAttributes => { | ||
| 85 | Attributes => [ | ||
| 86 | 'MyAttributeName', ... # min: 1, max: 256 | ||
| 87 | ], # min: 1, max: 50 | ||
| 88 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 89 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 90 | }, # OPTIONAL | ||
| 91 | SelectAttributes => { | ||
| 92 | Attributes => [ | ||
| 93 | 'MyAttributeName', ... # min: 1, max: 256 | ||
| 94 | ], # min: 1, max: 50 | ||
| 95 | Name => 'MyActivityName', # min: 1, max: 128 | ||
| 96 | Next => 'MyActivityName', # min: 1, max: 128 | ||
| 97 | }, # OPTIONAL | ||
| 98 | }, | ||
| 99 | |||
| 100 | ); | ||
| 101 | |||
| 102 | # Results: | ||
| 103 | my $LogResult = $RunPipelineActivityResponse->LogResult; | ||
| 104 | my $Payloads = $RunPipelineActivityResponse->Payloads; | ||
| 105 | |||
| 106 | # Returns a L<Paws::IoTAnalytics::RunPipelineActivityResponse> object. | ||
| 107 | |||
| 108 | 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. | ||
| 109 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotanalytics/RunPipelineActivity> | ||
| 110 | |||
| 111 | =head1 ATTRIBUTES | ||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> Payloads => ArrayRef[Str|Undef] | ||
| 115 | |||
| 116 | The sample message payloads on which the pipeline activity is run. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 B<REQUIRED> PipelineActivity => L<Paws::IoTAnalytics::PipelineActivity> | ||
| 121 | |||
| 122 | The pipeline activity that is run. This must not be a channel activity | ||
| 123 | or a datastore activity because these activities are used in a pipeline | ||
| 124 | only to load the original message and to store the (possibly) | ||
| 125 | transformed message. If a lambda activity is specified, only | ||
| 126 | short-running Lambda functions (those with a timeout of less than 30 | ||
| 127 | seconds or less) can be used. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head1 SEE ALSO | ||
| 133 | |||
| 134 | This class forms part of L<Paws>, documenting arguments for method RunPipelineActivity in L<Paws::IoTAnalytics> | ||
| 135 | |||
| 136 | =head1 BUGS and CONTRIBUTIONS | ||
| 137 | |||
| 138 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 139 | |||
| 140 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 141 | |||
| 142 | =cut | ||
| 143 |