Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeWorkspace

Returns information about an existing workspace.

Request Syntax


GET /workspaces/workspaceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

workspaceId

The ID of the workspace to describe.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9A-Za-z][-.0-9A-Z_a-z]*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "workspace": { 
      "alias": "string",
      "arn": "string",
      "createdAt": number,
      "kmsKeyArn": "string",
      "prometheusEndpoint": "string",
      "status": { 
         "statusCode": "string"
      },
      "tags": { 
         "string" : "string" 
      },
      "workspaceId": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

workspace

A structure that contains details about the workspace.

Type: WorkspaceDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred during the processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resources that doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400