LookoutMetrics / Client / detect_metric_set_config

detect_metric_set_config#

LookoutMetrics.Client.detect_metric_set_config(**kwargs)#

Detects an Amazon S3 dataset’s file format, interval, and offset.

See also: AWS API Documentation

Request Syntax

response = client.detect_metric_set_config(
    AnomalyDetectorArn='string',
    AutoDetectionMetricSource={
        'S3SourceConfig': {
            'TemplatedPathList': [
                'string',
            ],
            'HistoricalDataPathList': [
                'string',
            ]
        }
    }
)
Parameters:

  • AnomalyDetectorArn (string) –

    [REQUIRED]

    An anomaly detector ARN.

  • AutoDetectionMetricSource (dict) –

    [REQUIRED]

    A data source.

    • S3SourceConfig (dict) –

      The source’s source config.

      • TemplatedPathList (list) –

        The config’s templated path list.

        • (string) –

      • HistoricalDataPathList (list) –

        The config’s historical data path list.

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DetectedMetricSetConfig': {
        'Offset': {
            'Value': {
                'S': 'string',
                'N': 'string',
                'B': 'string',
                'SS': [
                    'string',
                ],
                'NS': [
                    'string',
                ],
                'BS': [
                    'string',
                ]
            },
            'Confidence': 'HIGH'|'LOW'|'NONE',
            'Message': 'string'
        },
        'MetricSetFrequency': {
            'Value': {
                'S': 'string',
                'N': 'string',
                'B': 'string',
                'SS': [
                    'string',
                ],
                'NS': [
                    'string',
                ],
                'BS': [
                    'string',
                ]
            },
            'Confidence': 'HIGH'|'LOW'|'NONE',
            'Message': 'string'
        },
        'MetricSource': {
            'S3SourceConfig': {
                'FileFormatDescriptor': {
                    'CsvFormatDescriptor': {
                        'FileCompression': {
                            'Value': {
                                'S': 'string',
                                'N': 'string',
                                'B': 'string',
                                'SS': [
                                    'string',
                                ],
                                'NS': [
                                    'string',
                                ],
                                'BS': [
                                    'string',
                                ]
                            },
                            'Confidence': 'HIGH'|'LOW'|'NONE',
                            'Message': 'string'
                        },
                        'Charset': {
                            'Value': {
                                'S': 'string',
                                'N': 'string',
                                'B': 'string',
                                'SS': [
                                    'string',
                                ],
                                'NS': [
                                    'string',
                                ],
                                'BS': [
                                    'string',
                                ]
                            },
                            'Confidence': 'HIGH'|'LOW'|'NONE',
                            'Message': 'string'
                        },
                        'ContainsHeader': {
                            'Value': {
                                'S': 'string',
                                'N': 'string',
                                'B': 'string',
                                'SS': [
                                    'string',
                                ],
                                'NS': [
                                    'string',
                                ],
                                'BS': [
                                    'string',
                                ]
                            },
                            'Confidence': 'HIGH'|'LOW'|'NONE',
                            'Message': 'string'
                        },
                        'Delimiter': {
                            'Value': {
                                'S': 'string',
                                'N': 'string',
                                'B': 'string',
                                'SS': [
                                    'string',
                                ],
                                'NS': [
                                    'string',
                                ],
                                'BS': [
                                    'string',
                                ]
                            },
                            'Confidence': 'HIGH'|'LOW'|'NONE',
                            'Message': 'string'
                        },
                        'HeaderList': {
                            'Value': {
                                'S': 'string',
                                'N': 'string',
                                'B': 'string',
                                'SS': [
                                    'string',
                                ],
                                'NS': [
                                    'string',
                                ],
                                'BS': [
                                    'string',
                                ]
                            },
                            'Confidence': 'HIGH'|'LOW'|'NONE',
                            'Message': 'string'
                        },
                        'QuoteSymbol': {
                            'Value': {
                                'S': 'string',
                                'N': 'string',
                                'B': 'string',
                                'SS': [
                                    'string',
                                ],
                                'NS': [
                                    'string',
                                ],
                                'BS': [
                                    'string',
                                ]
                            },
                            'Confidence': 'HIGH'|'LOW'|'NONE',
                            'Message': 'string'
                        }
                    },
                    'JsonFormatDescriptor': {
                        'FileCompression': {
                            'Value': {
                                'S': 'string',
                                'N': 'string',
                                'B': 'string',
                                'SS': [
                                    'string',
                                ],
                                'NS': [
                                    'string',
                                ],
                                'BS': [
                                    'string',
                                ]
                            },
                            'Confidence': 'HIGH'|'LOW'|'NONE',
                            'Message': 'string'
                        },
                        'Charset': {
                            'Value': {
                                'S': 'string',
                                'N': 'string',
                                'B': 'string',
                                'SS': [
                                    'string',
                                ],
                                'NS': [
                                    'string',
                                ],
                                'BS': [
                                    'string',
                                ]
                            },
                            'Confidence': 'HIGH'|'LOW'|'NONE',
                            'Message': 'string'
                        }
                    }
                }
            }
        }
    }
}

