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

ValidationException:

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

ResourceNotFoundException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

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

ResourceNotFoundException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

Result Syntax

[
    'AlertArn' => '<string>',
]

Result Details

Errors

ConflictException:

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

ValidationException:

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.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

ResourceNotFoundException:

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

InternalServerException:

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

Result Syntax

[
    'AnomalyDetectorArn' => '<string>',
]

Result Details

Errors

ConflictException:

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

ValidationException:

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.

ConflictException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

Result Syntax

[
    'MetricSetArn' => '<string>',
]

Result Details

Errors

ConflictException:

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

ValidationException:

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

ResourceNotFoundException:

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.

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

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

ConflictException:

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

ResourceNotFoundException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

ResourceNotFoundException:

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

ValidationException:

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

TooManyRequestsException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

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

ResourceNotFoundException:

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

ValidationException:

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

ConflictException:

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

TooManyRequestsException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

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

Errors

ResourceNotFoundException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

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

TooManyRequestsException:

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

Result Syntax

[
    'ExecutionList' => [
        [
            'FailureReason' => '<string>',
            'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|FAILED_TO_SCHEDULE',
            'Timestamp' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

Errors

ResourceNotFoundException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

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

TooManyRequestsException:

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

Errors

ResourceNotFoundException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

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

Errors

ResourceNotFoundException:

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

ValidationException:

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

InternalServerException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

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

Errors

ResourceNotFoundException:

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

ValidationException:

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

InternalServerException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

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

Errors

ResourceNotFoundException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

Result Syntax

[
    'AnomalyGroupTimeSeriesFeedback' => [
        [
            'IsAnomaly' => true || false,
            'TimeSeriesId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

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

TooManyRequestsException:

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

Result Syntax

[
    'HeaderValues' => ['<string>', ...],
    'SampleRows' => [
        ['<string>', ...],
        // ...
    ],
]

Result Details

Errors

ValidationException:

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

ResourceNotFoundException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

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

Errors

ResourceNotFoundException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

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

TooManyRequestsException:

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

ValidationException:

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

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

Errors

ResourceNotFoundException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

Result Syntax

[
    'InterMetricImpactList' => [
        [
            'AnomalyGroupId' => '<string>',
            'ContributionPercentage' => <float>,
            'MetricName' => '<string>',
            'RelationshipType' => 'CAUSE_OF_INPUT_ANOMALY_GROUP|EFFECT_OF_INPUT_ANOMALY_GROUP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

ValidationException:

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

InternalServerException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

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

Errors

ResourceNotFoundException:

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

ValidationException:

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

InternalServerException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

Result Syntax

[
    'AnomalyGroupId' => '<string>',
    'MetricName' => '<string>',
    'NextToken' => '<string>',
    'TimeSeriesList' => [
        [
            'DimensionList' => [
                [
                    'DimensionName' => '<string>',
                    'DimensionValue' => '<string>',
                ],
                // ...
            ],
            'MetricValueList' => [<float>, ...],
            'TimeSeriesId' => '<string>',
        ],
        // ...
    ],
    'TimestampList' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

ValidationException:

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

ResourceNotFoundException:

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

TooManyRequestsException:

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

Result Syntax

[
    'MetricSetSummaryList' => [
        [
            'AnomalyDetectorArn' => '<string>',
            'CreationTime' => <DateTime>,
            'LastModificationTime' => <DateTime>,
            'MetricSetArn' => '<string>',
            'MetricSetDescription' => '<string>',
            'MetricSetName' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

InternalServerException:

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

Errors

InternalServerException:

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

ValidationException:

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

ResourceNotFoundException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

ValidationException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

InternalServerException:

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

TooManyRequestsException:

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

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ResourceNotFoundException:

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

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ValidationException:

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

ResourceNotFoundException:

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

Result Syntax

[
    'AlertArn' => '<string>',
]

Result Details

Errors

ValidationException:

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

ResourceNotFoundException:

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

InternalServerException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

Result Syntax

[
    'AnomalyDetectorArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

ValidationException:

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

InternalServerException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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

Result Syntax

[
    'MetricSetArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

ValidationException:

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

InternalServerException:

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

AccessDeniedException:

You do not have sufficient permissions to perform this action.

TooManyRequestsException:

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.