EMRServerless / Client / get_resource_dashboard

get_resource_dashboard

EMRServerless.Client.get_resource_dashboard(**kwargs)

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.

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_resource_dashboard(
    applicationId='string',
    resourceId='string',
    resourceType='SESSION'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The ID of the application that the resource belongs to.

  • resourceId (string) –

    [REQUIRED]

    The ID of the resource.

  • resourceType (string) –

    [REQUIRED]

    The type of resource to access the dashboard for. Currently, only Session is supported.

Return type:

dict

Returns:

Response Syntax

{
    'url': 'string'
}

Response Structure

  • (dict) –

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

Exceptions

  • EMRServerless.Client.exceptions.ValidationException

  • EMRServerless.Client.exceptions.ResourceNotFoundException

  • EMRServerless.Client.exceptions.InternalServerException