PrometheusService / Client / create_rule_groups_namespace

create_rule_groups_namespace#

PrometheusService.Client.create_rule_groups_namespace(**kwargs)#

The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.

Request Syntax

response = client.create_rule_groups_namespace(
    clientToken='string',
    data=b'bytes',
    name='string',
    tags={
        'string': '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.
data (bytes) –
[REQUIRED]

The rules file to use in the new namespace.

Contains the base64-encoded version of the YAML rules file.

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
name (string) –
[REQUIRED]

The name for the new rule groups namespace.
tags (dict) –
The list of tag keys and values to associate with the rule groups namespace.
- (string) –
  
  The key of the tag. May not begin with aws:.
  - (string) –
    
    The value of the tag.
workspaceId (string) –
[REQUIRED]

The ID of the workspace to add the rule groups namespace.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

Represents the output of a CreateRuleGroupsNamespace operation.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the new rule groups namespace.
- name (string) –
  
  The name of the new rule groups namespace.
- status (dict) –
  
  A structure that returns the current status of the rule groups namespace.
  - statusCode (string) –
    
    The current status of the namespace.
  - statusReason (string) –
    
    The reason for the failure, if any.
- tags (dict) –
  
  The list of tag keys and values that are associated with the namespace.
  - (string) –
    
    The key of the tag. May not begin with aws:.
    - (string) –
      
      The value of the tag.

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
PrometheusService.Client.exceptions.ServiceQuotaExceededException