PrometheusService / Client / describe_rule_groups_namespace

describe_rule_groups_namespace#

PrometheusService.Client.describe_rule_groups_namespace(**kwargs)#

Describe a rule groups namespace.

Request Syntax

response = client.describe_rule_groups_namespace(
    workspaceId='string',
    name='string'
)

Parameters:

workspaceId (string) –
[REQUIRED]

The ID of the workspace to describe.
name (string) –
[REQUIRED]

The rule groups namespace.

Return type:

dict

Returns:

Response Syntax

{
    'ruleGroupsNamespace': {
        'arn': 'string',
        'name': 'string',
        'status': {
            'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
            'statusReason': 'string'
        },
        'data': b'bytes',
        'createdAt': datetime(2015, 1, 1),
        'modifiedAt': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) –

Represents the output of a DescribeRuleGroupsNamespace operation.
- ruleGroupsNamespace (dict) –
  
  The selected rule groups namespace.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of this rule groups namespace.
  - name (string) –
    
    The rule groups namespace name.
  - status (dict) –
    
    The status of rule groups namespace.
    - statusCode (string) –
      
      Status code of this namespace.
    - statusReason (string) –
      
      The reason for failure if any.
  - data (bytes) –
    
    The rule groups namespace data.
  - createdAt (datetime) –
    
    The time when the rule groups namespace was created.
  - modifiedAt (datetime) –
    
    The time when the rule groups namespace was modified.
  - tags (dict) –
    
    The tags of this rule groups namespace.
    - (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.ValidationException
PrometheusService.Client.exceptions.ResourceNotFoundException
PrometheusService.Client.exceptions.AccessDeniedException
PrometheusService.Client.exceptions.InternalServerException