client.imports.get_batches

A method of the Imports endpoint.

get_batches(id: int) → Response

Get details about a batch import

API URL: GET /imports/batches/{id}

import civis
client = civis.APIClient()
response = client.imports.get_batches(...)

Parameters:

idint

The ID for the import.

Returns:

civis.Response

• idint

  The ID for the import.

• schemastr

  The destination schema name. This schema must already exist in Redshift.

• tablestr

  The destination table name, without the schema prefix. This table must already exist in Redshift.

• remote_host_idint

  The ID of the destination database host.

• statestr

  The state of the run; one of “queued”, “running”, “succeeded”, “failed”, or “cancelled”.

• started_atstr (time)

  The time the last run started at.

• finished_atstr (time)

  The time the last run completed.

• errorstr

  The error returned by the run, if any.

• hiddenbool

  The hidden status of the item.