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

Description

Specifies information about the inference scheduler being used, including name, model, status, and associated metadata

Synopsis

Creating a Request

data DescribeInferenceScheduler Source #

See: newDescribeInferenceScheduler smart constructor.

Constructors

DescribeInferenceScheduler' 

Fields

Instances

Instances details
ToJSON DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

ToHeaders DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

ToPath DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

ToQuery DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

AWSRequest DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

Generic DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

Associated Types

type Rep DescribeInferenceScheduler :: Type -> Type #

Read DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

Show DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

NFData DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

Eq DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

Hashable DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

type AWSResponse DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

type Rep DescribeInferenceScheduler Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

type Rep DescribeInferenceScheduler = D1 ('MetaData "DescribeInferenceScheduler" "Amazonka.LookoutEquipment.DescribeInferenceScheduler" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "DescribeInferenceScheduler'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inferenceSchedulerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeInferenceScheduler Source #

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

DescribeInferenceScheduler, describeInferenceScheduler_inferenceSchedulerName - The name of the inference scheduler being described.

Request Lenses

Destructuring the Response

data DescribeInferenceSchedulerResponse Source #

Constructors

DescribeInferenceSchedulerResponse' 

Fields

  • createdAt :: Maybe POSIX

    Specifies the time at which the inference scheduler was created.

  • 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 configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

  • dataOutputConfiguration :: Maybe InferenceOutputConfiguration

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

  • dataUploadFrequency :: Maybe DataUploadFrequency

    Specifies how often data is uploaded to the source S3 bucket for the input data. This value 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.

  • inferenceSchedulerArn :: Maybe Text

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

  • inferenceSchedulerName :: Maybe Text

    The name of the inference scheduler being described.

  • latestInferenceResult :: Maybe LatestInferenceResult

    Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

  • modelArn :: Maybe Text

    The Amazon Resource Name (ARN) of the ML model of the inference scheduler being described.

  • modelName :: Maybe Text

    The name of the ML model of the inference scheduler being described.

  • roleArn :: Maybe Text

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

  • serverSideKmsKeyId :: Maybe Text

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

  • status :: Maybe InferenceSchedulerStatus

    Indicates the status of the inference scheduler.

  • updatedAt :: Maybe POSIX

    Specifies the time at which the inference scheduler was last updated, if it was.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

Associated Types

type Rep DescribeInferenceSchedulerResponse :: Type -> Type #

Read DescribeInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

Show DescribeInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

NFData DescribeInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

Eq DescribeInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

type Rep DescribeInferenceSchedulerResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.DescribeInferenceScheduler

type Rep DescribeInferenceSchedulerResponse = D1 ('MetaData "DescribeInferenceSchedulerResponse" "Amazonka.LookoutEquipment.DescribeInferenceScheduler" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "DescribeInferenceSchedulerResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (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 "inferenceSchedulerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "inferenceSchedulerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "latestInferenceResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LatestInferenceResult)) :*: S1 ('MetaSel ('Just "modelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "serverSideKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceSchedulerStatus))) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeInferenceSchedulerResponse Source #

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

DescribeInferenceSchedulerResponse, describeInferenceSchedulerResponse_createdAt - Specifies the time at which the inference scheduler was created.

DescribeInferenceSchedulerResponse, describeInferenceSchedulerResponse_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.

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

DescribeInferenceSchedulerResponse, describeInferenceSchedulerResponse_dataOutputConfiguration - Specifies information for the output results for the inference scheduler, including the output S3 location.

DescribeInferenceSchedulerResponse, describeInferenceSchedulerResponse_dataUploadFrequency - Specifies how often data is uploaded to the source S3 bucket for the input data. This value 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.

DescribeInferenceSchedulerResponse, describeInferenceSchedulerResponse_inferenceSchedulerArn - The Amazon Resource Name (ARN) of the inference scheduler being described.

DescribeInferenceScheduler, describeInferenceSchedulerResponse_inferenceSchedulerName - The name of the inference scheduler being described.

DescribeInferenceSchedulerResponse, describeInferenceSchedulerResponse_latestInferenceResult - Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

DescribeInferenceSchedulerResponse, describeInferenceSchedulerResponse_modelArn - The Amazon Resource Name (ARN) of the ML model of the inference scheduler being described.

DescribeInferenceSchedulerResponse, describeInferenceSchedulerResponse_modelName - The name of the ML model of the inference scheduler being described.

$sel:roleArn:DescribeInferenceSchedulerResponse', describeInferenceSchedulerResponse_roleArn - The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.

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

DescribeInferenceSchedulerResponse, describeInferenceSchedulerResponse_status - Indicates the status of the inference scheduler.

DescribeInferenceSchedulerResponse, describeInferenceSchedulerResponse_updatedAt - Specifies the time at which the inference scheduler was last updated, if it was.

$sel:httpStatus:DescribeInferenceSchedulerResponse', describeInferenceSchedulerResponse_httpStatus - The response's http status code.

Response Lenses

describeInferenceSchedulerResponse_createdAt :: Lens' DescribeInferenceSchedulerResponse (Maybe UTCTime) Source #

Specifies the time at which the inference scheduler was created.

describeInferenceSchedulerResponse_dataDelayOffsetInMinutes :: Lens' DescribeInferenceSchedulerResponse (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.

describeInferenceSchedulerResponse_dataInputConfiguration :: Lens' DescribeInferenceSchedulerResponse (Maybe InferenceInputConfiguration) Source #

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

describeInferenceSchedulerResponse_dataOutputConfiguration :: Lens' DescribeInferenceSchedulerResponse (Maybe InferenceOutputConfiguration) Source #

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

describeInferenceSchedulerResponse_dataUploadFrequency :: Lens' DescribeInferenceSchedulerResponse (Maybe DataUploadFrequency) Source #

Specifies how often data is uploaded to the source S3 bucket for the input data. This value 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.

describeInferenceSchedulerResponse_inferenceSchedulerArn :: Lens' DescribeInferenceSchedulerResponse (Maybe Text) Source #

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

describeInferenceSchedulerResponse_latestInferenceResult :: Lens' DescribeInferenceSchedulerResponse (Maybe LatestInferenceResult) Source #

Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

describeInferenceSchedulerResponse_modelArn :: Lens' DescribeInferenceSchedulerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the ML model of the inference scheduler being described.

describeInferenceSchedulerResponse_modelName :: Lens' DescribeInferenceSchedulerResponse (Maybe Text) Source #

The name of the ML model of the inference scheduler being described.

describeInferenceSchedulerResponse_roleArn :: Lens' DescribeInferenceSchedulerResponse (Maybe Text) Source #

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

describeInferenceSchedulerResponse_serverSideKmsKeyId :: Lens' DescribeInferenceSchedulerResponse (Maybe Text) Source #

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

describeInferenceSchedulerResponse_updatedAt :: Lens' DescribeInferenceSchedulerResponse (Maybe UTCTime) Source #

Specifies the time at which the inference scheduler was last updated, if it was.