amazonka-lookoutequipment-2.0: Amazon Lookout for Equipment SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LookoutEquipment.CreateInferenceScheduler

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.

Synopsis

Creating a Request

data CreateInferenceScheduler Source #

See: newCreateInferenceScheduler smart constructor.

Constructors

CreateInferenceScheduler' 

Fields

  • dataDelayOffsetInMinutes :: Maybe Natural

    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.

  • serverSideKmsKeyId :: Maybe Text

    Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.

  • tags :: Maybe [Tag]

    Any tags associated with the inference scheduler.

  • modelName :: Text

    The name of the previously trained ML model being used to create the inference scheduler.

  • inferenceSchedulerName :: Text

    The name of the inference scheduler being created.

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

  • dataInputConfiguration :: InferenceInputConfiguration

    Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

  • dataOutputConfiguration :: InferenceOutputConfiguration

    Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.

  • roleArn :: Text

    The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.

  • clientToken :: Text

    A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Instances

Instances details
ToJSON CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

ToHeaders CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

ToPath CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

ToQuery CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

AWSRequest CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

Generic CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

Associated Types

type Rep CreateInferenceScheduler :: Type -> Type #

Read CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

Show CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

NFData CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

Eq CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

Hashable CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

type AWSResponse CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

type Rep CreateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

type Rep CreateInferenceScheduler = D1 ('MetaData "CreateInferenceScheduler" "Amazonka.LookoutEquipment.CreateInferenceScheduler" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "CreateInferenceScheduler'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dataDelayOffsetInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "serverSideKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "inferenceSchedulerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "dataUploadFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataUploadFrequency) :*: S1 ('MetaSel ('Just "dataInputConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InferenceInputConfiguration)) :*: (S1 ('MetaSel ('Just "dataOutputConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InferenceOutputConfiguration) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateInferenceScheduler Source #

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:

CreateInferenceScheduler, createInferenceScheduler_dataDelayOffsetInMinutes - 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.

$sel:serverSideKmsKeyId:CreateInferenceScheduler', createInferenceScheduler_serverSideKmsKeyId - Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.

$sel:tags:CreateInferenceScheduler', createInferenceScheduler_tags - Any tags associated with the inference scheduler.

CreateInferenceScheduler, createInferenceScheduler_modelName - The name of the previously trained ML model being used to create the inference scheduler.

CreateInferenceScheduler, createInferenceScheduler_inferenceSchedulerName - The name of the inference scheduler being created.

CreateInferenceScheduler, createInferenceScheduler_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.

CreateInferenceScheduler, createInferenceScheduler_dataInputConfiguration - Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

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 #

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.

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_tags :: Lens' CreateInferenceScheduler (Maybe [Tag]) Source #

Any tags associated with the inference scheduler.

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

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.

Constructors

CreateInferenceSchedulerResponse' 

Fields

Instances

Instances details
Generic CreateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

Associated Types

type Rep CreateInferenceSchedulerResponse :: Type -> Type #

Read CreateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

Show CreateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

NFData CreateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

Eq CreateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

type Rep CreateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateInferenceScheduler

type Rep CreateInferenceSchedulerResponse = D1 ('MetaData "CreateInferenceSchedulerResponse" "Amazonka.LookoutEquipment.CreateInferenceScheduler" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "CreateInferenceSchedulerResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "inferenceSchedulerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "inferenceSchedulerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceSchedulerStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:

CreateInferenceSchedulerResponse, createInferenceSchedulerResponse_inferenceSchedulerArn - The Amazon Resource Name (ARN) of the inference scheduler being created.

CreateInferenceScheduler, createInferenceSchedulerResponse_inferenceSchedulerName - The name of inference scheduler being created.

CreateInferenceSchedulerResponse, createInferenceSchedulerResponse_status - Indicates the status of the CreateInferenceScheduler operation.

$sel:httpStatus:CreateInferenceSchedulerResponse', createInferenceSchedulerResponse_httpStatus - The response's http status code.

Response Lenses

createInferenceSchedulerResponse_inferenceSchedulerArn :: Lens' CreateInferenceSchedulerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the inference scheduler being created.