DescribeDataIngestionJob - Amazon Lookout for Equipment

DescribeDataIngestionJob

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

Request Syntax

{ "JobId": "string" }

Request Parameters

The request accepts the following data in JSON format.

JobId

The job ID of the data ingestion job.

Type: String

Length Constraints: Maximum length of 32.

Pattern: [A-Fa-f0-9]{0,32}

Required: Yes

Response Syntax

{ "CreatedAt": number, "DataEndTime": number, "DataQualitySummary": { "DuplicateTimestamps": { "TotalNumberOfDuplicateTimestamps": number }, "InsufficientSensorData": { "MissingCompleteSensorData": { "AffectedSensorCount": number }, "SensorsWithShortDateRange": { "AffectedSensorCount": number } }, "InvalidSensorData": { "AffectedSensorCount": number, "TotalNumberOfInvalidValues": number }, "MissingSensorData": { "AffectedSensorCount": number, "TotalNumberOfMissingValues": number }, "UnsupportedTimestamps": { "TotalNumberOfUnsupportedTimestamps": number } }, "DatasetArn": "string", "DataStartTime": number, "FailedReason": "string", "IngestedDataSize": number, "IngestedFilesSummary": { "DiscardedFiles": [ { "Bucket": "string", "Key": "string" } ], "IngestedNumberOfFiles": number, "TotalNumberOfFiles": number }, "IngestionInputConfiguration": { "S3InputConfiguration": { "Bucket": "string", "KeyPattern": "string", "Prefix": "string" } }, "JobId": "string", "RoleArn": "string", "Status": "string", "StatusDetail": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedAt

The time at which the data ingestion job was created.

Type: Timestamp

DataEndTime

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

Type: Timestamp

DataQualitySummary

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

Type: DataQualitySummary object

DatasetArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/.+

DataStartTime

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

Type: Timestamp

FailedReason

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5000.

Pattern: [\P{M}\p{M}]{1,5000}

IngestedDataSize

Indicates the size of the ingested dataset.

Type: Long

Valid Range: Minimum value of 0.

IngestedFilesSummary

Gives statistics about how many files have been ingested, and which files have not been ingested, for a particular ingestion job.

Type: IngestedFilesSummary object

IngestionInputConfiguration

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

Type: IngestionInputConfiguration object

JobId

Indicates the job ID of the data ingestion job.

Type: String

Length Constraints: Maximum length of 32.

Pattern: [A-Fa-f0-9]{0,32}

RoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Status

Indicates the status of the DataIngestionJob operation.

Type: String

Valid Values: IN_PROGRESS | SUCCESS | FAILED

StatusDetail

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5000.

Pattern: [\P{M}\p{M}]{1,5000}

Errors

AccessDeniedException

The request could not be completed because you do not have access to the resource.

HTTP Status Code: 400

InternalServerException

Processing of the request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource requested could not be found. Verify the resource ID and retry your request.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: