ExportJobService¶
Initialize the Elevate service.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
server
|
Optional[str]
|
The server name for the Elevate service API. If not provided, defaults to the |
None
|
client_id
|
Optional[str]
|
The client ID for authentication. If not provided, defaults to the |
None
|
secret_key
|
Optional[str]
|
The secret key for authentication. If not provided, defaults to the |
None
|
Raises:
| Type | Description |
|---|---|
ElevateConfigurationException
|
If any required parameter is missing or invalid |
get_export_s3_job_status
¶
Retrieves the current status and progress information of an Amazon S3 export job. Use this endpoint to monitor long-running export operations and determine when they have completed successfully or failed. The response includes detailed status information, progress indicators, and any error details if the job failed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
StrictStr
|
Unique identifier of the background job to query (required) |
required |
Returns:
| Type | Description |
|---|---|
ExportS3JobStatusResponse
|
Returns the result object. |