« blib/lib/Paws/LookoutMetrics/CreateAnomalyDetectorResponse.pm
↑ Summary
blib/lib/Paws/LookoutMetrics/CreateMetricSetResponse.pm »
| 1 | |||
| 2 | package Paws::LookoutMetrics::CreateMetricSet; | ||
| 3 | use Moose; | ||
| 4 | has AnomalyDetectorArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DimensionList => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has MetricList => (is => 'ro', isa => 'ArrayRef[Paws::LookoutMetrics::Metric]', required => 1); | ||
| 7 | has MetricSetDescription => (is => 'ro', isa => 'Str'); | ||
| 8 | has MetricSetFrequency => (is => 'ro', isa => 'Str'); | ||
| 9 | has MetricSetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has MetricSource => (is => 'ro', isa => 'Paws::LookoutMetrics::MetricSource', required => 1); | ||
| 11 | has Offset => (is => 'ro', isa => 'Int'); | ||
| 12 | has Tags => (is => 'ro', isa => 'Paws::LookoutMetrics::TagMap'); | ||
| 13 | has TimestampColumn => (is => 'ro', isa => 'Paws::LookoutMetrics::TimestampColumn'); | ||
| 14 | has Timezone => (is => 'ro', isa => 'Str'); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateMetricSet'); | ||
| 19 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/CreateMetricSet'); | ||
| 20 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LookoutMetrics::CreateMetricSetResponse'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::LookoutMetrics::CreateMetricSet - Arguments for method CreateMetricSet on L<Paws::LookoutMetrics> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method CreateMetricSet on the | ||
| 33 | L<Amazon Lookout for Metrics|Paws::LookoutMetrics> service. Use the attributes of this class | ||
| 34 | as arguments to method CreateMetricSet. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateMetricSet. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $lookoutmetrics = Paws->service('LookoutMetrics'); | ||
| 41 | my $CreateMetricSetResponse = $lookoutmetrics->CreateMetricSet( | ||
| 42 | AnomalyDetectorArn => 'MyArn', | ||
| 43 | MetricList => [ | ||
| 44 | { | ||
| 45 | AggregationFunction => 'AVG', # values: AVG, SUM | ||
| 46 | MetricName => 'MyColumnName', # min: 1, max: 63 | ||
| 47 | Namespace => 'MyNamespace', # min: 1, max: 255; OPTIONAL | ||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], | ||
| 51 | MetricSetName => 'MyMetricSetName', | ||
| 52 | MetricSource => { | ||
| 53 | AppFlowConfig => { | ||
| 54 | FlowName => 'MyFlowName', # max: 256 | ||
| 55 | RoleArn => 'MyArn', # max: 256 | ||
| 56 | |||
| 57 | }, # OPTIONAL | ||
| 58 | CloudWatchConfig => { | ||
| 59 | RoleArn => 'MyArn', # max: 256 | ||
| 60 | |||
| 61 | }, # OPTIONAL | ||
| 62 | RDSSourceConfig => { | ||
| 63 | DBInstanceIdentifier => 'MyRDSDatabaseIdentifier', # min: 1, max: 63 | ||
| 64 | DatabaseHost => 'MyDatabaseHost', # min: 1, max: 253 | ||
| 65 | DatabaseName => 'MyRDSDatabaseName', # min: 1, max: 64 | ||
| 66 | DatabasePort => 1, # min: 1, max: 65535 | ||
| 67 | RoleArn => 'MyArn', # max: 256 | ||
| 68 | SecretManagerArn => 'MyPoirotSecretManagerArn', # max: 256 | ||
| 69 | TableName => 'MyTableName', # min: 1, max: 100 | ||
| 70 | VpcConfiguration => { | ||
| 71 | SecurityGroupIdList => [ | ||
| 72 | 'MySecurityGroupId', ... # min: 1, max: 255 | ||
| 73 | ], | ||
| 74 | SubnetIdList => [ | ||
| 75 | 'MySubnetId', ... # max: 255 | ||
| 76 | ], | ||
| 77 | |||
| 78 | }, | ||
| 79 | |||
| 80 | }, # OPTIONAL | ||
| 81 | RedshiftSourceConfig => { | ||
| 82 | ClusterIdentifier => 'MyRedshiftClusterIdentifier', # min: 1, max: 63 | ||
| 83 | DatabaseHost => 'MyDatabaseHost', # min: 1, max: 253 | ||
| 84 | DatabaseName => 'MyRedshiftDatabaseName', # min: 1, max: 100 | ||
| 85 | DatabasePort => 1, # min: 1, max: 65535 | ||
| 86 | RoleArn => 'MyArn', # max: 256 | ||
| 87 | SecretManagerArn => 'MyPoirotSecretManagerArn', # max: 256 | ||
| 88 | TableName => 'MyTableName', # min: 1, max: 100 | ||
| 89 | VpcConfiguration => { | ||
| 90 | SecurityGroupIdList => [ | ||
| 91 | 'MySecurityGroupId', ... # min: 1, max: 255 | ||
| 92 | ], | ||
| 93 | SubnetIdList => [ | ||
| 94 | 'MySubnetId', ... # max: 255 | ||
| 95 | ], | ||
| 96 | |||
| 97 | }, | ||
| 98 | |||
| 99 | }, # OPTIONAL | ||
| 100 | S3SourceConfig => { | ||
| 101 | RoleArn => 'MyArn', # max: 256 | ||
| 102 | FileFormatDescriptor => { | ||
| 103 | CsvFormatDescriptor => { | ||
| 104 | Charset => 'MyCharset', # max: 63; OPTIONAL | ||
| 105 | ContainsHeader => 1, # OPTIONAL | ||
| 106 | Delimiter => 'MyDelimiter', # max: 1; OPTIONAL | ||
| 107 | FileCompression => 'NONE', # values: NONE, GZIP; OPTIONAL | ||
| 108 | HeaderList => [ | ||
| 109 | 'MyColumnName', ... # min: 1, max: 63 | ||
| 110 | ], # OPTIONAL | ||
| 111 | QuoteSymbol => 'MyQuoteSymbol', # max: 1; OPTIONAL | ||
| 112 | }, # OPTIONAL | ||
| 113 | JsonFormatDescriptor => { | ||
| 114 | Charset => 'MyCharset', # max: 63; OPTIONAL | ||
| 115 | FileCompression => 'NONE', # values: NONE, GZIP; OPTIONAL | ||
| 116 | }, # OPTIONAL | ||
| 117 | }, # OPTIONAL | ||
| 118 | HistoricalDataPathList => [ | ||
| 119 | 'MyHistoricalDataPath', ... # max: 1024 | ||
| 120 | ], # min: 1, max: 1; OPTIONAL | ||
| 121 | TemplatedPathList => [ | ||
| 122 | 'MyTemplatedPath', ... # max: 1024 | ||
| 123 | ], # min: 1, max: 1; OPTIONAL | ||
| 124 | }, # OPTIONAL | ||
| 125 | }, | ||
| 126 | DimensionList => [ | ||
| 127 | 'MyColumnName', ... # min: 1, max: 63 | ||
| 128 | ], # OPTIONAL | ||
| 129 | MetricSetDescription => 'MyMetricSetDescription', # OPTIONAL | ||
| 130 | MetricSetFrequency => 'P1D', # OPTIONAL | ||
| 131 | Offset => 1, # OPTIONAL | ||
| 132 | Tags => { | ||
| 133 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 134 | }, # OPTIONAL | ||
| 135 | TimestampColumn => { | ||
| 136 | ColumnFormat => 'MyDateTimeFormat', # max: 63; OPTIONAL | ||
| 137 | ColumnName => 'MyColumnName', # min: 1, max: 63 | ||
| 138 | }, # OPTIONAL | ||
| 139 | Timezone => 'MyTimezone', # OPTIONAL | ||
| 140 | ); | ||
| 141 | |||
| 142 | # Results: | ||
| 143 | my $MetricSetArn = $CreateMetricSetResponse->MetricSetArn; | ||
| 144 | |||
| 145 | # Returns a L<Paws::LookoutMetrics::CreateMetricSetResponse> object. | ||
| 146 | |||
| 147 | 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. | ||
| 148 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics/CreateMetricSet> | ||
| 149 | |||
| 150 | =head1 ATTRIBUTES | ||
| 151 | |||
| 152 | |||
| 153 | =head2 B<REQUIRED> AnomalyDetectorArn => Str | ||
| 154 | |||
| 155 | The ARN of the anomaly detector that will use the dataset. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head2 DimensionList => ArrayRef[Str|Undef] | ||
| 160 | |||
| 161 | A list of the fields you want to treat as dimensions. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 B<REQUIRED> MetricList => ArrayRef[L<Paws::LookoutMetrics::Metric>] | ||
| 166 | |||
| 167 | A list of metrics that the dataset will contain. | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head2 MetricSetDescription => Str | ||
| 172 | |||
| 173 | A description of the dataset you are creating. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head2 MetricSetFrequency => Str | ||
| 178 | |||
| 179 | The frequency with which the source data will be analyzed for | ||
| 180 | anomalies. | ||
| 181 | |||
| 182 | Valid values are: C<"P1D">, C<"PT1H">, C<"PT10M">, C<"PT5M"> | ||
| 183 | |||
| 184 | =head2 B<REQUIRED> MetricSetName => Str | ||
| 185 | |||
| 186 | The name of the dataset. | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head2 B<REQUIRED> MetricSource => L<Paws::LookoutMetrics::MetricSource> | ||
| 191 | |||
| 192 | Contains information about how the source data should be interpreted. | ||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head2 Offset => Int | ||
| 197 | |||
| 198 | After an interval ends, the amount of seconds that the detector waits | ||
| 199 | before importing data. Offset is only supported for S3 and Redshift | ||
| 200 | datasources. | ||
| 201 | |||
| 202 | |||
| 203 | |||
| 204 | =head2 Tags => L<Paws::LookoutMetrics::TagMap> | ||
| 205 | |||
| 206 | A list of tags | ||
| 207 | (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) | ||
| 208 | to apply to the dataset. | ||
| 209 | |||
| 210 | |||
| 211 | |||
| 212 | =head2 TimestampColumn => L<Paws::LookoutMetrics::TimestampColumn> | ||
| 213 | |||
| 214 | Contains information about the column used for tracking time in your | ||
| 215 | source data. | ||
| 216 | |||
| 217 | |||
| 218 | |||
| 219 | =head2 Timezone => Str | ||
| 220 | |||
| 221 | The time zone in which your source data was recorded. | ||
| 222 | |||
| 223 | |||
| 224 | |||
| 225 | |||
| 226 | =head1 SEE ALSO | ||
| 227 | |||
| 228 | This class forms part of L<Paws>, documenting arguments for method CreateMetricSet in L<Paws::LookoutMetrics> | ||
| 229 | |||
| 230 | =head1 BUGS and CONTRIBUTIONS | ||
| 231 | |||
| 232 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 233 | |||
| 234 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 235 | |||
| 236 | =cut | ||
| 237 |