PrometheusService / Client / create_workspace

create_workspace#

PrometheusService.Client.create_workspace(**kwargs)#

Creates a new AMP workspace.

Request Syntax

response = client.create_workspace(
    alias='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)

Parameters:

alias (string) – An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.
clientToken (string) –
Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

This field is autopopulated if not provided.
tags (dict) –
Optional, user-provided tags for 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: _ . : / = + - @

Return type:

dict

Returns:

Response Syntax

{
    'workspaceId': 'string',
    'arn': 'string',
    'status': {
        'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –

Represents the output of a CreateWorkspace operation.
- workspaceId (string) –
  
  The generated ID of the workspace that was just created.
- arn (string) –
  
  The ARN of the workspace that was just created.
- status (dict) –
  
  The status of the workspace that was just created (usually CREATING).
  - statusCode (string) –
    
    Status code of this workspace.
- 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.ConflictException
PrometheusService.Client.exceptions.ValidationException
PrometheusService.Client.exceptions.AccessDeniedException
PrometheusService.Client.exceptions.InternalServerException
PrometheusService.Client.exceptions.ServiceQuotaExceededException