AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Lookout for Metrics CreateMetricSet API operation.

Syntax

New-LOMMetricSet
-AnomalyDetectorArn <String>
-CsvFormatDescriptor_Charset <String>
-JsonFormatDescriptor_Charset <String>
-RedshiftSourceConfig_ClusterIdentifier <String>
-TimestampColumn_ColumnFormat <String>
-TimestampColumn_ColumnName <String>
-CsvFormatDescriptor_ContainsHeader <Boolean>
-RDSSourceConfig_DatabaseHost <String>
-RedshiftSourceConfig_DatabaseHost <String>
-AthenaSourceConfig_DatabaseName <String>
-RDSSourceConfig_DatabaseName <String>
-RedshiftSourceConfig_DatabaseName <String>
-RDSSourceConfig_DatabasePort <Int32>
-RedshiftSourceConfig_DatabasePort <Int32>
-AthenaSourceConfig_DataCatalog <String>
-RDSSourceConfig_DBInstanceIdentifier <String>
-CsvFormatDescriptor_Delimiter <String>
-DimensionFilterList <MetricSetDimensionFilter[]>
-DimensionList <String[]>
-CsvFormatDescriptor_FileCompression <CSVFileCompression>
-JsonFormatDescriptor_FileCompression <JsonFileCompression>
-AppFlowConfig_FlowName <String>
-CsvFormatDescriptor_HeaderList <String[]>
-S3SourceConfig_HistoricalDataPathList <String[]>
-MetricList <Metric[]>
-MetricSetDescription <String>
-MetricSetFrequency <Frequency>
-MetricSetName <String>
-Offset <Int32>
-CsvFormatDescriptor_QuoteSymbol <String>
-AppFlowConfig_RoleArn <String>
-AthenaSourceConfig_RoleArn <String>
-CloudWatchConfig_RoleArn <String>
-RDSSourceConfig_RoleArn <String>
-RedshiftSourceConfig_RoleArn <String>
-S3SourceConfig_RoleArn <String>
-BackTestConfiguration_RunBackTestMode <Boolean>
-MetricSource_CloudWatchConfig_BackTestConfiguration_RunBackTestMode <Boolean>
-AthenaSourceConfig_S3ResultsPath <String>
-RDSSourceConfig_SecretManagerArn <String>
-RedshiftSourceConfig_SecretManagerArn <String>
-MetricSource_RDSSourceConfig_VpcConfiguration_SecurityGroupIdList <String[]>
-MetricSource_RedshiftSourceConfig_VpcConfiguration_SecurityGroupIdList <String[]>
-MetricSource_RDSSourceConfig_VpcConfiguration_SubnetIdList <String[]>
-MetricSource_RedshiftSourceConfig_VpcConfiguration_SubnetIdList <String[]>
-AthenaSourceConfig_TableName <String>
-RDSSourceConfig_TableName <String>
-RedshiftSourceConfig_TableName <String>
-Tag <Hashtable>
-S3SourceConfig_TemplatedPathList <String[]>
-Timezone <String>
-AthenaSourceConfig_WorkGroupName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonLookoutMetricsConfig>

Description

Creates a dataset.

Parameters

