[ aws . lookoutmetrics ]
create-metric-set¶
Description¶
Creates a dataset.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-metric-set
--anomaly-detector-arn <value>
--metric-set-name <value>
[--metric-set-description <value>]
--metric-list <value>
[--offset <value>]
[--timestamp-column <value>]
[--dimension-list <value>]
[--metric-set-frequency <value>]
--metric-source <value>
[--timezone <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--anomaly-detector-arn (string)
The ARN of the anomaly detector that will use the dataset.
--metric-set-name (string)
The name of the dataset.
--metric-set-description (string)
A description of the dataset you are creating.
--metric-list (list)
A list of metrics that the dataset will contain.
(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.
Shorthand Syntax:
MetricName=string,AggregationFunction=string,Namespace=string ...
JSON Syntax:
[
{
"MetricName": "string",
"AggregationFunction": "AVG"|"SUM",
"Namespace": "string"
}
...
]
--offset (integer)
After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.
--timestamp-column (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.
Shorthand Syntax:
ColumnName=string,ColumnFormat=string
JSON Syntax:
{
"ColumnName": "string",
"ColumnFormat": "string"
}
--dimension-list (list)
A list of the fields you want to treat as dimensions.
(string)
Syntax:
"string" "string" ...
--metric-set-frequency (string)
The frequency with which the source data will be analyzed for anomalies.
Possible values:
P1D
PT1H
PT10M
PT5M
--metric-source (structure)
Contains information about how the source data should be interpreted.
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)
JSON Syntax:
{
"S3SourceConfig": {
"RoleArn": "string",
"TemplatedPathList": ["string", ...],
"HistoricalDataPathList": ["string", ...],
"FileFormatDescriptor": {
"CsvFormatDescriptor": {
"FileCompression": "NONE"|"GZIP",
"Charset": "string",
"ContainsHeader": true|false,
"Delimiter": "string",
"HeaderList": ["string", ...],
"QuoteSymbol": "string"
},
"JsonFormatDescriptor": {
"FileCompression": "NONE"|"GZIP",
"Charset": "string"
}
}
},
"AppFlowConfig": {
"RoleArn": "string",
"FlowName": "string"
},
"CloudWatchConfig": {
"RoleArn": "string"
},
"RDSSourceConfig": {
"DBInstanceIdentifier": "string",
"DatabaseHost": "string",
"DatabasePort": integer,
"SecretManagerArn": "string",
"DatabaseName": "string",
"TableName": "string",
"RoleArn": "string",
"VpcConfiguration": {
"SubnetIdList": ["string", ...],
"SecurityGroupIdList": ["string", ...]
}
},
"RedshiftSourceConfig": {
"ClusterIdentifier": "string",
"DatabaseHost": "string",
"DatabasePort": integer,
"SecretManagerArn": "string",
"DatabaseName": "string",
"TableName": "string",
"RoleArn": "string",
"VpcConfiguration": {
"SubnetIdList": ["string", ...],
"SecurityGroupIdList": ["string", ...]
}
}
}
--timezone (string)
The time zone in which your source data was recorded.
--tags (map)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--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.