Skip to content

describe_workspace

describe_workspace(
    workspace_id: WorkspaceId, *, config_overrides: Optional[grafanaClientConfig] = None
) -> DescribeWorkspaceResponse

Displays information about one Amazon Managed Grafana workspace.

Parameters:

  • workspace_id (WorkspaceId) –

    The ID of the workspace to display information about.

Raises:

Source code in docs_src/capo_grafana/_services/grafana.py
def describe_workspace(
    self,
    workspace_id: "capo_grafana.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[grafanaClientConfig] = None,
) -> "capo_grafana.types.describe_workspace_response.DescribeWorkspaceResponse":
    """<p>Displays information about one Amazon Managed Grafana workspace.</p>

    Args:
        workspace_id: <p>The ID of the workspace to display information about.</p>

    Raises:
        capo_grafana.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action. </p>
        capo_grafana.errors.internal_server_exception.InternalServerException: <p>Unexpected error while processing the request. Retry the request.</p>
        capo_grafana.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist.</p>
        capo_grafana.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling. Retry the request.</p>
        capo_grafana.errors.validation_exception.ValidationException: <p>The value of a parameter in the request caused an error.</p>
        capo_grafana.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_grafana.types.describe_workspace_request.DescribeWorkspaceRequest]",
    ) -> OperationResponse[
        "capo_grafana.types.describe_workspace_response.DescribeWorkspaceResponse"
    ]:
        import capo_grafana._operations.aws_grafana_control_plane.describe_workspace

        output, http_response = (
            capo_grafana._operations.aws_grafana_control_plane.describe_workspace.describe_workspace(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_grafana.types.describe_workspace_response.DescribeWorkspaceResponse",
    ) -> dict[str, Any]:
        import capo_grafana.types.describe_workspace_response

        return capo_grafana.types.describe_workspace_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeWorkspace", redact_output=_redact_output),
    )
    input_: capo_grafana.types.describe_workspace_request.DescribeWorkspaceRequest = {
        "workspace_id": workspace_id
    }

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