@aws-sdk/client-dynamodb
Version:
AWS SDK for JavaScript Dynamodb Client for Node.js, Browser and React Native
79 lines (78 loc) • 3.51 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
import type { DescribeEndpointsRequest, DescribeEndpointsResponse } from "../models/models_0";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link DescribeEndpointsCommand}.
*/
export interface DescribeEndpointsCommandInput extends DescribeEndpointsRequest {
}
/**
* @public
*
* The output of {@link DescribeEndpointsCommand}.
*/
export interface DescribeEndpointsCommandOutput extends DescribeEndpointsResponse, __MetadataBearer {
}
declare const DescribeEndpointsCommand_base: {
new (input: DescribeEndpointsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (...[input]: [] | [DescribeEndpointsCommandInput]): import("@smithy/smithy-client").CommandImpl<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Returns the regional endpoint information. For more information on policy permissions,
* please see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints">Internetwork traffic privacy</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { DynamoDBClient, DescribeEndpointsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
* // const { DynamoDBClient, DescribeEndpointsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
* // import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb";
* const config = {}; // type is DynamoDBClientConfig
* const client = new DynamoDBClient(config);
* const input = {};
* const command = new DescribeEndpointsCommand(input);
* const response = await client.send(command);
* // { // DescribeEndpointsResponse
* // Endpoints: [ // Endpoints // required
* // { // Endpoint
* // Address: "STRING_VALUE", // required
* // CachePeriodInMinutes: Number("long"), // required
* // },
* // ],
* // };
*
* ```
*
* @param DescribeEndpointsCommandInput - {@link DescribeEndpointsCommandInput}
* @returns {@link DescribeEndpointsCommandOutput}
* @see {@link DescribeEndpointsCommandInput} for command's `input` shape.
* @see {@link DescribeEndpointsCommandOutput} for command's `response` shape.
* @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
*
* @throws {@link DynamoDBServiceException}
* <p>Base exception class for all service exceptions from DynamoDB service.</p>
*
*
* @public
*/
export declare class DescribeEndpointsCommand extends DescribeEndpointsCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: {};
output: DescribeEndpointsResponse;
};
sdk: {
input: DescribeEndpointsCommandInput;
output: DescribeEndpointsCommandOutput;
};
};
}