| 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 |
Amazonka.HoneyCode.DescribeTableDataImportJob
Description
The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.
Synopsis
- data DescribeTableDataImportJob = DescribeTableDataImportJob' {}
- newDescribeTableDataImportJob :: Text -> Text -> Text -> DescribeTableDataImportJob
- describeTableDataImportJob_workbookId :: Lens' DescribeTableDataImportJob Text
- describeTableDataImportJob_tableId :: Lens' DescribeTableDataImportJob Text
- describeTableDataImportJob_jobId :: Lens' DescribeTableDataImportJob Text
- data DescribeTableDataImportJobResponse = DescribeTableDataImportJobResponse' {}
- newDescribeTableDataImportJobResponse :: Int -> TableDataImportJobStatus -> Text -> TableDataImportJobMetadata -> DescribeTableDataImportJobResponse
- describeTableDataImportJobResponse_errorCode :: Lens' DescribeTableDataImportJobResponse (Maybe ErrorCode)
- describeTableDataImportJobResponse_httpStatus :: Lens' DescribeTableDataImportJobResponse Int
- describeTableDataImportJobResponse_jobStatus :: Lens' DescribeTableDataImportJobResponse TableDataImportJobStatus
- describeTableDataImportJobResponse_message :: Lens' DescribeTableDataImportJobResponse Text
- describeTableDataImportJobResponse_jobMetadata :: Lens' DescribeTableDataImportJobResponse TableDataImportJobMetadata
Creating a Request
data DescribeTableDataImportJob Source #
See: newDescribeTableDataImportJob smart constructor.
Constructors
| DescribeTableDataImportJob' | |
Fields
| |
Instances
newDescribeTableDataImportJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DescribeTableDataImportJob |
Create a value of DescribeTableDataImportJob 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:
$sel:workbookId:DescribeTableDataImportJob', describeTableDataImportJob_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.
DescribeTableDataImportJob, describeTableDataImportJob_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.
$sel:jobId:DescribeTableDataImportJob', describeTableDataImportJob_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.
Request Lenses
describeTableDataImportJob_workbookId :: Lens' DescribeTableDataImportJob Text Source #
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.
describeTableDataImportJob_tableId :: Lens' DescribeTableDataImportJob Text Source #
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.
describeTableDataImportJob_jobId :: Lens' DescribeTableDataImportJob Text Source #
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.
Destructuring the Response
data DescribeTableDataImportJobResponse Source #
See: newDescribeTableDataImportJobResponse smart constructor.
Constructors
| DescribeTableDataImportJobResponse' | |
Fields
| |
Instances
newDescribeTableDataImportJobResponse Source #
Arguments
| :: Int | |
| -> TableDataImportJobStatus | |
| -> Text | |
| -> TableDataImportJobMetadata | |
| -> DescribeTableDataImportJobResponse |
Create a value of DescribeTableDataImportJobResponse 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:
$sel:errorCode:DescribeTableDataImportJobResponse', describeTableDataImportJobResponse_errorCode - If job status is failed, error code to understand reason for the
failure.
$sel:httpStatus:DescribeTableDataImportJobResponse', describeTableDataImportJobResponse_httpStatus - The response's http status code.
$sel:jobStatus:DescribeTableDataImportJobResponse', describeTableDataImportJobResponse_jobStatus - The current status of the import job.
$sel:message:DescribeTableDataImportJobResponse', describeTableDataImportJobResponse_message - A message providing more details about the current status of the import
job.
$sel:jobMetadata:DescribeTableDataImportJobResponse', describeTableDataImportJobResponse_jobMetadata - The metadata about the job that was submitted for import.
Response Lenses
describeTableDataImportJobResponse_errorCode :: Lens' DescribeTableDataImportJobResponse (Maybe ErrorCode) Source #
If job status is failed, error code to understand reason for the failure.
describeTableDataImportJobResponse_httpStatus :: Lens' DescribeTableDataImportJobResponse Int Source #
The response's http status code.
describeTableDataImportJobResponse_jobStatus :: Lens' DescribeTableDataImportJobResponse TableDataImportJobStatus Source #
The current status of the import job.
describeTableDataImportJobResponse_message :: Lens' DescribeTableDataImportJobResponse Text Source #
A message providing more details about the current status of the import job.
describeTableDataImportJobResponse_jobMetadata :: Lens' DescribeTableDataImportJobResponse TableDataImportJobMetadata Source #
The metadata about the job that was submitted for import.