@aws-sdk/client-redshift
TypeScript icon, indicating that this package has built-in type declarations

3.521.0 • Public • Published

@aws-sdk/client-redshift

Description

AWS SDK for JavaScript Redshift Client for Node.js, Browser and React Native.

Amazon Redshift

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.

Installing

To install the this package, simply type add or install @aws-sdk/client-redshift using your favorite package manager:

  • npm install @aws-sdk/client-redshift
  • yarn add @aws-sdk/client-redshift
  • pnpm add @aws-sdk/client-redshift

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the RedshiftClient and the commands you need, for example ListRecommendationsCommand:

// ES5 example
const { RedshiftClient, ListRecommendationsCommand } = require("@aws-sdk/client-redshift");
// ES6+ example
import { RedshiftClient, ListRecommendationsCommand } from "@aws-sdk/client-redshift";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new RedshiftClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListRecommendationsCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-redshift";
const client = new AWS.Redshift({ region: "REGION" });

// async/await.
try {
  const data = await client.listRecommendations(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listRecommendations(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listRecommendations(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-redshift package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

AcceptReservedNodeExchange

Command API Reference / Input / Output

AddPartner

Command API Reference / Input / Output

AssociateDataShareConsumer

Command API Reference / Input / Output

AuthorizeClusterSecurityGroupIngress

Command API Reference / Input / Output

AuthorizeDataShare

Command API Reference / Input / Output

AuthorizeEndpointAccess

Command API Reference / Input / Output

AuthorizeSnapshotAccess

Command API Reference / Input / Output

BatchDeleteClusterSnapshots

Command API Reference / Input / Output

BatchModifyClusterSnapshots

Command API Reference / Input / Output

CancelResize

Command API Reference / Input / Output

CopyClusterSnapshot

Command API Reference / Input / Output

CreateAuthenticationProfile

Command API Reference / Input / Output

CreateCluster

Command API Reference / Input / Output

CreateClusterParameterGroup

Command API Reference / Input / Output

CreateClusterSecurityGroup

Command API Reference / Input / Output

CreateClusterSnapshot

Command API Reference / Input / Output

CreateClusterSubnetGroup

Command API Reference / Input / Output

CreateCustomDomainAssociation

Command API Reference / Input / Output

CreateEndpointAccess

Command API Reference / Input / Output

CreateEventSubscription

Command API Reference / Input / Output

CreateHsmClientCertificate

Command API Reference / Input / Output

CreateHsmConfiguration

Command API Reference / Input / Output

CreateRedshiftIdcApplication

Command API Reference / Input / Output

CreateScheduledAction

Command API Reference / Input / Output

CreateSnapshotCopyGrant

Command API Reference / Input / Output

CreateSnapshotSchedule

Command API Reference / Input / Output

CreateTags

Command API Reference / Input / Output

CreateUsageLimit

Command API Reference / Input / Output

DeauthorizeDataShare

Command API Reference / Input / Output

DeleteAuthenticationProfile

Command API Reference / Input / Output

DeleteCluster

Command API Reference / Input / Output

DeleteClusterParameterGroup

Command API Reference / Input / Output

DeleteClusterSecurityGroup

Command API Reference / Input / Output

DeleteClusterSnapshot

Command API Reference / Input / Output

DeleteClusterSubnetGroup

Command API Reference / Input / Output

DeleteCustomDomainAssociation

Command API Reference / Input / Output

DeleteEndpointAccess

Command API Reference / Input / Output

DeleteEventSubscription

Command API Reference / Input / Output

DeleteHsmClientCertificate

Command API Reference / Input / Output

DeleteHsmConfiguration

Command API Reference / Input / Output

DeletePartner

Command API Reference / Input / Output

DeleteRedshiftIdcApplication

Command API Reference / Input / Output

DeleteResourcePolicy

Command API Reference / Input / Output

DeleteScheduledAction

Command API Reference / Input / Output

DeleteSnapshotCopyGrant

Command API Reference / Input / Output

DeleteSnapshotSchedule

Command API Reference / Input / Output

DeleteTags

Command API Reference / Input / Output

DeleteUsageLimit

Command API Reference / Input / Output

DescribeAccountAttributes

Command API Reference / Input / Output

DescribeAuthenticationProfiles

Command API Reference / Input / Output

DescribeClusterDbRevisions

Command API Reference / Input / Output

DescribeClusterParameterGroups

Command API Reference / Input / Output

DescribeClusterParameters

Command API Reference / Input / Output

DescribeClusters

Command API Reference / Input / Output

DescribeClusterSecurityGroups

Command API Reference / Input / Output

DescribeClusterSnapshots

Command API Reference / Input / Output

DescribeClusterSubnetGroups

Command API Reference / Input / Output

DescribeClusterTracks

Command API Reference / Input / Output

DescribeClusterVersions

Command API Reference / Input / Output

DescribeCustomDomainAssociations

Command API Reference / Input / Output

DescribeDataShares

Command API Reference / Input / Output

DescribeDataSharesForConsumer

Command API Reference / Input / Output

DescribeDataSharesForProducer

Command API Reference / Input / Output

DescribeDefaultClusterParameters

Command API Reference / Input / Output

DescribeEndpointAccess

Command API Reference / Input / Output

DescribeEndpointAuthorization

Command API Reference / Input / Output

DescribeEventCategories

Command API Reference / Input / Output

DescribeEvents

Command API Reference / Input / Output

DescribeEventSubscriptions

Command API Reference / Input / Output

DescribeHsmClientCertificates

Command API Reference / Input / Output

DescribeHsmConfigurations

Command API Reference / Input / Output

DescribeInboundIntegrations

Command API Reference / Input / Output

DescribeLoggingStatus

Command API Reference / Input / Output

DescribeNodeConfigurationOptions

Command API Reference / Input / Output

DescribeOrderableClusterOptions

Command API Reference / Input / Output

DescribePartners

Command API Reference / Input / Output

DescribeRedshiftIdcApplications

Command API Reference / Input / Output

DescribeReservedNodeExchangeStatus

Command API Reference / Input / Output

DescribeReservedNodeOfferings

Command API Reference / Input / Output

DescribeReservedNodes

Command API Reference / Input / Output

DescribeResize

Command API Reference / Input / Output

DescribeScheduledActions

Command API Reference / Input / Output

DescribeSnapshotCopyGrants

Command API Reference / Input / Output

DescribeSnapshotSchedules

Command API Reference / Input / Output

DescribeStorage

Command API Reference / Input / Output

DescribeTableRestoreStatus

Command API Reference / Input / Output

DescribeTags

Command API Reference / Input / Output

DescribeUsageLimits

Command API Reference / Input / Output

DisableLogging

Command API Reference / Input / Output

DisableSnapshotCopy

Command API Reference / Input / Output

DisassociateDataShareConsumer

Command API Reference / Input / Output

EnableLogging

Command API Reference / Input / Output

EnableSnapshotCopy

Command API Reference / Input / Output

FailoverPrimaryCompute

Command API Reference / Input / Output

GetClusterCredentials

Command API Reference / Input / Output

GetClusterCredentialsWithIAM

Command API Reference / Input / Output

GetReservedNodeExchangeConfigurationOptions

Command API Reference / Input / Output

GetReservedNodeExchangeOfferings

Command API Reference / Input / Output

GetResourcePolicy

Command API Reference / Input / Output

ListRecommendations

Command API Reference / Input / Output

ModifyAquaConfiguration

Command API Reference / Input / Output

ModifyAuthenticationProfile

Command API Reference / Input / Output

ModifyCluster

Command API Reference / Input / Output

ModifyClusterDbRevision

Command API Reference / Input / Output

ModifyClusterIamRoles

Command API Reference / Input / Output

ModifyClusterMaintenance

Command API Reference / Input / Output

ModifyClusterParameterGroup

Command API Reference / Input / Output

ModifyClusterSnapshot

Command API Reference / Input / Output

ModifyClusterSnapshotSchedule

Command API Reference / Input / Output

ModifyClusterSubnetGroup

Command API Reference / Input / Output

ModifyCustomDomainAssociation

Command API Reference / Input / Output

ModifyEndpointAccess

Command API Reference / Input / Output

ModifyEventSubscription

Command API Reference / Input / Output

ModifyRedshiftIdcApplication

Command API Reference / Input / Output

ModifyScheduledAction

Command API Reference / Input / Output

ModifySnapshotCopyRetentionPeriod

Command API Reference / Input / Output

ModifySnapshotSchedule

Command API Reference / Input / Output

ModifyUsageLimit

Command API Reference / Input / Output

PauseCluster

Command API Reference / Input / Output

PurchaseReservedNodeOffering

Command API Reference / Input / Output

PutResourcePolicy

Command API Reference / Input / Output

RebootCluster

Command API Reference / Input / Output

RejectDataShare

Command API Reference / Input / Output

ResetClusterParameterGroup

Command API Reference / Input / Output

ResizeCluster

Command API Reference / Input / Output

RestoreFromClusterSnapshot

Command API Reference / Input / Output

RestoreTableFromClusterSnapshot

Command API Reference / Input / Output

ResumeCluster

Command API Reference / Input / Output

RevokeClusterSecurityGroupIngress

Command API Reference / Input / Output

RevokeEndpointAccess

Command API Reference / Input / Output

RevokeSnapshotAccess

Command API Reference / Input / Output

RotateEncryptionKey

Command API Reference / Input / Output

UpdatePartnerStatus

Command API Reference / Input / Output

Readme

Keywords

none

Package Sidebar

Install

npm i @aws-sdk/client-redshift

Weekly Downloads

144,580

Version

3.521.0

License

Apache-2.0

Unpacked Size

3.43 MB

Total Files

787

Last publish

Collaborators

  • mattsb42-aws
  • kuhe
  • amzn-oss
  • aws-sdk-bot
  • trivikr-aws