list_rule_groups_namespaces

PrometheusService.Client.list_rule_groups_namespaces(**kwargs)

Lists rule groups namespaces.

See also: AWS API Documentation

Request Syntax

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

Parameters

• maxResults (integer) -- Maximum results to return in response (default=100, maximum=1000).
• name (string) -- Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.
• nextToken (string) -- Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.
• workspaceId (string) --

  [REQUIRED]

  The ID of the workspace.

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

    Pagination token to use when requesting the next page in this list.

  • ruleGroupsNamespaces (list) --

    The list of the selected rule groups namespaces.

    • (dict) --

      Represents a summary of the 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.

      • 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