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 CreateInferenceScheduler API operation.

Syntax

New-L4EInferenceScheduler
-S3InputConfiguration_Bucket <String>
-S3OutputConfiguration_Bucket <String>
-InferenceInputNameConfiguration_ComponentTimestampDelimiter <String>
-DataDelayOffsetInMinute <Int64>
-DataUploadFrequency <DataUploadFrequency>
-InferenceSchedulerName <String>
-DataInputConfiguration_InputTimeZoneOffset <String>
-DataOutputConfiguration_KmsKeyId <String>
-ModelName <String>
-S3InputConfiguration_Prefix <String>
-S3OutputConfiguration_Prefix <String>
-RoleArn <String>
-ServerSideKmsKeyId <String>
-Tag <Tag[]>
-InferenceInputNameConfiguration_TimestampFormat <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonLookoutEquipmentConfig>

Description

Creates a scheduled inference. Scheduling an inference is setting up a continuous real-time inference plan to analyze new measurement data. When setting up the schedule, you provide an S3 bucket location for the input data, assign it a delimiter between separate entries in the data, set an offset delay if desired, and set the frequency of inferencing. You must also provide an S3 bucket location for the output data.

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)
-DataDelayOffsetInMinute <Int64>
The interval (in minutes) of planned delay at the start of each inference segment. For example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and restart the scheduler when uploading new data.For more information, see Understanding the inference process.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataDelayOffsetInMinutes
-DataInputConfiguration_InputTimeZoneOffset <String>
Indicates the difference between your time zone and Coordinated Universal Time (UTC).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataOutputConfiguration_KmsKeyId <String>
The ID number for the AWS KMS key used to encrypt the inference output.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataUploadFrequency <DataUploadFrequency>
How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment runs inference on your data.For more information, see Understanding the inference process.
Required?True
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)
-InferenceInputNameConfiguration_ComponentTimestampDelimiter <String>
Indicates the delimiter character used between items in the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataInputConfiguration_InferenceInputNameConfiguration_ComponentTimestampDelimiter
-InferenceInputNameConfiguration_TimestampFormat <String>
The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataInputConfiguration_InferenceInputNameConfiguration_TimestampFormat
-InferenceSchedulerName <String>
The name of the inference scheduler being created.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelName <String>
The name of the previously trained ML model being used to create the inference scheduler.
Required?True
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 for the inference.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3InputConfiguration_Bucket <String>
The bucket containing the input dataset for the inference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataInputConfiguration_S3InputConfiguration_Bucket
-S3InputConfiguration_Prefix <String>
The prefix for the S3 bucket used for the input data for the inference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataInputConfiguration_S3InputConfiguration_Prefix
-S3OutputConfiguration_Bucket <String>
The bucket containing the output results from the inference
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataOutputConfiguration_S3OutputConfiguration_Bucket
-S3OutputConfiguration_Prefix <String>
The prefix for the S3 bucket used for the output results from the inference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataOutputConfiguration_S3OutputConfiguration_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.CreateInferenceSchedulerResponse). Specifying the name of a property of type Amazon.LookoutEquipment.Model.CreateInferenceSchedulerResponse 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 inference scheduler data by Amazon Lookout for Equipment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Any tags associated with the inference scheduler.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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.CreateInferenceSchedulerResponse 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