LookoutMetrics / Client / describe_anomaly_detection_executions

describe_anomaly_detection_executions#

LookoutMetrics.Client.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

  • LookoutMetrics.Client.exceptions.ResourceNotFoundException

  • LookoutMetrics.Client.exceptions.ValidationException

  • LookoutMetrics.Client.exceptions.AccessDeniedException

  • LookoutMetrics.Client.exceptions.TooManyRequestsException

  • LookoutMetrics.Client.exceptions.InternalServerException