LookoutMetrics

Client

class LookoutMetrics.Client

A low-level client representing Amazon Lookout for Metrics (LookoutMetrics)

This is the Amazon Lookout for Metrics API Reference . For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics Developer Guide.

client = session.create_client('lookoutmetrics')

These are the available methods:

activate_anomaly_detector(**kwargs)

Activates an anomaly detector.

See also: AWS API Documentation

Request Syntax

response = client.activate_anomaly_detector(
    AnomalyDetectorArn='string'
)
Parameters
AnomalyDetectorArn (string) --

[REQUIRED]

The ARN of the anomaly detector.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

back_test_anomaly_detector(**kwargs)

Runs a backtest for anomaly detection for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.back_test_anomaly_detector(
    AnomalyDetectorArn='string'
)
Parameters
AnomalyDetectorArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the anomaly detector.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_alert(**kwargs)

Creates an alert for an anomaly detector.

See also: AWS API Documentation

Request Syntax

response = client.create_alert(
    AlertName='string',
    AlertSensitivityThreshold=123,
    AlertDescription='string',
    AnomalyDetectorArn='string',
    Action={
        'SNSConfiguration': {
            'RoleArn': 'string',
            'SnsTopicArn': 'string',
            'SnsFormat': 'LONG_TEXT'|'SHORT_TEXT'|'JSON'
        },
        'LambdaConfiguration': {
            'RoleArn': 'string',
            'LambdaArn': 'string'
        }
    },
    Tags={
        'string': 'string'
    },
    AlertFilters={
        'MetricList': [
            'string',
        ],
        'DimensionFilterList': [
            {
                'DimensionName': 'string',
                'DimensionValueList': [
                    'string',
                ]
            },
        ]
    }
)
Parameters
  • AlertName (string) --

    [REQUIRED]

    The name of the alert.

  • AlertSensitivityThreshold (integer) -- An integer from 0 to 100 specifying the alert sensitivity threshold.
  • AlertDescription (string) -- A description of the alert.
  • AnomalyDetectorArn (string) --

    [REQUIRED]

    The ARN of the detector to which the alert is attached.

  • Action (dict) --

    [REQUIRED]

    Action that will be triggered when there is an alert.

    • SNSConfiguration (dict) --

      A configuration for an Amazon SNS channel.

      • RoleArn (string) -- [REQUIRED]

        The ARN of the IAM role that has access to the target SNS topic.

      • SnsTopicArn (string) -- [REQUIRED]

        The ARN of the target SNS topic.

      • SnsFormat (string) --

        The format of the SNS topic.

        • JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.
        • LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.
        • SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.
    • LambdaConfiguration (dict) --

      A configuration for an AWS Lambda channel.

      • RoleArn (string) -- [REQUIRED]

        The ARN of an IAM role that has permission to invoke the Lambda function.

      • LambdaArn (string) -- [REQUIRED]

        The ARN of the Lambda function.

  • Tags (dict) --

    A list of tags to apply to the alert.

    • (string) --
      • (string) --
  • AlertFilters (dict) --

    The configuration of the alert filters, containing MetricList and DimensionFilterList.

    • MetricList (list) --

      The list of measures that you want to get alerts for.

      • (string) --
    • DimensionFilterList (list) --

      The list of DimensionFilter objects that are used for dimension-based filtering.

      • (dict) --

        The dimension filter, containing DimensionName and DimensionValueList.

        • DimensionName (string) --

          The name of the dimension to filter on.

        • DimensionValueList (list) --

          The list of values for the dimension specified in DimensionName that you want to filter on.

          • (string) --
Return type

dict

Returns

Response Syntax

{
    'AlertArn': 'string'
}

Response Structure

  • (dict) --

    • AlertArn (string) --

      The ARN of the alert.

Exceptions

create_anomaly_detector(**kwargs)

Creates an anomaly detector.

See also: AWS API Documentation

Request Syntax

response = client.create_anomaly_detector(
    AnomalyDetectorName='string',
    AnomalyDetectorDescription='string',
    AnomalyDetectorConfig={
        'AnomalyDetectorFrequency': 'P1D'|'PT1H'|'PT10M'|'PT5M'
    },
    KmsKeyArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • AnomalyDetectorName (string) --

    [REQUIRED]

    The name of the detector.

  • AnomalyDetectorDescription (string) -- A description of the detector.
  • AnomalyDetectorConfig (dict) --

    [REQUIRED]

    Contains information about the configuration of the anomaly detector.

    • AnomalyDetectorFrequency (string) --

      The frequency at which the detector analyzes its source data.

  • KmsKeyArn (string) -- The ARN of the KMS key to use to encrypt your data.
  • Tags (dict) --

    A list of tags to apply to the anomaly detector.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'AnomalyDetectorArn': 'string'
}

Response Structure

  • (dict) --

    • AnomalyDetectorArn (string) --

      The ARN of the detector.

Exceptions

create_metric_set(**kwargs)

Creates a dataset.

See also: AWS API Documentation

Request Syntax

