PrometheusService / Client / describe_workspace

describe_workspace#

PrometheusService.Client.describe_workspace(**kwargs)#

Returns information about an existing workspace.

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': {
        'alias': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'kmsKeyArn': 'string',
        'prometheusEndpoint': 'string',
        'status': {
            'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
        },
        '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 does not need to be unique.
  - arn (string) –
    
    The ARN of the workspace. For example, arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.
  - 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. For example, https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/.
  - 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. Must not begin with aws:.
      - (string) –
        
        The value of the tag.
  - workspaceId (string) –
    
    The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.

Exceptions

PrometheusService.Client.exceptions.ThrottlingException
PrometheusService.Client.exceptions.ValidationException
PrometheusService.Client.exceptions.ResourceNotFoundException
PrometheusService.Client.exceptions.AccessDeniedException
PrometheusService.Client.exceptions.InternalServerException