Skip to main content

dashboard_for_job_runs

Creates, updates, deletes, gets or lists a dashboard_for_job_runs resource.

Overview

Namedashboard_for_job_runs
TypeResource
Idaws.emr_serverless.dashboard_for_job_runs

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
urlstringThe URL to view job run's dashboard.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_dashboard_for_job_runselectapplication_id, job_run_id, regionattempt, accessSystemProfileLogsCreates 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. 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
application_idstringThe ID of the application.
job_run_idstringThe ID of the job run.
regionstringAWS region (default: us-east-1)
accessSystemProfileLogsbooleanAllows access to system profile logs for Lake Formation-enabled jobs. Default is false.
attemptintegerAn optimal parameter that indicates the amount of attempts for the job. If not specified, this value defaults to the attempt of the latest job.

SELECT examples

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. 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.

SELECT
url
FROM aws.emr_serverless.dashboard_for_job_runs
WHERE application_id = '{{ application_id }}' -- required
AND job_run_id = '{{ job_run_id }}' -- required
AND region = '{{ region }}' -- required
AND attempt = '{{ attempt }}'
AND accessSystemProfileLogs = '{{ accessSystemProfileLogs }}'
;