:doc:`PrometheusService <../../amp>` / Client / describe_rule_groups_namespace

******************************
describe_rule_groups_namespace
******************************



.. py:method:: PrometheusService.Client.describe_rule_groups_namespace(**kwargs)

  

  Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ``ListRuleGroupsNamespaces``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeRuleGroupsNamespace>`_  


  **Request Syntax**
  ::

    response = client.describe_rule_groups_namespace(
        workspaceId='string',
        name='string'
    )
    
  :type workspaceId: string
  :param workspaceId: **[REQUIRED]** 

    The ID of the workspace containing the rule groups namespace.

    

  
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the rule groups namespace that you want information for.

    

  
  
  :rtype: 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 information about the rule groups namespace.

        
        

        - **arn** *(string) --* 

          The ARN of the rule groups namespace. For example, ``arn:aws:aps:<region>:123456789012:rulegroupsnamespace/ws-example1-1234-abcd-5678-ef90abcd1234/rulesfile1``.

          
        

        - **name** *(string) --* 

          The name of the rule groups namespace.

          
        

        - **status** *(dict) --* 

          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.

            
      
        

        - **data** *(bytes) --* 

          The rule groups file used in the namespace.

           

          For details about the rule groups namespace structure, see `RuleGroupsNamespaceData <https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html>`__.

          
        

        - **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.

          
        

        - **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**
  
  *   :py:class:`PrometheusService.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PrometheusService.Client.exceptions.ValidationException`

  
  *   :py:class:`PrometheusService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`PrometheusService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`PrometheusService.Client.exceptions.InternalServerException`

  