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

Description

Updates an inference scheduler.

Synopsis

Creating a Request

data UpdateInferenceScheduler Source #

See: newUpdateInferenceScheduler smart constructor.

Constructors

UpdateInferenceScheduler' 

Fields

  • dataDelayOffsetInMinutes :: Maybe Natural

    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.

  • dataInputConfiguration :: Maybe InferenceInputConfiguration

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

  • dataOutputConfiguration :: Maybe InferenceOutputConfiguration

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

  • dataUploadFrequency :: Maybe 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.

  • roleArn :: Maybe Text

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

  • inferenceSchedulerName :: Text

    The name of the inference scheduler to be updated.

Instances

Instances details
ToJSON UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

ToHeaders UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

ToPath UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

ToQuery UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

AWSRequest UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

Generic UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

Associated Types

type Rep UpdateInferenceScheduler :: Type -> Type #

Read UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

Show UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

NFData UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

Eq UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

Hashable UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

type AWSResponse UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

type Rep UpdateInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

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

newUpdateInferenceScheduler Source #

Create a value of UpdateInferenceScheduler 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:

UpdateInferenceScheduler, updateInferenceScheduler_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.

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

UpdateInferenceScheduler, updateInferenceScheduler_dataOutputConfiguration - Specifies information for the output results from the inference scheduler, including the output S3 location.

UpdateInferenceScheduler, updateInferenceScheduler_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:roleArn:UpdateInferenceScheduler', updateInferenceScheduler_roleArn - The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.

UpdateInferenceScheduler, updateInferenceScheduler_inferenceSchedulerName - The name of the inference scheduler to be updated.

Request Lenses

updateInferenceScheduler_dataDelayOffsetInMinutes :: Lens' UpdateInferenceScheduler (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.

updateInferenceScheduler_dataInputConfiguration :: Lens' UpdateInferenceScheduler (Maybe InferenceInputConfiguration) Source #

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

updateInferenceScheduler_dataOutputConfiguration :: Lens' UpdateInferenceScheduler (Maybe InferenceOutputConfiguration) Source #

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

updateInferenceScheduler_dataUploadFrequency :: Lens' UpdateInferenceScheduler (Maybe 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.

updateInferenceScheduler_roleArn :: Lens' UpdateInferenceScheduler (Maybe Text) Source #

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

updateInferenceScheduler_inferenceSchedulerName :: Lens' UpdateInferenceScheduler Text Source #

The name of the inference scheduler to be updated.

Destructuring the Response

data UpdateInferenceSchedulerResponse Source #

See: newUpdateInferenceSchedulerResponse smart constructor.

Instances

Instances details
Generic UpdateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

Associated Types

type Rep UpdateInferenceSchedulerResponse :: Type -> Type #

Read UpdateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

Show UpdateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

NFData UpdateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

Eq UpdateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

type Rep UpdateInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.UpdateInferenceScheduler

type Rep UpdateInferenceSchedulerResponse = D1 ('MetaData "UpdateInferenceSchedulerResponse" "Amazonka.LookoutEquipment.UpdateInferenceScheduler" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "UpdateInferenceSchedulerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateInferenceSchedulerResponse :: UpdateInferenceSchedulerResponse Source #

Create a value of UpdateInferenceSchedulerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.