PrometheusService / Client / describe_workspace

describe_workspace#

PrometheusService.Client.describe_workspace(**kwargs)#

Describes an existing AMP workspace.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspace(
    workspaceId='string'
)
Parameters:

workspaceId (string) –

[REQUIRED]

The ID of the workspace to describe.

Return type:

dict

Returns:

Response Syntax

{
    'workspace': {
        'workspaceId': 'string',
        'alias': 'string',
        'arn': 'string',
        'status': {
            'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
        },
        'prometheusEndpoint': 'string',
        'createdAt': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    Represents the output of a DescribeWorkspace operation.

    • workspace (dict) –

      The properties of the selected workspace.

      • workspaceId (string) –

        Unique string identifying this workspace.

      • alias (string) –

        Alias of this workspace.

      • arn (string) –

        The Amazon Resource Name (ARN) of this workspace.

      • status (dict) –

        The status of this workspace.

        • statusCode (string) –

          Status code of this workspace.

      • prometheusEndpoint (string) –

        Prometheus endpoint URI.

      • createdAt (datetime) –

        The time when the workspace was created.

      • tags (dict) –

        The tags of this workspace.

        • (string) –

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with aws:.

          • (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @

Exceptions

  • PrometheusService.Client.exceptions.ThrottlingException

  • PrometheusService.Client.exceptions.ValidationException

  • PrometheusService.Client.exceptions.ResourceNotFoundException

  • PrometheusService.Client.exceptions.AccessDeniedException

  • PrometheusService.Client.exceptions.InternalServerException