DescribeRuleGroupsNamespace - Amazon Managed Service for Prometheus

DescribeRuleGroupsNamespace

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

Request Syntax

GET /workspaces/workspaceId/rulegroupsnamespaces/name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

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

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9A-Za-z][-.0-9A-Z_a-z]*

Required: Yes

workspaceId

The ID of the workspace containing the rule groups namespace.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9A-Za-z][-.0-9A-Z_a-z]*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ruleGroupsNamespace": { "arn": "string", "createdAt": number, "data": blob, "modifiedAt": number, "name": "string", "status": { "statusCode": "string", "statusReason": "string" }, "tags": { "string" : "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ruleGroupsNamespace

The information about the rule groups namespace.

Type: RuleGroupsNamespaceDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred during the processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resources that doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: