« blib/lib/Paws/CloudWatch/PartialFailure.pm
↑ Summary
blib/lib/Paws/CloudWatch/PutAnomalyDetectorOutput.pm »
| 1 | |||
| 2 | package Paws::CloudWatch::PutAnomalyDetector; | ||
| 3 | use Moose; | ||
| 4 | has Configuration => (is => 'ro', isa => 'Paws::CloudWatch::AnomalyDetectorConfiguration'); | ||
| 5 | has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatch::Dimension]'); | ||
| 6 | has MetricName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Namespace => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Stat => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutAnomalyDetector'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatch::PutAnomalyDetectorOutput'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'PutAnomalyDetectorResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CloudWatch::PutAnomalyDetector - Arguments for method PutAnomalyDetector on L<Paws::CloudWatch> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method PutAnomalyDetector on the | ||
| 26 | L<Amazon CloudWatch|Paws::CloudWatch> service. Use the attributes of this class | ||
| 27 | as arguments to method PutAnomalyDetector. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutAnomalyDetector. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $monitoring = Paws->service('CloudWatch'); | ||
| 34 | my $PutAnomalyDetectorOutput = $monitoring->PutAnomalyDetector( | ||
| 35 | MetricName => 'MyMetricName', | ||
| 36 | Namespace => 'MyNamespace', | ||
| 37 | Stat => 'MyAnomalyDetectorMetricStat', | ||
| 38 | Configuration => { | ||
| 39 | ExcludedTimeRanges => [ | ||
| 40 | { | ||
| 41 | EndTime => '1970-01-01T01:00:00', | ||
| 42 | StartTime => '1970-01-01T01:00:00', | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], # OPTIONAL | ||
| 47 | MetricTimezone => 'MyAnomalyDetectorMetricTimezone', # max: 50; OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | Dimensions => [ | ||
| 50 | { | ||
| 51 | Name => 'MyDimensionName', # min: 1, max: 255 | ||
| 52 | Value => 'MyDimensionValue', # min: 1, max: 255 | ||
| 53 | |||
| 54 | }, | ||
| 55 | ... | ||
| 56 | ], # OPTIONAL | ||
| 57 | ); | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/monitoring/PutAnomalyDetector> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 Configuration => L<Paws::CloudWatch::AnomalyDetectorConfiguration> | ||
| 66 | |||
| 67 | The configuration specifies details about how the anomaly detection | ||
| 68 | model is to be trained, including time ranges to exclude when training | ||
| 69 | and updating the model. You can specify as many as 10 time ranges. | ||
| 70 | |||
| 71 | The configuration can also include the time zone to use for the metric. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>] | ||
| 76 | |||
| 77 | The metric dimensions to create the anomaly detection model for. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> MetricName => Str | ||
| 82 | |||
| 83 | The name of the metric to create the anomaly detection model for. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> Namespace => Str | ||
| 88 | |||
| 89 | The namespace of the metric to create the anomaly detection model for. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> Stat => Str | ||
| 94 | |||
| 95 | The statistic to use for the metric and the anomaly detection model. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, documenting arguments for method PutAnomalyDetector in L<Paws::CloudWatch> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |