PrometheusService / Client / put_rule_groups_namespace

put_rule_groups_namespace#

PrometheusService.Client.put_rule_groups_namespace(**kwargs)#

Updates an existing 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 update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace.

You can’t use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.

Request Syntax

response = client.put_rule_groups_namespace(
    clientToken='string',
    data=b'bytes',
    name='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 new rules file to use in the namespace. A base64-encoded version of the YAML rule groups file.

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

The name of the rule groups namespace that you are updating.
workspaceId (string) –
[REQUIRED]

The ID of the workspace where you are updating 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 PutRuleGroupsNamespace operation.
- arn (string) –
  
  The ARN of the rule groups namespace.
- name (string) –
  
  The name of the rule groups namespace that was updated.
- status (dict) –
  
  A structure that includes 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. Must 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