Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-redshift

Description

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.

Installation

NPM

npm install @aws-sdk/client-redshift

Yarn

yarn add @aws-sdk/client-redshift

pnpm

pnpm add @aws-sdk/client-redshift

Types

Type Name	Type
AcceptReservedNodeExchangeCommand	Class
AcceptReservedNodeExchangeCommandInput	Interface
AcceptReservedNodeExchangeCommandOutput	Interface
AcceptReservedNodeExchangeInputMessage	Interface
AcceptReservedNodeExchangeOutputMessage	Interface
AccessToClusterDeniedFault	Class
AccessToSnapshotDeniedFault	Class
AccountAttribute	Interface
AccountAttributeList	Interface
AccountWithRestoreAccess	Interface
ActionType	TypeAlias
ActionTypeenum	Variable
AddPartnerCommand	Class
AddPartnerCommandInput	Interface
AddPartnerCommandOutput	Interface
AquaConfiguration	Interface
AquaConfigurationStatus	TypeAlias
AquaConfigurationStatusenum	Variable
AquaStatus	TypeAlias
AquaStatusenum	Variable
AssociateDataShareConsumerCommand	Class
AssociateDataShareConsumerCommandInput	Interface
AssociateDataShareConsumerCommandOutput	Interface
AssociateDataShareConsumerMessage	Interface
Association	Interface
AttributeValueTarget	Interface
AuthenticationProfile	Interface
AuthenticationProfileAlreadyExistsFault	Class
AuthenticationProfileNotFoundFault	Class
AuthenticationProfileQuotaExceededFault	Class
AuthorizationAlreadyExistsFault	Class
AuthorizationNotFoundFault	Class
AuthorizationQuotaExceededFault	Class
AuthorizationStatus	TypeAlias
AuthorizationStatusenum	Variable
AuthorizeClusterSecurityGroupIngressCommand	Class
AuthorizeClusterSecurityGroupIngressCommandInput	Interface
AuthorizeClusterSecurityGroupIngressCommandOutput	Interface
AuthorizeClusterSecurityGroupIngressMessage	Interface
AuthorizeClusterSecurityGroupIngressResult	Interface
AuthorizeDataShareCommand	Class
AuthorizeDataShareCommandInput	Interface
AuthorizeDataShareCommandOutput	Interface
AuthorizeDataShareMessage	Interface
AuthorizedTokenIssuer	Interface
AuthorizeEndpointAccessCommand	Class
AuthorizeEndpointAccessCommandInput	Interface
AuthorizeEndpointAccessCommandOutput	Interface
AuthorizeEndpointAccessMessage	Interface
AuthorizeSnapshotAccessCommand	Class
AuthorizeSnapshotAccessCommandInput	Interface
AuthorizeSnapshotAccessCommandOutput	Interface
AuthorizeSnapshotAccessMessage	Interface
AuthorizeSnapshotAccessResult	Interface
AvailabilityZone	Interface
BatchDeleteClusterSnapshotsCommand	Class
BatchDeleteClusterSnapshotsCommandInput	Interface
BatchDeleteClusterSnapshotsCommandOutput	Interface
BatchDeleteClusterSnapshotsRequest	Interface
BatchDeleteClusterSnapshotsResult	Interface
BatchDeleteRequestSizeExceededFault	Class
BatchModifyClusterSnapshotsCommand	Class
BatchModifyClusterSnapshotsCommandInput	Interface
BatchModifyClusterSnapshotsCommandOutput	Interface
BatchModifyClusterSnapshotsLimitExceededFault	Class
BatchModifyClusterSnapshotsMessage	Interface
BatchModifyClusterSnapshotsOutputMessage	Interface
BucketNotFoundFault	Class
CancelResizeCommand	Class
CancelResizeCommandInput	Interface
CancelResizeCommandOutput	Interface
CancelResizeMessage	Interface
CertificateAssociation	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
Cluster	Interface
ClusterAlreadyExistsFault	Class
ClusterAssociatedToSchedule	Interface
ClusterCredentials	Interface
ClusterDbRevision	Interface
ClusterDbRevisionsMessage	Interface
ClusterExtendedCredentials	Interface
ClusterIamRole	Interface
ClusterNode	Interface
ClusterNotFoundFault	Class
ClusterOnLatestRevisionFault	Class
ClusterParameterGroup	Interface
ClusterParameterGroupAlreadyExistsFault	Class
ClusterParameterGroupDetails	Interface
ClusterParameterGroupNameMessage	Interface
ClusterParameterGroupNotFoundFault	Class
ClusterParameterGroupQuotaExceededFault	Class
ClusterParameterGroupsMessage	Interface
ClusterParameterGroupStatus	Interface
ClusterParameterStatus	Interface
ClusterQuotaExceededFault	Class
ClusterSecurityGroup	Interface
ClusterSecurityGroupAlreadyExistsFault	Class
ClusterSecurityGroupMembership	Interface
ClusterSecurityGroupMessage	Interface
ClusterSecurityGroupNotFoundFault	Class
ClusterSecurityGroupQuotaExceededFault	Class
ClustersMessage	Interface
ClusterSnapshotAlreadyExistsFault	Class
ClusterSnapshotCopyStatus	Interface
ClusterSnapshotNotFoundFault	Class
ClusterSnapshotQuotaExceededFault	Class
ClusterSubnetGroup	Interface
ClusterSubnetGroupAlreadyExistsFault	Class
ClusterSubnetGroupMessage	Interface
ClusterSubnetGroupNotFoundFault	Class
ClusterSubnetGroupQuotaExceededFault	Class
ClusterSubnetQuotaExceededFault	Class
ClusterVersion	Interface
ClusterVersionsMessage	Interface
ConflictPolicyUpdateFault	Class
CopyClusterSnapshotCommand	Class
CopyClusterSnapshotCommandInput	Interface
CopyClusterSnapshotCommandOutput	Interface
CopyClusterSnapshotMessage	Interface
CopyClusterSnapshotResult	Interface
CopyToRegionDisabledFault	Class
CreateAuthenticationProfileCommand	Class
CreateAuthenticationProfileCommandInput	Interface
CreateAuthenticationProfileCommandOutput	Interface
CreateAuthenticationProfileMessage	Interface
CreateAuthenticationProfileResult	Interface
CreateClusterCommand	Class
CreateClusterCommandInput	Interface
CreateClusterCommandOutput	Interface
CreateClusterMessage	Interface
CreateClusterParameterGroupCommand	Class
CreateClusterParameterGroupCommandInput	Interface
CreateClusterParameterGroupCommandOutput	Interface
CreateClusterParameterGroupMessage	Interface
CreateClusterParameterGroupResult	Interface
CreateClusterResult	Interface
CreateClusterSecurityGroupCommand	Class
CreateClusterSecurityGroupCommandInput	Interface
CreateClusterSecurityGroupCommandOutput	Interface
CreateClusterSecurityGroupMessage	Interface
CreateClusterSecurityGroupResult	Interface
CreateClusterSnapshotCommand	Class
CreateClusterSnapshotCommandInput	Interface
CreateClusterSnapshotCommandOutput	Interface
CreateClusterSnapshotMessage	Interface
CreateClusterSnapshotResult	Interface
CreateClusterSubnetGroupCommand	Class
CreateClusterSubnetGroupCommandInput	Interface
CreateClusterSubnetGroupCommandOutput	Interface
CreateClusterSubnetGroupMessage	Interface
CreateClusterSubnetGroupResult	Interface
CreateCustomDomainAssociationCommand	Class
CreateCustomDomainAssociationCommandInput	Interface
CreateCustomDomainAssociationCommandOutput	Interface
CreateCustomDomainAssociationMessage	Interface
CreateCustomDomainAssociationResult	Interface
CreateEndpointAccessCommand	Class
CreateEndpointAccessCommandInput	Interface
CreateEndpointAccessCommandOutput	Interface
CreateEndpointAccessMessage	Interface
CreateEventSubscriptionCommand	Class
CreateEventSubscriptionCommandInput	Interface
CreateEventSubscriptionCommandOutput	Interface
CreateEventSubscriptionMessage	Interface
CreateEventSubscriptionResult	Interface
CreateHsmClientCertificateCommand	Class
CreateHsmClientCertificateCommandInput	Interface
CreateHsmClientCertificateCommandOutput	Interface
CreateHsmClientCertificateMessage	Interface
CreateHsmClientCertificateResult	Interface
CreateHsmConfigurationCommand	Class
CreateHsmConfigurationCommandInput	Interface
CreateHsmConfigurationCommandOutput	Interface
CreateHsmConfigurationMessage	Interface
CreateHsmConfigurationResult	Interface
CreateIntegrationCommand	Class
CreateIntegrationCommandInput	Interface
CreateIntegrationCommandOutput	Interface
CreateIntegrationMessage	Interface
CreateRedshiftIdcApplicationCommand	Class
CreateRedshiftIdcApplicationCommandInput	Interface
CreateRedshiftIdcApplicationCommandOutput	Interface
CreateRedshiftIdcApplicationMessage	Interface
CreateRedshiftIdcApplicationResult	Interface
CreateScheduledActionCommand	Class
CreateScheduledActionCommandInput	Interface
CreateScheduledActionCommandOutput	Interface
CreateScheduledActionMessage	Interface
CreateSnapshotCopyGrantCommand	Class
CreateSnapshotCopyGrantCommandInput	Interface
CreateSnapshotCopyGrantCommandOutput	Interface
CreateSnapshotCopyGrantMessage	Interface
CreateSnapshotCopyGrantResult	Interface
CreateSnapshotScheduleCommand	Class
CreateSnapshotScheduleCommandInput	Interface
CreateSnapshotScheduleCommandOutput	Interface
CreateSnapshotScheduleMessage	Interface
CreateTagsCommand	Class
CreateTagsCommandInput	Interface
CreateTagsCommandOutput	Interface
CreateTagsMessage	Interface
CreateUsageLimitCommand	Class
CreateUsageLimitCommandInput	Interface
CreateUsageLimitCommandOutput	Interface
CreateUsageLimitMessage	Interface
CustomCnameAssociationFault	Class
CustomDomainAssociationNotFoundFault	Class
CustomDomainAssociationsMessage	Interface
CustomerStorageMessage	Interface
DataShare	Interface
DataShareAssociation	Interface
DataShareStatus	TypeAlias
DataShareStatusenum	Variable
DataShareStatusForConsumer	TypeAlias
DataShareStatusForConsumerenum	Variable
DataShareStatusForProducer	TypeAlias
DataShareStatusForProducerenum	Variable
DataShareType	TypeAlias
DataShareTypeenum	Variable
DataTransferProgress	Interface
DeauthorizeDataShareCommand	Class
DeauthorizeDataShareCommandInput	Interface
DeauthorizeDataShareCommandOutput	Interface
DeauthorizeDataShareMessage	Interface
DefaultClusterParameters	Interface
DeferredMaintenanceWindow	Interface
DeleteAuthenticationProfileCommand	Class
DeleteAuthenticationProfileCommandInput	Interface
DeleteAuthenticationProfileCommandOutput	Interface
DeleteAuthenticationProfileMessage	Interface
DeleteAuthenticationProfileResult	Interface
DeleteClusterCommand	Class
DeleteClusterCommandInput	Interface
DeleteClusterCommandOutput	Interface
DeleteClusterMessage	Interface
DeleteClusterParameterGroupCommand	Class
DeleteClusterParameterGroupCommandInput	Interface
DeleteClusterParameterGroupCommandOutput	Interface
DeleteClusterParameterGroupMessage	Interface
DeleteClusterResult	Interface
DeleteClusterSecurityGroupCommand	Class
DeleteClusterSecurityGroupCommandInput	Interface
DeleteClusterSecurityGroupCommandOutput	Interface
DeleteClusterSecurityGroupMessage	Interface
DeleteClusterSnapshotCommand	Class
DeleteClusterSnapshotCommandInput	Interface
DeleteClusterSnapshotCommandOutput	Interface
DeleteClusterSnapshotMessage	Interface
DeleteClusterSnapshotResult	Interface
DeleteClusterSubnetGroupCommand	Class
DeleteClusterSubnetGroupCommandInput	Interface
DeleteClusterSubnetGroupCommandOutput	Interface
DeleteClusterSubnetGroupMessage	Interface
DeleteCustomDomainAssociationCommand	Class
DeleteCustomDomainAssociationCommandInput	Interface
DeleteCustomDomainAssociationCommandOutput	Interface
DeleteCustomDomainAssociationMessage	Interface
DeleteEndpointAccessCommand	Class
DeleteEndpointAccessCommandInput	Interface
DeleteEndpointAccessCommandOutput	Interface
DeleteEndpointAccessMessage	Interface
DeleteEventSubscriptionCommand	Class
DeleteEventSubscriptionCommandInput	Interface
DeleteEventSubscriptionCommandOutput	Interface
DeleteEventSubscriptionMessage	Interface
DeleteHsmClientCertificateCommand	Class
DeleteHsmClientCertificateCommandInput	Interface
DeleteHsmClientCertificateCommandOutput	Interface
DeleteHsmClientCertificateMessage	Interface
DeleteHsmConfigurationCommand	Class
DeleteHsmConfigurationCommandInput	Interface
DeleteHsmConfigurationCommandOutput	Interface
DeleteHsmConfigurationMessage	Interface
DeleteIntegrationCommand	Class
DeleteIntegrationCommandInput	Interface
DeleteIntegrationCommandOutput	Interface
DeleteIntegrationMessage	Interface
DeletePartnerCommand	Class
DeletePartnerCommandInput	Interface
DeletePartnerCommandOutput	Interface
DeleteRedshiftIdcApplicationCommand	Class
DeleteRedshiftIdcApplicationCommandInput	Interface
DeleteRedshiftIdcApplicationCommandOutput	Interface
DeleteRedshiftIdcApplicationMessage	Interface
DeleteResourcePolicyCommand	Class
DeleteResourcePolicyCommandInput	Interface
DeleteResourcePolicyCommandOutput	Interface
DeleteResourcePolicyMessage	Interface
DeleteScheduledActionCommand	Class
DeleteScheduledActionCommandInput	Interface
DeleteScheduledActionCommandOutput	Interface
DeleteScheduledActionMessage	Interface
DeleteSnapshotCopyGrantCommand	Class
DeleteSnapshotCopyGrantCommandInput	Interface
DeleteSnapshotCopyGrantCommandOutput	Interface
DeleteSnapshotCopyGrantMessage	Interface
DeleteSnapshotScheduleCommand	Class
DeleteSnapshotScheduleCommandInput	Interface
DeleteSnapshotScheduleCommandOutput	Interface
DeleteSnapshotScheduleMessage	Interface
DeleteTagsCommand	Class
DeleteTagsCommandInput	Interface
DeleteTagsCommandOutput	Interface
DeleteTagsMessage	Interface
DeleteUsageLimitCommand	Class
DeleteUsageLimitCommandInput	Interface
DeleteUsageLimitCommandOutput	Interface
DeleteUsageLimitMessage	Interface
DependentServiceAccessDeniedFault	Class
DependentServiceRequestThrottlingFault	Class
DependentServiceUnavailableFault	Class
DeregisterNamespaceCommand	Class
DeregisterNamespaceCommandInput	Interface
DeregisterNamespaceCommandOutput	Interface
DeregisterNamespaceInputMessage	Interface
DeregisterNamespaceOutputMessage	Interface
DescribeAccountAttributesCommand	Class
DescribeAccountAttributesCommandInput	Interface
DescribeAccountAttributesCommandOutput	Interface
DescribeAccountAttributesMessage	Interface
DescribeAuthenticationProfilesCommand	Class
DescribeAuthenticationProfilesCommandInput	Interface
DescribeAuthenticationProfilesCommandOutput	Interface
DescribeAuthenticationProfilesMessage	Interface
DescribeAuthenticationProfilesResult	Interface
DescribeClusterDbRevisionsCommand	Class
DescribeClusterDbRevisionsCommandInput	Interface
DescribeClusterDbRevisionsCommandOutput	Interface
DescribeClusterDbRevisionsMessage	Interface
DescribeClusterParameterGroupsCommand	Class
DescribeClusterParameterGroupsCommandInput	Interface
DescribeClusterParameterGroupsCommandOutput	Interface
DescribeClusterParameterGroupsMessage	Interface
DescribeClusterParametersCommand	Class
DescribeClusterParametersCommandInput	Interface
DescribeClusterParametersCommandOutput	Interface
DescribeClusterParametersMessage	Interface
DescribeClustersCommand	Class
DescribeClustersCommandInput	Interface
DescribeClustersCommandOutput	Interface
DescribeClusterSecurityGroupsCommand	Class
DescribeClusterSecurityGroupsCommandInput	Interface
DescribeClusterSecurityGroupsCommandOutput	Interface
DescribeClusterSecurityGroupsMessage	Interface
DescribeClustersMessage	Interface
DescribeClusterSnapshotsCommand	Class
DescribeClusterSnapshotsCommandInput	Interface
DescribeClusterSnapshotsCommandOutput	Interface
DescribeClusterSnapshotsMessage	Interface
DescribeClusterSubnetGroupsCommand	Class
DescribeClusterSubnetGroupsCommandInput	Interface
DescribeClusterSubnetGroupsCommandOutput	Interface
DescribeClusterSubnetGroupsMessage	Interface
DescribeClusterTracksCommand	Class
DescribeClusterTracksCommandInput	Interface
DescribeClusterTracksCommandOutput	Interface
DescribeClusterTracksMessage	Interface
DescribeClusterVersionsCommand	Class
DescribeClusterVersionsCommandInput	Interface
DescribeClusterVersionsCommandOutput	Interface
DescribeClusterVersionsMessage	Interface
DescribeCustomDomainAssociationsCommand	Class
DescribeCustomDomainAssociationsCommandInput	Interface
DescribeCustomDomainAssociationsCommandOutput	Interface
DescribeCustomDomainAssociationsMessage	Interface
DescribeDataSharesCommand	Class
DescribeDataSharesCommandInput	Interface
DescribeDataSharesCommandOutput	Interface
DescribeDataSharesForConsumerCommand	Class
DescribeDataSharesForConsumerCommandInput	Interface
DescribeDataSharesForConsumerCommandOutput	Interface
DescribeDataSharesForConsumerMessage	Interface
DescribeDataSharesForConsumerResult	Interface
DescribeDataSharesForProducerCommand	Class
DescribeDataSharesForProducerCommandInput	Interface
DescribeDataSharesForProducerCommandOutput	Interface
DescribeDataSharesForProducerMessage	Interface
DescribeDataSharesForProducerResult	Interface
DescribeDataSharesMessage	Interface
DescribeDataSharesResult	Interface
DescribeDefaultClusterParametersCommand	Class
DescribeDefaultClusterParametersCommandInput	Interface
DescribeDefaultClusterParametersCommandOutput	Interface
DescribeDefaultClusterParametersMessage	Interface
DescribeDefaultClusterParametersResult	Interface
DescribeEndpointAccessCommand	Class
DescribeEndpointAccessCommandInput	Interface
DescribeEndpointAccessCommandOutput	Interface
DescribeEndpointAccessMessage	Interface
DescribeEndpointAuthorizationCommand	Class
DescribeEndpointAuthorizationCommandInput	Interface
DescribeEndpointAuthorizationCommandOutput	Interface
DescribeEndpointAuthorizationMessage	Interface
DescribeEventCategoriesCommand	Class
DescribeEventCategoriesCommandInput	Interface
DescribeEventCategoriesCommandOutput	Interface
DescribeEventCategoriesMessage	Interface
DescribeEventsCommand	Class
DescribeEventsCommandInput	Interface
DescribeEventsCommandOutput	Interface
DescribeEventsMessage	Interface
DescribeEventSubscriptionsCommand	Class
DescribeEventSubscriptionsCommandInput	Interface
DescribeEventSubscriptionsCommandOutput	Interface
DescribeEventSubscriptionsMessage	Interface
DescribeHsmClientCertificatesCommand	Class
DescribeHsmClientCertificatesCommandInput	Interface
DescribeHsmClientCertificatesCommandOutput	Interface
DescribeHsmClientCertificatesMessage	Interface
DescribeHsmConfigurationsCommand	Class
DescribeHsmConfigurationsCommandInput	Interface
DescribeHsmConfigurationsCommandOutput	Interface
DescribeHsmConfigurationsMessage	Interface
DescribeInboundIntegrationsCommand	Class
DescribeInboundIntegrationsCommandInput	Interface
DescribeInboundIntegrationsCommandOutput	Interface
DescribeInboundIntegrationsMessage	Interface
DescribeIntegrationsCommand	Class
DescribeIntegrationsCommandInput	Interface
DescribeIntegrationsCommandOutput	Interface
DescribeIntegrationsFilter	Interface
DescribeIntegrationsFilterName	TypeAlias
DescribeIntegrationsFilterNameenum	Variable
DescribeIntegrationsMessage	Interface
DescribeLoggingStatusCommand	Class
DescribeLoggingStatusCommandInput	Interface
DescribeLoggingStatusCommandOutput	Interface
DescribeLoggingStatusMessage	Interface
DescribeNodeConfigurationOptionsCommand	Class
DescribeNodeConfigurationOptionsCommandInput	Interface
DescribeNodeConfigurationOptionsCommandOutput	Interface
DescribeNodeConfigurationOptionsMessage	Interface
DescribeOrderableClusterOptionsCommand	Class
DescribeOrderableClusterOptionsCommandInput	Interface
DescribeOrderableClusterOptionsCommandOutput	Interface
DescribeOrderableClusterOptionsMessage	Interface
DescribePartnersCommand	Class
DescribePartnersCommandInput	Interface
DescribePartnersCommandOutput	Interface
DescribePartnersInputMessage	Interface
DescribePartnersOutputMessage	Interface
DescribeRedshiftIdcApplicationsCommand	Class
DescribeRedshiftIdcApplicationsCommandInput	Interface
DescribeRedshiftIdcApplicationsCommandOutput	Interface
DescribeRedshiftIdcApplicationsMessage	Interface
DescribeRedshiftIdcApplicationsResult	Interface
DescribeReservedNodeExchangeStatusCommand	Class
DescribeReservedNodeExchangeStatusCommandInput	Interface
DescribeReservedNodeExchangeStatusCommandOutput	Interface
DescribeReservedNodeExchangeStatusInputMessage	Interface
DescribeReservedNodeExchangeStatusOutputMessage	Interface
DescribeReservedNodeOfferingsCommand	Class
DescribeReservedNodeOfferingsCommandInput	Interface
DescribeReservedNodeOfferingsCommandOutput	Interface
DescribeReservedNodeOfferingsMessage	Interface
DescribeReservedNodesCommand	Class
DescribeReservedNodesCommandInput	Interface
DescribeReservedNodesCommandOutput	Interface
DescribeReservedNodesMessage	Interface
DescribeResizeCommand	Class
DescribeResizeCommandInput	Interface
DescribeResizeCommandOutput	Interface
DescribeResizeMessage	Interface
DescribeScheduledActionsCommand	Class
DescribeScheduledActionsCommandInput	Interface
DescribeScheduledActionsCommandOutput	Interface
DescribeScheduledActionsMessage	Interface
DescribeSnapshotCopyGrantsCommand	Class
DescribeSnapshotCopyGrantsCommandInput	Interface
DescribeSnapshotCopyGrantsCommandOutput	Interface
DescribeSnapshotCopyGrantsMessage	Interface
DescribeSnapshotSchedulesCommand	Class
DescribeSnapshotSchedulesCommandInput	Interface
DescribeSnapshotSchedulesCommandOutput	Interface
DescribeSnapshotSchedulesMessage	Interface
DescribeSnapshotSchedulesOutputMessage	Interface
DescribeStorageCommand	Class
DescribeStorageCommandInput	Interface
DescribeStorageCommandOutput	Interface
DescribeTableRestoreStatusCommand	Class
DescribeTableRestoreStatusCommandInput	Interface
DescribeTableRestoreStatusCommandOutput	Interface
DescribeTableRestoreStatusMessage	Interface
DescribeTagsCommand	Class
DescribeTagsCommandInput	Interface
DescribeTagsCommandOutput	Interface
DescribeTagsMessage	Interface
DescribeUsageLimitsCommand	Class
DescribeUsageLimitsCommandInput	Interface
DescribeUsageLimitsCommandOutput	Interface
DescribeUsageLimitsMessage	Interface
DisableLoggingCommand	Class
DisableLoggingCommandInput	Interface
DisableLoggingCommandOutput	Interface
DisableLoggingMessage	Interface
DisableSnapshotCopyCommand	Class
DisableSnapshotCopyCommandInput	Interface
DisableSnapshotCopyCommandOutput	Interface
DisableSnapshotCopyMessage	Interface
DisableSnapshotCopyResult	Interface
DisassociateDataShareConsumerCommand	Class
DisassociateDataShareConsumerCommandInput	Interface
DisassociateDataShareConsumerCommandOutput	Interface
DisassociateDataShareConsumerMessage	Interface
EC2SecurityGroup	Interface
ElasticIpStatus	Interface
EnableLoggingCommand	Class
EnableLoggingCommandInput	Interface
EnableLoggingCommandOutput	Interface
EnableLoggingMessage	Interface
EnableSnapshotCopyCommand	Class
EnableSnapshotCopyCommandInput	Interface
EnableSnapshotCopyCommandOutput	Interface
EnableSnapshotCopyMessage	Interface
EnableSnapshotCopyResult	Interface
Endpoint	Interface
EndpointAccess	Interface
EndpointAccessList	Interface
EndpointAlreadyExistsFault	Class
EndpointAuthorization	Interface
EndpointAuthorizationAlreadyExistsFault	Class
EndpointAuthorizationList	Interface
EndpointAuthorizationNotFoundFault	Class
EndpointAuthorizationsPerClusterLimitExceededFault	Class
EndpointNotFoundFault	Class
EndpointsPerAuthorizationLimitExceededFault	Class
EndpointsPerClusterLimitExceededFault	Class
Event	Interface
EventCategoriesMap	Interface
EventCategoriesMessage	Interface
EventInfoMap	Interface
EventsMessage	Interface
EventSubscription	Interface
EventSubscriptionQuotaExceededFault	Class
EventSubscriptionsMessage	Interface
FailoverPrimaryComputeCommand	Class
FailoverPrimaryComputeCommandInput	Interface
FailoverPrimaryComputeCommandOutput	Interface
FailoverPrimaryComputeInputMessage	Interface
FailoverPrimaryComputeResult	Interface
GetClusterCredentialsCommand	Class
GetClusterCredentialsCommandInput	Interface
GetClusterCredentialsCommandOutput	Interface
GetClusterCredentialsMessage	Interface
GetClusterCredentialsWithIAMCommand	Class
GetClusterCredentialsWithIAMCommandInput	Interface
GetClusterCredentialsWithIAMCommandOutput	Interface
GetClusterCredentialsWithIAMMessage	Interface
GetReservedNodeExchangeConfigurationOptionsCommand	Class
GetReservedNodeExchangeConfigurationOptionsCommandInput	Interface
GetReservedNodeExchangeConfigurationOptionsCommandOutput	Interface
GetReservedNodeExchangeConfigurationOptionsInputMessage	Interface
GetReservedNodeExchangeConfigurationOptionsOutputMessage	Interface
GetReservedNodeExchangeOfferingsCommand	Class
GetReservedNodeExchangeOfferingsCommandInput	Interface
GetReservedNodeExchangeOfferingsCommandOutput	Interface
GetReservedNodeExchangeOfferingsInputMessage	Interface
GetReservedNodeExchangeOfferingsOutputMessage	Interface
GetResourcePolicyCommand	Class
GetResourcePolicyCommandInput	Interface
GetResourcePolicyCommandOutput	Interface
GetResourcePolicyMessage	Interface
GetResourcePolicyResult	Interface
HsmClientCertificate	Interface
HsmClientCertificateAlreadyExistsFault	Class
HsmClientCertificateMessage	Interface
HsmClientCertificateNotFoundFault	Class
HsmClientCertificateQuotaExceededFault	Class
HsmConfiguration	Interface
HsmConfigurationAlreadyExistsFault	Class
HsmConfigurationMessage	Interface
HsmConfigurationNotFoundFault	Class
HsmConfigurationQuotaExceededFault	Class
HsmStatus	Interface
ImpactRankingType	TypeAlias
ImpactRankingTypeenum	Variable
InboundIntegration	Interface
InboundIntegrationsMessage	Interface
IncompatibleOrderableOptions	Class
InProgressTableRestoreQuotaExceededFault	Class
InsufficientClusterCapacityFault	Class
InsufficientS3BucketPolicyFault	Class
Integration	Interface
IntegrationAlreadyExistsFault	Class
IntegrationConflictOperationFault	Class
IntegrationConflictStateFault	Class
IntegrationError	Interface
IntegrationNotFoundFault	Class
IntegrationQuotaExceededFault	Class
IntegrationsMessage	Interface
IntegrationSourceNotFoundFault	Class
IntegrationTargetNotFoundFault	Class
InvalidAuthenticationProfileRequestFault	Class
InvalidAuthorizationStateFault	Class
InvalidClusterParameterGroupStateFault	Class
InvalidClusterSecurityGroupStateFault	Class
InvalidClusterSnapshotScheduleStateFault	Class
InvalidClusterSnapshotStateFault	Class
InvalidClusterStateFault	Class
InvalidClusterSubnetGroupStateFault	Class
InvalidClusterSubnetStateFault	Class
InvalidClusterTrackFault	Class
InvalidDataShareFault	Class
InvalidElasticIpFault	Class
InvalidEndpointStateFault	Class
InvalidHsmClientCertificateStateFault	Class
InvalidHsmConfigurationStateFault	Class
InvalidNamespaceFault	Class
InvalidPolicyFault	Class
InvalidReservedNodeStateFault	Class
InvalidRestoreFault	Class
InvalidRetentionPeriodFault	Class
InvalidS3BucketNameFault	Class
InvalidS3KeyPrefixFault	Class
InvalidScheduledActionFault	Class
InvalidScheduleFault	Class
InvalidSnapshotCopyGrantStateFault	Class
InvalidSubnet	Class
InvalidSubscriptionStateFault	Class
InvalidTableRestoreArgumentFault	Class
InvalidTagFault	Class
InvalidUsageLimitFault	Class
InvalidVPCNetworkStateFault	Class
IPRange	Interface
Ipv6CidrBlockNotFoundFault	Class
LakeFormationQuery	Interface
LakeFormationScopeUnion	Namespace
LakeFormationScopeUnion	TypeAlias
LimitExceededFault	Class
ListRecommendationsCommand	Class
ListRecommendationsCommandInput	Interface
ListRecommendationsCommandOutput	Interface
ListRecommendationsMessage	Interface
ListRecommendationsResult	Interface
LogDestinationType	TypeAlias
LogDestinationTypeenum	Variable
LoggingStatus	Interface
MaintenanceTrack	Interface
Mode	TypeAlias
Modeenum	Variable
ModifyAquaConfigurationCommand	Class
ModifyAquaConfigurationCommandInput	Interface
ModifyAquaConfigurationCommandOutput	Interface
ModifyAquaInputMessage	Interface
ModifyAquaOutputMessage	Interface
ModifyAuthenticationProfileCommand	Class
ModifyAuthenticationProfileCommandInput	Interface
ModifyAuthenticationProfileCommandOutput	Interface
ModifyAuthenticationProfileMessage	Interface
ModifyAuthenticationProfileResult	Interface
ModifyClusterCommand	Class
ModifyClusterCommandInput	Interface
ModifyClusterCommandOutput	Interface
ModifyClusterDbRevisionCommand	Class
ModifyClusterDbRevisionCommandInput	Interface
ModifyClusterDbRevisionCommandOutput	Interface
ModifyClusterDbRevisionMessage	Interface
ModifyClusterDbRevisionResult	Interface
ModifyClusterIamRolesCommand	Class
ModifyClusterIamRolesCommandInput	Interface
ModifyClusterIamRolesCommandOutput	Interface
ModifyClusterIamRolesMessage	Interface
ModifyClusterIamRolesResult	Interface
ModifyClusterMaintenanceCommand	Class
ModifyClusterMaintenanceCommandInput	Interface
ModifyClusterMaintenanceCommandOutput	Interface
ModifyClusterMaintenanceMessage	Interface
ModifyClusterMaintenanceResult	Interface
ModifyClusterMessage	Interface
ModifyClusterParameterGroupCommand	Class
ModifyClusterParameterGroupCommandInput	Interface
ModifyClusterParameterGroupCommandOutput	Interface
ModifyClusterParameterGroupMessage	Interface
ModifyClusterResult	Interface
ModifyClusterSnapshotCommand	Class
ModifyClusterSnapshotCommandInput	Interface
ModifyClusterSnapshotCommandOutput	Interface
ModifyClusterSnapshotMessage	Interface
ModifyClusterSnapshotResult	Interface
ModifyClusterSnapshotScheduleCommand	Class
ModifyClusterSnapshotScheduleCommandInput	Interface
ModifyClusterSnapshotScheduleCommandOutput	Interface
ModifyClusterSnapshotScheduleMessage	Interface
ModifyClusterSubnetGroupCommand	Class
ModifyClusterSubnetGroupCommandInput	Interface
ModifyClusterSubnetGroupCommandOutput	Interface
ModifyClusterSubnetGroupMessage	Interface
ModifyClusterSubnetGroupResult	Interface
ModifyCustomDomainAssociationCommand	Class
ModifyCustomDomainAssociationCommandInput	Interface
ModifyCustomDomainAssociationCommandOutput	Interface
ModifyCustomDomainAssociationMessage	Interface
ModifyCustomDomainAssociationResult	Interface
ModifyEndpointAccessCommand	Class
ModifyEndpointAccessCommandInput	Interface
ModifyEndpointAccessCommandOutput	Interface
ModifyEndpointAccessMessage	Interface
ModifyEventSubscriptionCommand	Class
ModifyEventSubscriptionCommandInput	Interface
ModifyEventSubscriptionCommandOutput	Interface
ModifyEventSubscriptionMessage	Interface
ModifyEventSubscriptionResult	Interface
ModifyIntegrationCommand	Class
ModifyIntegrationCommandInput	Interface
ModifyIntegrationCommandOutput	Interface
ModifyIntegrationMessage	Interface
ModifyRedshiftIdcApplicationCommand	Class
ModifyRedshiftIdcApplicationCommandInput	Interface
ModifyRedshiftIdcApplicationCommandOutput	Interface
ModifyRedshiftIdcApplicationMessage	Interface
ModifyRedshiftIdcApplicationResult	Interface
ModifyScheduledActionCommand	Class
ModifyScheduledActionCommandInput	Interface
ModifyScheduledActionCommandOutput	Interface
ModifyScheduledActionMessage	Interface
ModifySnapshotCopyRetentionPeriodCommand	Class
ModifySnapshotCopyRetentionPeriodCommandInput	Interface
ModifySnapshotCopyRetentionPeriodCommandOutput	Interface
ModifySnapshotCopyRetentionPeriodMessage	Interface
ModifySnapshotCopyRetentionPeriodResult	Interface
ModifySnapshotScheduleCommand	Class
ModifySnapshotScheduleCommandInput	Interface
ModifySnapshotScheduleCommandOutput	Interface
ModifySnapshotScheduleMessage	Interface
ModifyUsageLimitCommand	Class
ModifyUsageLimitCommandInput	Interface
ModifyUsageLimitCommandOutput	Interface
ModifyUsageLimitMessage	Interface
NamespaceIdentifierUnion	Namespace
NamespaceIdentifierUnion	TypeAlias
NamespaceRegistrationStatus	TypeAlias
NamespaceRegistrationStatusenum	Variable
NetworkInterface	Interface
NodeConfigurationOption	Interface
NodeConfigurationOptionsFilter	Interface
NodeConfigurationOptionsFilterName	TypeAlias
NodeConfigurationOptionsFilterNameenum	Variable
NodeConfigurationOptionsMessage	Interface
NumberOfNodesPerClusterLimitExceededFault	Class
NumberOfNodesQuotaExceededFault	Class
OperatorType	TypeAlias
OperatorTypeenum	Variable
OrderableClusterOption	Interface
OrderableClusterOptionsMessage	Interface
paginateDescribeClusterDbRevisions	Variable
paginateDescribeClusterParameterGroups	Variable
paginateDescribeClusterParameters	Variable
paginateDescribeClusters	Variable
paginateDescribeClusterSecurityGroups	Variable
paginateDescribeClusterSnapshots	Variable
paginateDescribeClusterSubnetGroups	Variable
paginateDescribeClusterTracks	Variable
paginateDescribeClusterVersions	Variable
paginateDescribeCustomDomainAssociations	Variable
paginateDescribeDataShares	Variable
paginateDescribeDataSharesForConsumer	Variable
paginateDescribeDataSharesForProducer	Variable
paginateDescribeDefaultClusterParameters	Variable
paginateDescribeEndpointAccess	Variable
paginateDescribeEndpointAuthorization	Variable
paginateDescribeEvents	Variable
paginateDescribeEventSubscriptions	Variable
paginateDescribeHsmClientCertificates	Variable
paginateDescribeHsmConfigurations	Variable
paginateDescribeInboundIntegrations	Variable
paginateDescribeIntegrations	Variable
paginateDescribeNodeConfigurationOptions	Variable
paginateDescribeOrderableClusterOptions	Variable
paginateDescribeRedshiftIdcApplications	Variable
paginateDescribeReservedNodeExchangeStatus	Variable
paginateDescribeReservedNodeOfferings	Variable
paginateDescribeReservedNodes	Variable
paginateDescribeScheduledActions	Variable
paginateDescribeSnapshotCopyGrants	Variable
paginateDescribeSnapshotSchedules	Variable
paginateDescribeTableRestoreStatus	Variable
paginateDescribeTags	Variable
paginateDescribeUsageLimits	Variable
paginateGetReservedNodeExchangeConfigurationOptions	Variable
paginateGetReservedNodeExchangeOfferings	Variable
paginateListRecommendations	Variable
Parameter	Interface
ParameterApplyType	TypeAlias
ParameterApplyTypeenum	Variable
PartnerIntegrationInfo	Interface
PartnerIntegrationInputMessage	Interface
PartnerIntegrationOutputMessage	Interface
PartnerIntegrationStatus	TypeAlias
PartnerIntegrationStatusenum	Variable
PartnerNotFoundFault	Class
PauseClusterCommand	Class
PauseClusterCommandInput	Interface
PauseClusterCommandOutput	Interface
PauseClusterMessage	Interface
PauseClusterResult	Interface
PendingModifiedValues	Interface
ProvisionedIdentifier	Interface
PurchaseReservedNodeOfferingCommand	Class
PurchaseReservedNodeOfferingCommandInput	Interface
PurchaseReservedNodeOfferingCommandOutput	Interface
PurchaseReservedNodeOfferingMessage	Interface
PurchaseReservedNodeOfferingResult	Interface
PutResourcePolicyCommand	Class
PutResourcePolicyCommandInput	Interface
PutResourcePolicyCommandOutput	Interface
PutResourcePolicyMessage	Interface
PutResourcePolicyResult	Interface
ReadWriteAccess	Interface
RebootClusterCommand	Class
RebootClusterCommandInput	Interface
RebootClusterCommandOutput	Interface
RebootClusterMessage	Interface
RebootClusterResult	Interface
Recommendation	Interface
RecommendedAction	Interface
RecommendedActionType	TypeAlias
RecommendedActionTypeenum	Variable
RecurringCharge	Interface
Redshift	Class
Redshift	Interface
RedshiftClient	Class
RedshiftClientConfig	Interface
RedshiftClientConfigType	TypeAlias
RedshiftClientResolvedConfig	Interface
RedshiftClientResolvedConfigType	TypeAlias
RedshiftIdcApplication	Interface
RedshiftIdcApplicationAlreadyExistsFault	Class
RedshiftIdcApplicationNotExistsFault	Class
RedshiftIdcApplicationQuotaExceededFault	Class
RedshiftPaginationConfiguration	Interface
RedshiftServiceException	Class
ReferenceLink	Interface
RegisterNamespaceCommand	Class
RegisterNamespaceCommandInput	Interface
RegisterNamespaceCommandOutput	Interface
RegisterNamespaceInputMessage	Interface
RegisterNamespaceOutputMessage	Interface
RejectDataShareCommand	Class
RejectDataShareCommandInput	Interface
RejectDataShareCommandOutput	Interface
RejectDataShareMessage	Interface
ReservedNode	Interface
ReservedNodeAlreadyExistsFault	Class
ReservedNodeAlreadyMigratedFault	Class
ReservedNodeConfigurationOption	Interface
ReservedNodeExchangeActionType	TypeAlias
ReservedNodeExchangeActionTypeenum	Variable
ReservedNodeExchangeNotFoundFault	Class
ReservedNodeExchangeStatus	Interface
ReservedNodeExchangeStatusType	TypeAlias
ReservedNodeExchangeStatusTypeenum	Variable
ReservedNodeNotFoundFault	Class
ReservedNodeOffering	Interface
ReservedNodeOfferingNotFoundFault	Class
ReservedNodeOfferingsMessage	Interface
ReservedNodeOfferingType	TypeAlias
ReservedNodeOfferingTypeenum	Variable
ReservedNodeQuotaExceededFault	Class
ReservedNodesMessage	Interface
ResetClusterParameterGroupCommand	Class
ResetClusterParameterGroupCommandInput	Interface
ResetClusterParameterGroupCommandOutput	Interface
ResetClusterParameterGroupMessage	Interface
ResizeClusterCommand	Class
ResizeClusterCommandInput	Interface
ResizeClusterCommandOutput	Interface
ResizeClusterMessage	Interface
ResizeClusterResult	Interface
ResizeInfo	Interface
ResizeNotFoundFault	Class
ResizeProgressMessage	Interface
ResourceNotFoundFault	Class
ResourcePolicy	Interface
RestoreFromClusterSnapshotCommand	Class
RestoreFromClusterSnapshotCommandInput	Interface
RestoreFromClusterSnapshotCommandOutput	Interface
RestoreFromClusterSnapshotMessage	Interface
RestoreFromClusterSnapshotResult	Interface
RestoreStatus	Interface
RestoreTableFromClusterSnapshotCommand	Class
RestoreTableFromClusterSnapshotCommandInput	Interface
RestoreTableFromClusterSnapshotCommandOutput	Interface
RestoreTableFromClusterSnapshotMessage	Interface
RestoreTableFromClusterSnapshotResult	Interface
ResumeClusterCommand	Class
ResumeClusterCommandInput	Interface
ResumeClusterCommandOutput	Interface
ResumeClusterMessage	Interface
ResumeClusterResult	Interface
RevisionTarget	Interface
RevokeClusterSecurityGroupIngressCommand	Class
RevokeClusterSecurityGroupIngressCommandInput	Interface
RevokeClusterSecurityGroupIngressCommandOutput	Interface
RevokeClusterSecurityGroupIngressMessage	Interface
RevokeClusterSecurityGroupIngressResult	Interface
RevokeEndpointAccessCommand	Class
RevokeEndpointAccessCommandInput	Interface
RevokeEndpointAccessCommandOutput	Interface
RevokeEndpointAccessMessage	Interface
RevokeSnapshotAccessCommand	Class
RevokeSnapshotAccessCommandInput	Interface
RevokeSnapshotAccessCommandOutput	Interface
RevokeSnapshotAccessMessage	Interface
RevokeSnapshotAccessResult	Interface
RotateEncryptionKeyCommand	Class
RotateEncryptionKeyCommandInput	Interface
RotateEncryptionKeyCommandOutput	Interface
RotateEncryptionKeyMessage	Interface
RotateEncryptionKeyResult	Interface
RuntimeExtension	Interface
S3AccessGrantsScopeUnion	Namespace
S3AccessGrantsScopeUnion	TypeAlias
ScheduledAction	Interface
ScheduledActionAlreadyExistsFault	Class
ScheduledActionFilter	Interface
ScheduledActionFilterName	TypeAlias
ScheduledActionFilterNameenum	Variable
ScheduledActionNotFoundFault	Class
ScheduledActionQuotaExceededFault	Class
ScheduledActionsMessage	Interface
ScheduledActionState	TypeAlias
ScheduledActionStateenum	Variable
ScheduledActionType	Interface
ScheduledActionTypeUnsupportedFault	Class
ScheduledActionTypeValues	TypeAlias
ScheduledActionTypeValuesenum	Variable
ScheduleDefinitionTypeUnsupportedFault	Class
ScheduleState	TypeAlias
ScheduleStateenum	Variable
SecondaryClusterInfo	Interface
ServerlessIdentifier	Interface
ServiceAuthorization	TypeAlias
ServiceAuthorizationenum	Variable
ServiceInputTypes	TypeAlias
ServiceIntegrationsUnion	Namespace
ServiceIntegrationsUnion	TypeAlias
ServiceOutputTypes	TypeAlias
Snapshot	Interface
SnapshotAttributeToSortBy	TypeAlias
SnapshotAttributeToSortByenum	Variable
SnapshotCopyAlreadyDisabledFault	Class
SnapshotCopyAlreadyEnabledFault	Class
SnapshotCopyDisabledFault	Class
SnapshotCopyGrant	Interface
SnapshotCopyGrantAlreadyExistsFault	Class
SnapshotCopyGrantMessage	Interface
SnapshotCopyGrantNotFoundFault	Class
SnapshotCopyGrantQuotaExceededFault	Class
SnapshotErrorMessage	Interface
SnapshotMessage	Interface
SnapshotSchedule	Interface
SnapshotScheduleAlreadyExistsFault	Class
SnapshotScheduleNotFoundFault	Class
SnapshotScheduleQuotaExceededFault	Class
SnapshotScheduleUpdateInProgressFault	Class
SnapshotSortingEntity	Interface
SNSInvalidTopicFault	Class
SNSNoAuthorizationFault	Class
SNSTopicArnNotFoundFault	Class
SortByOrder	TypeAlias
SortByOrderenum	Variable
SourceNotFoundFault	Class
SourceType	TypeAlias
SourceTypeenum	Variable
Subnet	Interface
SubnetAlreadyInUse	Class
SubscriptionAlreadyExistFault	Class
SubscriptionCategoryNotFoundFault	Class
SubscriptionEventIdNotFoundFault	Class
SubscriptionNotFoundFault	Class
SubscriptionSeverityNotFoundFault	Class
SupportedOperation	Interface
SupportedPlatform	Interface
TableLimitExceededFault	Class
TableRestoreNotFoundFault	Class
TableRestoreStatus	Interface
TableRestoreStatusMessage	Interface
TableRestoreStatusType	TypeAlias
TableRestoreStatusTypeenum	Variable
Tag	Interface
TaggedResource	Interface
TaggedResourceListMessage	Interface
TagLimitExceededFault	Class
TrackListMessage	Interface
UnauthorizedOperation	Class
UnauthorizedPartnerIntegrationFault	Class
UnknownSnapshotCopyRegionFault	Class
UnsupportedOperationFault	Class
UnsupportedOptionFault	Class
UpdatePartnerStatusCommand	Class
UpdatePartnerStatusCommandInput	Interface
UpdatePartnerStatusCommandOutput	Interface
UpdatePartnerStatusInputMessage	Interface
UpdateTarget	Interface
UsageLimit	Interface
UsageLimitAlreadyExistsFault	Class
UsageLimitBreachAction	TypeAlias
UsageLimitBreachActionenum	Variable
UsageLimitFeatureType	TypeAlias
UsageLimitFeatureTypeenum	Variable
UsageLimitLimitType	TypeAlias
UsageLimitLimitTypeenum	Variable
UsageLimitList	Interface
UsageLimitNotFoundFault	Class
UsageLimitPeriod	TypeAlias
UsageLimitPeriodenum	Variable
VpcEndpoint	Interface
VpcSecurityGroupMembership	Interface
waitForClusterAvailabledeprecated	Variable
waitForClusterDeleteddeprecated	Variable
waitForClusterRestoreddeprecated	Variable
waitForSnapshotAvailabledeprecated	Variable
waitUntilClusterAvailable	Variable
waitUntilClusterDeleted	Variable
waitUntilClusterRestored	Variable
waitUntilSnapshotAvailable	Variable
ZeroETLIntegrationStatus	TypeAlias
ZeroETLIntegrationStatusenum	Variable

Getting Started

References

@aws-sdk/client-redshift

Description

Installation

Types

Table of Contents

Search