Response Structure

  • (dict) –

    • DetectedMetricSetConfig (dict) –

      The inferred dataset configuration for the datasource.

      • Offset (dict) –

        The dataset’s offset.

        • Value (dict) –

          The field’s value.

          • S (string) –

            A string.

          • N (string) –

            A number.

          • B (string) –

            A binary value.

          • SS (list) –

            A list of strings.

            • (string) –

          • NS (list) –

            A list of numbers.

            • (string) –

          • BS (list) –

            A list of binary values.

            • (string) –

        • Confidence (string) –

          The field’s confidence.

        • Message (string) –

          The field’s message.

      • MetricSetFrequency (dict) –

        The dataset’s interval.

        • Value (dict) –

          The field’s value.

          • S (string) –

            A string.

          • N (string) –

            A number.

          • B (string) –

            A binary value.

          • SS (list) –

            A list of strings.

            • (string) –

          • NS (list) –

            A list of numbers.

            • (string) –

          • BS (list) –

            A list of binary values.

            • (string) –

        • Confidence (string) –

          The field’s confidence.

        • Message (string) –

          The field’s message.

      • MetricSource (dict) –

        The dataset’s data source.

        • S3SourceConfig (dict) –

          The data source’s source configuration.

          • FileFormatDescriptor (dict) –

            The source’s file format descriptor.

            • CsvFormatDescriptor (dict) –

              Details about a CSV format.

              • FileCompression (dict) –

                The format’s file compression.

                • Value (dict) –

                  The field’s value.

                  • S (string) –

                    A string.

                  • N (string) –

                    A number.

                  • B (string) –

                    A binary value.

                  • SS (list) –

                    A list of strings.

                    • (string) –

                  • NS (list) –

                    A list of numbers.

                    • (string) –

                  • BS (list) –

                    A list of binary values.

                    • (string) –

                • Confidence (string) –

                  The field’s confidence.

                • Message (string) –

                  The field’s message.

              • Charset (dict) –

                The format’s charset.

                • Value (dict) –

                  The field’s value.

                  • S (string) –

                    A string.

                  • N (string) –

                    A number.

                  • B (string) –

                    A binary value.

                  • SS (list) –

                    A list of strings.

                    • (string) –

                  • NS (list) –

                    A list of numbers.

                    • (string) –

                  • BS (list) –

                    A list of binary values.

                    • (string) –

                • Confidence (string) –

                  The field’s confidence.

                • Message (string) –

                  The field’s message.

              • ContainsHeader (dict) –

                Whether the format includes a header.

                • Value (dict) –

                  The field’s value.

                  • S (string) –

                    A string.

                  • N (string) –

                    A number.

                  • B (string) –

                    A binary value.

                  • SS (list) –

                    A list of strings.

                    • (string) –

                  • NS (list) –

                    A list of numbers.

                    • (string) –

                  • BS (list) –

                    A list of binary values.

                    • (string) –

                • Confidence (string) –

                  The field’s confidence.

                • Message (string) –

                  The field’s message.

              • Delimiter (dict) –

                The format’s delimiter.

                • Value (dict) –

                  The field’s value.

                  • S (string) –

                    A string.

                  • N (string) –

                    A number.

                  • B (string) –

                    A binary value.

                  • SS (list) –

                    A list of strings.

                    • (string) –

                  • NS (list) –

                    A list of numbers.

                    • (string) –

                  • BS (list) –

                    A list of binary values.

                    • (string) –

                • Confidence (string) –

                  The field’s confidence.

                • Message (string) –

                  The field’s message.

              • HeaderList (dict) –

                The format’s header list.

                • Value (dict) –

                  The field’s value.

                  • S (string) –

                    A string.

                  • N (string) –

                    A number.

                  • B (string) –

                    A binary value.

                  • SS (list) –

                    A list of strings.

                    • (string) –

                  • NS (list) –

                    A list of numbers.

                    • (string) –

                  • BS (list) –

                    A list of binary values.

                    • (string) –

                • Confidence (string) –

                  The field’s confidence.

                • Message (string) –

                  The field’s message.

              • QuoteSymbol (dict) –

                The format’s quote symbol.

                • Value (dict) –

                  The field’s value.

                  • S (string) –

                    A string.

                  • N (string) –

                    A number.

                  • B (string) –

                    A binary value.

                  • SS (list) –

                    A list of strings.

                    • (string) –

                  • NS (list) –

                    A list of numbers.

                    • (string) –

                  • BS (list) –

                    A list of binary values.

                    • (string) –

                • Confidence (string) –

                  The field’s confidence.

                • Message (string) –

                  The field’s message.

            • JsonFormatDescriptor (dict) –

              Details about a JSON format.

              • FileCompression (dict) –

                The format’s file compression.

                • Value (dict) –

                  The field’s value.

                  • S (string) –

                    A string.

                  • N (string) –

                    A number.

                  • B (string) –

                    A binary value.

                  • SS (list) –

                    A list of strings.

                    • (string) –

                  • NS (list) –

                    A list of numbers.

                    • (string) –

                  • BS (list) –

                    A list of binary values.

                    • (string) –

                • Confidence (string) –

                  The field’s confidence.

                • Message (string) –

                  The field’s message.

              • Charset (dict) –

                The format’s character set.

                • Value (dict) –

                  The field’s value.

                  • S (string) –

                    A string.

                  • N (string) –

                    A number.

                  • B (string) –

                    A binary value.

                  • SS (list) –

                    A list of strings.

                    • (string) –

                  • NS (list) –

                    A list of numbers.

                    • (string) –

                  • BS (list) –

                    A list of binary values.

                    • (string) –

                • Confidence (string) –

                  The field’s confidence.

                • Message (string) –

                  The field’s message.

Exceptions