resource_dashboards

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

Overview

Name	resource_dashboards
Type	Resource
Id	aws.emr_serverless.resource_dashboards

Fields

The following fields are returned by SELECT queries:

get_resource_dashboard

Name	Datatype	Description
url	string	A URL to the resource dashboard. For an active resource, this URL opens the live application UI. For a terminated resource, this URL opens the persistent application UI. This value is not included in the response if the URL is not available.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource_dashboard	select	application_id, resourceId, resourceType, region		Returns a URL that you can use to access the application UIs for a specified resource, such as a session. For resources in a running state, the application UI is a live user interface such as the Spark web UI. For terminated resources, the application UI is a persistent application user interface such as the Spark History Server. 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.

Name	Datatype	Description
application_id	string	The ID of the application that the resource belongs to.
region	string	AWS region (default: us-east-1)
resourceId	string	The ID of the resource.
resourceType	string	The type of resource to access the dashboard for. Currently, only Session is supported.

SELECT examples

get_resource_dashboard

Returns a URL that you can use to access the application UIs for a specified resource, such as a session. For resources in a running state, the application UI is a live user interface such as the Spark web UI. For terminated resources, the application UI is a persistent application user interface such as the Spark History Server. 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.resource_dashboards
WHERE application_id = '{{ application_id }}' -- required
AND resourceId = '{{ resourceId }}' -- required
AND resourceType = '{{ resourceType }}' -- required
AND region = '{{ region }}' -- required
;