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 Equipment CreateModel API operation.

Syntax

New-L4EModel
-S3InputConfiguration_Bucket <String>
-DatasetName <String>
-EvaluationDataEndTime <DateTime>
-EvaluationDataStartTime <DateTime>
-DatasetSchema_InlineDataSchema <String>
-LabelsInputConfiguration_LabelGroupName <String>
-ModelName <String>
-OffCondition <String>
-S3InputConfiguration_Prefix <String>
-RoleArn <String>
-ServerSideKmsKeyId <String>
-Tag <Tag[]>
-DataPreProcessingConfiguration_TargetSamplingRate <TargetSamplingRate>
-TrainingDataEndTime <DateTime>
-TrainingDataStartTime <DateTime>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonLookoutEquipmentConfig>

Description

Creates an ML model for data inference. A machine-learning (ML) model is a mathematical model that finds patterns in your data. In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal behavior that could be potential equipment failure (or maintenance events). The models are made by analyzing normal data and abnormalities in machine behavior that have already occurred. Your model is trained using a portion of the data from your dataset and uses that data to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. Another portion of the data is used to evaluate the model's accuracy.

Parameters

Amazon.PowerShell.Cmdlets.L4E.AmazonLookoutEquipmentClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataPreProcessingConfiguration_TargetSamplingRate <TargetSamplingRate>
The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatasetName <String>
The name of the dataset for the ML model being created.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatasetSchema_InlineDataSchema <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EvaluationDataEndTime <DateTime>
Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EvaluationDataStartTime <DateTime>
Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
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)
-LabelsInputConfiguration_LabelGroupName <String>
The name of the label group to be used for label data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelName <String>
The name for the ML model to be created.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OffCondition <String>
Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3InputConfiguration_Bucket <String>
The name of the S3 bucket holding the label data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLabelsInputConfiguration_S3InputConfiguration_Bucket
-S3InputConfiguration_Prefix <String>
The prefix for the S3 bucket used for the label data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLabelsInputConfiguration_S3InputConfiguration_Prefix
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutEquipment.Model.CreateModelResponse). Specifying the name of a property of type Amazon.LookoutEquipment.Model.CreateModelResponse 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)
-ServerSideKmsKeyId <String>
Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Any tags associated with the ML model being created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TrainingDataEndTime <DateTime>
Indicates the time reference in the dataset that should be used to end the subset of training data for the ML model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TrainingDataStartTime <DateTime>
Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML model.
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

This cmdlet returns an Amazon.LookoutEquipment.Model.CreateModelResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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