AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::LookoutMetrics::Types::CreateMetricSetRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb

Overview

Note:

When making an API call, you may pass CreateMetricSetRequest data as a hash:

{
  anomaly_detector_arn: "Arn", # required
  metric_set_name: "MetricSetName", # required
  metric_set_description: "MetricSetDescription",
  metric_list: [ # required
    {
      metric_name: "ColumnName", # required
      aggregation_function: "AVG", # required, accepts AVG, SUM
      namespace: "Namespace",
    },
  ],
  offset: 1,
  timestamp_column: {
    column_name: "ColumnName",
    column_format: "DateTimeFormat",
  },
  dimension_list: ["ColumnName"],
  metric_set_frequency: "P1D", # accepts P1D, PT1H, PT10M, PT5M
  metric_source: { # required
    s3_source_config: {
      role_arn: "Arn", # required
      templated_path_list: ["TemplatedPath"],
      historical_data_path_list: ["HistoricalDataPath"],
      file_format_descriptor: {
        csv_format_descriptor: {
          file_compression: "NONE", # accepts NONE, GZIP
          charset: "Charset",
          contains_header: false,
          delimiter: "Delimiter",
          header_list: ["ColumnName"],
          quote_symbol: "QuoteSymbol",
        },
        json_format_descriptor: {
          file_compression: "NONE", # accepts NONE, GZIP
          charset: "Charset",
        },
      },
    },
    app_flow_config: {
      role_arn: "Arn", # required
      flow_name: "FlowName", # required
    },
    cloud_watch_config: {
      role_arn: "Arn", # required
    },
    rds_source_config: {
      db_instance_identifier: "RDSDatabaseIdentifier", # required
      database_host: "DatabaseHost", # required
      database_port: 1, # required
      secret_manager_arn: "PoirotSecretManagerArn", # required
      database_name: "RDSDatabaseName", # required
      table_name: "TableName", # required
      role_arn: "Arn", # required
      vpc_configuration: { # required
        subnet_id_list: ["SubnetId"], # required
        security_group_id_list: ["SecurityGroupId"], # required
      },
    },
    redshift_source_config: {
      cluster_identifier: "RedshiftClusterIdentifier", # required
      database_host: "DatabaseHost", # required
      database_port: 1, # required
      secret_manager_arn: "PoirotSecretManagerArn", # required
      database_name: "RedshiftDatabaseName", # required
      table_name: "TableName", # required
      role_arn: "Arn", # required
      vpc_configuration: { # required
        subnet_id_list: ["SubnetId"], # required
        security_group_id_list: ["SecurityGroupId"], # required
      },
    },
  },
  timezone: "Timezone",
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#anomaly_detector_arnString

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

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#dimension_listArray<String>

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

Returns:

  • (Array<String>)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#metric_listArray<Types::Metric>

A list of metrics that the dataset will contain.

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#metric_set_descriptionString

A description of the dataset you are creating.

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#metric_set_frequencyString

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

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#metric_set_nameString

The name of the dataset.

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#metric_sourceTypes::MetricSource

Contains information about how the source data should be interpreted.

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#offsetInteger

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

Returns:

  • (Integer)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

A list of tags to apply to the dataset.

Returns:

  • (Hash<String,String>)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp_columnTypes::TimestampColumn

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



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#timezoneString

The time zone in which your source data was recorded.

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/types.rb', line 826

class CreateMetricSetRequest < Struct.new(
  :anomaly_detector_arn,
  :metric_set_name,
  :metric_set_description,
  :metric_list,
  :offset,
  :timestamp_column,
  :dimension_list,
  :metric_set_frequency,
  :metric_source,
  :timezone,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end