Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LookoutEquipment.DescribeDataIngestionJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.

Synopsis

Creating a Request

data DescribeDataIngestionJob Source #

See: newDescribeDataIngestionJob smart constructor.

Constructors

DescribeDataIngestionJob'
Fields jobId :: Text The job ID of the data ingestion job.

Instances

Instances details

ToJSON DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods toJSON :: DescribeDataIngestionJob -> Value # toEncoding :: DescribeDataIngestionJob -> Encoding # toJSONList :: [DescribeDataIngestionJob] -> Value # toEncodingList :: [DescribeDataIngestionJob] -> Encoding #
ToHeaders DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods toHeaders :: DescribeDataIngestionJob -> [Header] #
ToPath DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods toPath :: DescribeDataIngestionJob -> ByteString #
ToQuery DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods toQuery :: DescribeDataIngestionJob -> QueryString #
AWSRequest DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Associated Types type AWSResponse DescribeDataIngestionJob # Methods request :: (Service -> Service) -> DescribeDataIngestionJob -> Request DescribeDataIngestionJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDataIngestionJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDataIngestionJob))) #
Generic DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Associated Types type Rep DescribeDataIngestionJob :: Type -> Type # Methods from :: DescribeDataIngestionJob -> Rep DescribeDataIngestionJob x # to :: Rep DescribeDataIngestionJob x -> DescribeDataIngestionJob #
Read DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods readsPrec :: Int -> ReadS DescribeDataIngestionJob # readList :: ReadS [DescribeDataIngestionJob] # readPrec :: ReadPrec DescribeDataIngestionJob # readListPrec :: ReadPrec [DescribeDataIngestionJob] #
Show DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods showsPrec :: Int -> DescribeDataIngestionJob -> ShowS # show :: DescribeDataIngestionJob -> String # showList :: [DescribeDataIngestionJob] -> ShowS #
NFData DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods rnf :: DescribeDataIngestionJob -> () #
Eq DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods (==) :: DescribeDataIngestionJob -> DescribeDataIngestionJob -> Bool # (/=) :: DescribeDataIngestionJob -> DescribeDataIngestionJob -> Bool #
Hashable DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods hashWithSalt :: Int -> DescribeDataIngestionJob -> Int # hash :: DescribeDataIngestionJob -> Int #
type AWSResponse DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob type AWSResponse DescribeDataIngestionJob = DescribeDataIngestionJobResponse
type Rep DescribeDataIngestionJob Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob type Rep DescribeDataIngestionJob = D1 ('MetaData "DescribeDataIngestionJob" "Amazonka.LookoutEquipment.DescribeDataIngestionJob" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "DescribeDataIngestionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDataIngestionJob Source #

Arguments

:: Text	`DescribeDataIngestionJob`
-> DescribeDataIngestionJob

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

DescribeDataIngestionJob, describeDataIngestionJob_jobId - The job ID of the data ingestion job.

Request Lenses

describeDataIngestionJob_jobId :: Lens' DescribeDataIngestionJob Text Source #

The job ID of the data ingestion job.

Destructuring the Response

data DescribeDataIngestionJobResponse Source #

See: newDescribeDataIngestionJobResponse smart constructor.

Constructors

DescribeDataIngestionJobResponse'

Fields

createdAt :: Maybe POSIX
The time at which the data ingestion job was created.
dataEndTime :: Maybe POSIX
Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.
dataQualitySummary :: Maybe DataQualitySummary
Gives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.
dataStartTime :: Maybe POSIX
Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.
datasetArn :: Maybe Text
The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.
failedReason :: Maybe Text
Specifies the reason for failure when a data ingestion job has failed.
ingestedDataSize :: Maybe Natural
Indicates the size of the ingested dataset.
ingestedFilesSummary :: Maybe IngestedFilesSummary
ingestionInputConfiguration :: Maybe IngestionInputConfiguration
Specifies the S3 location configuration for the data input for the data ingestion job.
jobId :: Maybe Text
Indicates the job ID of the data ingestion job.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.
status :: Maybe IngestionJobStatus
Indicates the status of the DataIngestionJob operation.
statusDetail :: Maybe Text
Provides details about status of the ingestion job that is currently in progress.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeDataIngestionJobResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Associated Types type Rep DescribeDataIngestionJobResponse :: Type -> Type # Methods from :: DescribeDataIngestionJobResponse -> Rep DescribeDataIngestionJobResponse x # to :: Rep DescribeDataIngestionJobResponse x -> DescribeDataIngestionJobResponse #
Read DescribeDataIngestionJobResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods readsPrec :: Int -> ReadS DescribeDataIngestionJobResponse # readList :: ReadS [DescribeDataIngestionJobResponse] # readPrec :: ReadPrec DescribeDataIngestionJobResponse # readListPrec :: ReadPrec [DescribeDataIngestionJobResponse] #
Show DescribeDataIngestionJobResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods showsPrec :: Int -> DescribeDataIngestionJobResponse -> ShowS # show :: DescribeDataIngestionJobResponse -> String # showList :: [DescribeDataIngestionJobResponse] -> ShowS #
NFData DescribeDataIngestionJobResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods rnf :: DescribeDataIngestionJobResponse -> () #
Eq DescribeDataIngestionJobResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob Methods (==) :: DescribeDataIngestionJobResponse -> DescribeDataIngestionJobResponse -> Bool # (/=) :: DescribeDataIngestionJobResponse -> DescribeDataIngestionJobResponse -> Bool #
type Rep DescribeDataIngestionJobResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.DescribeDataIngestionJob type Rep DescribeDataIngestionJobResponse = D1 ('MetaData "DescribeDataIngestionJobResponse" "Amazonka.LookoutEquipment.DescribeDataIngestionJob" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "DescribeDataIngestionJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "dataEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "dataQualitySummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataQualitySummary)))) :: ((S1 ('MetaSel ('Just "dataStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "failedReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ingestedDataSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: ((S1 ('MetaSel ('Just "ingestedFilesSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IngestedFilesSummary)) :: (S1 ('MetaSel ('Just "ingestionInputConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IngestionInputConfiguration)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IngestionJobStatus))) :: (S1 ('MetaSel ('Just "statusDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeDataIngestionJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDataIngestionJobResponse'`
-> DescribeDataIngestionJobResponse

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

DescribeDataIngestionJobResponse, describeDataIngestionJobResponse_createdAt - The time at which the data ingestion job was created.

DescribeDataIngestionJobResponse, describeDataIngestionJobResponse_dataEndTime - Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

$sel:dataQualitySummary:DescribeDataIngestionJobResponse', describeDataIngestionJobResponse_dataQualitySummary - Gives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

DescribeDataIngestionJobResponse, describeDataIngestionJobResponse_dataStartTime - Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

DescribeDataIngestionJobResponse, describeDataIngestionJobResponse_datasetArn - The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.

DescribeDataIngestionJobResponse, describeDataIngestionJobResponse_failedReason - Specifies the reason for failure when a data ingestion job has failed.

$sel:ingestedDataSize:DescribeDataIngestionJobResponse', describeDataIngestionJobResponse_ingestedDataSize - Indicates the size of the ingested dataset.

$sel:ingestedFilesSummary:DescribeDataIngestionJobResponse', describeDataIngestionJobResponse_ingestedFilesSummary - Undocumented member.

DescribeDataIngestionJobResponse, describeDataIngestionJobResponse_ingestionInputConfiguration - Specifies the S3 location configuration for the data input for the data ingestion job.

DescribeDataIngestionJob, describeDataIngestionJobResponse_jobId - Indicates the job ID of the data ingestion job.

$sel:roleArn:DescribeDataIngestionJobResponse', describeDataIngestionJobResponse_roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.

DescribeDataIngestionJobResponse, describeDataIngestionJobResponse_status - Indicates the status of the DataIngestionJob operation.

$sel:statusDetail:DescribeDataIngestionJobResponse', describeDataIngestionJobResponse_statusDetail - Provides details about status of the ingestion job that is currently in progress.

$sel:httpStatus:DescribeDataIngestionJobResponse', describeDataIngestionJobResponse_httpStatus - The response's http status code.

Response Lenses

describeDataIngestionJobResponse_createdAt :: Lens' DescribeDataIngestionJobResponse (Maybe UTCTime) Source #

The time at which the data ingestion job was created.

describeDataIngestionJobResponse_dataEndTime :: Lens' DescribeDataIngestionJobResponse (Maybe UTCTime) Source #

Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

describeDataIngestionJobResponse_dataQualitySummary :: Lens' DescribeDataIngestionJobResponse (Maybe DataQualitySummary) Source #

Gives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

describeDataIngestionJobResponse_dataStartTime :: Lens' DescribeDataIngestionJobResponse (Maybe UTCTime) Source #

Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

describeDataIngestionJobResponse_datasetArn :: Lens' DescribeDataIngestionJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.

describeDataIngestionJobResponse_failedReason :: Lens' DescribeDataIngestionJobResponse (Maybe Text) Source #

Specifies the reason for failure when a data ingestion job has failed.

describeDataIngestionJobResponse_ingestedDataSize :: Lens' DescribeDataIngestionJobResponse (Maybe Natural) Source #

Indicates the size of the ingested dataset.

describeDataIngestionJobResponse_ingestedFilesSummary :: Lens' DescribeDataIngestionJobResponse (Maybe IngestedFilesSummary) Source #

Undocumented member.

describeDataIngestionJobResponse_ingestionInputConfiguration :: Lens' DescribeDataIngestionJobResponse (Maybe IngestionInputConfiguration) Source #

Specifies the S3 location configuration for the data input for the data ingestion job.

describeDataIngestionJobResponse_jobId :: Lens' DescribeDataIngestionJobResponse (Maybe Text) Source #

Indicates the job ID of the data ingestion job.

describeDataIngestionJobResponse_roleArn :: Lens' DescribeDataIngestionJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.

describeDataIngestionJobResponse_status :: Lens' DescribeDataIngestionJobResponse (Maybe IngestionJobStatus) Source #

Indicates the status of the DataIngestionJob operation.

describeDataIngestionJobResponse_statusDetail :: Lens' DescribeDataIngestionJobResponse (Maybe Text) Source #

Provides details about status of the ingestion job that is currently in progress.

describeDataIngestionJobResponse_httpStatus :: Lens' DescribeDataIngestionJobResponse Int Source #

The response's http status code.