DescribeMetricSet - Amazon Lookout for Metrics

DescribeMetricSet

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.

Request Syntax

POST /DescribeMetricSet HTTP/1.1 Content-type: application/json { "MetricSetArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MetricSetArn

The ARN of the dataset.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):.*:.*:.*:.+

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AnomalyDetectorArn": "string", "CreationTime": number, "DimensionList": [ "string" ], "LastModificationTime": number, "MetricList": [ { "AggregationFunction": "string", "MetricName": "string", "Namespace": "string" } ], "MetricSetArn": "string", "MetricSetDescription": "string", "MetricSetFrequency": "string", "MetricSetName": "string", "MetricSource": { "AppFlowConfig": { "FlowName": "string", "RoleArn": "string" }, "CloudWatchConfig": { "RoleArn": "string" }, "RDSSourceConfig": { "DatabaseHost": "string", "DatabaseName": "string", "DatabasePort": number, "DBInstanceIdentifier": "string", "RoleArn": "string", "SecretManagerArn": "string", "TableName": "string", "VpcConfiguration": { "SecurityGroupIdList": [ "string" ], "SubnetIdList": [ "string" ] } }, "RedshiftSourceConfig": { "ClusterIdentifier": "string", "DatabaseHost": "string", "DatabaseName": "string", "DatabasePort": number, "RoleArn": "string", "SecretManagerArn": "string", "TableName": "string", "VpcConfiguration": { "SecurityGroupIdList": [ "string" ], "SubnetIdList": [ "string" ] } }, "S3SourceConfig": { "FileFormatDescriptor": { "CsvFormatDescriptor": { "Charset": "string", "ContainsHeader": boolean, "Delimiter": "string", "FileCompression": "string", "HeaderList": [ "string" ], "QuoteSymbol": "string" }, "JsonFormatDescriptor": { "Charset": "string", "FileCompression": "string" } }, "HistoricalDataPathList": [ "string" ], "RoleArn": "string", "TemplatedPathList": [ "string" ] } }, "Offset": number, "TimestampColumn": { "ColumnFormat": "string", "ColumnName": "string" }, "Timezone": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AnomalyDetectorArn

The ARN of the detector that contains the dataset.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):.*:.*:.*:.+

CreationTime

The time at which the dataset was created.

Type: Timestamp

DimensionList

A list of the dimensions chosen for analysis.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

LastModificationTime

The time at which the dataset was last modified.

Type: Timestamp

MetricList

A list of the metrics defined by the dataset.

Type: Array of Metric objects

Array Members: Minimum number of 1 item.

MetricSetArn

The ARN of the dataset.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):.*:.*:.*:.+

MetricSetDescription

The dataset's description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*\S.*

MetricSetFrequency

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

Type: String

Valid Values: P1D | PT1H | PT10M | PT5M

MetricSetName

The name of the dataset.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

MetricSource

Contains information about the dataset's source data.

Type: MetricSource object

Offset

The offset in seconds. Only supported for S3 and Redshift datasources.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 432000.

TimestampColumn

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

Type: TimestampColumn object

Timezone

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

Type: String

Length Constraints: Maximum length of 60.

Pattern: .*\S.*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 400

TooManyRequestsException

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

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: