Amazon Lookout for Metrics 2017-07-25
- Client: Aws\LookoutMetrics\LookoutMetricsClient
- Service ID: lookoutmetrics
- Version: 2017-07-25
This page describes the parameters and results for the operations of the Amazon Lookout for Metrics (2017-07-25), and shows how to use the Aws\LookoutMetrics\LookoutMetricsClient object to call the described operations. This documentation is specific to the 2017-07-25 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- ActivateAnomalyDetector ( array $params = [] )
Activates an anomaly detector.
- BackTestAnomalyDetector ( array $params = [] )
Runs a backtest for anomaly detection for the specified resource.
- CreateAlert ( array $params = [] )
Creates an alert for an anomaly detector.
- CreateAnomalyDetector ( array $params = [] )
Creates an anomaly detector.
- CreateMetricSet ( array $params = [] )
Creates a dataset.
- DeactivateAnomalyDetector ( array $params = [] )
Deactivates an anomaly detector.
- DeleteAlert ( array $params = [] )
Deletes an alert.
- DeleteAnomalyDetector ( array $params = [] )
Deletes a detector.
- DescribeAlert ( array $params = [] )
Describes an alert.
- DescribeAnomalyDetectionExecutions ( array $params = [] )
Returns information about the status of the specified anomaly detection jobs.
- DescribeAnomalyDetector ( array $params = [] )
Describes a detector.
- DescribeMetricSet ( array $params = [] )
Describes a dataset.
- DetectMetricSetConfig ( array $params = [] )
Detects an Amazon S3 dataset's file format, interval, and offset.
- GetAnomalyGroup ( array $params = [] )
Returns details about a group of anomalous metrics.
- GetDataQualityMetrics ( array $params = [] )
Returns details about the requested data quality metrics.
- GetFeedback ( array $params = [] )
Get feedback for an anomaly group.
- GetSampleData ( array $params = [] )
Returns a selection of sample records from an Amazon S3 datasource.
- ListAlerts ( array $params = [] )
Lists the alerts attached to a detector.
- ListAnomalyDetectors ( array $params = [] )
Lists the detectors in the current AWS Region.
- ListAnomalyGroupRelatedMetrics ( array $params = [] )
Returns a list of measures that are potential causes or effects of an anomaly group.
- ListAnomalyGroupSummaries ( array $params = [] )
Returns a list of anomaly groups.
- ListAnomalyGroupTimeSeries ( array $params = [] )
Gets a list of anomalous metrics for a measure in an anomaly group.
- ListMetricSets ( array $params = [] )
Lists the datasets in the current AWS Region.
- ListTagsForResource ( array $params = [] )
Gets a list of tags for a detector, dataset, or alert.
- PutFeedback ( array $params = [] )
Add feedback for an anomalous metric.
- TagResource ( array $params = [] )
Adds tags to a detector, dataset, or alert.
- UntagResource ( array $params = [] )
Removes tags from a detector, dataset, or alert.
- UpdateAlert ( array $params = [] )
Make changes to an existing alert.
- UpdateAnomalyDetector ( array $params = [] )
Updates a detector.
- UpdateMetricSet ( array $params = [] )
Updates a dataset.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
ActivateAnomalyDetector
$result = $client->activateAnomalyDetector([/* ... */]); $promise = $client->activateAnomalyDetectorAsync([/* ... */]);
Activates an anomaly detector.
Parameter Syntax
$result = $client->activateAnomalyDetector([
'AnomalyDetectorArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
-
There was a conflict processing the request. Try your request again.
BackTestAnomalyDetector
$result = $client->backTestAnomalyDetector([/* ... */]); $promise = $client->backTestAnomalyDetectorAsync([/* ... */]);
Runs a backtest for anomaly detection for the specified resource.
Parameter Syntax
$result = $client->backTestAnomalyDetector([
'AnomalyDetectorArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
CreateAlert
$result = $client->createAlert([/* ... */]); $promise = $client->createAlertAsync([/* ... */]);
Creates an alert for an anomaly detector.
Parameter Syntax
$result = $client->createAlert([
'Action' => [ // REQUIRED
'LambdaConfiguration' => [
'LambdaArn' => '<string>', // REQUIRED
'RoleArn' => '<string>', // REQUIRED
],
'SNSConfiguration' => [
'RoleArn' => '<string>', // REQUIRED
'SnsFormat' => 'LONG_TEXT|SHORT_TEXT|JSON',
'SnsTopicArn' => '<string>', // REQUIRED
],
],
'AlertDescription' => '<string>',
'AlertFilters' => [
'DimensionFilterList' => [
[
'DimensionName' => '<string>',
'DimensionValueList' => ['<string>', ...],
],
// ...
],
'MetricList' => ['<string>', ...],
],
'AlertName' => '<string>', // REQUIRED
'AlertSensitivityThreshold' => <integer>,
'AnomalyDetectorArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- Action
-
- Required: Yes
- Type: Action structure
Action that will be triggered when there is an alert.
- AlertDescription
-
- Type: string
A description of the alert.
- AlertFilters
-
- Type: AlertFilters structure
The configuration of the alert filters, containing MetricList and DimensionFilterList.
- AlertName
-
- Required: Yes
- Type: string
The name of the alert.
- AlertSensitivityThreshold
-
- Type: int
An integer from 0 to 100 specifying the alert sensitivity threshold.
- AnomalyDetectorArn
-
- Required: Yes
- Type: string
The ARN of the detector to which the alert is attached.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to apply to the alert.
Result Syntax
[
'AlertArn' => '<string>',
]
Result Details
Errors
-
There was a conflict processing the request. Try your request again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
ServiceQuotaExceededException:
The request exceeded the service's quotas. Check the service quotas and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The request processing has failed because of an unknown error, exception, or failure.
CreateAnomalyDetector
$result = $client->createAnomalyDetector([/* ... */]); $promise = $client->createAnomalyDetectorAsync([/* ... */]);
Creates an anomaly detector.
Parameter Syntax
$result = $client->createAnomalyDetector([
'AnomalyDetectorConfig' => [ // REQUIRED
'AnomalyDetectorFrequency' => 'P1D|PT1H|PT10M|PT5M',
],
'AnomalyDetectorDescription' => '<string>',
'AnomalyDetectorName' => '<string>', // REQUIRED
'KmsKeyArn' => '<string>',
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- AnomalyDetectorConfig
-
- Required: Yes
- Type: AnomalyDetectorConfig structure
Contains information about the configuration of the anomaly detector.
- AnomalyDetectorDescription
-
- Type: string
A description of the detector.
- AnomalyDetectorName
-
- Required: Yes
- Type: string
The name of the detector.
- KmsKeyArn
-
- Type: string
The ARN of the KMS key to use to encrypt your data.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to apply to the anomaly detector.
Result Syntax
[
'AnomalyDetectorArn' => '<string>',
]
Result Details
Errors
-
There was a conflict processing the request. Try your request again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
ServiceQuotaExceededException:
The request exceeded the service's quotas. Check the service quotas and try again.
-
There was a conflict processing the request. Try your request again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
CreateMetricSet
$result = $client->createMetricSet([/* ... */]); $promise = $client->createMetricSetAsync([/* ... */]);
Creates a dataset.
Parameter Syntax
$result = $client->createMetricSet([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'DimensionFilterList' => [
[
'FilterList' => [
[
'DimensionValue' => '<string>',
'FilterOperation' => 'EQUALS',
],
// ...
],
'Name' => '<string>',
],
// ...
],
'DimensionList' => ['<string>', ...],
'MetricList' => [ // REQUIRED
[
'AggregationFunction' => 'AVG|SUM', // REQUIRED
'MetricName' => '<string>', // REQUIRED
'Namespace' => '<string>',
],
// ...
],
'MetricSetDescription' => '<string>',
'MetricSetFrequency' => 'P1D|PT1H|PT10M|PT5M',
'MetricSetName' => '<string>', // REQUIRED
'MetricSource' => [ // REQUIRED
'AppFlowConfig' => [
'FlowName' => '<string>',
'RoleArn' => '<string>',
],
'AthenaSourceConfig' => [
'BackTestConfiguration' => [
'RunBackTestMode' => true || false, // REQUIRED
],
'DataCatalog' => '<string>',
'DatabaseName' => '<string>',
'RoleArn' => '<string>',
'S3ResultsPath' => '<string>',
'TableName' => '<string>',
'WorkGroupName' => '<string>',
],
'CloudWatchConfig' => [
'BackTestConfiguration' => [
'RunBackTestMode' => true || false, // REQUIRED
],
'RoleArn' => '<string>',
],
'RDSSourceConfig' => [
'DBInstanceIdentifier' => '<string>',
'DatabaseHost' => '<string>',
'DatabaseName' => '<string>',
'DatabasePort' => <integer>,
'RoleArn' => '<string>',
'SecretManagerArn' => '<string>',
'TableName' => '<string>',
'VpcConfiguration' => [
'SecurityGroupIdList' => ['<string>', ...], // REQUIRED
'SubnetIdList' => ['<string>', ...], // REQUIRED
],
],
'RedshiftSourceConfig' => [
'ClusterIdentifier' => '<string>',
'DatabaseHost' => '<string>',
'DatabaseName' => '<string>',
'DatabasePort' => <integer>,
'RoleArn' => '<string>',
'SecretManagerArn' => '<string>',
'TableName' => '<string>',
'VpcConfiguration' => [
'SecurityGroupIdList' => ['<string>', ...], // REQUIRED
'SubnetIdList' => ['<string>', ...], // REQUIRED
],
],
'S3SourceConfig' => [
'FileFormatDescriptor' => [
'CsvFormatDescriptor' => [
'Charset' => '<string>',
'ContainsHeader' => true || false,
'Delimiter' => '<string>',
'FileCompression' => 'NONE|GZIP',
'HeaderList' => ['<string>', ...],
'QuoteSymbol' => '<string>',
],
'JsonFormatDescriptor' => [
'Charset' => '<string>',
'FileCompression' => 'NONE|GZIP',
],
],
'HistoricalDataPathList' => ['<string>', ...],
'RoleArn' => '<string>',
'TemplatedPathList' => ['<string>', ...],
],
],
'Offset' => <integer>,
'Tags' => ['<string>', ...],
'TimestampColumn' => [
'ColumnFormat' => '<string>',
'ColumnName' => '<string>',
],
'Timezone' => '<string>',
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Required: Yes
- Type: string
The ARN of the anomaly detector that will use the dataset.
- DimensionFilterList
-
- Type: Array of MetricSetDimensionFilter structures
A list of filters that specify which data is kept for anomaly detection.
- DimensionList
-
- Type: Array of strings
A list of the fields you want to treat as dimensions.
- MetricList
-
- Required: Yes
- Type: Array of Metric structures
A list of metrics that the dataset will contain.
- MetricSetDescription
-
- Type: string
A description of the dataset you are creating.
- MetricSetFrequency
-
- Type: string
The frequency with which the source data will be analyzed for anomalies.
- MetricSetName
-
- Required: Yes
- Type: string
The name of the dataset.
- MetricSource
-
- Required: Yes
- Type: MetricSource structure
Contains information about how the source data should be interpreted.
- Offset
-
- Type: int
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.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to apply to the dataset.
- TimestampColumn
-
- Type: TimestampColumn structure
Contains information about the column used for tracking time in your source data.
- Timezone
-
- Type: string
The time zone in which your source data was recorded.
Result Syntax
[
'MetricSetArn' => '<string>',
]
Result Details
Errors
-
There was a conflict processing the request. Try your request again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
ServiceQuotaExceededException:
The request exceeded the service's quotas. Check the service quotas and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
DeactivateAnomalyDetector
$result = $client->deactivateAnomalyDetector([/* ... */]); $promise = $client->deactivateAnomalyDetectorAsync([/* ... */]);
Deactivates an anomaly detector.
Parameter Syntax
$result = $client->deactivateAnomalyDetector([
'AnomalyDetectorArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
There was a conflict processing the request. Try your request again.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
DeleteAlert
$result = $client->deleteAlert([/* ... */]); $promise = $client->deleteAlertAsync([/* ... */]);
Deletes an alert.
Parameter Syntax
$result = $client->deleteAlert([
'AlertArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The request was denied due to too many requests being submitted at the same time.
-
You do not have sufficient permissions to perform this action.
-
The request processing has failed because of an unknown error, exception, or failure.
DeleteAnomalyDetector
$result = $client->deleteAnomalyDetector([/* ... */]); $promise = $client->deleteAnomalyDetectorAsync([/* ... */]);
Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.
Parameter Syntax
$result = $client->deleteAnomalyDetector([
'AnomalyDetectorArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
There was a conflict processing the request. Try your request again.
-
The request was denied due to too many requests being submitted at the same time.
-
You do not have sufficient permissions to perform this action.
-
The request processing has failed because of an unknown error, exception, or failure.
DescribeAlert
$result = $client->describeAlert([/* ... */]); $promise = $client->describeAlertAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->describeAlert([
'AlertArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Alert' => [
'Action' => [
'LambdaConfiguration' => [
'LambdaArn' => '<string>',
'RoleArn' => '<string>',
],
'SNSConfiguration' => [
'RoleArn' => '<string>',
'SnsFormat' => 'LONG_TEXT|SHORT_TEXT|JSON',
'SnsTopicArn' => '<string>',
],
],
'AlertArn' => '<string>',
'AlertDescription' => '<string>',
'AlertFilters' => [
'DimensionFilterList' => [
[
'DimensionName' => '<string>',
'DimensionValueList' => ['<string>', ...],
],
// ...
],
'MetricList' => ['<string>', ...],
],
'AlertName' => '<string>',
'AlertSensitivityThreshold' => <integer>,
'AlertStatus' => 'ACTIVE|INACTIVE',
'AlertType' => 'SNS|LAMBDA',
'AnomalyDetectorArn' => '<string>',
'CreationTime' => <DateTime>,
'LastModificationTime' => <DateTime>,
],
]
Result Details
Members
- Alert
-
- Type: Alert structure
Contains information about an alert.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
You do not have sufficient permissions to perform this action.
-
The request processing has failed because of an unknown error, exception, or failure.
-
The request was denied due to too many requests being submitted at the same time.
DescribeAnomalyDetectionExecutions
$result = $client->describeAnomalyDetectionExecutions([/* ... */]); $promise = $client->describeAnomalyDetectionExecutionsAsync([/* ... */]);
Returns information about the status of the specified anomaly detection jobs.
Parameter Syntax
$result = $client->describeAnomalyDetectionExecutions([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Timestamp' => '<string>',
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the anomaly detector.
- MaxResults
-
- Type: int
The number of items to return in the response.
- NextToken
-
- Type: string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
- Timestamp
-
- Type: string
The timestamp of the anomaly detection job.
Result Syntax
[
'ExecutionList' => [
[
'FailureReason' => '<string>',
'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|FAILED_TO_SCHEDULE',
'Timestamp' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ExecutionList
-
- Type: Array of ExecutionStatus structures
A list of detection jobs.
- NextToken
-
- Type: string
The pagination token that's included if more results are available.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
DescribeAnomalyDetector
$result = $client->describeAnomalyDetector([/* ... */]); $promise = $client->describeAnomalyDetectorAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->describeAnomalyDetector([
'AnomalyDetectorArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AnomalyDetectorArn' => '<string>',
'AnomalyDetectorConfig' => [
'AnomalyDetectorFrequency' => 'P1D|PT1H|PT10M|PT5M',
],
'AnomalyDetectorDescription' => '<string>',
'AnomalyDetectorName' => '<string>',
'CreationTime' => <DateTime>,
'FailureReason' => '<string>',
'FailureType' => 'ACTIVATION_FAILURE|BACK_TEST_ACTIVATION_FAILURE|DELETION_FAILURE|DEACTIVATION_FAILURE',
'KmsKeyArn' => '<string>',
'LastModificationTime' => <DateTime>,
'Status' => 'ACTIVE|ACTIVATING|DELETING|FAILED|INACTIVE|LEARNING|BACK_TEST_ACTIVATING|BACK_TEST_ACTIVE|BACK_TEST_COMPLETE|DEACTIVATED|DEACTIVATING',
]
Result Details
Members
- AnomalyDetectorArn
-
- Type: string
The ARN of the detector.
- AnomalyDetectorConfig
-
- Type: AnomalyDetectorConfigSummary structure
Contains information about the detector's configuration.
- AnomalyDetectorDescription
-
- Type: string
A description of the detector.
- AnomalyDetectorName
-
- Type: string
The name of the detector.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the detector was created.
- FailureReason
-
- Type: string
The reason that the detector failed.
- FailureType
-
- Type: string
The process that caused the detector to fail.
- KmsKeyArn
-
- Type: string
The ARN of the KMS key to use to encrypt your data.
- LastModificationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the detector was last modified.
- Status
-
- Type: string
The status of the detector.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
You do not have sufficient permissions to perform this action.
-
The request processing has failed because of an unknown error, exception, or failure.
-
The request was denied due to too many requests being submitted at the same time.
DescribeMetricSet
$result = $client->describeMetricSet([/* ... */]); $promise = $client->describeMetricSetAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->describeMetricSet([
'MetricSetArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AnomalyDetectorArn' => '<string>',
'CreationTime' => <DateTime>,
'DimensionFilterList' => [
[
'FilterList' => [
[
'DimensionValue' => '<string>',
'FilterOperation' => 'EQUALS',
],
// ...
],
'Name' => '<string>',
],
// ...
],
'DimensionList' => ['<string>', ...],
'LastModificationTime' => <DateTime>,
'MetricList' => [
[
'AggregationFunction' => 'AVG|SUM',
'MetricName' => '<string>',
'Namespace' => '<string>',
],
// ...
],
'MetricSetArn' => '<string>',
'MetricSetDescription' => '<string>',
'MetricSetFrequency' => 'P1D|PT1H|PT10M|PT5M',
'MetricSetName' => '<string>',
'MetricSource' => [
'AppFlowConfig' => [
'FlowName' => '<string>',
'RoleArn' => '<string>',
],
'AthenaSourceConfig' => [
'BackTestConfiguration' => [
'RunBackTestMode' => true || false,
],
'DataCatalog' => '<string>',
'DatabaseName' => '<string>',
'RoleArn' => '<string>',
'S3ResultsPath' => '<string>',
'TableName' => '<string>',
'WorkGroupName' => '<string>',
],
'CloudWatchConfig' => [
'BackTestConfiguration' => [
'RunBackTestMode' => true || false,
],
'RoleArn' => '<string>',
],
'RDSSourceConfig' => [
'DBInstanceIdentifier' => '<string>',
'DatabaseHost' => '<string>',
'DatabaseName' => '<string>',
'DatabasePort' => <integer>,
'RoleArn' => '<string>',
'SecretManagerArn' => '<string>',
'TableName' => '<string>',
'VpcConfiguration' => [
'SecurityGroupIdList' => ['<string>', ...],
'SubnetIdList' => ['<string>', ...],
],
],
'RedshiftSourceConfig' => [
'ClusterIdentifier' => '<string>',
'DatabaseHost' => '<string>',
'DatabaseName' => '<string>',
'DatabasePort' => <integer>,
'RoleArn' => '<string>',
'SecretManagerArn' => '<string>',
'TableName' => '<string>',
'VpcConfiguration' => [
'SecurityGroupIdList' => ['<string>', ...],
'SubnetIdList' => ['<string>', ...],
],
],
'S3SourceConfig' => [
'FileFormatDescriptor' => [
'CsvFormatDescriptor' => [
'Charset' => '<string>',
'ContainsHeader' => true || false,
'Delimiter' => '<string>',
'FileCompression' => 'NONE|GZIP',
'HeaderList' => ['<string>', ...],
'QuoteSymbol' => '<string>',
],
'JsonFormatDescriptor' => [
'Charset' => '<string>',
'FileCompression' => 'NONE|GZIP',
],
],
'HistoricalDataPathList' => ['<string>', ...],
'RoleArn' => '<string>',
'TemplatedPathList' => ['<string>', ...],
],
],
'Offset' => <integer>,
'TimestampColumn' => [
'ColumnFormat' => '<string>',
'ColumnName' => '<string>',
],
'Timezone' => '<string>',
]
Result Details
Members
- AnomalyDetectorArn
-
- Type: string
The ARN of the detector that contains the dataset.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the dataset was created.
- DimensionFilterList
-
- Type: Array of MetricSetDimensionFilter structures
The dimensions and their values that were used to filter the dataset.
- DimensionList
-
- Type: Array of strings
A list of the dimensions chosen for analysis.
- LastModificationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the dataset was last modified.
- MetricList
-
- Type: Array of Metric structures
A list of the metrics defined by the dataset.
- MetricSetArn
-
- Type: string
The ARN of the dataset.
- MetricSetDescription
-
- Type: string
The dataset's description.
- MetricSetFrequency
-
- Type: string
The interval at which the data will be analyzed for anomalies.
- MetricSetName
-
- Type: string
The name of the dataset.
- MetricSource
-
- Type: MetricSource structure
Contains information about the dataset's source data.
- Offset
-
- Type: int
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
-
- Type: TimestampColumn structure
Contains information about the column used for tracking time in your source data.
- Timezone
-
- Type: string
The time zone in which the dataset's data was recorded.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
DetectMetricSetConfig
$result = $client->detectMetricSetConfig([/* ... */]); $promise = $client->detectMetricSetConfigAsync([/* ... */]);
Detects an Amazon S3 dataset's file format, interval, and offset.
Parameter Syntax
$result = $client->detectMetricSetConfig([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'AutoDetectionMetricSource' => [ // REQUIRED
'S3SourceConfig' => [
'HistoricalDataPathList' => ['<string>', ...],
'TemplatedPathList' => ['<string>', ...],
],
],
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Required: Yes
- Type: string
An anomaly detector ARN.
- AutoDetectionMetricSource
-
- Required: Yes
- Type: AutoDetectionMetricSource structure
A data source.
Result Syntax
[
'DetectedMetricSetConfig' => [
'MetricSetFrequency' => [
'Confidence' => 'HIGH|LOW|NONE',
'Message' => '<string>',
'Value' => [
'B' => '<string>',
'BS' => ['<string>', ...],
'N' => '<string>',
'NS' => ['<string>', ...],
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
'MetricSource' => [
'S3SourceConfig' => [
'FileFormatDescriptor' => [
'CsvFormatDescriptor' => [
'Charset' => [
'Confidence' => 'HIGH|LOW|NONE',
'Message' => '<string>',
'Value' => [
'B' => '<string>',
'BS' => ['<string>', ...],
'N' => '<string>',
'NS' => ['<string>', ...],
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
'ContainsHeader' => [
'Confidence' => 'HIGH|LOW|NONE',
'Message' => '<string>',
'Value' => [
'B' => '<string>',
'BS' => ['<string>', ...],
'N' => '<string>',
'NS' => ['<string>', ...],
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
'Delimiter' => [
'Confidence' => 'HIGH|LOW|NONE',
'Message' => '<string>',
'Value' => [
'B' => '<string>',
'BS' => ['<string>', ...],
'N' => '<string>',
'NS' => ['<string>', ...],
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
'FileCompression' => [
'Confidence' => 'HIGH|LOW|NONE',
'Message' => '<string>',
'Value' => [
'B' => '<string>',
'BS' => ['<string>', ...],
'N' => '<string>',
'NS' => ['<string>', ...],
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
'HeaderList' => [
'Confidence' => 'HIGH|LOW|NONE',
'Message' => '<string>',
'Value' => [
'B' => '<string>',
'BS' => ['<string>', ...],
'N' => '<string>',
'NS' => ['<string>', ...],
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
'QuoteSymbol' => [
'Confidence' => 'HIGH|LOW|NONE',
'Message' => '<string>',
'Value' => [
'B' => '<string>',
'BS' => ['<string>', ...],
'N' => '<string>',
'NS' => ['<string>', ...],
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
],
'JsonFormatDescriptor' => [
'Charset' => [
'Confidence' => 'HIGH|LOW|NONE',
'Message' => '<string>',
'Value' => [
'B' => '<string>',
'BS' => ['<string>', ...],
'N' => '<string>',
'NS' => ['<string>', ...],
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
'FileCompression' => [
'Confidence' => 'HIGH|LOW|NONE',
'Message' => '<string>',
'Value' => [
'B' => '<string>',
'BS' => ['<string>', ...],
'N' => '<string>',
'NS' => ['<string>', ...],
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
],
],
],
],
'Offset' => [
'Confidence' => 'HIGH|LOW|NONE',
'Message' => '<string>',
'Value' => [
'B' => '<string>',
'BS' => ['<string>', ...],
'N' => '<string>',
'NS' => ['<string>', ...],
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
],
]
Result Details
Members
- DetectedMetricSetConfig
-
- Type: DetectedMetricSetConfig structure
The inferred dataset configuration for the datasource.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The request processing has failed because of an unknown error, exception, or failure.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
GetAnomalyGroup
$result = $client->getAnomalyGroup([/* ... */]); $promise = $client->getAnomalyGroupAsync([/* ... */]);
Returns details about a group of anomalous metrics.
Parameter Syntax
$result = $client->getAnomalyGroup([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'AnomalyGroupId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AnomalyGroup' => [
'AnomalyGroupId' => '<string>',
'AnomalyGroupScore' => <float>,
'EndTime' => '<string>',
'MetricLevelImpactList' => [
[
'ContributionMatrix' => [
'DimensionContributionList' => [
[
'DimensionName' => '<string>',
'DimensionValueContributionList' => [
[
'ContributionScore' => <float>,
'DimensionValue' => '<string>',
],
// ...
],
],
// ...
],
],
'MetricName' => '<string>',
'NumTimeSeries' => <integer>,
],
// ...
],
'PrimaryMetricName' => '<string>',
'StartTime' => '<string>',
],
]
Result Details
Members
- AnomalyGroup
-
- Type: AnomalyGroup structure
Details about the anomaly group.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The request processing has failed because of an unknown error, exception, or failure.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
GetDataQualityMetrics
$result = $client->getDataQualityMetrics([/* ... */]); $promise = $client->getDataQualityMetricsAsync([/* ... */]);
Returns details about the requested data quality metrics.
Parameter Syntax
$result = $client->getDataQualityMetrics([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'MetricSetArn' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'AnomalyDetectorDataQualityMetricList' => [
[
'MetricSetDataQualityMetricList' => [
[
'DataQualityMetricList' => [
[
'MetricDescription' => '<string>',
'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',
'MetricValue' => <float>,
'RelatedColumnName' => '<string>',
],
// ...
],
'MetricSetArn' => '<string>',
],
// ...
],
'StartTimestamp' => <DateTime>,
],
// ...
],
]
Result Details
Members
- AnomalyDetectorDataQualityMetricList
-
- Type: Array of AnomalyDetectorDataQualityMetric structures
A list of the data quality metrics for the
AnomalyDetectorArnthat you requested.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
GetFeedback
$result = $client->getFeedback([/* ... */]); $promise = $client->getFeedbackAsync([/* ... */]);
Get feedback for an anomaly group.
Parameter Syntax
$result = $client->getFeedback([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'AnomalyGroupTimeSeriesFeedback' => [ // REQUIRED
'AnomalyGroupId' => '<string>', // REQUIRED
'TimeSeriesId' => '<string>',
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the anomaly detector.
- AnomalyGroupTimeSeriesFeedback
-
- Required: Yes
- Type: AnomalyGroupTimeSeries structure
The anomalous metric and group ID.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Result Syntax
[
'AnomalyGroupTimeSeriesFeedback' => [
[
'IsAnomaly' => true || false,
'TimeSeriesId' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AnomalyGroupTimeSeriesFeedback
-
- Type: Array of TimeSeriesFeedback structures
Feedback for an anomalous metric.
- NextToken
-
- Type: string
The pagination token that's included if more results are available.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
You do not have sufficient permissions to perform this action.
-
The request processing has failed because of an unknown error, exception, or failure.
-
The request was denied due to too many requests being submitted at the same time.
GetSampleData
$result = $client->getSampleData([/* ... */]); $promise = $client->getSampleDataAsync([/* ... */]);
Returns a selection of sample records from an Amazon S3 datasource.
Parameter Syntax
$result = $client->getSampleData([
'S3SourceConfig' => [
'FileFormatDescriptor' => [ // REQUIRED
'CsvFormatDescriptor' => [
'Charset' => '<string>',
'ContainsHeader' => true || false,
'Delimiter' => '<string>',
'FileCompression' => 'NONE|GZIP',
'HeaderList' => ['<string>', ...],
'QuoteSymbol' => '<string>',
],
'JsonFormatDescriptor' => [
'Charset' => '<string>',
'FileCompression' => 'NONE|GZIP',
],
],
'HistoricalDataPathList' => ['<string>', ...],
'RoleArn' => '<string>', // REQUIRED
'TemplatedPathList' => ['<string>', ...],
],
]);
Parameter Details
Members
- S3SourceConfig
-
- Type: SampleDataS3SourceConfig structure
A datasource bucket in Amazon S3.
Result Syntax
[
'HeaderValues' => ['<string>', ...],
'SampleRows' => [
['<string>', ...],
// ...
],
]
Result Details
Members
Errors
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
ListAlerts
$result = $client->listAlerts([/* ... */]); $promise = $client->listAlertsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listAlerts([
'AnomalyDetectorArn' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Type: string
The ARN of the alert's detector.
- MaxResults
-
- Type: int
The maximum number of results that will be displayed by the request.
- NextToken
-
- Type: 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.
Result Syntax
[
'AlertSummaryList' => [
[
'AlertArn' => '<string>',
'AlertName' => '<string>',
'AlertSensitivityThreshold' => <integer>,
'AlertStatus' => 'ACTIVE|INACTIVE',
'AlertType' => 'SNS|LAMBDA',
'AnomalyDetectorArn' => '<string>',
'CreationTime' => <DateTime>,
'LastModificationTime' => <DateTime>,
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AlertSummaryList
-
- Type: Array of AlertSummary structures
Contains information about an alert.
- NextToken
-
- Type: 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.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
You do not have sufficient permissions to perform this action.
-
The request processing has failed because of an unknown error, exception, or failure.
-
The request was denied due to too many requests being submitted at the same time.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
ListAnomalyDetectors
$result = $client->listAnomalyDetectors([/* ... */]); $promise = $client->listAnomalyDetectorsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listAnomalyDetectors([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'AnomalyDetectorSummaryList' => [
[
'AnomalyDetectorArn' => '<string>',
'AnomalyDetectorDescription' => '<string>',
'AnomalyDetectorName' => '<string>',
'CreationTime' => <DateTime>,
'LastModificationTime' => <DateTime>,
'Status' => 'ACTIVE|ACTIVATING|DELETING|FAILED|INACTIVE|LEARNING|BACK_TEST_ACTIVATING|BACK_TEST_ACTIVE|BACK_TEST_COMPLETE|DEACTIVATED|DEACTIVATING',
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AnomalyDetectorSummaryList
-
- Type: Array of AnomalyDetectorSummary structures
A list of anomaly detectors in the account in the current region.
- NextToken
-
- Type: 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.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
ListAnomalyGroupRelatedMetrics
$result = $client->listAnomalyGroupRelatedMetrics([/* ... */]); $promise = $client->listAnomalyGroupRelatedMetricsAsync([/* ... */]);
Returns a list of measures that are potential causes or effects of an anomaly group.
Parameter Syntax
$result = $client->listAnomalyGroupRelatedMetrics([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'AnomalyGroupId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'RelationshipTypeFilter' => 'CAUSE_OF_INPUT_ANOMALY_GROUP|EFFECT_OF_INPUT_ANOMALY_GROUP',
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the anomaly detector.
- AnomalyGroupId
-
- Required: Yes
- Type: string
The ID of the anomaly group.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
- RelationshipTypeFilter
-
- Type: string
Filter for potential causes (
CAUSE_OF_INPUT_ANOMALY_GROUP) or downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.
Result Syntax
[
'InterMetricImpactList' => [
[
'AnomalyGroupId' => '<string>',
'ContributionPercentage' => <float>,
'MetricName' => '<string>',
'RelationshipType' => 'CAUSE_OF_INPUT_ANOMALY_GROUP|EFFECT_OF_INPUT_ANOMALY_GROUP',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- InterMetricImpactList
-
- Type: Array of InterMetricImpactDetails structures
Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.
- NextToken
-
- Type: string
The pagination token that's included if more results are available.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The request processing has failed because of an unknown error, exception, or failure.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
ListAnomalyGroupSummaries
$result = $client->listAnomalyGroupSummaries([/* ... */]); $promise = $client->listAnomalyGroupSummariesAsync([/* ... */]);
Returns a list of anomaly groups.
Parameter Syntax
$result = $client->listAnomalyGroupSummaries([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SensitivityThreshold' => <integer>, // REQUIRED
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the anomaly detector.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
- SensitivityThreshold
-
- Required: Yes
- Type: int
The minimum severity score for inclusion in the output.
Result Syntax
[
'AnomalyGroupStatistics' => [
'EvaluationStartDate' => '<string>',
'ItemizedMetricStatsList' => [
[
'MetricName' => '<string>',
'OccurrenceCount' => <integer>,
],
// ...
],
'TotalCount' => <integer>,
],
'AnomalyGroupSummaryList' => [
[
'AnomalyGroupId' => '<string>',
'AnomalyGroupScore' => <float>,
'EndTime' => '<string>',
'PrimaryMetricName' => '<string>',
'StartTime' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AnomalyGroupStatistics
-
- Type: AnomalyGroupStatistics structure
Aggregated details about the anomaly groups.
- AnomalyGroupSummaryList
-
- Type: Array of AnomalyGroupSummary structures
A list of anomaly group summaries.
- NextToken
-
- Type: string
The pagination token that's included if more results are available.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The request processing has failed because of an unknown error, exception, or failure.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
ListAnomalyGroupTimeSeries
$result = $client->listAnomalyGroupTimeSeries([/* ... */]); $promise = $client->listAnomalyGroupTimeSeriesAsync([/* ... */]);
Gets a list of anomalous metrics for a measure in an anomaly group.
Parameter Syntax
$result = $client->listAnomalyGroupTimeSeries([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'AnomalyGroupId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'MetricName' => '<string>', // REQUIRED
'NextToken' => '<string>',
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the anomaly detector.
- AnomalyGroupId
-
- Required: Yes
- Type: string
The ID of the anomaly group.
- MaxResults
-
- Type: int
The maximum number of results to return.
- MetricName
-
- Required: Yes
- Type: string
The name of the measure field.
- NextToken
-
- Type: string
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
Result Syntax
[
'AnomalyGroupId' => '<string>',
'MetricName' => '<string>',
'NextToken' => '<string>',
'TimeSeriesList' => [
[
'DimensionList' => [
[
'DimensionName' => '<string>',
'DimensionValue' => '<string>',
],
// ...
],
'MetricValueList' => [<float>, ...],
'TimeSeriesId' => '<string>',
],
// ...
],
'TimestampList' => ['<string>', ...],
]
Result Details
Members
- AnomalyGroupId
-
- Type: string
The ID of the anomaly group.
- MetricName
-
- Type: string
The name of the measure field.
- NextToken
-
- Type: string
The pagination token that's included if more results are available.
- TimeSeriesList
-
- Type: Array of TimeSeries structures
A list of anomalous metrics.
- TimestampList
-
- Type: Array of strings
Timestamps for the anomalous metrics.
Errors
-
The request processing has failed because of an unknown error, exception, or failure.
-
You do not have sufficient permissions to perform this action.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The request was denied due to too many requests being submitted at the same time.
ListMetricSets
$result = $client->listMetricSets([/* ... */]); $promise = $client->listMetricSetsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listMetricSets([
'AnomalyDetectorArn' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Type: string
The ARN of the anomaly detector containing the metrics sets to list.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: 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.
Result Syntax
[
'MetricSetSummaryList' => [
[
'AnomalyDetectorArn' => '<string>',
'CreationTime' => <DateTime>,
'LastModificationTime' => <DateTime>,
'MetricSetArn' => '<string>',
'MetricSetDescription' => '<string>',
'MetricSetName' => '<string>',
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- MetricSetSummaryList
-
- Type: Array of MetricSetSummary structures
A list of the datasets in the AWS Region, with configuration details for each.
- NextToken
-
- Type: 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.
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
The request processing has failed because of an unknown error, exception, or failure.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Gets a list of tags for a detector, dataset, or alert.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
The request processing has failed because of an unknown error, exception, or failure.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
PutFeedback
$result = $client->putFeedback([/* ... */]); $promise = $client->putFeedbackAsync([/* ... */]);
Add feedback for an anomalous metric.
Parameter Syntax
$result = $client->putFeedback([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'AnomalyGroupTimeSeriesFeedback' => [ // REQUIRED
'AnomalyGroupId' => '<string>', // REQUIRED
'IsAnomaly' => true || false, // REQUIRED
'TimeSeriesId' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the anomaly detector.
- AnomalyGroupTimeSeriesFeedback
-
- Required: Yes
- Type: AnomalyGroupTimeSeriesFeedback structure
Feedback for an anomalous metric.
Result Syntax
[]
Result Details
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
You do not have sufficient permissions to perform this action.
-
The request processing has failed because of an unknown error, exception, or failure.
-
The request was denied due to too many requests being submitted at the same time.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds tags to a detector, dataset, or alert.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception, or failure.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from a detector, dataset, or alert.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception, or failure.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
UpdateAlert
$result = $client->updateAlert([/* ... */]); $promise = $client->updateAlertAsync([/* ... */]);
Make changes to an existing alert.
Parameter Syntax
$result = $client->updateAlert([
'Action' => [
'LambdaConfiguration' => [
'LambdaArn' => '<string>', // REQUIRED
'RoleArn' => '<string>', // REQUIRED
],
'SNSConfiguration' => [
'RoleArn' => '<string>', // REQUIRED
'SnsFormat' => 'LONG_TEXT|SHORT_TEXT|JSON',
'SnsTopicArn' => '<string>', // REQUIRED
],
],
'AlertArn' => '<string>', // REQUIRED
'AlertDescription' => '<string>',
'AlertFilters' => [
'DimensionFilterList' => [
[
'DimensionName' => '<string>',
'DimensionValueList' => ['<string>', ...],
],
// ...
],
'MetricList' => ['<string>', ...],
],
'AlertSensitivityThreshold' => <integer>,
]);
Parameter Details
Members
- Action
-
- Type: Action structure
Action that will be triggered when there is an alert.
- AlertArn
-
- Required: Yes
- Type: string
The ARN of the alert to update.
- AlertDescription
-
- Type: string
A description of the alert.
- AlertFilters
-
- Type: AlertFilters structure
The configuration of the alert filters, containing MetricList and DimensionFilterList.
- AlertSensitivityThreshold
-
- Type: int
An integer from 0 to 100 specifying the alert sensitivity threshold.
Result Syntax
[
'AlertArn' => '<string>',
]
Result Details
Errors
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The request processing has failed because of an unknown error, exception, or failure.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
UpdateAnomalyDetector
$result = $client->updateAnomalyDetector([/* ... */]); $promise = $client->updateAnomalyDetectorAsync([/* ... */]);
Updates a detector. After activation, you can only change a detector's ingestion delay and description.
Parameter Syntax
$result = $client->updateAnomalyDetector([
'AnomalyDetectorArn' => '<string>', // REQUIRED
'AnomalyDetectorConfig' => [
'AnomalyDetectorFrequency' => 'P1D|PT1H|PT10M|PT5M',
],
'AnomalyDetectorDescription' => '<string>',
'KmsKeyArn' => '<string>',
]);
Parameter Details
Members
- AnomalyDetectorArn
-
- Required: Yes
- Type: string
The ARN of the detector to update.
- AnomalyDetectorConfig
-
- Type: AnomalyDetectorConfig structure
Contains information about the configuration to which the detector will be updated.
- AnomalyDetectorDescription
-
- Type: string
The updated detector description.
- KmsKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of an AWS KMS encryption key.
Result Syntax
[
'AnomalyDetectorArn' => '<string>',
]
Result Details
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The request processing has failed because of an unknown error, exception, or failure.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
UpdateMetricSet
$result = $client->updateMetricSet([/* ... */]); $promise = $client->updateMetricSetAsync([/* ... */]);
Updates a dataset.
Parameter Syntax
$result = $client->updateMetricSet([
'DimensionFilterList' => [
[
'FilterList' => [
[
'DimensionValue' => '<string>',
'FilterOperation' => 'EQUALS',
],
// ...
],
'Name' => '<string>',
],
// ...
],
'DimensionList' => ['<string>', ...],
'MetricList' => [
[
'AggregationFunction' => 'AVG|SUM', // REQUIRED
'MetricName' => '<string>', // REQUIRED
'Namespace' => '<string>',
],
// ...
],
'MetricSetArn' => '<string>', // REQUIRED
'MetricSetDescription' => '<string>',
'MetricSetFrequency' => 'P1D|PT1H|PT10M|PT5M',
'MetricSource' => [
'AppFlowConfig' => [
'FlowName' => '<string>',
'RoleArn' => '<string>',
],
'AthenaSourceConfig' => [
'BackTestConfiguration' => [
'RunBackTestMode' => true || false, // REQUIRED
],
'DataCatalog' => '<string>',
'DatabaseName' => '<string>',
'RoleArn' => '<string>',
'S3ResultsPath' => '<string>',
'TableName' => '<string>',
'WorkGroupName' => '<string>',
],
'CloudWatchConfig' => [
'BackTestConfiguration' => [
'RunBackTestMode' => true || false, // REQUIRED
],
'RoleArn' => '<string>',
],
'RDSSourceConfig' => [
'DBInstanceIdentifier' => '<string>',
'DatabaseHost' => '<string>',
'DatabaseName' => '<string>',
'DatabasePort' => <integer>,
'RoleArn' => '<string>',
'SecretManagerArn' => '<string>',
'TableName' => '<string>',
'VpcConfiguration' => [
'SecurityGroupIdList' => ['<string>', ...], // REQUIRED
'SubnetIdList' => ['<string>', ...], // REQUIRED
],
],
'RedshiftSourceConfig' => [
'ClusterIdentifier' => '<string>',
'DatabaseHost' => '<string>',
'DatabaseName' => '<string>',
'DatabasePort' => <integer>,
'RoleArn' => '<string>',
'SecretManagerArn' => '<string>',
'TableName' => '<string>',
'VpcConfiguration' => [
'SecurityGroupIdList' => ['<string>', ...], // REQUIRED
'SubnetIdList' => ['<string>', ...], // REQUIRED
],
],
'S3SourceConfig' => [
'FileFormatDescriptor' => [
'CsvFormatDescriptor' => [
'Charset' => '<string>',
'ContainsHeader' => true || false,
'Delimiter' => '<string>',
'FileCompression' => 'NONE|GZIP',
'HeaderList' => ['<string>', ...],
'QuoteSymbol' => '<string>',
],
'JsonFormatDescriptor' => [
'Charset' => '<string>',
'FileCompression' => 'NONE|GZIP',
],
],
'HistoricalDataPathList' => ['<string>', ...],
'RoleArn' => '<string>',
'TemplatedPathList' => ['<string>', ...],
],
],
'Offset' => <integer>,
'TimestampColumn' => [
'ColumnFormat' => '<string>',
'ColumnName' => '<string>',
],
]);
Parameter Details
Members
- DimensionFilterList
-
- Type: Array of MetricSetDimensionFilter structures
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.
- DimensionList
-
- Type: Array of strings
The dimension list.
- MetricList
-
- Type: Array of Metric structures
The metric list.
- MetricSetArn
-
- Required: Yes
- Type: string
The ARN of the dataset to update.
- MetricSetDescription
-
- Type: string
The dataset's description.
- MetricSetFrequency
-
- Type: string
The dataset's interval.
- MetricSource
-
- Type: MetricSource structure
Contains information about source data used to generate metrics.
- Offset
-
- Type: int
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
-
- Type: TimestampColumn structure
The timestamp column.
Result Syntax
[
'MetricSetArn' => '<string>',
]
Result Details
Errors
-
The specified resource cannot be found. Check the ARN of the resource and try again.
-
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
-
The request processing has failed because of an unknown error, exception, or failure.
-
You do not have sufficient permissions to perform this action.
-
The request was denied due to too many requests being submitted at the same time.
-
ServiceQuotaExceededException:
The request exceeded the service's quotas. Check the service quotas and try again.
Shapes
AccessDeniedException
Description
You do not have sufficient permissions to perform this action.
Members
Action
Description
A configuration that specifies the action to perform when anomalies are detected.
Members
- LambdaConfiguration
-
- Type: LambdaConfiguration structure
A configuration for an AWS Lambda channel.
- SNSConfiguration
-
- Type: SNSConfiguration structure
A configuration for an Amazon SNS channel.
Alert
Description
A configuration for Amazon SNS-integrated notifications.
Members
- Action
-
- Type: Action structure
Action that will be triggered when there is an alert.
- AlertArn
-
- Type: string
The ARN of the alert.
- AlertDescription
-
- Type: string
A description of the alert.
- AlertFilters
-
- Type: AlertFilters structure
The configuration of the alert filters, containing MetricList and DimensionFilter.
- AlertName
-
- Type: string
The name of the alert.
- AlertSensitivityThreshold
-
- Type: int
The minimum severity for an anomaly to trigger the alert.
- AlertStatus
-
- Type: string
The status of the alert.
- AlertType
-
- Type: string
The type of the alert.
- AnomalyDetectorArn
-
- Type: string
The ARN of the detector to which the alert is attached.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the alert was created.
- LastModificationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the alert was last modified.
AlertFilters
Description
The configuration of the alert filters.
Members
- DimensionFilterList
-
- Type: Array of DimensionFilter structures
The list of DimensionFilter objects that are used for dimension-based filtering.
- MetricList
-
- Type: Array of strings
The list of measures that you want to get alerts for.
AlertSummary
Description
Provides a summary of an alert's configuration.
Members
- AlertArn
-
- Type: string
The ARN of the alert.
- AlertName
-
- Type: string
The name of the alert.
- AlertSensitivityThreshold
-
- Type: int
The minimum severity for an anomaly to trigger the alert.
- AlertStatus
-
- Type: string
The status of the alert.
- AlertType
-
- Type: string
The type of the alert.
- AnomalyDetectorArn
-
- Type: string
The ARN of the detector to which the alert is attached.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the alert was created.
- LastModificationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the alert was last modified.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The alert's tags.
AnomalyDetectorConfig
Description
Contains information about a detector's configuration.
Members
AnomalyDetectorConfigSummary
Description
Contains information about a detector's configuration.
Members
AnomalyDetectorDataQualityMetric
Description
Aggregated details about the data quality metrics collected for the AnomalyDetectorArn provided in the GetDataQualityMetrics object.
Members
- MetricSetDataQualityMetricList
-
- Type: Array of MetricSetDataQualityMetric structures
An array of
DataQualityMetricListobjects. Each object in the array contains information about a data quality metric. - StartTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time for the data quality metrics collection.
AnomalyDetectorSummary
Description
Contains information about an an anomaly detector.
Members
- AnomalyDetectorArn
-
- Type: string
The ARN of the detector.
- AnomalyDetectorDescription
-
- Type: string
A description of the detector.
- AnomalyDetectorName
-
- Type: string
The name of the detector.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the detector was created.
- LastModificationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the detector was last modified.
- Status
-
- Type: string
The status of detector.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The detector's tags.
AnomalyGroup
Description
A group of anomalous metrics
Members
- AnomalyGroupId
-
- Type: string
The ID of the anomaly group.
- AnomalyGroupScore
-
- Type: double
The severity score of the group.
- EndTime
-
- Type: string
The end time for the group.
- MetricLevelImpactList
-
- Type: Array of MetricLevelImpact structures
A list of measures affected by the anomaly.
- PrimaryMetricName
-
- Type: string
The name of the primary affected measure for the group.
- StartTime
-
- Type: string
The start time for the group.
AnomalyGroupStatistics
Description
Aggregated statistics for a group of anomalous metrics.
Members
- EvaluationStartDate
-
- Type: string
The start of the time range that was searched.
- ItemizedMetricStatsList
-
- Type: Array of ItemizedMetricStats structures
Statistics for individual metrics within the group.
- TotalCount
-
- Type: int
The number of groups found.
AnomalyGroupSummary
Description
Details about a group of anomalous metrics.
Members
- AnomalyGroupId
-
- Type: string
The ID of the anomaly group.
- AnomalyGroupScore
-
- Type: double
The severity score of the group.
- EndTime
-
- Type: string
The end time for the group.
- PrimaryMetricName
-
- Type: string
The name of the primary affected measure for the group.
- StartTime
-
- Type: string
The start time for the group.
AnomalyGroupTimeSeries
Description
An anomalous metric in an anomaly group.
Members
AnomalyGroupTimeSeriesFeedback
Description
Feedback for an anomalous metric.
Members
AppFlowConfig
Description
Details about an Amazon AppFlow flow datasource.
Members
AthenaSourceConfig
Description
Details about an Amazon Athena datasource.
Members
- BackTestConfiguration
-
- Type: BackTestConfiguration structure
Settings for backtest mode.
- DataCatalog
-
- Type: string
The database's data catalog.
- DatabaseName
-
- Type: string
The database's name.
- RoleArn
-
- Type: string
An IAM role that gives Amazon Lookout for Metrics permission to access the data.
- S3ResultsPath
-
- Type: string
The database's results path.
- TableName
-
- Type: string
The database's table name.
- WorkGroupName
-
- Type: string
The database's work group name.
AttributeValue
Description
An attribute value.
Members
AutoDetectionMetricSource
Description
An auto detection metric source.
Members
- S3SourceConfig
-
- Type: AutoDetectionS3SourceConfig structure
The source's source config.
AutoDetectionS3SourceConfig
Description
An auto detection source config.
Members
BackTestConfiguration
Description
Settings for backtest mode.
Members
CloudWatchConfig
Description
Details about an Amazon CloudWatch datasource.
Members
- BackTestConfiguration
-
- Type: BackTestConfiguration structure
Settings for backtest mode.
- RoleArn
-
- Type: string
An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
ConflictException
Description
There was a conflict processing the request. Try your request again.
Members
ContributionMatrix
Description
Details about dimensions that contributed to an anomaly.
Members
- DimensionContributionList
-
- Type: Array of DimensionContribution structures
A list of contributing dimensions.
CsvFormatDescriptor
Description
Contains information about how a source CSV data file should be analyzed.
Members
- Charset
-
- Type: string
The character set in which the source CSV file is written.
- ContainsHeader
-
- Type: boolean
Whether or not the source CSV file contains a header.
- Delimiter
-
- Type: string
The character used to delimit the source CSV file.
- FileCompression
-
- Type: string
The level of compression of the source CSV file.
- HeaderList
-
- Type: Array of strings
A list of the source CSV file's headers, if any.
- QuoteSymbol
-
- Type: string
The character used as a quote character.
DataQualityMetric
Description
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.
Members
DetectedCsvFormatDescriptor
Description
Properties of an inferred CSV format.
Members
- Charset
-
- Type: DetectedField structure
The format's charset.
- ContainsHeader
-
- Type: DetectedField structure
Whether the format includes a header.
- Delimiter
-
- Type: DetectedField structure
The format's delimiter.
- FileCompression
-
- Type: DetectedField structure
The format's file compression.
- HeaderList
-
- Type: DetectedField structure
The format's header list.
- QuoteSymbol
-
- Type: DetectedField structure
The format's quote symbol.
DetectedField
Description
An inferred field.
Members
- Confidence
-
- Type: string
The field's confidence.
- Message
-
- Type: string
The field's message.
- Value
-
- Type: AttributeValue structure
The field's value.
DetectedFileFormatDescriptor
Description
Properties of an inferred data format.
Members
- CsvFormatDescriptor
-
- Type: DetectedCsvFormatDescriptor structure
Details about a CSV format.
- JsonFormatDescriptor
-
- Type: DetectedJsonFormatDescriptor structure
Details about a JSON format.
DetectedJsonFormatDescriptor
Description
A detected JSON format descriptor.
Members
- Charset
-
- Type: DetectedField structure
The format's character set.
- FileCompression
-
- Type: DetectedField structure
The format's file compression.
DetectedMetricSetConfig
Description
An inferred dataset configuration.
Members
- MetricSetFrequency
-
- Type: DetectedField structure
The dataset's interval.
- MetricSource
-
- Type: DetectedMetricSource structure
The dataset's data source.
- Offset
-
- Type: DetectedField structure
The dataset's offset.
DetectedMetricSource
Description
An inferred data source.
Members
- S3SourceConfig
-
- Type: DetectedS3SourceConfig structure
The data source's source configuration.
DetectedS3SourceConfig
Description
An inferred source configuration.
Members
- FileFormatDescriptor
-
- Type: DetectedFileFormatDescriptor structure
The source's file format descriptor.
DimensionContribution
Description
Details about a dimension that contributed to an anomaly.
Members
- DimensionName
-
- Type: string
The name of the dimension.
- DimensionValueContributionList
-
- Type: Array of DimensionValueContribution structures
A list of dimension values that contributed to the anomaly.
DimensionFilter
Description
The dimension filter, containing DimensionName and DimensionValueList.
Members
DimensionNameValue
Description
A dimension name and value.
Members
DimensionValueContribution
Description
The severity of a value of a dimension that contributed to an anomaly.
Members
ExecutionStatus
Description
The status of an anomaly detector run.
Members
FileFormatDescriptor
Description
Contains information about a source file's formatting.
Members
- CsvFormatDescriptor
-
- Type: CsvFormatDescriptor structure
Contains information about how a source CSV data file should be analyzed.
- JsonFormatDescriptor
-
- Type: JsonFormatDescriptor structure
Contains information about how a source JSON data file should be analyzed.
Filter
Description
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.
Members
InterMetricImpactDetails
Description
Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.
Members
- AnomalyGroupId
-
- Type: string
The ID of the anomaly group.
- ContributionPercentage
-
- Type: double
For potential causes (
CAUSE_OF_INPUT_ANOMALY_GROUP), the percentage contribution the measure has in causing the anomalies. - MetricName
-
- Type: string
The name of the measure.
- RelationshipType
-
- Type: 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).
InternalServerException
Description
The request processing has failed because of an unknown error, exception, or failure.
Members
ItemizedMetricStats
Description
Aggregated statistics about a measure affected by an anomaly.
Members
JsonFormatDescriptor
Description
Contains information about how a source JSON data file should be analyzed.
Members
LambdaConfiguration
Description
Contains information about a Lambda configuration.
Members
Metric
Description
A calculation made by contrasting a measure and a dimension from your source data.
Members
MetricLevelImpact
Description
Details about a measure affected by an anomaly.
Members
- ContributionMatrix
-
- Type: ContributionMatrix structure
Details about the dimensions that contributed to the anomaly.
- MetricName
-
- Type: string
The name of the measure.
- NumTimeSeries
-
- Type: int
The number of anomalous metrics for the measure.
MetricSetDataQualityMetric
Description
An array of DataQualityMetric objects that describes one or more data quality metrics.
Members
- DataQualityMetricList
-
- Type: Array of DataQualityMetric structures
The array of data quality metrics contained in the data quality metric set.
- MetricSetArn
-
- Type: string
The Amazon Resource Name (ARN) of the data quality metric array.
MetricSetDimensionFilter
Description
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.
Members
- FilterList
-
- Type: Array of Filter structures
The list of filters that you are applying.
- Name
-
- Type: string
The dimension that you want to filter on.
MetricSetSummary
Description
Contains information about a dataset.
Members
- AnomalyDetectorArn
-
- Type: string
The ARN of the detector to which the dataset belongs.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the dataset was created.
- LastModificationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the dataset was last modified.
- MetricSetArn
-
- Type: string
The ARN of the dataset.
- MetricSetDescription
-
- Type: string
The description of the dataset.
- MetricSetName
-
- Type: string
The name of the dataset.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The dataset's tags.
MetricSource
Description
Contains information about source data used to generate metrics.
Members
- AppFlowConfig
-
- Type: AppFlowConfig structure
Details about an AppFlow datasource.
- AthenaSourceConfig
-
- Type: AthenaSourceConfig structure
Details about an Amazon Athena datasource.
- CloudWatchConfig
-
- Type: CloudWatchConfig structure
Details about an Amazon CloudWatch monitoring datasource.
- RDSSourceConfig
-
- Type: RDSSourceConfig structure
Details about an Amazon Relational Database Service (RDS) datasource.
- RedshiftSourceConfig
-
- Type: RedshiftSourceConfig structure
Details about an Amazon Redshift database datasource.
- S3SourceConfig
-
- Type: S3SourceConfig structure
Contains information about the configuration of the S3 bucket that contains source files.
RDSSourceConfig
Description
Contains information about the Amazon Relational Database Service (RDS) configuration.
Members
- DBInstanceIdentifier
-
- Type: string
A string identifying the database instance.
- DatabaseHost
-
- Type: string
The host name of the database.
- DatabaseName
-
- Type: string
The name of the RDS database.
- DatabasePort
-
- Type: int
The port number where the database can be accessed.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role.
- SecretManagerArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
- TableName
-
- Type: string
The name of the table in the database.
- VpcConfiguration
-
- Type: VpcConfiguration structure
An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
RedshiftSourceConfig
Description
Provides information about the Amazon Redshift database configuration.
Members
- ClusterIdentifier
-
- Type: string
A string identifying the Redshift cluster.
- DatabaseHost
-
- Type: string
The name of the database host.
- DatabaseName
-
- Type: string
The Redshift database name.
- DatabasePort
-
- Type: int
The port number where the database can be accessed.
- RoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the role providing access to the database.
- SecretManagerArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
- TableName
-
- Type: string
The table name of the Redshift database.
- VpcConfiguration
-
- Type: VpcConfiguration structure
Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
ResourceNotFoundException
Description
The specified resource cannot be found. Check the ARN of the resource and try again.
Members
S3SourceConfig
Description
Contains information about the configuration of the S3 bucket that contains source files.
Members
- FileFormatDescriptor
-
- Type: FileFormatDescriptor structure
Contains information about a source file's formatting.
- HistoricalDataPathList
-
- Type: Array of strings
A list of paths to the historical data files.
- RoleArn
-
- Type: string
The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
- TemplatedPathList
-
- Type: Array of strings
A list of templated paths to the source files.
SNSConfiguration
Description
Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.
Members
- RoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that has access to the target SNS topic.
- SnsFormat
-
- Type: 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.
- SnsTopicArn
-
- Required: Yes
- Type: string
The ARN of the target SNS topic.
SampleDataS3SourceConfig
Description
Contains information about the source configuration in Amazon S3.
Members
- FileFormatDescriptor
-
- Required: Yes
- Type: FileFormatDescriptor structure
Contains information about a source file's formatting.
- HistoricalDataPathList
-
- Type: Array of strings
An array of strings containing the historical set of data paths.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the role.
- TemplatedPathList
-
- Type: Array of strings
An array of strings containing the list of templated paths.
ServiceQuotaExceededException
Description
The request exceeded the service's quotas. Check the service quotas and try again.
Members
TimeSeries
Description
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.
Members
- DimensionList
-
- Required: Yes
- Type: Array of DimensionNameValue structures
The dimensions of the metric.
- MetricValueList
-
- Required: Yes
- Type: Array of doubles
The values for the metric.
- TimeSeriesId
-
- Required: Yes
- Type: string
The ID of the metric.
TimeSeriesFeedback
Description
Details about feedback submitted for an anomalous metric.
Members
TimestampColumn
Description
Contains information about the column used to track time in a source data file.
Members
TooManyRequestsException
Description
The request was denied due to too many requests being submitted at the same time.
Members
ValidationException
Description
The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
Members
- Fields
-
- Type: Array of ValidationExceptionField structures
Fields that failed validation.
- Message
-
- Required: Yes
- Type: string
- Reason
-
- Type: string
The reason that validation failed.
ValidationExceptionField
Description
Contains information about a a field in a validation exception.
Members
VpcConfiguration
Description
Contains configuration information about the Amazon Virtual Private Cloud (VPC).