-AnomalyDetectorArn <String>
The ARN of the anomaly detector that will use the dataset.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AppFlowConfig_FlowName <String>
name of the flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_AppFlowConfig_FlowName
-AppFlowConfig_RoleArn <String>
An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_AppFlowConfig_RoleArn
-AthenaSourceConfig_DatabaseName <String>
The database's name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_AthenaSourceConfig_DatabaseName
-AthenaSourceConfig_DataCatalog <String>
The database's data catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_AthenaSourceConfig_DataCatalog
-AthenaSourceConfig_RoleArn <String>
An IAM role that gives Amazon Lookout for Metrics permission to access the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_AthenaSourceConfig_RoleArn
-AthenaSourceConfig_S3ResultsPath <String>
The database's results path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_AthenaSourceConfig_S3ResultsPath
-AthenaSourceConfig_TableName <String>
The database's table name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_AthenaSourceConfig_TableName
-AthenaSourceConfig_WorkGroupName <String>
The database's work group name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_AthenaSourceConfig_WorkGroupName
-BackTestConfiguration_RunBackTestMode <Boolean>
Run a backtest instead of monitoring new data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_AthenaSourceConfig_BackTestConfiguration_RunBackTestMode
-ClientConfig <AmazonLookoutMetricsConfig>
Amazon.PowerShell.Cmdlets.LOM.AmazonLookoutMetricsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudWatchConfig_RoleArn <String>
An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_CloudWatchConfig_RoleArn
-CsvFormatDescriptor_Charset <String>
The character set in which the source CSV file is written.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_FileFormatDescriptor_CsvFormatDescriptor_Charset
-CsvFormatDescriptor_ContainsHeader <Boolean>
Whether or not the source CSV file contains a header.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_FileFormatDescriptor_CsvFormatDescriptor_ContainsHeader
-CsvFormatDescriptor_Delimiter <String>
The character used to delimit the source CSV file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_FileFormatDescriptor_CsvFormatDescriptor_Delimiter
-CsvFormatDescriptor_FileCompression <CSVFileCompression>
The level of compression of the source CSV file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_FileFormatDescriptor_CsvFormatDescriptor_FileCompression
-CsvFormatDescriptor_HeaderList <String[]>
A list of the source CSV file's headers, if any.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_FileFormatDescriptor_CsvFormatDescriptor_HeaderList
-CsvFormatDescriptor_QuoteSymbol <String>
The character used as a quote character.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_FileFormatDescriptor_CsvFormatDescriptor_QuoteSymbol
-DimensionFilterList <MetricSetDimensionFilter[]>
A list of filters that specify which data is kept for anomaly detection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DimensionList <String[]>
A list of the fields you want to treat as dimensions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JsonFormatDescriptor_Charset <String>
The character set in which the source JSON file is written.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_FileFormatDescriptor_JsonFormatDescriptor_Charset
-JsonFormatDescriptor_FileCompression <JsonFileCompression>
The level of compression of the source CSV file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_FileFormatDescriptor_JsonFormatDescriptor_FileCompression
-MetricList <Metric[]>
A list of metrics that the dataset will contain.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MetricSetDescription <String>
A description of the dataset you are creating.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MetricSetFrequency <Frequency>
The frequency with which the source data will be analyzed for anomalies.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MetricSetName <String>
The name of the dataset.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MetricSource_CloudWatchConfig_BackTestConfiguration_RunBackTestMode <Boolean>
Run a backtest instead of monitoring new data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCloudWatch_BackTestConfiguration_RunBackTestMode
-MetricSource_RDSSourceConfig_VpcConfiguration_SecurityGroupIdList <String[]>
An array of strings containing the list of security groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRDSSourceConfig_VpcConfiguration_SecurityGroupIdList
-MetricSource_RDSSourceConfig_VpcConfiguration_SubnetIdList <String[]>
An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRDSSourceConfig_VpcConfiguration_SubnetIdList
-MetricSource_RedshiftSourceConfig_VpcConfiguration_SecurityGroupIdList <String[]>
An array of strings containing the list of security groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MetricSource_RedshiftSourceConfig_VpcConfiguration_SubnetIdList <String[]>
An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Offset <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AnomalyDetectorArn parameter. The -PassThru parameter is deprecated, use -Select '^AnomalyDetectorArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RDSSourceConfig_DatabaseHost <String>
The host name of the database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RDSSourceConfig_DatabaseHost
-RDSSourceConfig_DatabaseName <String>
The name of the RDS database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RDSSourceConfig_DatabaseName
-RDSSourceConfig_DatabasePort <Int32>
The port number where the database can be accessed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RDSSourceConfig_DatabasePort
-RDSSourceConfig_DBInstanceIdentifier <String>
A string identifying the database instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RDSSourceConfig_DBInstanceIdentifier
-RDSSourceConfig_RoleArn <String>
The Amazon Resource Name (ARN) of the role.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RDSSourceConfig_RoleArn
-RDSSourceConfig_SecretManagerArn <String>
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RDSSourceConfig_SecretManagerArn
-RDSSourceConfig_TableName <String>
The name of the table in the database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RDSSourceConfig_TableName
-RedshiftSourceConfig_ClusterIdentifier <String>
A string identifying the Redshift cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RedshiftSourceConfig_ClusterIdentifier
-RedshiftSourceConfig_DatabaseHost <String>
The name of the database host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RedshiftSourceConfig_DatabaseHost
-RedshiftSourceConfig_DatabaseName <String>
The Redshift database name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RedshiftSourceConfig_DatabaseName
-RedshiftSourceConfig_DatabasePort <Int32>
The port number where the database can be accessed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RedshiftSourceConfig_DatabasePort
-RedshiftSourceConfig_RoleArn <String>
The Amazon Resource Name (ARN) of the role providing access to the database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RedshiftSourceConfig_RoleArn
-RedshiftSourceConfig_SecretManagerArn <String>
The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RedshiftSourceConfig_SecretManagerArn
-RedshiftSourceConfig_TableName <String>
The table name of the Redshift database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_RedshiftSourceConfig_TableName
-S3SourceConfig_HistoricalDataPathList <String[]>
A list of paths to the historical data files.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_HistoricalDataPathList
-S3SourceConfig_RoleArn <String>
The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_RoleArn
-S3SourceConfig_TemplatedPathList <String[]>
A list of templated paths to the source files.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricSource_S3SourceConfig_TemplatedPathList
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MetricSetArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutMetrics.Model.CreateMetricSetResponse). Specifying the name of a property of type Amazon.LookoutMetrics.Model.CreateMetricSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
A list of tags to apply to the dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TimestampColumn_ColumnFormat <String>
The format of the timestamp column.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimestampColumn_ColumnName <String>
The name of the timestamp column.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Timezone <String>
The time zone in which your source data was recorded.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.LookoutMetrics.Model.CreateMetricSetResponse
This cmdlet returns a System.String object. The service call response (type Amazon.LookoutMetrics.Model.CreateMetricSetResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z