Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class DescribeRuleGroupsNamespaceCommandProtected

Describe a rule groups namespace.

Example

Use a bare-bones client and the command you need to make an API call.

import { AmpClient, DescribeRuleGroupsNamespaceCommand } from "@aws-sdk/client-amp"; // ES Modules import
// const { AmpClient, DescribeRuleGroupsNamespaceCommand } = require("@aws-sdk/client-amp"); // CommonJS import
const client = new AmpClient(config);
const input = { // DescribeRuleGroupsNamespaceRequest
workspaceId: "STRING_VALUE", // required
name: "STRING_VALUE", // required
};
const command = new DescribeRuleGroupsNamespaceCommand(input);
const response = await client.send(command);
// { // DescribeRuleGroupsNamespaceResponse
// ruleGroupsNamespace: { // RuleGroupsNamespaceDescription
// arn: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// status: { // RuleGroupsNamespaceStatus
// statusCode: "STRING_VALUE", // required
// statusReason: "STRING_VALUE",
// },
// data: "BLOB_VALUE", // required
// createdAt: new Date("TIMESTAMP"), // required
// modifiedAt: new Date("TIMESTAMP"), // required
// tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// },
// };

Param

DescribeRuleGroupsNamespaceCommandInput

Returns

DescribeRuleGroupsNamespaceCommandOutput

See

Throws

AccessDeniedException (client fault) User does not have sufficient access to perform this action.

Throws

InternalServerException (server fault) Unexpected error during processing of request.

Throws

ResourceNotFoundException (client fault) Request references a resource which does not exist.

Throws

ThrottlingException (client fault) Request was denied due to request throttling.

Throws

ValidationException (client fault) The input fails to satisfy the constraints specified by an AWS service.

Throws

AmpServiceException

Base exception class for all service exceptions from Amp service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods