DataZone / Client / get_job_run

get_job_run

DataZone.Client.get_job_run(**kwargs)

The details of the job run.

See also: AWS API Documentation

Request Syntax

response = client.get_job_run(
    domainIdentifier='string',
    identifier='string'
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the domain.

• identifier (string) –

  [REQUIRED]

  The ID of the job run.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'details': {
        'lineageRunDetails': {
            'sqlQueryRunDetails': {
                'errorMessages': [
                    'string',
                ],
                'numQueriesFailed': 123,
                'queryEndTime': datetime(2015, 1, 1),
                'queryStartTime': datetime(2015, 1, 1),
                'totalQueriesProcessed': 123
            }
        }
    },
    'domainId': 'string',
    'endTime': datetime(2015, 1, 1),
    'error': {
        'message': 'string'
    },
    'id': 'string',
    'jobId': 'string',
    'jobType': 'LINEAGE',
    'runMode': 'SCHEDULED'|'ON_DEMAND',
    'startTime': datetime(2015, 1, 1),
    'status': 'SCHEDULED'|'IN_PROGRESS'|'SUCCESS'|'PARTIALLY_SUCCEEDED'|'FAILED'|'ABORTED'|'TIMED_OUT'|'CANCELED'
}

Response Structure

• (dict) –

  • createdAt (datetime) –

    The timestamp of when the job run was created.

  • createdBy (string) –

    The user who created the job run.

  • details (dict) –

    The details of the job run.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: lineageRunDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • lineageRunDetails (dict) –

      The data lineage details of a job run.

      • sqlQueryRunDetails (dict) –

        The SQL query run details of a data lineage run.

        • errorMessages (list) –

          The error message of the SQL query run details of a data lineage run.

          • (string) –

        • numQueriesFailed (integer) –

          The number of queries that failed in the SQL query run details of a data lineage run.

        • queryEndTime (datetime) –

          The query end time in the SQL query run details of a data lineage run.

        • queryStartTime (datetime) –

          The query start time in the SQL query run details of a data lineage run.

        • totalQueriesProcessed (integer) –

          The total queries processed in the SQL query run details of a data lineage run.

  • domainId (string) –

    The ID of the domain.

  • endTime (datetime) –

    The timestamp of when the job run ended.

  • error (dict) –

    The error generated if the action is not completed successfully.

    • message (string) –

      The job run error message.

  • id (string) –

    The ID of the job run.

  • jobId (string) –

    The ID of the job run.

  • jobType (string) –

    The type of the job run.

  • runMode (string) –

    The mode of the job run.

  • startTime (datetime) –

    The timestamp of when the job run started.

  • status (string) –

    The status of the job run.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException