| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.HoneyCode.StartTableDataImportJob
Description
The StartTableDataImportJob API allows you to start an import job on a table. This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.
Synopsis
- data StartTableDataImportJob = StartTableDataImportJob' {}
- newStartTableDataImportJob :: Text -> ImportDataSource -> ImportSourceDataFormat -> Text -> ImportOptions -> Text -> StartTableDataImportJob
- startTableDataImportJob_workbookId :: Lens' StartTableDataImportJob Text
- startTableDataImportJob_dataSource :: Lens' StartTableDataImportJob ImportDataSource
- startTableDataImportJob_dataFormat :: Lens' StartTableDataImportJob ImportSourceDataFormat
- startTableDataImportJob_destinationTableId :: Lens' StartTableDataImportJob Text
- startTableDataImportJob_importOptions :: Lens' StartTableDataImportJob ImportOptions
- startTableDataImportJob_clientRequestToken :: Lens' StartTableDataImportJob Text
- data StartTableDataImportJobResponse = StartTableDataImportJobResponse' {}
- newStartTableDataImportJobResponse :: Int -> Text -> TableDataImportJobStatus -> StartTableDataImportJobResponse
- startTableDataImportJobResponse_httpStatus :: Lens' StartTableDataImportJobResponse Int
- startTableDataImportJobResponse_jobId :: Lens' StartTableDataImportJobResponse Text
- startTableDataImportJobResponse_jobStatus :: Lens' StartTableDataImportJobResponse TableDataImportJobStatus
Creating a Request
data StartTableDataImportJob Source #
See: newStartTableDataImportJob smart constructor.
Constructors
| StartTableDataImportJob' | |
Fields
| |
Instances
newStartTableDataImportJob Source #
Arguments
| :: Text | |
| -> ImportDataSource | |
| -> ImportSourceDataFormat | |
| -> Text | |
| -> ImportOptions | |
| -> Text | |
| -> StartTableDataImportJob |
Create a value of StartTableDataImportJob 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:StartTableDataImportJob', startTableDataImportJob_workbookId - The ID of the workbook where the rows are being imported.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
$sel:dataSource:StartTableDataImportJob', startTableDataImportJob_dataSource - The source of the data that is being imported. The size of source must
be no larger than 100 MB. Source must have no more than 100,000 cells
and no more than 1,000 rows.
$sel:dataFormat:StartTableDataImportJob', startTableDataImportJob_dataFormat - The format of the data that is being imported. Currently the only option
supported is "DELIMITED_TEXT".
$sel:destinationTableId:StartTableDataImportJob', startTableDataImportJob_destinationTableId - The ID of the table where the rows are being imported.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.
$sel:importOptions:StartTableDataImportJob', startTableDataImportJob_importOptions - The options for customizing this import request.
$sel:clientRequestToken:StartTableDataImportJob', startTableDataImportJob_clientRequestToken - The request token for performing the update action. Request tokens help
to identify duplicate requests. If a call times out or fails due to a
transient error like a failed network connection, you can retry the call
with the same request token. The service ensures that if the first call
using that request token is successfully performed, the second call will
not perform the action again.
Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
Request Lenses
startTableDataImportJob_workbookId :: Lens' StartTableDataImportJob Text Source #
The ID of the workbook where the rows are being imported.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
startTableDataImportJob_dataSource :: Lens' StartTableDataImportJob ImportDataSource Source #
The source of the data that is being imported. The size of source must be no larger than 100 MB. Source must have no more than 100,000 cells and no more than 1,000 rows.
startTableDataImportJob_dataFormat :: Lens' StartTableDataImportJob ImportSourceDataFormat Source #
The format of the data that is being imported. Currently the only option supported is "DELIMITED_TEXT".
startTableDataImportJob_destinationTableId :: Lens' StartTableDataImportJob Text Source #
The ID of the table where the rows are being imported.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.
startTableDataImportJob_importOptions :: Lens' StartTableDataImportJob ImportOptions Source #
The options for customizing this import request.
startTableDataImportJob_clientRequestToken :: Lens' StartTableDataImportJob Text Source #
The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.
Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
Destructuring the Response
data StartTableDataImportJobResponse Source #
See: newStartTableDataImportJobResponse smart constructor.
Constructors
| StartTableDataImportJobResponse' | |
Fields
| |
Instances
newStartTableDataImportJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> TableDataImportJobStatus | |
| -> StartTableDataImportJobResponse |
Create a value of StartTableDataImportJobResponse 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:httpStatus:StartTableDataImportJobResponse', startTableDataImportJobResponse_httpStatus - The response's http status code.
$sel:jobId:StartTableDataImportJobResponse', startTableDataImportJobResponse_jobId - The id that is assigned to this import job. Future requests to find out
the status of this import job need to send this id in the appropriate
parameter in the request.
$sel:jobStatus:StartTableDataImportJobResponse', startTableDataImportJobResponse_jobStatus - The status of the import job immediately after submitting the request.
Response Lenses
startTableDataImportJobResponse_httpStatus :: Lens' StartTableDataImportJobResponse Int Source #
The response's http status code.
startTableDataImportJobResponse_jobId :: Lens' StartTableDataImportJobResponse Text Source #
The id that is assigned to this import job. Future requests to find out the status of this import job need to send this id in the appropriate parameter in the request.
startTableDataImportJobResponse_jobStatus :: Lens' StartTableDataImportJobResponse TableDataImportJobStatus Source #
The status of the import job immediately after submitting the request.