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