import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DAXClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DAXClient"; import type { DescribeClustersRequest, DescribeClustersResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeClustersCommand}. */ export interface DescribeClustersCommandInput extends DescribeClustersRequest { } /** * @public * * The output of {@link DescribeClustersCommand}. */ export interface DescribeClustersCommandOutput extends DescribeClustersResponse, __MetadataBearer { } declare const DescribeClustersCommand_base: { new (input: DescribeClustersCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeClustersCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Returns information about all provisioned DAX clusters if no cluster identifier is * specified, or about a specific DAX cluster if a cluster identifier is * supplied.

*

If the cluster is in the CREATING state, only cluster level information will be * displayed until all of the nodes are successfully provisioned.

*

If the cluster is in the DELETING state, only cluster level information will be * displayed.

*

If nodes are currently being added to the DAX cluster, node endpoint information * and creation time for the additional nodes will not be displayed until they are * completely provisioned. When the DAX cluster state is * available, the cluster is ready for use.

*

If nodes are currently being removed from the DAX cluster, no * endpoint information for the removed nodes is displayed.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DAXClient, DescribeClustersCommand } from "@aws-sdk/client-dax"; // ES Modules import * // const { DAXClient, DescribeClustersCommand } = require("@aws-sdk/client-dax"); // CommonJS import * // import type { DAXClientConfig } from "@aws-sdk/client-dax"; * const config = {}; // type is DAXClientConfig * const client = new DAXClient(config); * const input = { // DescribeClustersRequest * ClusterNames: [ // ClusterNameList * "STRING_VALUE", * ], * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * }; * const command = new DescribeClustersCommand(input); * const response = await client.send(command); * // { // DescribeClustersResponse * // NextToken: "STRING_VALUE", * // Clusters: [ // ClusterList * // { // Cluster * // ClusterName: "STRING_VALUE", * // Description: "STRING_VALUE", * // ClusterArn: "STRING_VALUE", * // TotalNodes: Number("int"), * // ActiveNodes: Number("int"), * // NodeType: "STRING_VALUE", * // Status: "STRING_VALUE", * // ClusterDiscoveryEndpoint: { // Endpoint * // Address: "STRING_VALUE", * // Port: Number("int"), * // URL: "STRING_VALUE", * // }, * // NodeIdsToRemove: [ // NodeIdentifierList * // "STRING_VALUE", * // ], * // Nodes: [ // NodeList * // { // Node * // NodeId: "STRING_VALUE", * // Endpoint: { * // Address: "STRING_VALUE", * // Port: Number("int"), * // URL: "STRING_VALUE", * // }, * // NodeCreateTime: new Date("TIMESTAMP"), * // AvailabilityZone: "STRING_VALUE", * // NodeStatus: "STRING_VALUE", * // ParameterGroupStatus: "STRING_VALUE", * // }, * // ], * // PreferredMaintenanceWindow: "STRING_VALUE", * // NotificationConfiguration: { // NotificationConfiguration * // TopicArn: "STRING_VALUE", * // TopicStatus: "STRING_VALUE", * // }, * // SubnetGroup: "STRING_VALUE", * // SecurityGroups: [ // SecurityGroupMembershipList * // { // SecurityGroupMembership * // SecurityGroupIdentifier: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // IamRoleArn: "STRING_VALUE", * // ParameterGroup: { // ParameterGroupStatus * // ParameterGroupName: "STRING_VALUE", * // ParameterApplyStatus: "STRING_VALUE", * // NodeIdsToReboot: [ * // "STRING_VALUE", * // ], * // }, * // SSEDescription: { // SSEDescription * // Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED", * // }, * // ClusterEndpointEncryptionType: "NONE" || "TLS", * // NetworkType: "ipv4" || "ipv6" || "dual_stack", * // }, * // ], * // }; * * ``` * * @param DescribeClustersCommandInput - {@link DescribeClustersCommandInput} * @returns {@link DescribeClustersCommandOutput} * @see {@link DescribeClustersCommandInput} for command's `input` shape. * @see {@link DescribeClustersCommandOutput} for command's `response` shape. * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape. * * @throws {@link ClusterNotFoundFault} (client fault) *

The requested cluster ID does not refer to an existing DAX * cluster.

* * @throws {@link InvalidParameterCombinationException} (client fault) *

Two or more incompatible parameters were specified.

* * @throws {@link InvalidParameterValueException} (client fault) *

The value for a parameter is invalid.

* * @throws {@link ServiceLinkedRoleNotFoundFault} (client fault) *

The specified service linked role (SLR) was not found.

* * @throws {@link DAXServiceException} *

Base exception class for all service exceptions from DAX service.

* * * @public */ export declare class DescribeClustersCommand extends DescribeClustersCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeClustersRequest; output: DescribeClustersResponse; }; sdk: { input: DescribeClustersCommandInput; output: DescribeClustersCommandOutput; }; }; }