GetDashboardForJobRun
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.
Request Syntax
GET /applications/applicationId/jobruns/jobRunId/dashboard?accessSystemProfileLogs=accessSystemProfileLogs&attempt=attempt HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- accessSystemProfileLogs
-
Allows access to system profile logs for Lake Formation-enabled jobs. Default is false.
- applicationId
-
The ID of the application.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-z]+$Required: Yes
- attempt
-
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.
Valid Range: Minimum value of 1.
- jobRunId
-
The ID of the job run.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-z]+$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"url": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- url
-
The URL to view job run's dashboard.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
