Cloud

Get "Update AWS Data Source" Job Status

Get the status of a data source update request started by Update AWS Data Source or Update AWS Data Source from File.

get/v1/dataSources/aws/{awsDataSourceId}/{jobReferenceId}/status

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/dataSources/aws/{awsDataSourceId}/{jobReferenceId}/status
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: cloud.datasource)

Path parameters

awsDataSourceIdstring required

AWS data source ID

Example:awsds_12345

The ID of the AWS data source associated with the job

jobReferenceIdstring required

Unique identifier for an asynchronous job

Example:jobr_2f5e5b82-6f1d-4c9f-932a-14e43cf30454

Response

OK. Returns the job status.

jobIdstring required

Unique identifier for an asynchronous job

status'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' required

Status of an asynchronous job

Example response

{
  "jobId": "jobr_2f5e5b82-6f1d-4c9f-932a-14e43cf30454",
  "status": "SUCCEEDED",
  "response": {
    "name": "Example AWS Data Source",
    "dataSourceId": "awsds_12345"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.