describe_rule_groups_namespace

PrometheusService.Client.describe_rule_groups_namespace(**kwargs)

Describe a rule groups namespace.

See also: AWS API Documentation

Request Syntax

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

Parameters

• name (string) --

  [REQUIRED]

  The rule groups namespace.

• workspaceId (string) --

  [REQUIRED]

  The ID of the workspace to describe.

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 selected rule groups namespace.

    • arn (string) --

      The Amazon Resource Name (ARN) of this rule groups namespace.

    • createdAt (datetime) --

      The time when the rule groups namespace was created.

    • data (bytes) --

      The rule groups namespace data.

    • modifiedAt (datetime) --

      The time when the rule groups namespace was modified.

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

    • 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