PrometheusService / Client / describe_workspace



Returns information about an existing workspace.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspace(

workspaceId (string) –


The ID of the workspace to describe.

Return type:



Response Syntax

    'workspace': {
        'alias': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'kmsKeyArn': 'string',
        'prometheusEndpoint': 'string',
        'status': {
        'tags': {
            'string': 'string'
        'workspaceId': 'string'

Response Structure

  • (dict) –

    Represents the output of a DescribeWorkspace operation.

    • workspace (dict) –

      A structure that contains details about the workspace.

      • alias (string) –

        The alias that is assigned to this workspace to help identify it. It may not be unique.

      • arn (string) –

        The ARN of the workspace.

      • createdAt (datetime) –

        The date and time that the workspace was created.

      • kmsKeyArn (string) –

        (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

      • prometheusEndpoint (string) –

        The Prometheus endpoint available for this workspace.

      • status (dict) –

        The current status of the workspace.

        • statusCode (string) –

          The current status of the workspace.

      • tags (dict) –

        The list of tag keys and values that are associated with the workspace.

        • (string) –

          The key of the tag. May not begin with aws:.

          • (string) –

            The value of the tag.

      • workspaceId (string) –

        The unique ID for the workspace.


  • PrometheusService.Client.exceptions.ThrottlingException

  • PrometheusService.Client.exceptions.ValidationException

  • PrometheusService.Client.exceptions.ResourceNotFoundException

  • PrometheusService.Client.exceptions.AccessDeniedException

  • PrometheusService.Client.exceptions.InternalServerException