response = client.create_metric_set(
    AnomalyDetectorArn='string',
    MetricSetName='string',
    MetricSetDescription='string',
    MetricList=[
        {
            'MetricName': 'string',
            'AggregationFunction': 'AVG'|'SUM',
            'Namespace': 'string'
        },
    ],
    Offset=123,
    TimestampColumn={
        'ColumnName': 'string',
        'ColumnFormat': 'string'
    },
    DimensionList=[
        'string',
    ],
    MetricSetFrequency='P1D'|'PT1H'|'PT10M'|'PT5M',
    MetricSource={
        'S3SourceConfig': {
            'RoleArn': 'string',
            'TemplatedPathList': [
                'string',
            ],
            'HistoricalDataPathList': [
                'string',
            ],
            'FileFormatDescriptor': {
                'CsvFormatDescriptor': {
                    'FileCompression': 'NONE'|'GZIP',
                    'Charset': 'string',
                    'ContainsHeader': True|False,
                    'Delimiter': 'string',
                    'HeaderList': [
                        'string',
                    ],
                    'QuoteSymbol': 'string'
                },
                'JsonFormatDescriptor': {
                    'FileCompression': 'NONE'|'GZIP',
                    'Charset': 'string'
                }
            }
        },
        'AppFlowConfig': {
            'RoleArn': 'string',
            'FlowName': 'string'
        },
        'CloudWatchConfig': {
            'RoleArn': 'string',
            'BackTestConfiguration': {
                'RunBackTestMode': True|False
            }
        },
        'RDSSourceConfig': {
            'DBInstanceIdentifier': 'string',
            'DatabaseHost': 'string',
            'DatabasePort': 123,
            'SecretManagerArn': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'RoleArn': 'string',
            'VpcConfiguration': {
                'SubnetIdList': [
                    'string',
                ],
                'SecurityGroupIdList': [
                    'string',
                ]
            }
        },
        'RedshiftSourceConfig': {
            'ClusterIdentifier': 'string',
            'DatabaseHost': 'string',
            'DatabasePort': 123,
            'SecretManagerArn': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'RoleArn': 'string',
            'VpcConfiguration': {
                'SubnetIdList': [
                    'string',
                ],
                'SecurityGroupIdList': [
                    'string',
                ]
            }
        },
        'AthenaSourceConfig': {
            'RoleArn': 'string',
            'DatabaseName': 'string',
            'DataCatalog': 'string',
            'TableName': 'string',
            'WorkGroupName': 'string',
            'S3ResultsPath': 'string',
            'BackTestConfiguration': {
                'RunBackTestMode': True|False
            }
        }
    },
    Timezone='string',
    Tags={
        'string': 'string'
    },
    DimensionFilterList=[
        {
            'Name': 'string',
            'FilterList': [
                {
                    'DimensionValue': 'string',
                    'FilterOperation': 'EQUALS'
                },
            ]
        },
    ]
)
Parameters
  • AnomalyDetectorArn (string) --

    [REQUIRED]

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

  • MetricSetName (string) --

    [REQUIRED]

    The name of the dataset.

  • MetricSetDescription (string) -- A description of the dataset you are creating.
  • MetricList (list) --

    [REQUIRED]

    A list of metrics that the dataset will contain.

    • (dict) --

      A calculation made by contrasting a measure and a dimension from your source data.

      • MetricName (string) -- [REQUIRED]

        The name of the metric.

      • AggregationFunction (string) -- [REQUIRED]

        The function with which the metric is calculated.

      • Namespace (string) --

        The namespace for the metric.

  • Offset (integer) -- After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
  • TimestampColumn (dict) --

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

    • ColumnName (string) --

      The name of the timestamp column.

    • ColumnFormat (string) --

      The format of the timestamp column.

  • DimensionList (list) --

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

    • (string) --
  • MetricSetFrequency (string) -- The frequency with which the source data will be analyzed for anomalies.
  • MetricSource (dict) --

    [REQUIRED]

    Contains information about how the source data should be interpreted.

    • S3SourceConfig (dict) --

      Contains information about the configuration of the S3 bucket that contains source files.

      • RoleArn (string) --

        The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

      • TemplatedPathList (list) --

        A list of templated paths to the source files.

        • (string) --
      • HistoricalDataPathList (list) --

        A list of paths to the historical data files.

        • (string) --
      • FileFormatDescriptor (dict) --

        Contains information about a source file's formatting.

        • CsvFormatDescriptor (dict) --

          Contains information about how a source CSV data file should be analyzed.

          • FileCompression (string) --

            The level of compression of the source CSV file.

          • Charset (string) --

            The character set in which the source CSV file is written.

          • ContainsHeader (boolean) --

            Whether or not the source CSV file contains a header.

          • Delimiter (string) --

            The character used to delimit the source CSV file.

          • HeaderList (list) --

            A list of the source CSV file's headers, if any.

            • (string) --
          • QuoteSymbol (string) --

            The character used as a quote character.

        • JsonFormatDescriptor (dict) --

          Contains information about how a source JSON data file should be analyzed.

          • FileCompression (string) --

            The level of compression of the source CSV file.

          • Charset (string) --

            The character set in which the source JSON file is written.

    • AppFlowConfig (dict) --

      Details about an AppFlow datasource.

      • RoleArn (string) --

        An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

      • FlowName (string) --

        name of the flow.

    • CloudWatchConfig (dict) --

      Details about an Amazon CloudWatch monitoring datasource.

      • RoleArn (string) --

        An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

      • BackTestConfiguration (dict) --

        Settings for backtest mode.

        • RunBackTestMode (boolean) -- [REQUIRED]

          Run a backtest instead of monitoring new data.

    • RDSSourceConfig (dict) --

      Details about an Amazon Relational Database Service (RDS) datasource.

      • DBInstanceIdentifier (string) --

        A string identifying the database instance.

      • DatabaseHost (string) --

        The host name of the database.

      • DatabasePort (integer) --

        The port number where the database can be accessed.

      • SecretManagerArn (string) --

        The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

      • DatabaseName (string) --

        The name of the RDS database.

      • TableName (string) --

        The name of the table in the database.

      • RoleArn (string) --

        The Amazon Resource Name (ARN) of the role.

      • VpcConfiguration (dict) --

        An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

        • SubnetIdList (list) -- [REQUIRED]

          An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .

          • (string) --
        • SecurityGroupIdList (list) -- [REQUIRED]

          An array of strings containing the list of security groups.

          • (string) --
    • RedshiftSourceConfig (dict) --

      Details about an Amazon Redshift database datasource.

      • ClusterIdentifier (string) --

        A string identifying the Redshift cluster.

      • DatabaseHost (string) --

        The name of the database host.

      • DatabasePort (integer) --

        The port number where the database can be accessed.

      • SecretManagerArn (string) --

        The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

      • DatabaseName (string) --

        The Redshift database name.

      • TableName (string) --

        The table name of the Redshift database.

      • RoleArn (string) --

        The Amazon Resource Name (ARN) of the role providing access to the database.

      • VpcConfiguration (dict) --

        Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

        • SubnetIdList (list) -- [REQUIRED]

          An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .

          • (string) --
        • SecurityGroupIdList (list) -- [REQUIRED]

          An array of strings containing the list of security groups.

          • (string) --
    • AthenaSourceConfig (dict) --

      Details about an Amazon Athena datasource.

      • RoleArn (string) --

        An IAM role that gives Amazon Lookout for Metrics permission to access the data.

      • DatabaseName (string) --

        The database's name.

      • DataCatalog (string) --

        The database's data catalog.

      • TableName (string) --

        The database's table name.

      • WorkGroupName (string) --

        The database's work group name.

      • S3ResultsPath (string) --

        The database's results path.

      • BackTestConfiguration (dict) --

        Settings for backtest mode.

        • RunBackTestMode (boolean) -- [REQUIRED]

          Run a backtest instead of monitoring new data.

  • Timezone (string) -- The time zone in which your source data was recorded.
  • Tags (dict) --

    A list of tags to apply to the dataset.

    • (string) --
      • (string) --
  • DimensionFilterList (list) --

    A list of filters that specify which data is kept for anomaly detection.

    • (dict) --

      Describes a list of filters for choosing a subset of dimension values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

      • Name (string) --

        The dimension that you want to filter on.

      • FilterList (list) --

        The list of filters that you are applying.

        • (dict) --

          Describes a filter for choosing a subset of dimension values. Each filter consists of the dimension that you want to include and the condition statement. The condition statement is specified in the FilterOperation object.

          • DimensionValue (string) --

            The value that you want to include in the filter.

          • FilterOperation (string) --

            The condition to apply.

Return type

dict

Returns

Response Syntax

{
    'MetricSetArn': 'string'
}

Response Structure

  • (dict) --

    • MetricSetArn (string) --

      The ARN of the dataset.

Exceptions

deactivate_anomaly_detector(**kwargs)

Deactivates an anomaly detector.

See also: AWS API Documentation

Request Syntax

response = client.deactivate_anomaly_detector(
    AnomalyDetectorArn='string'
)
Parameters
AnomalyDetectorArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the anomaly detector.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_alert(**kwargs)

Deletes an alert.

See also: AWS API Documentation

Request Syntax

response = client.delete_alert(
    AlertArn='string'
)
Parameters
AlertArn (string) --

[REQUIRED]

The ARN of the alert to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_anomaly_detector(**kwargs)

Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.

See also: AWS API Documentation

Request Syntax

response = client.delete_anomaly_detector(
    AnomalyDetectorArn='string'
)
Parameters
AnomalyDetectorArn (string) --

[REQUIRED]

The ARN of the detector to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

describe_alert(**kwargs)

Describes an alert.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

See also: AWS API Documentation

Request Syntax

response = client.describe_alert(
    AlertArn='string'
)
Parameters
AlertArn (string) --

[REQUIRED]

The ARN of the alert to describe.

Return type
dict
Returns
Response Syntax
{
    'Alert': {
        'Action': {
            'SNSConfiguration': {
                'RoleArn': 'string',
                'SnsTopicArn': 'string',
                'SnsFormat': 'LONG_TEXT'|'SHORT_TEXT'|'JSON'
            },
            'LambdaConfiguration': {
                'RoleArn': 'string',
                'LambdaArn': 'string'
            }
        },
        'AlertDescription': 'string',
        'AlertArn': 'string',
        'AnomalyDetectorArn': 'string',
        'AlertName': 'string',
        'AlertSensitivityThreshold': 123,
        'AlertType': 'SNS'|'LAMBDA',
        'AlertStatus': 'ACTIVE'|'INACTIVE',
        'LastModificationTime': datetime(2015, 1, 1),
        'CreationTime': datetime(2015, 1, 1),
        'AlertFilters': {
            'MetricList': [
                'string',
            ],
            'DimensionFilterList': [
                {
                    'DimensionName': 'string',
                    'DimensionValueList': [
                        'string',
                    ]
                },
            ]
        }
    }
}

