ListDataIngestionJobs - Amazon Lookout for Equipment

ListDataIngestionJobs

Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.

Request Syntax

{ "DatasetName": "string", "MaxResults": number, "NextToken": "string", "Status": "string" }

Request Parameters

The request accepts the following data in JSON format.

DatasetName

The name of the dataset being used for the data ingestion job.

Type: String

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

Pattern: ^[0-9a-zA-Z_-]{1,200}$

Required: No

MaxResults

Specifies the maximum number of data ingestion jobs to list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

An opaque pagination token indicating where to continue the listing of data ingestion jobs.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Required: No

Status

Indicates the status of the data ingestion job.

Type: String

Valid Values: IN_PROGRESS | SUCCESS | FAILED

Required: No

Response Syntax

{ "DataIngestionJobSummaries": [ { "DatasetArn": "string", "DatasetName": "string", "IngestionInputConfiguration": { "S3InputConfiguration": { "Bucket": "string", "Prefix": "string" } }, "JobId": "string", "Status": "string" } ], "NextToken": "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.

DataIngestionJobSummaries

Specifies information about the specific data ingestion job, including dataset name and status.

Type: Array of DataIngestionJobSummary objects

NextToken

An opaque pagination token indicating where to continue the listing of data ingestion jobs.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

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

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: