Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartDataIngestionJob

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

Request Syntax


{
   "ClientToken": "string",
   "DatasetName": "string",
   "IngestionInputConfiguration": { 
      "S3InputConfiguration": { 
         "Bucket": "string",
         "KeyPattern": "string",
         "Prefix": "string"
      }
   },
   "RoleArn": "string"
}

Request Parameters

The request accepts the following data in JSON format.

ClientToken

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Type: String

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

Pattern: \p{ASCII}{1,256}

Required: Yes

DatasetName

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

Type: String

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

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

Required: Yes

IngestionInputConfiguration

Specifies information for the input data for the data ingestion job, including dataset S3 location.

Type: IngestionInputConfiguration object

Required: Yes

RoleArn

The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.

Type: String

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

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

Required: Yes

Response Syntax


{
   "JobId": "string",
   "Status": "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.

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}

Status

Indicates the status of the StartDataIngestionJob operation.

Type: String

Valid Values: IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS

Errors

AccessDeniedException

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

HTTP Status Code: 400

ConflictException

The request could not be completed due to a conflict with the current state of the target 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

ServiceQuotaExceededException

Resource limitations have been exceeded.

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