Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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.
Synopsis
- data CreateInferenceScheduler = CreateInferenceScheduler' {
- dataDelayOffsetInMinutes :: Maybe Natural
- tags :: Maybe [Tag]
- serverSideKmsKeyId :: Maybe Text
- modelName :: Text
- inferenceSchedulerName :: Text
- dataUploadFrequency :: DataUploadFrequency
- dataInputConfiguration :: InferenceInputConfiguration
- dataOutputConfiguration :: InferenceOutputConfiguration
- roleArn :: Text
- clientToken :: Text
- newCreateInferenceScheduler :: Text -> Text -> DataUploadFrequency -> InferenceInputConfiguration -> InferenceOutputConfiguration -> Text -> Text -> CreateInferenceScheduler
- createInferenceScheduler_dataDelayOffsetInMinutes :: Lens' CreateInferenceScheduler (Maybe Natural)
- createInferenceScheduler_tags :: Lens' CreateInferenceScheduler (Maybe [Tag])
- createInferenceScheduler_serverSideKmsKeyId :: Lens' CreateInferenceScheduler (Maybe Text)
- createInferenceScheduler_modelName :: Lens' CreateInferenceScheduler Text
- createInferenceScheduler_inferenceSchedulerName :: Lens' CreateInferenceScheduler Text
- createInferenceScheduler_dataUploadFrequency :: Lens' CreateInferenceScheduler DataUploadFrequency
- createInferenceScheduler_dataInputConfiguration :: Lens' CreateInferenceScheduler InferenceInputConfiguration
- createInferenceScheduler_dataOutputConfiguration :: Lens' CreateInferenceScheduler InferenceOutputConfiguration
- createInferenceScheduler_roleArn :: Lens' CreateInferenceScheduler Text
- createInferenceScheduler_clientToken :: Lens' CreateInferenceScheduler Text
- data CreateInferenceSchedulerResponse = CreateInferenceSchedulerResponse' {}
- newCreateInferenceSchedulerResponse :: Int -> CreateInferenceSchedulerResponse
- createInferenceSchedulerResponse_status :: Lens' CreateInferenceSchedulerResponse (Maybe InferenceSchedulerStatus)
- createInferenceSchedulerResponse_inferenceSchedulerArn :: Lens' CreateInferenceSchedulerResponse (Maybe Text)
- createInferenceSchedulerResponse_inferenceSchedulerName :: Lens' CreateInferenceSchedulerResponse (Maybe Text)
- createInferenceSchedulerResponse_httpStatus :: Lens' CreateInferenceSchedulerResponse Int
Creating a Request
data CreateInferenceScheduler Source #
See: newCreateInferenceScheduler
smart constructor.
CreateInferenceScheduler' | |
|
Instances
newCreateInferenceScheduler Source #
:: Text | |
-> Text | |
-> DataUploadFrequency | |
-> InferenceInputConfiguration | |
-> InferenceOutputConfiguration | |
-> Text | |
-> Text | |
-> CreateInferenceScheduler |
Create a value of CreateInferenceScheduler
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataDelayOffsetInMinutes:CreateInferenceScheduler'
, createInferenceScheduler_dataDelayOffsetInMinutes
- A period of time (in minutes) by which inference on the data is delayed
after the data starts. For instance, if you select an offset delay time
of five minutes, inference will not begin on the data until the first
data measurement after the five minute mark. For example, if five
minutes is selected, the inference scheduler will wake up at the
configured frequency with the additional five minute delay time to check
the customer S3 bucket. The customer can upload data at the same
frequency and they don't need to stop and restart the scheduler when
uploading new data.
$sel:tags:CreateInferenceScheduler'
, createInferenceScheduler_tags
- Any tags associated with the inference scheduler.
$sel:serverSideKmsKeyId:CreateInferenceScheduler'
, createInferenceScheduler_serverSideKmsKeyId
- Provides the identifier of the KMS key used to encrypt inference
scheduler data by Amazon Lookout for Equipment.
$sel:modelName:CreateInferenceScheduler'
, createInferenceScheduler_modelName
- The name of the previously trained ML model being used to create the
inference scheduler.
$sel:inferenceSchedulerName:CreateInferenceScheduler'
, createInferenceScheduler_inferenceSchedulerName
- The name of the inference scheduler being created.
$sel:dataUploadFrequency:CreateInferenceScheduler'
, createInferenceScheduler_dataUploadFrequency
- How often data is uploaded to the source 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
starts a scheduled inference on your data. In this example, it starts
once every 5 minutes.
$sel:dataInputConfiguration:CreateInferenceScheduler'
, createInferenceScheduler_dataInputConfiguration
- Specifies configuration information for the input data for the inference
scheduler, including delimiter, format, and dataset location.
$sel:dataOutputConfiguration:CreateInferenceScheduler'
, createInferenceScheduler_dataOutputConfiguration
- Specifies configuration information for the output results for the
inference scheduler, including the S3 location for the output.
$sel:roleArn:CreateInferenceScheduler'
, createInferenceScheduler_roleArn
- The Amazon Resource Name (ARN) of a role with permission to access the
data source being used for the inference.
$sel:clientToken:CreateInferenceScheduler'
, createInferenceScheduler_clientToken
- A unique identifier for the request. If you do not set the client
request token, Amazon Lookout for Equipment generates one.
Request Lenses
createInferenceScheduler_dataDelayOffsetInMinutes :: Lens' CreateInferenceScheduler (Maybe Natural) Source #
A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.
createInferenceScheduler_tags :: Lens' CreateInferenceScheduler (Maybe [Tag]) Source #
Any tags associated with the inference scheduler.
createInferenceScheduler_serverSideKmsKeyId :: Lens' CreateInferenceScheduler (Maybe Text) Source #
Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.
createInferenceScheduler_modelName :: Lens' CreateInferenceScheduler Text Source #
The name of the previously trained ML model being used to create the inference scheduler.
createInferenceScheduler_inferenceSchedulerName :: Lens' CreateInferenceScheduler Text Source #
The name of the inference scheduler being created.
createInferenceScheduler_dataUploadFrequency :: Lens' CreateInferenceScheduler DataUploadFrequency Source #
How often data is uploaded to the source 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 starts a scheduled inference on your data. In this example, it starts once every 5 minutes.
createInferenceScheduler_dataInputConfiguration :: Lens' CreateInferenceScheduler InferenceInputConfiguration Source #
Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
createInferenceScheduler_dataOutputConfiguration :: Lens' CreateInferenceScheduler InferenceOutputConfiguration Source #
Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.
createInferenceScheduler_roleArn :: Lens' CreateInferenceScheduler Text Source #
The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
createInferenceScheduler_clientToken :: Lens' CreateInferenceScheduler Text Source #
A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
Destructuring the Response
data CreateInferenceSchedulerResponse Source #
See: newCreateInferenceSchedulerResponse
smart constructor.
CreateInferenceSchedulerResponse' | |
|
Instances
newCreateInferenceSchedulerResponse Source #
Create a value of CreateInferenceSchedulerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:CreateInferenceSchedulerResponse'
, createInferenceSchedulerResponse_status
- Indicates the status of the CreateInferenceScheduler
operation.
$sel:inferenceSchedulerArn:CreateInferenceSchedulerResponse'
, createInferenceSchedulerResponse_inferenceSchedulerArn
- The Amazon Resource Name (ARN) of the inference scheduler being created.
$sel:inferenceSchedulerName:CreateInferenceScheduler'
, createInferenceSchedulerResponse_inferenceSchedulerName
- The name of inference scheduler being created.
$sel:httpStatus:CreateInferenceSchedulerResponse'
, createInferenceSchedulerResponse_httpStatus
- The response's http status code.
Response Lenses
createInferenceSchedulerResponse_status :: Lens' CreateInferenceSchedulerResponse (Maybe InferenceSchedulerStatus) Source #
Indicates the status of the CreateInferenceScheduler
operation.
createInferenceSchedulerResponse_inferenceSchedulerArn :: Lens' CreateInferenceSchedulerResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the inference scheduler being created.
createInferenceSchedulerResponse_inferenceSchedulerName :: Lens' CreateInferenceSchedulerResponse (Maybe Text) Source #
The name of inference scheduler being created.
createInferenceSchedulerResponse_httpStatus :: Lens' CreateInferenceSchedulerResponse Int Source #
The response's http status code.