get_datasource_dataflow_execution_details¶

DatasourcesApi.get_datasource_dataflow_execution_details(datasource_id, id, execution_id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get a specific ArcGIS dataflow execution

Returns one ArcGIS dataflow run by ExecutionId. The caller (identified by role_id) must have at least read/view permission on the datasource (else AUTH-1012). ArcGIS only; other datasource types have no handler. When MetadataIngestionJobRunId or DataIngestionJobRunId is present, short-lived S3 presigned URLs for output/error logs are added if those files exist.

Parameters:

datasource_id (str) – UUID of the parent datasource. Rejected with IPV-1045 if missing. ArcGIS disabled by admin returns DTSC-1025. (required)
id (str) – UUID of the dataflow (DataflowId). Rejected with IPV-1045 if missing. (required)
execution_id (str) – ExecutionId of the ArcGIS run. Rejected with IPV-1045 if no matching run exists for this dataflow. (required)
role_id (str) – Amorphic role ID the request is authorized against. Must be a role the user belongs to with at least read/view access on the datasource. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

Executions

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /datasources/{datasource_id}/dataflows/{id}/executions/{execution_id}

Success (HTTP 200)¶

The DynamoDB run item for the matching ExecutionId, optionally with MetadataIngestion*LogURL and DataIngestion*LogURL presigned fields.

ArcGIS run with optional log URLs

{
  "DataflowId": "b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f",
  "DatasourceId": "a2f7d3b1-8e5c-4a6f-9d1e-2b3c4d5e6f7a",
  "ExecutionId": "exec-123",
  "ExecutionArn": "arn:aws:states:us-east-1:123456789012:execution:arcgis:exec-123",
  "StartTime": "2024-06-01 12:00:00",
  "EndTime": "2024-06-01 12:15:00",
  "RunStatus": "completed",
  "Message": "ArcGIS dataflow execution completed",
  "LastModifiedBy": "user1",
  "LastModifiedTime": "2024-06-01 12:15:00",
  "EstimatedCost": 0.12,
  "MetadataIngestionJobRunId": "jr_meta_1",
  "DataIngestionJobRunId": "jr_data_1",
  "MetadataIngestionOutputLogURL": "https://amorphic-logs.s3.amazonaws.com/...?X-Amz-Algorithm=...",
  "DataIngestionErrorLogURL": "https://amorphic-logs.s3.amazonaws.com/...?X-Amz-Algorithm=..."
}

Errors¶

Documented error codes: AUTH-1012, IPV-1045, DTSC-1025.

HTTP 400

Validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Common codes: AUTH-1012 (no view access), IPV-1045 (missing datasource, dataflow, or ExecutionId), DTSC-1025 (ArcGIS disabled by admin).

Caller lacks view access

{
  "Message": "AUTH-1012 - User: user1 requires at least read-only access on the resource to perform this action."
}

No run for ExecutionId on this dataflow

{
  "Message": "IPV-1045 - Invalid parameter - ExecutionId(exec-123), value either missing or is invalid."
}

HTTP 500

Backend failure. Body is {“Message”: “<CODE> - <text>”} or a plain Message string. Non-ArcGIS datasource types are not supported.

Unexpected backend failure

{
  "Message": "Something went wrong at backend"
}