NAME

Paws::LookoutMetrics::CreateMetricSet - Arguments for method CreateMetricSet on Paws::LookoutMetrics

DESCRIPTION

This class represents the parameters used for calling the method CreateMetricSet on the Amazon Lookout for Metrics service. Use the attributes of this class as arguments to method CreateMetricSet.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateMetricSet.

SYNOPSIS

            

              
              
my $lookoutmetrics = Paws->service('LookoutMetrics');
my $CreateMetricSetResponse = $lookoutmetrics->CreateMetricSet(
  AnomalyDetectorArn => 'MyArn',
  MetricList         => [
    {
      AggregationFunction => 'AVG',             # values: AVG, SUM
      MetricName          => 'MyColumnName',    # min: 1, max: 63
      Namespace           => 'MyNamespace',     # min: 1, max: 255; OPTIONAL
    },
    ...
  ],
  MetricSetName => 'MyMetricSetName',
  MetricSource  => {
    AppFlowConfig => {
      FlowName => 'MyFlowName',                 # max: 256
      RoleArn  => 'MyArn',                      # max: 256
    },    # OPTIONAL
    CloudWatchConfig => {
      RoleArn => 'MyArn',    # max: 256
    },    # OPTIONAL
    RDSSourceConfig => {
      DBInstanceIdentifier => 'MyRDSDatabaseIdentifier',  # min: 1, max: 63
      DatabaseHost         => 'MyDatabaseHost',           # min: 1, max: 253
      DatabaseName         => 'MyRDSDatabaseName',        # min: 1, max: 64
      DatabasePort     => 1,                            # min: 1, max: 65535
      RoleArn          => 'MyArn',                      # max: 256
      SecretManagerArn => 'MyPoirotSecretManagerArn',   # max: 256
      TableName        => 'MyTableName',                # min: 1, max: 100
      VpcConfiguration => {
        SecurityGroupIdList => [
          'MySecurityGroupId', ...                      # min: 1, max: 255
        ],
        SubnetIdList => [
          'MySubnetId', ...                             # max: 255
        ],
      },
    },    # OPTIONAL
    RedshiftSourceConfig => {
      ClusterIdentifier => 'MyRedshiftClusterIdentifier', # min: 1, max: 63
      DatabaseHost      => 'MyDatabaseHost',              # min: 1, max: 253
      DatabaseName      => 'MyRedshiftDatabaseName',      # min: 1, max: 100
      DatabasePort      => 1,                           # min: 1, max: 65535
      RoleArn           => 'MyArn',                     # max: 256
      SecretManagerArn  => 'MyPoirotSecretManagerArn',  # max: 256
      TableName         => 'MyTableName',               # min: 1, max: 100
      VpcConfiguration  => {
        SecurityGroupIdList => [
          'MySecurityGroupId', ...                      # min: 1, max: 255
        ],
        SubnetIdList => [
          'MySubnetId', ...                             # max: 255
        ],
      },
    },    # OPTIONAL
    S3SourceConfig => {
      RoleArn              => 'MyArn',    # max: 256
      FileFormatDescriptor => {
        CsvFormatDescriptor => {
          Charset         => 'MyCharset',     # max: 63; OPTIONAL
          ContainsHeader  => 1,               # OPTIONAL
          Delimiter       => 'MyDelimiter',   # max: 1; OPTIONAL
          FileCompression => 'NONE',          # values: NONE, GZIP; OPTIONAL
          HeaderList      => [
            'MyColumnName', ...               # min: 1, max: 63
          ],    # OPTIONAL
          QuoteSymbol => 'MyQuoteSymbol',    # max: 1; OPTIONAL
        },    # OPTIONAL
        JsonFormatDescriptor => {
          Charset         => 'MyCharset',    # max: 63; OPTIONAL
          FileCompression => 'NONE',         # values: NONE, GZIP; OPTIONAL
        },    # OPTIONAL
      },    # OPTIONAL
      HistoricalDataPathList => [
        'MyHistoricalDataPath', ...    # max: 1024
      ],    # min: 1, max: 1; OPTIONAL
      TemplatedPathList => [
        'MyTemplatedPath', ...    # max: 1024
      ],    # min: 1, max: 1; OPTIONAL
    },    # OPTIONAL
  },
  DimensionList => [
    'MyColumnName', ...    # min: 1, max: 63
  ],    # OPTIONAL
  MetricSetDescription => 'MyMetricSetDescription',    # OPTIONAL
  MetricSetFrequency   => 'P1D',                       # OPTIONAL
  Offset               => 1,                           # OPTIONAL
  Tags                 => {
    'MyTagKey' => 'MyTagValue',    # key: min: 1, max: 128, value: max: 256
  },    # OPTIONAL
  TimestampColumn => {
    ColumnFormat => 'MyDateTimeFormat',    # max: 63; OPTIONAL
    ColumnName   => 'MyColumnName',        # min: 1, max: 63
  },    # OPTIONAL
  Timezone => 'MyTimezone',    # OPTIONAL
);
# Results:
my $MetricSetArn = $CreateMetricSetResponse->MetricSetArn;
# Returns a L<Paws::LookoutMetrics::CreateMetricSetResponse> object.
            
          

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics/CreateMetricSet

ATTRIBUTES

REQUIRED AnomalyDetectorArn => Str

The ARN of the anomaly detector that will use the dataset.

DimensionList => ArrayRef[Str|Undef]

A list of the fields you want to treat as dimensions.

REQUIRED MetricList => ArrayRef[Paws::LookoutMetrics::Metric]

A list of metrics that the dataset will contain.

MetricSetDescription => Str

A description of the dataset you are creating.

MetricSetFrequency => Str

The frequency with which the source data will be analyzed for anomalies.

Valid values are: "P1D", "PT1H", "PT10M", "PT5M"

REQUIRED MetricSetName => Str

The name of the dataset.

REQUIRED MetricSource => Paws::LookoutMetrics::MetricSource

Contains information about how the source data should be interpreted.

Offset => Int

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.

Tags => Paws::LookoutMetrics::TagMap

A list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) to apply to the dataset.

TimestampColumn => Paws::LookoutMetrics::TimestampColumn

Contains information about the column used for tracking time in your source data.

Timezone => Str

The time zone in which your source data was recorded.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateMetricSet in Paws::LookoutMetrics

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws

perl -MCPAN -e shell
install Paws