PrometheusService / Client / describe_rule_groups_namespace

describe_rule_groups_namespace#

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

Request Syntax

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

  • name (string) –

    [REQUIRED]

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

  • workspaceId (string) –

    [REQUIRED]

    The ID of the workspace containing the rule groups namespace.

Return type:

dict

Returns:

Response Syntax

{
    'ruleGroupsNamespace': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'data': b'bytes',
        '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 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.

      • createdAt (datetime) –

        The date and time that the rule groups namespace was created.

      • data (bytes) –

        The rule groups file used in the namespace.

        For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

      • 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) –

        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