Response Structure

  • (dict) --
    • Alert (dict) --

      Contains information about an alert.

      • Action (dict) --

        Action that will be triggered when there is an alert.

        • SNSConfiguration (dict) --

          A configuration for an Amazon SNS channel.

          • RoleArn (string) --

            The ARN of the IAM role that has access to the target SNS topic.

          • SnsTopicArn (string) --

            The ARN of the target SNS topic.

          • SnsFormat (string) --

            The format of the SNS topic.

            • JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.
            • LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.
            • SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.
        • LambdaConfiguration (dict) --

          A configuration for an AWS Lambda channel.

          • RoleArn (string) --

            The ARN of an IAM role that has permission to invoke the Lambda function.

          • LambdaArn (string) --

            The ARN of the Lambda function.

      • AlertDescription (string) --

        A description of the alert.

      • AlertArn (string) --

        The ARN of the alert.

      • AnomalyDetectorArn (string) --

        The ARN of the detector to which the alert is attached.

      • AlertName (string) --

        The name of the alert.

      • AlertSensitivityThreshold (integer) --

        The minimum severity for an anomaly to trigger the alert.

      • AlertType (string) --

        The type of the alert.

      • AlertStatus (string) --

        The status of the alert.

      • LastModificationTime (datetime) --

        The time at which the alert was last modified.

      • CreationTime (datetime) --

        The time at which the alert was created.

      • AlertFilters (dict) --

        The configuration of the alert filters, containing MetricList and DimensionFilter.

        • MetricList (list) --

          The list of measures that you want to get alerts for.

          • (string) --
        • DimensionFilterList (list) --

          The list of DimensionFilter objects that are used for dimension-based filtering.

          • (dict) --

            The dimension filter, containing DimensionName and DimensionValueList.

            • DimensionName (string) --

              The name of the dimension to filter on.

            • DimensionValueList (list) --

              The list of values for the dimension specified in DimensionName that you want to filter on.

              • (string) --

Exceptions

describe_anomaly_detection_executions(**kwargs)

Returns information about the status of the specified anomaly detection jobs.

See also: AWS API Documentation

Request Syntax

response = client.describe_anomaly_detection_executions(
    AnomalyDetectorArn='string',
    Timestamp='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AnomalyDetectorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the anomaly detector.

  • Timestamp (string) -- The timestamp of the anomaly detection job.
  • MaxResults (integer) -- The number of items to return in the response.
  • NextToken (string) -- Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'ExecutionList': [
        {
            'Timestamp': 'string',
            'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE',
            'FailureReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ExecutionList (list) --

      A list of detection jobs.

      • (dict) --

        The status of an anomaly detector run.

        • Timestamp (string) --

          The run's timestamp.

        • Status (string) --

          The run's status.

        • FailureReason (string) --

          The reason that the run failed, if applicable.

    • NextToken (string) --

      The pagination token that's included if more results are available.

Exceptions

describe_anomaly_detector(**kwargs)

Describes a detector.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

See also: AWS API Documentation

Request Syntax

response = client.describe_anomaly_detector(
    AnomalyDetectorArn='string'
)
Parameters
AnomalyDetectorArn (string) --

[REQUIRED]

The ARN of the detector to describe.

Return type
dict
Returns
Response Syntax
{
    'AnomalyDetectorArn': 'string',
    'AnomalyDetectorName': 'string',
    'AnomalyDetectorDescription': 'string',
    'AnomalyDetectorConfig': {
        'AnomalyDetectorFrequency': 'P1D'|'PT1H'|'PT10M'|'PT5M'
    },
    'CreationTime': datetime(2015, 1, 1),
    'LastModificationTime': datetime(2015, 1, 1),
    'Status': 'ACTIVE'|'ACTIVATING'|'DELETING'|'FAILED'|'INACTIVE'|'LEARNING'|'BACK_TEST_ACTIVATING'|'BACK_TEST_ACTIVE'|'BACK_TEST_COMPLETE'|'DEACTIVATED'|'DEACTIVATING',
    'FailureReason': 'string',
    'KmsKeyArn': 'string',
    'FailureType': 'ACTIVATION_FAILURE'|'BACK_TEST_ACTIVATION_FAILURE'|'DELETION_FAILURE'|'DEACTIVATION_FAILURE'
}

Response Structure

  • (dict) --
    • AnomalyDetectorArn (string) --

      The ARN of the detector.

    • AnomalyDetectorName (string) --

      The name of the detector.

    • AnomalyDetectorDescription (string) --

      A description of the detector.

    • AnomalyDetectorConfig (dict) --

      Contains information about the detector's configuration.

      • AnomalyDetectorFrequency (string) --

        The interval at which the detector analyzes its source data.

    • CreationTime (datetime) --

      The time at which the detector was created.

    • LastModificationTime (datetime) --

      The time at which the detector was last modified.

    • Status (string) --

      The status of the detector.

    • FailureReason (string) --

      The reason that the detector failed.

    • KmsKeyArn (string) --

      The ARN of the KMS key to use to encrypt your data.

    • FailureType (string) --

      The process that caused the detector to fail.

Exceptions

describe_metric_set(**kwargs)

Describes a dataset.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

See also: AWS API Documentation

Request Syntax

response = client.describe_metric_set(
    MetricSetArn='string'
)
Parameters
MetricSetArn (string) --

[REQUIRED]

The ARN of the dataset.

Return type
dict
Returns
Response Syntax
{
    'MetricSetArn': 'string',
    'AnomalyDetectorArn': 'string',
    'MetricSetName': 'string',
    'MetricSetDescription': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModificationTime': datetime(2015, 1, 1),
    'Offset': 123,
    'MetricList': [
        {
            'MetricName': 'string',
            'AggregationFunction': 'AVG'|'SUM',
            'Namespace': 'string'
        },
    ],
    'TimestampColumn': {
        'ColumnName': 'string',
        'ColumnFormat': 'string'
    },
    'DimensionList': [
        'string',
    ],
    'MetricSetFrequency': 'P1D'|'PT1H'|'PT10M'|'PT5M',
    'Timezone': 'string',
    'MetricSource': {
        'S3SourceConfig': {
            'RoleArn': 'string',
            'TemplatedPathList': [
                'string',
            ],
            'HistoricalDataPathList': [
                'string',
            ],
            'FileFormatDescriptor': {
                'CsvFormatDescriptor': {
                    'FileCompression': 'NONE'|'GZIP',
                    'Charset': 'string',
                    'ContainsHeader': True|False,
                    'Delimiter': 'string',
                    'HeaderList': [
                        'string',
                    ],
                    'QuoteSymbol': 'string'
                },
                'JsonFormatDescriptor': {
                    'FileCompression': 'NONE'|'GZIP',
                    'Charset': 'string'
                }
            }
        },
        'AppFlowConfig': {
            'RoleArn': 'string',
            'FlowName': 'string'
        },
        'CloudWatchConfig': {
            'RoleArn': 'string',
            'BackTestConfiguration': {
                'RunBackTestMode': True|False
            }
        },
        'RDSSourceConfig': {
            'DBInstanceIdentifier': 'string',
            'DatabaseHost': 'string',
            'DatabasePort': 123,
            'SecretManagerArn': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'RoleArn': 'string',
            'VpcConfiguration': {
                'SubnetIdList': [
                    'string',
                ],
                'SecurityGroupIdList': [
                    'string',
                ]
            }
        },
        'RedshiftSourceConfig': {
            'ClusterIdentifier': 'string',
            'DatabaseHost': 'string',
            'DatabasePort': 123,
            'SecretManagerArn': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'RoleArn': 'string',
            'VpcConfiguration': {
                'SubnetIdList': [
                    'string',
                ],
                'SecurityGroupIdList': [
                    'string',
                ]
            }
        },
        'AthenaSourceConfig': {
            'RoleArn': 'string',
            'DatabaseName': 'string',
            'DataCatalog': 'string',
            'TableName': 'string',
            'WorkGroupName': 'string',
            'S3ResultsPath': 'string',
            'BackTestConfiguration': {
                'RunBackTestMode': True|False
            }
        }
    },
    'DimensionFilterList': [
        {
            'Name': 'string',
            'FilterList': [
                {
                    'DimensionValue': 'string',
                    'FilterOperation': 'EQUALS'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --
    • MetricSetArn (string) --

      The ARN of the dataset.

    • AnomalyDetectorArn (string) --

      The ARN of the detector that contains the dataset.

    • MetricSetName (string) --

      The name of the dataset.

    • MetricSetDescription (string) --

      The dataset's description.

    • CreationTime (datetime) --

      The time at which the dataset was created.

    • LastModificationTime (datetime) --

      The time at which the dataset was last modified.

    • Offset (integer) --

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

    • MetricList (list) --

      A list of the metrics defined by the dataset.

      • (dict) --

        A calculation made by contrasting a measure and a dimension from your source data.

        • MetricName (string) --

          The name of the metric.

        • AggregationFunction (string) --

          The function with which the metric is calculated.

        • Namespace (string) --

          The namespace for the metric.

    • TimestampColumn (dict) --

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

      • ColumnName (string) --

        The name of the timestamp column.

      • ColumnFormat (string) --

        The format of the timestamp column.

    • DimensionList (list) --

      A list of the dimensions chosen for analysis.

      • (string) --
    • MetricSetFrequency (string) --

      The interval at which the data will be analyzed for anomalies.

    • Timezone (string) --

      The time zone in which the dataset's data was recorded.

    • MetricSource (dict) --

      Contains information about the dataset's source data.

      • S3SourceConfig (dict) --

        Contains information about the configuration of the S3 bucket that contains source files.

        • RoleArn (string) --

          The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

        • TemplatedPathList (list) --

          A list of templated paths to the source files.

          • (string) --
        • HistoricalDataPathList (list) --

          A list of paths to the historical data files.

          • (string) --
        • FileFormatDescriptor (dict) --

          Contains information about a source file's formatting.

          • CsvFormatDescriptor (dict) --

            Contains information about how a source CSV data file should be analyzed.

            • FileCompression (string) --

              The level of compression of the source CSV file.

            • Charset (string) --

              The character set in which the source CSV file is written.

            • ContainsHeader (boolean) --

              Whether or not the source CSV file contains a header.

            • Delimiter (string) --

              The character used to delimit the source CSV file.

            • HeaderList (list) --

              A list of the source CSV file's headers, if any.

              • (string) --
            • QuoteSymbol (string) --

              The character used as a quote character.

          • JsonFormatDescriptor (dict) --

            Contains information about how a source JSON data file should be analyzed.

            • FileCompression (string) --

              The level of compression of the source CSV file.

            • Charset (string) --

              The character set in which the source JSON file is written.

      • AppFlowConfig (dict) --

        Details about an AppFlow datasource.

        • RoleArn (string) --

          An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

        • FlowName (string) --

          name of the flow.

      • CloudWatchConfig (dict) --

        Details about an Amazon CloudWatch monitoring datasource.

        • RoleArn (string) --

          An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

        • BackTestConfiguration (dict) --

          Settings for backtest mode.

          • RunBackTestMode (boolean) --

            Run a backtest instead of monitoring new data.

      • RDSSourceConfig (dict) --

        Details about an Amazon Relational Database Service (RDS) datasource.

        • DBInstanceIdentifier (string) --

          A string identifying the database instance.

        • DatabaseHost (string) --

          The host name of the database.

        • DatabasePort (integer) --

          The port number where the database can be accessed.

        • SecretManagerArn (string) --

          The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

        • DatabaseName (string) --

          The name of the RDS database.

        • TableName (string) --

          The name of the table in the database.

        • RoleArn (string) --

          The Amazon Resource Name (ARN) of the role.

        • VpcConfiguration (dict) --

          An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

          • SubnetIdList (list) --

            An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .

            • (string) --
          • SecurityGroupIdList (list) --

            An array of strings containing the list of security groups.

            • (string) --
      • RedshiftSourceConfig (dict) --

        Details about an Amazon Redshift database datasource.

        • ClusterIdentifier (string) --

          A string identifying the Redshift cluster.

        • DatabaseHost (string) --

          The name of the database host.

        • DatabasePort (integer) --

          The port number where the database can be accessed.

        • SecretManagerArn (string) --

          The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

        • DatabaseName (string) --

          The Redshift database name.

        • TableName (string) --

          The table name of the Redshift database.

        • RoleArn (string) --

          The Amazon Resource Name (ARN) of the role providing access to the database.

        • VpcConfiguration (dict) --

          Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

          • SubnetIdList (list) --

            An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .

            • (string) --
          • SecurityGroupIdList (list) --

            An array of strings containing the list of security groups.

            • (string) --
      • AthenaSourceConfig (dict) --

        Details about an Amazon Athena datasource.

        • RoleArn (string) --

          An IAM role that gives Amazon Lookout for Metrics permission to access the data.

        • DatabaseName (string) --

          The database's name.

        • DataCatalog (string) --

          The database's data catalog.

        • TableName (string) --

          The database's table name.

        • WorkGroupName (string) --

          The database's work group name.

        • S3ResultsPath (string) --

          The database's results path.

        • BackTestConfiguration (dict) --

          Settings for backtest mode.

          • RunBackTestMode (boolean) --

            Run a backtest instead of monitoring new data.

    • DimensionFilterList (list) --

      The dimensions and their values that were used to filter the dataset.

      • (dict) --

        Describes a list of filters for choosing a subset of dimension values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

        • Name (string) --

          The dimension that you want to filter on.

        • FilterList (list) --

          The list of filters that you are applying.

          • (dict) --

            Describes a filter for choosing a subset of dimension values. Each filter consists of the dimension that you want to include and the condition statement. The condition statement is specified in the FilterOperation object.

            • DimensionValue (string) --

              The value that you want to include in the filter.

            • FilterOperation (string) --

              The condition to apply.

Exceptions

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

get_anomaly_group(**kwargs)

Returns details about a group of anomalous metrics.

See also: AWS API Documentation

Request Syntax

response = client.get_anomaly_group(
    AnomalyGroupId='string',
    AnomalyDetectorArn='string'
)
Parameters
  • AnomalyGroupId (string) --

    [REQUIRED]

    The ID of the anomaly group.

  • AnomalyDetectorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the anomaly detector.

Return type

dict

Returns

Response Syntax

{
    'AnomalyGroup': {
        'StartTime': 'string',
        'EndTime': 'string',
        'AnomalyGroupId': 'string',
        'AnomalyGroupScore': 123.0,
        'PrimaryMetricName': 'string',
        'MetricLevelImpactList': [
            {
                'MetricName': 'string',
                'NumTimeSeries': 123,
                'ContributionMatrix': {
                    'DimensionContributionList': [
                        {
                            'DimensionName': 'string',
                            'DimensionValueContributionList': [
                                {
                                    'DimensionValue': 'string',
                                    'ContributionScore': 123.0
                                },
                            ]
                        },
                    ]
                }
            },
        ]
    }
}

Response Structure

  • (dict) --

    • AnomalyGroup (dict) --

      Details about the anomaly group.

      • StartTime (string) --

        The start time for the group.

      • EndTime (string) --

        The end time for the group.

      • AnomalyGroupId (string) --

        The ID of the anomaly group.

      • AnomalyGroupScore (float) --

        The severity score of the group.

      • PrimaryMetricName (string) --

        The name of the primary affected measure for the group.

      • MetricLevelImpactList (list) --

        A list of measures affected by the anomaly.

        • (dict) --

          Details about a measure affected by an anomaly.

          • MetricName (string) --

            The name of the measure.

          • NumTimeSeries (integer) --

            The number of anomalous metrics for the measure.

          • ContributionMatrix (dict) --

            Details about the dimensions that contributed to the anomaly.

            • DimensionContributionList (list) --

              A list of contributing dimensions.

              • (dict) --

                Details about a dimension that contributed to an anomaly.

                • DimensionName (string) --

                  The name of the dimension.

                • DimensionValueContributionList (list) --

                  A list of dimension values that contributed to the anomaly.

                  • (dict) --

                    The severity of a value of a dimension that contributed to an anomaly.

                    • DimensionValue (string) --

                      The value of the dimension.

                    • ContributionScore (float) --

                      The severity score of the value.

Exceptions

get_data_quality_metrics(**kwargs)

Returns details about the requested data quality metrics.

See also: AWS API Documentation

Request Syntax

response = client.get_data_quality_metrics(
    AnomalyDetectorArn='string',
    MetricSetArn='string'
)
Parameters
  • AnomalyDetectorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.

  • MetricSetArn (string) -- The Amazon Resource Name (ARN) of a specific data quality metric set.
Return type

dict

Returns

Response Syntax

{
    'AnomalyDetectorDataQualityMetricList': [
        {
            'StartTimestamp': datetime(2015, 1, 1),
            'MetricSetDataQualityMetricList': [
                {
                    'MetricSetArn': 'string',
                    'DataQualityMetricList': [
                        {
                            'MetricType': 'COLUMN_COMPLETENESS'|'DIMENSION_UNIQUENESS'|'TIME_SERIES_COUNT'|'ROWS_PROCESSED'|'ROWS_PARTIAL_COMPLIANCE'|'INVALID_ROWS_COMPLIANCE'|'BACKTEST_TRAINING_DATA_START_TIME_STAMP'|'BACKTEST_TRAINING_DATA_END_TIME_STAMP'|'BACKTEST_INFERENCE_DATA_START_TIME_STAMP'|'BACKTEST_INFERENCE_DATA_END_TIME_STAMP',
                            'MetricDescription': 'string',
                            'RelatedColumnName': 'string',
                            'MetricValue': 123.0
                        },
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • AnomalyDetectorDataQualityMetricList (list) --

      A list of the data quality metrics for the AnomalyDetectorArn that you requested.

      • (dict) --

        Aggregated details about the data quality metrics collected for the AnomalyDetectorArn provided in the GetDataQualityMetrics object.

        • StartTimestamp (datetime) --

          The start time for the data quality metrics collection.

        • MetricSetDataQualityMetricList (list) --

          An array of DataQualityMetricList objects. Each object in the array contains information about a data quality metric.

          • (dict) --

            An array of DataQualityMetric objects that describes one or more data quality metrics.

            • MetricSetArn (string) --

              The Amazon Resource Name (ARN) of the data quality metric array.

            • DataQualityMetricList (list) --

              The array of data quality metrics contained in the data quality metric set.

              • (dict) --

                An array that describes a data quality metric. Each DataQualityMetric object contains the data quality metric name, its value, a description of the metric, and the affected column.

                • MetricType (string) --

                  The name of the data quality metric.

                • MetricDescription (string) --

                  A description of the data quality metric.

                • RelatedColumnName (string) --

                  The column that is being monitored.

                • MetricValue (float) --

                  The value of the data quality metric.

Exceptions

get_feedback(**kwargs)

Get feedback for an anomaly group.

See also: AWS API Documentation

Request Syntax

response = client.get_feedback(
    AnomalyDetectorArn='string',
    AnomalyGroupTimeSeriesFeedback={
        'AnomalyGroupId': 'string',
        'TimeSeriesId': 'string'
    },
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AnomalyDetectorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the anomaly detector.

  • AnomalyGroupTimeSeriesFeedback (dict) --

    [REQUIRED]

    The anomalous metric and group ID.

    • AnomalyGroupId (string) -- [REQUIRED]

      The ID of the anomaly group.

    • TimeSeriesId (string) --

      The ID of the metric.

  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'AnomalyGroupTimeSeriesFeedback': [
        {
            'TimeSeriesId': 'string',
            'IsAnomaly': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AnomalyGroupTimeSeriesFeedback (list) --

      Feedback for an anomalous metric.

      • (dict) --

        Details about feedback submitted for an anomalous metric.

        • TimeSeriesId (string) --

          The ID of the metric.

        • IsAnomaly (boolean) --

          Feedback on whether the metric is a legitimate anomaly.

    • NextToken (string) --

      The pagination token that's included if more results are available.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_sample_data(**kwargs)

Returns a selection of sample records from an Amazon S3 datasource.

See also: AWS API Documentation

Request Syntax

response = client.get_sample_data(
    S3SourceConfig={
        'RoleArn': 'string',
        'TemplatedPathList': [
            'string',
        ],
        'HistoricalDataPathList': [
            'string',
        ],
        'FileFormatDescriptor': {
            'CsvFormatDescriptor': {
                'FileCompression': 'NONE'|'GZIP',
                'Charset': 'string',
                'ContainsHeader': True|False,
                'Delimiter': 'string',
                'HeaderList': [
                    'string',
                ],
                'QuoteSymbol': 'string'
            },
            'JsonFormatDescriptor': {
                'FileCompression': 'NONE'|'GZIP',
                'Charset': 'string'
            }
        }
    }
)
Parameters
S3SourceConfig (dict) --

A datasource bucket in Amazon S3.

  • RoleArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the role.

  • TemplatedPathList (list) --

    An array of strings containing the list of templated paths.

    • (string) --
  • HistoricalDataPathList (list) --

    An array of strings containing the historical set of data paths.

    • (string) --
  • FileFormatDescriptor (dict) -- [REQUIRED]

    Contains information about a source file's formatting.

    • CsvFormatDescriptor (dict) --

      Contains information about how a source CSV data file should be analyzed.

      • FileCompression (string) --

        The level of compression of the source CSV file.

      • Charset (string) --

        The character set in which the source CSV file is written.

      • ContainsHeader (boolean) --

        Whether or not the source CSV file contains a header.

      • Delimiter (string) --

        The character used to delimit the source CSV file.

      • HeaderList (list) --

        A list of the source CSV file's headers, if any.

        • (string) --
      • QuoteSymbol (string) --

        The character used as a quote character.

    • JsonFormatDescriptor (dict) --

      Contains information about how a source JSON data file should be analyzed.

      • FileCompression (string) --

        The level of compression of the source CSV file.

      • Charset (string) --

        The character set in which the source JSON file is written.

Return type
dict
Returns
Response Syntax
{
    'HeaderValues': [
        'string',
    ],
    'SampleRows': [
        [
            'string',
        ],
    ]
}

Response Structure

  • (dict) --
    • HeaderValues (list) --

      A list of header labels for the records.

      • (string) --
    • SampleRows (list) --

      A list of records.

      • (list) --
        • (string) --

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_alerts(**kwargs)

Lists the alerts attached to a detector.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

See also: AWS API Documentation

Request Syntax

response = client.list_alerts(
    AnomalyDetectorArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • AnomalyDetectorArn (string) -- The ARN of the alert's detector.
  • NextToken (string) -- If the result of the previous request is truncated, the response includes a NextToken . To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
  • MaxResults (integer) -- The maximum number of results that will be displayed by the request.
Return type

dict

Returns

Response Syntax

{
    'AlertSummaryList': [
        {
            'AlertArn': 'string',
            'AnomalyDetectorArn': 'string',
            'AlertName': 'string',
            'AlertSensitivityThreshold': 123,
            'AlertType': 'SNS'|'LAMBDA',
            'AlertStatus': 'ACTIVE'|'INACTIVE',
            'LastModificationTime': datetime(2015, 1, 1),
            'CreationTime': datetime(2015, 1, 1),
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AlertSummaryList (list) --

      Contains information about an alert.

      • (dict) --

        Provides a summary of an alert's configuration.

        • AlertArn (string) --

          The ARN of the alert.

        • AnomalyDetectorArn (string) --

          The ARN of the detector to which the alert is attached.

        • AlertName (string) --

          The name of the alert.

        • AlertSensitivityThreshold (integer) --

          The minimum severity for an anomaly to trigger the alert.

        • AlertType (string) --

          The type of the alert.

        • AlertStatus (string) --

          The status of the alert.

        • LastModificationTime (datetime) --

          The time at which the alert was last modified.

        • CreationTime (datetime) --

          The time at which the alert was created.

        • Tags (dict) --

          The alert's tags.

          • (string) --
            • (string) --
    • NextToken (string) --

      If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.

Exceptions

list_anomaly_detectors(**kwargs)

Lists the detectors in the current AWS Region.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

See also: AWS API Documentation

Request Syntax

response = client.list_anomaly_detectors(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- If the result of the previous request was truncated, the response includes a NextToken . To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
Return type

dict

Returns

Response Syntax

{
    'AnomalyDetectorSummaryList': [
        {
            'AnomalyDetectorArn': 'string',
            'AnomalyDetectorName': 'string',
            'AnomalyDetectorDescription': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModificationTime': datetime(2015, 1, 1),
            'Status': 'ACTIVE'|'ACTIVATING'|'DELETING'|'FAILED'|'INACTIVE'|'LEARNING'|'BACK_TEST_ACTIVATING'|'BACK_TEST_ACTIVE'|'BACK_TEST_COMPLETE'|'DEACTIVATED'|'DEACTIVATING',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AnomalyDetectorSummaryList (list) --

      A list of anomaly detectors in the account in the current region.

      • (dict) --

        Contains information about an an anomaly detector.

        • AnomalyDetectorArn (string) --

          The ARN of the detector.

        • AnomalyDetectorName (string) --

          The name of the detector.

        • AnomalyDetectorDescription (string) --

          A description of the detector.

        • CreationTime (datetime) --

          The time at which the detector was created.

        • LastModificationTime (datetime) --

          The time at which the detector was last modified.

        • Status (string) --

          The status of detector.

        • Tags (dict) --

          The detector's tags.

          • (string) --
            • (string) --
    • NextToken (string) --

      If the response is truncated, the service returns this token. To retrieve the next set of results, use the token in the next request.

Exceptions

Returns a list of measures that are potential causes or effects of an anomaly group.

See also: AWS API Documentation

Request Syntax

response = client.list_anomaly_group_related_metrics(
    AnomalyDetectorArn='string',
    AnomalyGroupId='string',
    RelationshipTypeFilter='CAUSE_OF_INPUT_ANOMALY_GROUP'|'EFFECT_OF_INPUT_ANOMALY_GROUP',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AnomalyDetectorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the anomaly detector.

  • AnomalyGroupId (string) --

    [REQUIRED]

    The ID of the anomaly group.

  • RelationshipTypeFilter (string) -- Filter for potential causes ( CAUSE_OF_INPUT_ANOMALY_GROUP ) or downstream effects ( EFFECT_OF_INPUT_ANOMALY_GROUP ) of the anomaly group.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'InterMetricImpactList': [
        {
            'MetricName': 'string',
            'AnomalyGroupId': 'string',
            'RelationshipType': 'CAUSE_OF_INPUT_ANOMALY_GROUP'|'EFFECT_OF_INPUT_ANOMALY_GROUP',
            'ContributionPercentage': 123.0
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • InterMetricImpactList (list) --

      Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.

      • (dict) --

        Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.

        • MetricName (string) --

          The name of the measure.

        • AnomalyGroupId (string) --

          The ID of the anomaly group.

        • RelationshipType (string) --

          Whether a measure is a potential cause of the anomaly group ( CAUSE_OF_INPUT_ANOMALY_GROUP ), or whether the measure is impacted by the anomaly group ( EFFECT_OF_INPUT_ANOMALY_GROUP ).

        • ContributionPercentage (float) --

          For potential causes ( CAUSE_OF_INPUT_ANOMALY_GROUP ), the percentage contribution the measure has in causing the anomalies.

    • NextToken (string) --

      The pagination token that's included if more results are available.

Exceptions

list_anomaly_group_summaries(**kwargs)

Returns a list of anomaly groups.

See also: AWS API Documentation

Request Syntax

response = client.list_anomaly_group_summaries(
    AnomalyDetectorArn='string',
    SensitivityThreshold=123,
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AnomalyDetectorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the anomaly detector.

  • SensitivityThreshold (integer) --

    [REQUIRED]

    The minimum severity score for inclusion in the output.

  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'AnomalyGroupSummaryList': [
        {
            'StartTime': 'string',
            'EndTime': 'string',
            'AnomalyGroupId': 'string',
            'AnomalyGroupScore': 123.0,
            'PrimaryMetricName': 'string'
        },
    ],
    'AnomalyGroupStatistics': {
        'EvaluationStartDate': 'string',
        'TotalCount': 123,
        'ItemizedMetricStatsList': [
            {
                'MetricName': 'string',
                'OccurrenceCount': 123
            },
        ]
    },
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AnomalyGroupSummaryList (list) --

      A list of anomaly group summaries.

      • (dict) --

        Details about a group of anomalous metrics.

        • StartTime (string) --

          The start time for the group.

        • EndTime (string) --

          The end time for the group.

        • AnomalyGroupId (string) --

          The ID of the anomaly group.

        • AnomalyGroupScore (float) --

          The severity score of the group.

        • PrimaryMetricName (string) --

          The name of the primary affected measure for the group.

    • AnomalyGroupStatistics (dict) --

      Aggregated details about the anomaly groups.

      • EvaluationStartDate (string) --

        The start of the time range that was searched.

      • TotalCount (integer) --

        The number of groups found.

      • ItemizedMetricStatsList (list) --

        Statistics for individual metrics within the group.

        • (dict) --

          Aggregated statistics about a measure affected by an anomaly.

          • MetricName (string) --

            The name of the measure.

          • OccurrenceCount (integer) --

            The number of times that the measure appears.

    • NextToken (string) --

      The pagination token that's included if more results are available.

Exceptions

list_anomaly_group_time_series(**kwargs)

Gets a list of anomalous metrics for a measure in an anomaly group.

See also: AWS API Documentation

Request Syntax

response = client.list_anomaly_group_time_series(
    AnomalyDetectorArn='string',
    AnomalyGroupId='string',
    MetricName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AnomalyDetectorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the anomaly detector.

  • AnomalyGroupId (string) --

    [REQUIRED]

    The ID of the anomaly group.

  • MetricName (string) --

    [REQUIRED]

    The name of the measure field.

  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'AnomalyGroupId': 'string',
    'MetricName': 'string',
    'TimestampList': [
        'string',
    ],
    'NextToken': 'string',
    'TimeSeriesList': [
        {
            'TimeSeriesId': 'string',
            'DimensionList': [
                {
                    'DimensionName': 'string',
                    'DimensionValue': 'string'
                },
            ],
            'MetricValueList': [
                123.0,
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • AnomalyGroupId (string) --

      The ID of the anomaly group.

    • MetricName (string) --

      The name of the measure field.

    • TimestampList (list) --

      Timestamps for the anomalous metrics.

      • (string) --
    • NextToken (string) --

      The pagination token that's included if more results are available.

    • TimeSeriesList (list) --

      A list of anomalous metrics.

      • (dict) --

        Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as availability in the us-east-1 Region.

        • TimeSeriesId (string) --

          The ID of the metric.

        • DimensionList (list) --

          The dimensions of the metric.

          • (dict) --

            A dimension name and value.

            • DimensionName (string) --

              The name of the dimension.

            • DimensionValue (string) --

              The value of the dimension.

        • MetricValueList (list) --

          The values for the metric.

          • (float) --

Exceptions

list_metric_sets(**kwargs)

Lists the datasets in the current AWS Region.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

See also: AWS API Documentation

Request Syntax

response = client.list_metric_sets(
    AnomalyDetectorArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AnomalyDetectorArn (string) -- The ARN of the anomaly detector containing the metrics sets to list.
  • MaxResults (integer) -- The maximum number of results to return.
  • NextToken (string) -- If the result of the previous request was truncated, the response includes a NextToken . To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
Return type

dict

Returns

Response Syntax

{
    'MetricSetSummaryList': [
        {
            'MetricSetArn': 'string',
            'AnomalyDetectorArn': 'string',
            'MetricSetDescription': 'string',
            'MetricSetName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModificationTime': datetime(2015, 1, 1),
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • MetricSetSummaryList (list) --

      A list of the datasets in the AWS Region, with configuration details for each.

      • (dict) --

        Contains information about a dataset.

        • MetricSetArn (string) --

          The ARN of the dataset.

        • AnomalyDetectorArn (string) --

          The ARN of the detector to which the dataset belongs.

        • MetricSetDescription (string) --

          The description of the dataset.

        • MetricSetName (string) --

          The name of the dataset.

        • CreationTime (datetime) --

          The time at which the dataset was created.

        • LastModificationTime (datetime) --

          The time at which the dataset was last modified.

        • Tags (dict) --

          The dataset's tags.

          • (string) --
            • (string) --
    • NextToken (string) --

      If the response is truncated, the list call returns this token. To retrieve the next set of results, use the token in the next list request.

Exceptions

list_tags_for_resource(**kwargs)

Gets a list of tags for a detector, dataset, or alert.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The resource's Amazon Resource Name (ARN).

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      The resource's tags.

      • (string) --
        • (string) --

Exceptions

put_feedback(**kwargs)

Add feedback for an anomalous metric.

See also: AWS API Documentation

Request Syntax

response = client.put_feedback(
    AnomalyDetectorArn='string',
    AnomalyGroupTimeSeriesFeedback={
        'AnomalyGroupId': 'string',
        'TimeSeriesId': 'string',
        'IsAnomaly': True|False
    }
)
Parameters
  • AnomalyDetectorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the anomaly detector.

  • AnomalyGroupTimeSeriesFeedback (dict) --

    [REQUIRED]

    Feedback for an anomalous metric.

    • AnomalyGroupId (string) -- [REQUIRED]

      The ID of the anomaly group.

    • TimeSeriesId (string) -- [REQUIRED]

      The ID of the metric.

    • IsAnomaly (boolean) -- [REQUIRED]

      Feedback on whether the metric is a legitimate anomaly.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

tag_resource(**kwargs)

Adds tags to a detector, dataset, or alert.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The resource's Amazon Resource Name (ARN).

  • Tags (dict) --

    [REQUIRED]

    Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@-

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes tags from a detector, dataset, or alert.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The resource's Amazon Resource Name (ARN).

  • TagKeys (list) --

    [REQUIRED]

    Keys to remove from the resource's tags.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_alert(**kwargs)

Make changes to an existing alert.

See also: AWS API Documentation

Request Syntax

response = client.update_alert(
    AlertArn='string',
    AlertDescription='string',
    AlertSensitivityThreshold=123,
    Action={
        'SNSConfiguration': {
            'RoleArn': 'string',
            'SnsTopicArn': 'string',
            'SnsFormat': 'LONG_TEXT'|'SHORT_TEXT'|'JSON'
        },
        'LambdaConfiguration': {
            'RoleArn': 'string',
            'LambdaArn': 'string'
        }
    },
    AlertFilters={
        'MetricList': [
            'string',
        ],
        'DimensionFilterList': [
            {
                'DimensionName': 'string',
                'DimensionValueList': [
                    'string',
                ]
            },
        ]
    }
)
Parameters
  • AlertArn (string) --

    [REQUIRED]

    The ARN of the alert to update.

  • AlertDescription (string) -- A description of the alert.
  • AlertSensitivityThreshold (integer) -- An integer from 0 to 100 specifying the alert sensitivity threshold.
  • Action (dict) --

    Action that will be triggered when there is an alert.

    • SNSConfiguration (dict) --

      A configuration for an Amazon SNS channel.

      • RoleArn (string) -- [REQUIRED]

        The ARN of the IAM role that has access to the target SNS topic.

      • SnsTopicArn (string) -- [REQUIRED]

        The ARN of the target SNS topic.

      • SnsFormat (string) --

        The format of the SNS topic.

        • JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.
        • LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.
        • SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.
    • LambdaConfiguration (dict) --

      A configuration for an AWS Lambda channel.

      • RoleArn (string) -- [REQUIRED]

        The ARN of an IAM role that has permission to invoke the Lambda function.

      • LambdaArn (string) -- [REQUIRED]

        The ARN of the Lambda function.

  • AlertFilters (dict) --

    The configuration of the alert filters, containing MetricList and DimensionFilterList.

    • MetricList (list) --

      The list of measures that you want to get alerts for.

      • (string) --
    • DimensionFilterList (list) --

      The list of DimensionFilter objects that are used for dimension-based filtering.

      • (dict) --

        The dimension filter, containing DimensionName and DimensionValueList.

        • DimensionName (string) --

          The name of the dimension to filter on.

        • DimensionValueList (list) --

          The list of values for the dimension specified in DimensionName that you want to filter on.

          • (string) --
Return type

dict

Returns

Response Syntax

{
    'AlertArn': 'string'
}

Response Structure

  • (dict) --

    • AlertArn (string) --

      The ARN of the updated alert.

Exceptions

update_anomaly_detector(**kwargs)

Updates a detector. After activation, you can only change a detector's ingestion delay and description.

See also: AWS API Documentation

Request Syntax

response = client.update_anomaly_detector(
    AnomalyDetectorArn='string',
    KmsKeyArn='string',
    AnomalyDetectorDescription='string',
    AnomalyDetectorConfig={
        'AnomalyDetectorFrequency': 'P1D'|'PT1H'|'PT10M'|'PT5M'
    }
)
Parameters
  • AnomalyDetectorArn (string) --

    [REQUIRED]

    The ARN of the detector to update.

  • KmsKeyArn (string) -- The Amazon Resource Name (ARN) of an AWS KMS encryption key.
  • AnomalyDetectorDescription (string) -- The updated detector description.
  • AnomalyDetectorConfig (dict) --

    Contains information about the configuration to which the detector will be updated.

    • AnomalyDetectorFrequency (string) --

      The frequency at which the detector analyzes its source data.

Return type

dict

Returns

Response Syntax

{
    'AnomalyDetectorArn': 'string'
}

Response Structure

  • (dict) --

    • AnomalyDetectorArn (string) --

      The ARN of the updated detector.

Exceptions

update_metric_set(**kwargs)

Updates a dataset.

See also: AWS API Documentation

Request Syntax

response = client.update_metric_set(
    MetricSetArn='string',
    MetricSetDescription='string',
    MetricList=[
        {
            'MetricName': 'string',
            'AggregationFunction': 'AVG'|'SUM',
            'Namespace': 'string'
        },
    ],
    Offset=123,
    TimestampColumn={
        'ColumnName': 'string',
        'ColumnFormat': 'string'
    },
    DimensionList=[
        'string',
    ],
    MetricSetFrequency='P1D'|'PT1H'|'PT10M'|'PT5M',
    MetricSource={
        'S3SourceConfig': {
            'RoleArn': 'string',
            'TemplatedPathList': [
                'string',
            ],
            'HistoricalDataPathList': [
                'string',
            ],
            'FileFormatDescriptor': {
                'CsvFormatDescriptor': {
                    'FileCompression': 'NONE'|'GZIP',
                    'Charset': 'string',
                    'ContainsHeader': True|False,
                    'Delimiter': 'string',
                    'HeaderList': [
                        'string',
                    ],
                    'QuoteSymbol': 'string'
                },
                'JsonFormatDescriptor': {
                    'FileCompression': 'NONE'|'GZIP',
                    'Charset': 'string'
                }
            }
        },
        'AppFlowConfig': {
            'RoleArn': 'string',
            'FlowName': 'string'
        },
        'CloudWatchConfig': {
            'RoleArn': 'string',
            'BackTestConfiguration': {
                'RunBackTestMode': True|False
            }
        },
        'RDSSourceConfig': {
            'DBInstanceIdentifier': 'string',
            'DatabaseHost': 'string',
            'DatabasePort': 123,
            'SecretManagerArn': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'RoleArn': 'string',
            'VpcConfiguration': {
                'SubnetIdList': [
                    'string',
                ],
                'SecurityGroupIdList': [
                    'string',
                ]
            }
        },
        'RedshiftSourceConfig': {
            'ClusterIdentifier': 'string',
            'DatabaseHost': 'string',
            'DatabasePort': 123,
            'SecretManagerArn': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'RoleArn': 'string',
            'VpcConfiguration': {
                'SubnetIdList': [
                    'string',
                ],
                'SecurityGroupIdList': [
                    'string',
                ]
            }
        },
        'AthenaSourceConfig': {
            'RoleArn': 'string',
            'DatabaseName': 'string',
            'DataCatalog': 'string',
            'TableName': 'string',
            'WorkGroupName': 'string',
            'S3ResultsPath': 'string',
            'BackTestConfiguration': {
                'RunBackTestMode': True|False
            }
        }
    },
    DimensionFilterList=[
        {
            'Name': 'string',
            'FilterList': [
                {
                    'DimensionValue': 'string',
                    'FilterOperation': 'EQUALS'
                },
            ]
        },
    ]
)
Parameters
  • MetricSetArn (string) --

    [REQUIRED]

    The ARN of the dataset to update.

  • MetricSetDescription (string) -- The dataset's description.
  • MetricList (list) --

    The metric list.

    • (dict) --

      A calculation made by contrasting a measure and a dimension from your source data.

      • MetricName (string) -- [REQUIRED]

        The name of the metric.

      • AggregationFunction (string) -- [REQUIRED]

        The function with which the metric is calculated.

      • Namespace (string) --

        The namespace for the metric.

  • Offset (integer) -- After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
  • TimestampColumn (dict) --

    The timestamp column.

    • ColumnName (string) --

      The name of the timestamp column.

    • ColumnFormat (string) --

      The format of the timestamp column.

  • DimensionList (list) --

    The dimension list.

    • (string) --
  • MetricSetFrequency (string) -- The dataset's interval.
  • MetricSource (dict) --

    Contains information about source data used to generate metrics.

    • S3SourceConfig (dict) --

      Contains information about the configuration of the S3 bucket that contains source files.

      • RoleArn (string) --

        The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

      • TemplatedPathList (list) --

        A list of templated paths to the source files.

        • (string) --
      • HistoricalDataPathList (list) --

        A list of paths to the historical data files.

        • (string) --
      • FileFormatDescriptor (dict) --

        Contains information about a source file's formatting.

        • CsvFormatDescriptor (dict) --

          Contains information about how a source CSV data file should be analyzed.

          • FileCompression (string) --

            The level of compression of the source CSV file.

          • Charset (string) --

            The character set in which the source CSV file is written.

          • ContainsHeader (boolean) --

            Whether or not the source CSV file contains a header.

          • Delimiter (string) --

            The character used to delimit the source CSV file.

          • HeaderList (list) --

            A list of the source CSV file's headers, if any.

            • (string) --
          • QuoteSymbol (string) --

            The character used as a quote character.

        • JsonFormatDescriptor (dict) --

          Contains information about how a source JSON data file should be analyzed.

          • FileCompression (string) --

            The level of compression of the source CSV file.

          • Charset (string) --

            The character set in which the source JSON file is written.

    • AppFlowConfig (dict) --

      Details about an AppFlow datasource.

      • RoleArn (string) --

        An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

      • FlowName (string) --

        name of the flow.

    • CloudWatchConfig (dict) --

      Details about an Amazon CloudWatch monitoring datasource.

      • RoleArn (string) --

        An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

      • BackTestConfiguration (dict) --

        Settings for backtest mode.

        • RunBackTestMode (boolean) -- [REQUIRED]

          Run a backtest instead of monitoring new data.

    • RDSSourceConfig (dict) --

      Details about an Amazon Relational Database Service (RDS) datasource.

      • DBInstanceIdentifier (string) --

        A string identifying the database instance.

      • DatabaseHost (string) --

        The host name of the database.

      • DatabasePort (integer) --

        The port number where the database can be accessed.

      • SecretManagerArn (string) --

        The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

      • DatabaseName (string) --

        The name of the RDS database.

      • TableName (string) --

        The name of the table in the database.

      • RoleArn (string) --

        The Amazon Resource Name (ARN) of the role.

      • VpcConfiguration (dict) --

        An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

        • SubnetIdList (list) -- [REQUIRED]

          An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .

          • (string) --
        • SecurityGroupIdList (list) -- [REQUIRED]

          An array of strings containing the list of security groups.

          • (string) --
    • RedshiftSourceConfig (dict) --

      Details about an Amazon Redshift database datasource.

      • ClusterIdentifier (string) --

        A string identifying the Redshift cluster.

      • DatabaseHost (string) --

        The name of the database host.

      • DatabasePort (integer) --

        The port number where the database can be accessed.

      • SecretManagerArn (string) --

        The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

      • DatabaseName (string) --

        The Redshift database name.

      • TableName (string) --

        The table name of the Redshift database.

      • RoleArn (string) --

        The Amazon Resource Name (ARN) of the role providing access to the database.

      • VpcConfiguration (dict) --

        Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

        • SubnetIdList (list) -- [REQUIRED]

          An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE .

          • (string) --
        • SecurityGroupIdList (list) -- [REQUIRED]

          An array of strings containing the list of security groups.

          • (string) --
    • AthenaSourceConfig (dict) --

      Details about an Amazon Athena datasource.

      • RoleArn (string) --

        An IAM role that gives Amazon Lookout for Metrics permission to access the data.

      • DatabaseName (string) --

        The database's name.

      • DataCatalog (string) --

        The database's data catalog.

      • TableName (string) --

        The database's table name.

      • WorkGroupName (string) --

        The database's work group name.

      • S3ResultsPath (string) --

        The database's results path.

      • BackTestConfiguration (dict) --

        Settings for backtest mode.

        • RunBackTestMode (boolean) -- [REQUIRED]

          Run a backtest instead of monitoring new data.

  • DimensionFilterList (list) --

    Describes a list of filters for choosing specific dimensions and specific values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

    • (dict) --

      Describes a list of filters for choosing a subset of dimension values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

      • Name (string) --

        The dimension that you want to filter on.

      • FilterList (list) --

        The list of filters that you are applying.

        • (dict) --

          Describes a filter for choosing a subset of dimension values. Each filter consists of the dimension that you want to include and the condition statement. The condition statement is specified in the FilterOperation object.

          • DimensionValue (string) --

            The value that you want to include in the filter.

          • FilterOperation (string) --

            The condition to apply.

Return type

dict

Returns

Response Syntax

{
    'MetricSetArn': 'string'
}

Response Structure

  • (dict) --

    • MetricSetArn (string) --

      The ARN of the dataset.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class LookoutMetrics.Client.exceptions.AccessDeniedException

You do not have sufficient permissions to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient permissions to perform this action.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutMetrics.Client.exceptions.ConflictException

There was a conflict processing the request. Try your request again.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There was a conflict processing the request. Try your request again.

    • Message (string) --

    • ResourceId (string) --

      The ID of the resource.

    • ResourceType (string) --

      The type of the resource.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutMetrics.Client.exceptions.InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request processing has failed because of an unknown error, exception, or failure.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutMetrics.Client.exceptions.ResourceNotFoundException

The specified resource cannot be found. Check the ARN of the resource and try again.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource cannot be found. Check the ARN of the resource and try again.

    • Message (string) --

    • ResourceId (string) --

      The ID of the resource.

    • ResourceType (string) --

      The type of the resource.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutMetrics.Client.exceptions.ServiceQuotaExceededException

The request exceeded the service's quotas. Check the service quotas and try again.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'QuotaCode': 'string',
    'ServiceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request exceeded the service's quotas. Check the service quotas and try again.

    • Message (string) --

    • ResourceId (string) --

      The ID of the resource.

    • ResourceType (string) --

      The type of the resource.

    • QuotaCode (string) --

      The quota code.

    • ServiceCode (string) --

      The service code.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutMetrics.Client.exceptions.TooManyRequestsException

The request was denied due to too many requests being submitted at the same time.

Example

try:
  ...
except client.exceptions.TooManyRequestsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied due to too many requests being submitted at the same time.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutMetrics.Client.exceptions.ValidationException

The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Reason': 'UNKNOWN_OPERATION'|'CANNOT_PARSE'|'FIELD_VALIDATION_FAILED'|'OTHER',
    'Fields': [
        {
            'Name': 'string',
            'Message': 'string'
        },
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.

    • Message (string) --

    • Reason (string) --

      The reason that validation failed.

    • Fields (list) --

      Fields that failed validation.

      • (dict) --

        Contains information about a a field in a validation exception.

        • Name (string) --

          The name of the field.

        • Message (string) --

          The message with more information about the validation exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: