« blib/lib/Paws/IoTAnalytics/UpdateChannel.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/UpdateDatastore.pm »
| 1 | |||
| 2 | package Paws::IoTAnalytics::UpdateDataset; | ||
| 3 | use Moose; | ||
| 4 | has Actions => (is => 'ro', isa => 'ArrayRef[Paws::IoTAnalytics::DatasetAction]', traits => ['NameInRequest'], request_name => 'actions', required => 1); | ||
| 5 | has ContentDeliveryRules => (is => 'ro', isa => 'ArrayRef[Paws::IoTAnalytics::DatasetContentDeliveryRule]', traits => ['NameInRequest'], request_name => 'contentDeliveryRules'); | ||
| 6 | has DatasetName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'datasetName', required => 1); | ||
| 7 | has LateDataRules => (is => 'ro', isa => 'ArrayRef[Paws::IoTAnalytics::LateDataRule]', traits => ['NameInRequest'], request_name => 'lateDataRules'); | ||
| 8 | has RetentionPeriod => (is => 'ro', isa => 'Paws::IoTAnalytics::RetentionPeriod', traits => ['NameInRequest'], request_name => 'retentionPeriod'); | ||
| 9 | has Triggers => (is => 'ro', isa => 'ArrayRef[Paws::IoTAnalytics::DatasetTrigger]', traits => ['NameInRequest'], request_name => 'triggers'); | ||
| 10 | has VersioningConfiguration => (is => 'ro', isa => 'Paws::IoTAnalytics::VersioningConfiguration', traits => ['NameInRequest'], request_name => 'versioningConfiguration'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateDataset'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/datasets/{datasetName}'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::IoTAnalytics::UpdateDataset - Arguments for method UpdateDataset on L<Paws::IoTAnalytics> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method UpdateDataset on the | ||
| 29 | L<AWS IoT Analytics|Paws::IoTAnalytics> service. Use the attributes of this class | ||
| 30 | as arguments to method UpdateDataset. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDataset. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $iotanalytics = Paws->service('IoTAnalytics'); | ||
| 37 | $iotanalytics->UpdateDataset( | ||
| 38 | Actions => [ | ||
| 39 | { | ||
| 40 | ActionName => 'MyDatasetActionName', # min: 1, max: 128; OPTIONAL | ||
| 41 | ContainerAction => { | ||
| 42 | ExecutionRoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 43 | Image => 'MyImage', # max: 255 | ||
| 44 | ResourceConfiguration => { | ||
| 45 | ComputeType => 'ACU_1', # values: ACU_1, ACU_2 | ||
| 46 | VolumeSizeInGB => 1, # min: 1, max: 50 | ||
| 47 | |||
| 48 | }, | ||
| 49 | Variables => [ | ||
| 50 | { | ||
| 51 | Name => 'MyVariableName', # min: 1, max: 256 | ||
| 52 | DatasetContentVersionValue => { | ||
| 53 | DatasetName => 'MyDatasetName', # min: 1, max: 128 | ||
| 54 | |||
| 55 | }, # OPTIONAL | ||
| 56 | DoubleValue => 1, # OPTIONAL | ||
| 57 | OutputFileUriValue => { | ||
| 58 | FileName => 'MyOutputFileName', | ||
| 59 | |||
| 60 | }, # OPTIONAL | ||
| 61 | StringValue => 'MyStringValue', # max: 1024; OPTIONAL | ||
| 62 | }, | ||
| 63 | ... | ||
| 64 | ], # max: 50; OPTIONAL | ||
| 65 | }, # OPTIONAL | ||
| 66 | QueryAction => { | ||
| 67 | SqlQuery => 'MySqlQuery', | ||
| 68 | Filters => [ | ||
| 69 | { | ||
| 70 | DeltaTime => { | ||
| 71 | OffsetSeconds => 1, | ||
| 72 | TimeExpression => 'MyTimeExpression', | ||
| 73 | |||
| 74 | }, # OPTIONAL | ||
| 75 | }, | ||
| 76 | ... | ||
| 77 | ], # max: 1; OPTIONAL | ||
| 78 | }, # OPTIONAL | ||
| 79 | }, | ||
| 80 | ... | ||
| 81 | ], | ||
| 82 | DatasetName => 'MyDatasetName', | ||
| 83 | ContentDeliveryRules => [ | ||
| 84 | { | ||
| 85 | Destination => { | ||
| 86 | IotEventsDestinationConfiguration => { | ||
| 87 | InputName => 'MyIotEventsInputName', # min: 1, max: 128 | ||
| 88 | RoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 89 | |||
| 90 | }, # OPTIONAL | ||
| 91 | S3DestinationConfiguration => { | ||
| 92 | Bucket => 'MyBucketName', # min: 3, max: 255 | ||
| 93 | Key => 'MyBucketKeyExpression', # min: 1, max: 255 | ||
| 94 | RoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 95 | GlueConfiguration => { | ||
| 96 | DatabaseName => 'MyGlueDatabaseName', # min: 1, max: 150 | ||
| 97 | TableName => 'MyGlueTableName', # min: 1, max: 150 | ||
| 98 | |||
| 99 | }, # OPTIONAL | ||
| 100 | }, # OPTIONAL | ||
| 101 | }, | ||
| 102 | EntryName => 'MyEntryName', # OPTIONAL | ||
| 103 | }, | ||
| 104 | ... | ||
| 105 | ], # OPTIONAL | ||
| 106 | LateDataRules => [ | ||
| 107 | { | ||
| 108 | RuleConfiguration => { | ||
| 109 | DeltaTimeSessionWindowConfiguration => { | ||
| 110 | TimeoutInMinutes => 1, # min: 1, max: 60 | ||
| 111 | |||
| 112 | }, # OPTIONAL | ||
| 113 | }, | ||
| 114 | RuleName => 'MyLateDataRuleName', # min: 1, max: 128; OPTIONAL | ||
| 115 | }, | ||
| 116 | ... | ||
| 117 | ], # OPTIONAL | ||
| 118 | RetentionPeriod => { | ||
| 119 | NumberOfDays => 1, # min: 1; OPTIONAL | ||
| 120 | Unlimited => 1, # OPTIONAL | ||
| 121 | }, # OPTIONAL | ||
| 122 | Triggers => [ | ||
| 123 | { | ||
| 124 | Dataset => { | ||
| 125 | Name => 'MyDatasetName', # min: 1, max: 128 | ||
| 126 | |||
| 127 | }, # OPTIONAL | ||
| 128 | Schedule => { | ||
| 129 | Expression => 'MyScheduleExpression', # OPTIONAL | ||
| 130 | }, # OPTIONAL | ||
| 131 | }, | ||
| 132 | ... | ||
| 133 | ], # OPTIONAL | ||
| 134 | VersioningConfiguration => { | ||
| 135 | MaxVersions => 1, # min: 1, max: 1000; OPTIONAL | ||
| 136 | Unlimited => 1, # OPTIONAL | ||
| 137 | }, # OPTIONAL | ||
| 138 | ); | ||
| 139 | |||
| 140 | 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. | ||
| 141 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotanalytics/UpdateDataset> | ||
| 142 | |||
| 143 | =head1 ATTRIBUTES | ||
| 144 | |||
| 145 | |||
| 146 | =head2 B<REQUIRED> Actions => ArrayRef[L<Paws::IoTAnalytics::DatasetAction>] | ||
| 147 | |||
| 148 | A list of C<DatasetAction> objects. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 ContentDeliveryRules => ArrayRef[L<Paws::IoTAnalytics::DatasetContentDeliveryRule>] | ||
| 153 | |||
| 154 | When dataset contents are created, they are delivered to destinations | ||
| 155 | specified here. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head2 B<REQUIRED> DatasetName => Str | ||
| 160 | |||
| 161 | The name of the data set to update. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 LateDataRules => ArrayRef[L<Paws::IoTAnalytics::LateDataRule>] | ||
| 166 | |||
| 167 | A list of data rules that send notifications to Amazon CloudWatch, when | ||
| 168 | data arrives late. To specify C<lateDataRules>, the dataset must use a | ||
| 169 | DeltaTimer | ||
| 170 | (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) | ||
| 171 | filter. | ||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head2 RetentionPeriod => L<Paws::IoTAnalytics::RetentionPeriod> | ||
| 176 | |||
| 177 | How long, in days, dataset contents are kept for the dataset. | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head2 Triggers => ArrayRef[L<Paws::IoTAnalytics::DatasetTrigger>] | ||
| 182 | |||
| 183 | A list of C<DatasetTrigger> objects. The list can be empty or can | ||
| 184 | contain up to five C<DatasetTrigger> objects. | ||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head2 VersioningConfiguration => L<Paws::IoTAnalytics::VersioningConfiguration> | ||
| 189 | |||
| 190 | Optional. How many versions of dataset contents are kept. If not | ||
| 191 | specified or set to null, only the latest version plus the latest | ||
| 192 | succeeded version (if they are different) are kept for the time period | ||
| 193 | specified by the C<retentionPeriod> parameter. For more information, | ||
| 194 | see Keeping Multiple Versions of AWS IoT Analytics Data Sets | ||
| 195 | (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) | ||
| 196 | in the I<AWS IoT Analytics User Guide>. | ||
| 197 | |||
| 198 | |||
| 199 | |||
| 200 | |||
| 201 | =head1 SEE ALSO | ||
| 202 | |||
| 203 | This class forms part of L<Paws>, documenting arguments for method UpdateDataset in L<Paws::IoTAnalytics> | ||
| 204 | |||
| 205 | =head1 BUGS and CONTRIBUTIONS | ||
| 206 | |||
| 207 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 208 | |||
| 209 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 210 | |||
| 211 | =cut | ||
| 212 |