- Navigation GuideYou are on a type information page within a Client package. Return to the Client landing page
@aws-sdk/client-redshift
RedshiftClient Class
Overview
This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces .
Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.
If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide .
If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.
Members
Name | Type | Details |
|---|---|---|
(constructor) Required | constructor(...[configuration]: CheckOptionalClientConfig<RedshiftClientConfig>) | Constructs a new instance of the RedshiftClient class |
config Required | RedshiftClientResolvedConfig | The resolved configuration of RedshiftClient class. This is resolved and normalized from the constructor configuration interface. |
destroy Required | destroy(): void | Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them. |
middlewareStack Required | MiddlewareStack<ClientInput, ClientOutput> | |
send Required | send<InputType extends ClientInput, OutputType extends ClientOutput>(command: Command<ClientInput, InputType, ClientOutput, OutputType, SmithyResolvedConfiguration<HandlerOptions>, options?: HandlerOptions): Promise<OutputType> | |
send Required | send<InputType extends ClientInput, OutputType extends ClientOutput>(command: Command<ClientInput, InputType, ClientOutput, OutputType, SmithyResolvedConfiguration<HandlerOptions>, cb: (err: any, data?: OutputType) = void): void | |
send Required | send<InputType extends ClientInput, OutputType extends ClientOutput>(command: Command<ClientInput, InputType, ClientOutput, OutputType, SmithyResolvedConfiguration<HandlerOptions>, options: HandlerOptions, cb: (err: any, data?: OutputType) = void): void |
Full Signature
export declare class RedshiftClient extends Client<HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, RedshiftClientResolvedConfig>