[ aws . lookoutmetrics ]
Describes a dataset.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-metric-set
--metric-set-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--metric-set-arn
(string)
The ARN of the dataset.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
MetricSetArn -> (string)
The ARN of the dataset.
AnomalyDetectorArn -> (string)
The ARN of the detector that contains the dataset.
MetricSetName -> (string)
The name of the dataset.
MetricSetDescription -> (string)
The dataset’s description.
CreationTime -> (timestamp)
The time at which the dataset was created.
LastModificationTime -> (timestamp)
The time at which the dataset was last modified.
Offset -> (integer)
The offset in seconds. Only supported for S3 and Redshift datasources.
MetricList -> (list)
A list of the metrics defined by the dataset.
(structure)
A calculation made by contrasting a measure and a dimension from your source data.
MetricName -> (string)
The name of the metric.
AggregationFunction -> (string)
The function with which the metric is calculated.
Namespace -> (string)
The namespace for the metric.
TimestampColumn -> (structure)
Contains information about the column used for tracking time in your source data.
ColumnName -> (string)
The name of the timestamp column.
ColumnFormat -> (string)
The format of the timestamp column.
DimensionList -> (list)
A list of the dimensions chosen for analysis.
(string)
MetricSetFrequency -> (string)
The interval at which the data will be analyzed for anomalies.
Timezone -> (string)
The time zone in which the dataset’s data was recorded.
MetricSource -> (structure)
Contains information about the dataset’s source data.
S3SourceConfig -> (structure)
Contains information about the configuration of the S3 bucket that contains source files.
RoleArn -> (string)
The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
TemplatedPathList -> (list)
A list of templated paths to the source files.
(string)
HistoricalDataPathList -> (list)
A list of paths to the historical data files.
(string)
FileFormatDescriptor -> (structure)
Contains information about a source file’s formatting.
CsvFormatDescriptor -> (structure)
Contains information about how a source CSV data file should be analyzed.
FileCompression -> (string)
The level of compression of the source CSV file.
Charset -> (string)
The character set in which the source CSV file is written.
ContainsHeader -> (boolean)
Whether or not the source CSV file contains a header.
Delimiter -> (string)
The character used to delimit the source CSV file.
HeaderList -> (list)
A list of the source CSV file’s headers, if any.
(string)
QuoteSymbol -> (string)
The character used as a quote character.
JsonFormatDescriptor -> (structure)
Contains information about how a source JSON data file should be analyzed.
FileCompression -> (string)
The level of compression of the source CSV file.
Charset -> (string)
The character set in which the source JSON file is written.
AppFlowConfig -> (structure)
An object containing information about the AppFlow configuration.
RoleArn -> (string)
An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
FlowName -> (string)
name of the flow.
CloudWatchConfig -> (structure)
An object containing information about the Amazon CloudWatch monitoring configuration.
RoleArn -> (string)
An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
RDSSourceConfig -> (structure)
An object containing information about the Amazon Relational Database Service (RDS) configuration.
DBInstanceIdentifier -> (string)
A string identifying the database instance.
DatabaseHost -> (string)
The host name of the database.
DatabasePort -> (integer)
The port number where the database can be accessed.
SecretManagerArn -> (string)
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
DatabaseName -> (string)
The name of the RDS database.
TableName -> (string)
The name of the table in the database.
RoleArn -> (string)
The Amazon Resource Name (ARN) of the role.
VpcConfiguration -> (structure)
An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
SubnetIdList -> (list)
An array of strings containing the Amazon VPC subnet IDs (e.g.,
subnet-0bb1c79de3EXAMPLE
.(string)
SecurityGroupIdList -> (list)
An array of strings containing the list of security groups.
(string)
RedshiftSourceConfig -> (structure)
An object containing information about the Amazon Redshift database configuration.
ClusterIdentifier -> (string)
A string identifying the Redshift cluster.
DatabaseHost -> (string)
The name of the database host.
DatabasePort -> (integer)
The port number where the database can be accessed.
SecretManagerArn -> (string)
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
DatabaseName -> (string)
The Redshift database name.
TableName -> (string)
The table name of the Redshift database.
RoleArn -> (string)
The Amazon Resource Name (ARN) of the role providing access to the database.
VpcConfiguration -> (structure)
Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
SubnetIdList -> (list)
An array of strings containing the Amazon VPC subnet IDs (e.g.,
subnet-0bb1c79de3EXAMPLE
.(string)
SecurityGroupIdList -> (list)
An array of strings containing the list of security groups.
(string)