import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeGlobalClustersMessage, GlobalClustersMessage } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeGlobalClustersCommand}. */ export interface DescribeGlobalClustersCommandInput extends DescribeGlobalClustersMessage { } /** * @public * * The output of {@link DescribeGlobalClustersCommand}. */ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessage, __MetadataBearer { } declare const DescribeGlobalClustersCommand_base: { new (input: DescribeGlobalClustersCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeGlobalClustersCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

* *

This action only applies to Amazon DocumentDB clusters.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DocDBClient, DescribeGlobalClustersCommand } from "@aws-sdk/client-docdb"; // ES Modules import * // const { DocDBClient, DescribeGlobalClustersCommand } = require("@aws-sdk/client-docdb"); // CommonJS import * // import type { DocDBClientConfig } from "@aws-sdk/client-docdb"; * const config = {}; // type is DocDBClientConfig * const client = new DocDBClient(config); * const input = { // DescribeGlobalClustersMessage * GlobalClusterIdentifier: "STRING_VALUE", * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", // required * Values: [ // FilterValueList // required * "STRING_VALUE", * ], * }, * ], * MaxRecords: Number("int"), * Marker: "STRING_VALUE", * }; * const command = new DescribeGlobalClustersCommand(input); * const response = await client.send(command); * // { // GlobalClustersMessage * // Marker: "STRING_VALUE", * // GlobalClusters: [ // GlobalClusterList * // { // GlobalCluster * // GlobalClusterIdentifier: "STRING_VALUE", * // GlobalClusterResourceId: "STRING_VALUE", * // GlobalClusterArn: "STRING_VALUE", * // Status: "STRING_VALUE", * // Engine: "STRING_VALUE", * // EngineVersion: "STRING_VALUE", * // DatabaseName: "STRING_VALUE", * // StorageEncrypted: true || false, * // DeletionProtection: true || false, * // GlobalClusterMembers: [ // GlobalClusterMemberList * // { // GlobalClusterMember * // DBClusterArn: "STRING_VALUE", * // Readers: [ // ReadersArnList * // "STRING_VALUE", * // ], * // IsWriter: true || false, * // SynchronizationStatus: "connected" || "pending-resync", * // }, * // ], * // FailoverState: { // FailoverState * // Status: "pending" || "failing-over" || "cancelling", * // FromDbClusterArn: "STRING_VALUE", * // ToDbClusterArn: "STRING_VALUE", * // IsDataLossAllowed: true || false, * // }, * // TagList: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // }, * // ], * // }; * * ``` * * @param DescribeGlobalClustersCommandInput - {@link DescribeGlobalClustersCommandInput} * @returns {@link DescribeGlobalClustersCommandOutput} * @see {@link DescribeGlobalClustersCommandInput} for command's `input` shape. * @see {@link DescribeGlobalClustersCommandOutput} for command's `response` shape. * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape. * * @throws {@link GlobalClusterNotFoundFault} (client fault) *

The GlobalClusterIdentifier doesn't refer to an existing global cluster.

* * @throws {@link DocDBServiceException} *

Base exception class for all service exceptions from DocDB service.

* * * @public */ export declare class DescribeGlobalClustersCommand extends DescribeGlobalClustersCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeGlobalClustersMessage; output: GlobalClustersMessage; }; sdk: { input: DescribeGlobalClustersCommandInput; output: DescribeGlobalClustersCommandOutput; }; }; }