Skip to content

get_dashboard_url

get_dashboard_url(
    resource_id: NameString,
    resource_type: GlueResourceType,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    request_origin: Optional[OrchestrationNameString] = None,
) -> GetDashboardUrlResponse

Retrieves the URL for the Spark monitoring dashboard for a Glue resource.

Parameters:

  • resource_id (NameString) –

    The unique identifier of the resource for which to retrieve the dashboard URL.

  • resource_type (GlueResourceType) –

    The type of the resource. Valid values are SESSION and JOB.

  • request_origin (Optional[OrchestrationNameString], default: None ) –

    The origin of the request.

Raises:

Source code in docs_src/capo_glue/_services/glue.py
def get_dashboard_url(
    self,
    resource_id: "capo_glue.types.name_string.NameString",
    resource_type: "capo_glue.types.glue_resource_type.GlueResourceType",
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    request_origin: Optional[
        "capo_glue.types.orchestration_name_string.OrchestrationNameString"
    ] = None,
) -> "capo_glue.types.get_dashboard_url_response.GetDashboardUrlResponse":
    """<p>Retrieves the URL for the Spark monitoring dashboard for a Glue resource.</p>

    Args:
        resource_id: <p>The unique identifier of the resource for which to retrieve the dashboard URL.</p>
        resource_type: <p>The type of the resource. Valid values are <code>SESSION</code> and <code>JOB</code>.</p>
        request_origin: <p>The origin of the request. </p>

    Raises:
        capo_glue.errors.access_denied_exception.AccessDeniedException: <p>Access to a resource was denied.</p>
        capo_glue.errors.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist</p>
        capo_glue.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_glue.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_glue.errors.operation_not_supported_exception.OperationNotSupportedException: <p>The operation is not available in the region.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_glue.types.get_dashboard_url_request.GetDashboardUrlRequest]",
    ) -> OperationResponse[
        "capo_glue.types.get_dashboard_url_response.GetDashboardUrlResponse"
    ]:
        import capo_glue._operations.aws_glue.get_dashboard_url

        output, http_response = (
            capo_glue._operations.aws_glue.get_dashboard_url.get_dashboard_url(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_glue.types.get_dashboard_url_response.GetDashboardUrlResponse",
    ) -> dict[str, Any]:
        import capo_glue.types.get_dashboard_url_response

        return capo_glue.types.get_dashboard_url_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetDashboardUrl", redact_output=_redact_output),
    )
    input_: capo_glue.types.get_dashboard_url_request.GetDashboardUrlRequest = {
        "resource_id": resource_id,
        "resource_type": resource_type,
    }
    if request_origin is not None:
        input_["request_origin"] = request_origin

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output