PrometheusService / Client / list_rule_groups_namespaces

list_rule_groups_namespaces#

PrometheusService.Client.list_rule_groups_namespaces(**kwargs)#

Returns a list of rule groups namespaces in a workspace.

Request Syntax

response = client.list_rule_groups_namespaces(
    maxResults=123,
    name='string',
    nextToken='string',
    workspaceId='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return. The default is 100.
name (string) – Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned.
nextToken (string) –
The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

For example, if your initial request has maxResults of 10, and there are 12 rule groups namespaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 namespaces.
workspaceId (string) –
[REQUIRED]

The ID of the workspace containing the rule groups namespaces.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'ruleGroupsNamespaces': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1),
            '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 ListRuleGroupsNamespaces operation.
- nextToken (string) –
  
  A token indicating that there are more results to retrieve. You can use this token as part of your next ListRuleGroupsNamespaces request to retrieve those results.
- ruleGroupsNamespaces (list) –
  
  The returned list of rule groups namespaces.
  - (dict) –
    
    The high-level information about a rule groups namespace. To retrieve more information, use DescribeRuleGroupsNamespace.
    - arn (string) –
      
      The ARN of the rule groups namespace.
    - createdAt (datetime) –
      
      The date and time that the rule groups namespace was created.
    - modifiedAt (datetime) –
      
      The date and time that the rule groups namespace was most recently changed.
    - name (string) –
      
      The name of the rule groups namespace.
    - status (dict) –
      
      A structure that displays 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 rule groups 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.ValidationException
PrometheusService.Client.exceptions.ResourceNotFoundException
PrometheusService.Client.exceptions.AccessDeniedException
PrometheusService.Client.exceptions.InternalServerException