PrometheusService / Client / delete_workspace

delete_workspace#

PrometheusService.Client.delete_workspace(**kwargs)#

Deletes an existing workspace.

Note

When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.

See also: AWS API Documentation

Request Syntax

response = client.delete_workspace(
    clientToken='string',
    workspaceId='string'
)
Parameters:

  • clientToken (string) –

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

    This field is autopopulated if not provided.

  • workspaceId (string) –

    [REQUIRED]

    The ID of the workspace to delete.

Returns:

None

Exceptions

  • PrometheusService.Client.exceptions.ThrottlingException

  • PrometheusService.Client.exceptions.ConflictException

  • PrometheusService.Client.exceptions.ValidationException

  • PrometheusService.Client.exceptions.ResourceNotFoundException

  • PrometheusService.Client.exceptions.AccessDeniedException

  • PrometheusService.Client.exceptions.InternalServerException