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 |
Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.
Synopsis
- data DescribeDataIngestionJob = DescribeDataIngestionJob' {}
- newDescribeDataIngestionJob :: Text -> DescribeDataIngestionJob
- describeDataIngestionJob_jobId :: Lens' DescribeDataIngestionJob Text
- data DescribeDataIngestionJobResponse = DescribeDataIngestionJobResponse' {
- createdAt :: Maybe POSIX
- dataEndTime :: Maybe POSIX
- dataQualitySummary :: Maybe DataQualitySummary
- dataStartTime :: Maybe POSIX
- datasetArn :: Maybe Text
- failedReason :: Maybe Text
- ingestedDataSize :: Maybe Natural
- ingestedFilesSummary :: Maybe IngestedFilesSummary
- ingestionInputConfiguration :: Maybe IngestionInputConfiguration
- jobId :: Maybe Text
- roleArn :: Maybe Text
- status :: Maybe IngestionJobStatus
- statusDetail :: Maybe Text
- httpStatus :: Int
- newDescribeDataIngestionJobResponse :: Int -> DescribeDataIngestionJobResponse
- describeDataIngestionJobResponse_createdAt :: Lens' DescribeDataIngestionJobResponse (Maybe UTCTime)
- describeDataIngestionJobResponse_dataEndTime :: Lens' DescribeDataIngestionJobResponse (Maybe UTCTime)
- describeDataIngestionJobResponse_dataQualitySummary :: Lens' DescribeDataIngestionJobResponse (Maybe DataQualitySummary)
- describeDataIngestionJobResponse_dataStartTime :: Lens' DescribeDataIngestionJobResponse (Maybe UTCTime)
- describeDataIngestionJobResponse_datasetArn :: Lens' DescribeDataIngestionJobResponse (Maybe Text)
- describeDataIngestionJobResponse_failedReason :: Lens' DescribeDataIngestionJobResponse (Maybe Text)
- describeDataIngestionJobResponse_ingestedDataSize :: Lens' DescribeDataIngestionJobResponse (Maybe Natural)
- describeDataIngestionJobResponse_ingestedFilesSummary :: Lens' DescribeDataIngestionJobResponse (Maybe IngestedFilesSummary)
- describeDataIngestionJobResponse_ingestionInputConfiguration :: Lens' DescribeDataIngestionJobResponse (Maybe IngestionInputConfiguration)
- describeDataIngestionJobResponse_jobId :: Lens' DescribeDataIngestionJobResponse (Maybe Text)
- describeDataIngestionJobResponse_roleArn :: Lens' DescribeDataIngestionJobResponse (Maybe Text)
- describeDataIngestionJobResponse_status :: Lens' DescribeDataIngestionJobResponse (Maybe IngestionJobStatus)
- describeDataIngestionJobResponse_statusDetail :: Lens' DescribeDataIngestionJobResponse (Maybe Text)
- describeDataIngestionJobResponse_httpStatus :: Lens' DescribeDataIngestionJobResponse Int
Creating a Request
data DescribeDataIngestionJob Source #
See: newDescribeDataIngestionJob
smart constructor.
Instances
newDescribeDataIngestionJob Source #
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.
DescribeDataIngestionJobResponse' | |
|
Instances
newDescribeDataIngestionJobResponse Source #
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.