DescribeTableDataImportJob - Amazon Honeycode

DescribeTableDataImportJob

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

Request Syntax

GET /workbooks/workbookId/tables/tableId/import/jobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

jobId

The ID of the job that was returned by the StartTableDataImportJob request.

If a job with the specified id could not be found, this API throws ResourceNotFoundException.

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

Pattern: ^[^\n\r\x00\x08\x0B\x0C\x0E\x1F]*$

Required: Yes

tableId

The ID of the table into which data was imported.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

workbookId

The ID of the workbook into which data was imported.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "jobMetadata": { "dataSource": { "dataSourceConfig": { "dataSourceUrl": "string" } }, "importOptions": { "delimitedTextOptions": { "dataCharacterEncoding": "string", "delimiter": "string", "hasHeaderRow": boolean, "ignoreEmptyRows": boolean }, "destinationOptions": { "columnMap": { "string" : { "columnIndex": number } } } }, "submitter": { "email": "string", "userArn": "string" }, "submitTime": number }, "jobStatus": "string", "message": "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.

jobMetadata

The metadata about the job that was submitted for import.

Type: TableDataImportJobMetadata object

jobStatus

The current status of the import job.

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED

message

A message providing more details about the current status of the import job.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

HTTP Status Code: 403

InternalServerException

There were unexpected errors from the server.

HTTP Status Code: 500

ResourceNotFoundException

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

HTTP Status Code: 404

ServiceUnavailableException

Remote service is unreachable.

HTTP Status Code: 503

ThrottlingException

Tps(transactions per second) rate reached.

HTTP Status Code: 429

ValidationException

Request is invalid. The message in the response contains details on why the request is invalid.

HTTP Status Code: 400

See Also

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