EMRServerless / Client / get_dashboard_for_job_run

get_dashboard_for_job_run#

EMRServerless.Client.get_dashboard_for_job_run(**kwargs)#

Creates and returns a URL that you can use to access the application UIs for a job run.

For jobs in a running state, the application UI is a live user interface such as the Spark or Tez web UI. For completed jobs, the application UI is a persistent application user interface such as the Spark History Server or persistent Tez UI.

Note

The URL is valid for one hour after you generate it. To access the application UI after that hour elapses, you must invoke the API again to generate a new URL.

See also: AWS API Documentation

Request Syntax

response = client.get_dashboard_for_job_run(
    applicationId='string',
    jobRunId='string',
    attempt=123,
    accessSystemProfileLogs=True|False
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The ID of the application.

  • jobRunId (string) –

    [REQUIRED]

    The ID of the job run.

  • attempt (integer) – An optimal parameter that indicates the amount of attempts for the job. If not specified, this value defaults to the attempt of the latest job.

  • accessSystemProfileLogs (boolean) – Allows access to system profile logs for Lake Formation-enabled jobs. Default is false.

Return type:

dict

Returns:

Response Syntax

{
    'url': 'string'
}

Response Structure

  • (dict) –

    • url (string) –

      The URL to view job run’s dashboard.

Exceptions

  • EMRServerless.Client.exceptions.ValidationException

  • EMRServerless.Client.exceptions.ResourceNotFoundException

  • EMRServerless.Client.exceptions.InternalServerException