We are excited to announce our new API Documentation.
Rest
...__namedParameters: [] | [RedshiftClientConfig]Readonly
configThe resolved configuration of RedshiftClient class. This is resolved and normalized from the constructor configuration interface.
Optional
options: HttpHandlerOptionsOptional
data: AcceptReservedNodeExchangeCommandOutputOptional
data: AcceptReservedNodeExchangeCommandOutputOptional
options: HttpHandlerOptionsOptional
data: AddPartnerCommandOutputOptional
data: AddPartnerCommandOutputOptional
options: HttpHandlerOptionsOptional
data: AssociateDataShareConsumerCommandOutputOptional
data: AssociateDataShareConsumerCommandOutputOptional
options: HttpHandlerOptionsOptional
data: AuthorizeClusterSecurityGroupIngressCommandOutputOptional
data: AuthorizeClusterSecurityGroupIngressCommandOutputOptional
options: HttpHandlerOptionsOptional
data: AuthorizeDataShareCommandOutputOptional
data: AuthorizeDataShareCommandOutputOptional
options: HttpHandlerOptionsOptional
data: AuthorizeEndpointAccessCommandOutputOptional
data: AuthorizeEndpointAccessCommandOutputOptional
options: HttpHandlerOptionsOptional
data: AuthorizeSnapshotAccessCommandOutputOptional
data: AuthorizeSnapshotAccessCommandOutputOptional
options: HttpHandlerOptionsOptional
data: BatchDeleteClusterSnapshotsCommandOutputOptional
data: BatchDeleteClusterSnapshotsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: BatchModifyClusterSnapshotsCommandOutputOptional
data: BatchModifyClusterSnapshotsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CancelResizeCommandOutputOptional
data: CancelResizeCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CopyClusterSnapshotCommandOutputOptional
data: CopyClusterSnapshotCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateAuthenticationProfileCommandOutputOptional
data: CreateAuthenticationProfileCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateClusterCommandOutputOptional
data: CreateClusterCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateClusterParameterGroupCommandOutputOptional
data: CreateClusterParameterGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateClusterSecurityGroupCommandOutputOptional
data: CreateClusterSecurityGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateClusterSnapshotCommandOutputOptional
data: CreateClusterSnapshotCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateClusterSubnetGroupCommandOutputOptional
data: CreateClusterSubnetGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateCustomDomainAssociationCommandOutputOptional
data: CreateCustomDomainAssociationCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateEndpointAccessCommandOutputOptional
data: CreateEndpointAccessCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateEventSubscriptionCommandOutputOptional
data: CreateEventSubscriptionCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateHsmClientCertificateCommandOutputOptional
data: CreateHsmClientCertificateCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateHsmConfigurationCommandOutputOptional
data: CreateHsmConfigurationCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateScheduledActionCommandOutputOptional
data: CreateScheduledActionCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateSnapshotCopyGrantCommandOutputOptional
data: CreateSnapshotCopyGrantCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateSnapshotScheduleCommandOutputOptional
data: CreateSnapshotScheduleCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateTagsCommandOutputOptional
data: CreateTagsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateUsageLimitCommandOutputOptional
data: CreateUsageLimitCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeauthorizeDataShareCommandOutputOptional
data: DeauthorizeDataShareCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteAuthenticationProfileCommandOutputOptional
data: DeleteAuthenticationProfileCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteClusterCommandOutputOptional
data: DeleteClusterCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteClusterParameterGroupCommandOutputOptional
data: DeleteClusterParameterGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteClusterSecurityGroupCommandOutputOptional
data: DeleteClusterSecurityGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteClusterSnapshotCommandOutputOptional
data: DeleteClusterSnapshotCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteClusterSubnetGroupCommandOutputOptional
data: DeleteClusterSubnetGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteCustomDomainAssociationCommandOutputOptional
data: DeleteCustomDomainAssociationCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteEndpointAccessCommandOutputOptional
data: DeleteEndpointAccessCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteEventSubscriptionCommandOutputOptional
data: DeleteEventSubscriptionCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteHsmClientCertificateCommandOutputOptional
data: DeleteHsmClientCertificateCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteHsmConfigurationCommandOutputOptional
data: DeleteHsmConfigurationCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeletePartnerCommandOutputOptional
data: DeletePartnerCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteScheduledActionCommandOutputOptional
data: DeleteScheduledActionCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteSnapshotCopyGrantCommandOutputOptional
data: DeleteSnapshotCopyGrantCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteSnapshotScheduleCommandOutputOptional
data: DeleteSnapshotScheduleCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteTagsCommandOutputOptional
data: DeleteTagsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteUsageLimitCommandOutputOptional
data: DeleteUsageLimitCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeAccountAttributesCommandOutputOptional
data: DescribeAccountAttributesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeAuthenticationProfilesCommandOutputOptional
data: DescribeAuthenticationProfilesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeClusterDbRevisionsCommandOutputOptional
data: DescribeClusterDbRevisionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeClusterParameterGroupsCommandOutputOptional
data: DescribeClusterParameterGroupsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeClusterParametersCommandOutputOptional
data: DescribeClusterParametersCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeClusterSecurityGroupsCommandOutputOptional
data: DescribeClusterSecurityGroupsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeClusterSnapshotsCommandOutputOptional
data: DescribeClusterSnapshotsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeClusterSubnetGroupsCommandOutputOptional
data: DescribeClusterSubnetGroupsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeClusterTracksCommandOutputOptional
data: DescribeClusterTracksCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeClusterVersionsCommandOutputOptional
data: DescribeClusterVersionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeClustersCommandOutputOptional
data: DescribeClustersCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeCustomDomainAssociationsCommandOutputOptional
data: DescribeCustomDomainAssociationsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeDataSharesCommandOutputOptional
data: DescribeDataSharesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeDataSharesForConsumerCommandOutputOptional
data: DescribeDataSharesForConsumerCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeDataSharesForProducerCommandOutputOptional
data: DescribeDataSharesForProducerCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeDefaultClusterParametersCommandOutputOptional
data: DescribeDefaultClusterParametersCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeEndpointAccessCommandOutputOptional
data: DescribeEndpointAccessCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeEndpointAuthorizationCommandOutputOptional
data: DescribeEndpointAuthorizationCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeEventCategoriesCommandOutputOptional
data: DescribeEventCategoriesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeEventSubscriptionsCommandOutputOptional
data: DescribeEventSubscriptionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeEventsCommandOutputOptional
data: DescribeEventsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeHsmClientCertificatesCommandOutputOptional
data: DescribeHsmClientCertificatesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeHsmConfigurationsCommandOutputOptional
data: DescribeHsmConfigurationsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeLoggingStatusCommandOutputOptional
data: DescribeLoggingStatusCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeNodeConfigurationOptionsCommandOutputOptional
data: DescribeNodeConfigurationOptionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeOrderableClusterOptionsCommandOutputOptional
data: DescribeOrderableClusterOptionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribePartnersCommandOutputOptional
data: DescribePartnersCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeReservedNodeExchangeStatusCommandOutputOptional
data: DescribeReservedNodeExchangeStatusCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeReservedNodeOfferingsCommandOutputOptional
data: DescribeReservedNodeOfferingsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeReservedNodesCommandOutputOptional
data: DescribeReservedNodesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeResizeCommandOutputOptional
data: DescribeResizeCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeScheduledActionsCommandOutputOptional
data: DescribeScheduledActionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeSnapshotCopyGrantsCommandOutputOptional
data: DescribeSnapshotCopyGrantsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeSnapshotSchedulesCommandOutputOptional
data: DescribeSnapshotSchedulesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeStorageCommandOutputOptional
data: DescribeStorageCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeTableRestoreStatusCommandOutputOptional
data: DescribeTableRestoreStatusCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeTagsCommandOutputOptional
data: DescribeTagsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeUsageLimitsCommandOutputOptional
data: DescribeUsageLimitsCommandOutputDestroy 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.
Optional
options: HttpHandlerOptionsOptional
data: DisableLoggingCommandOutputOptional
data: DisableLoggingCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DisableSnapshotCopyCommandOutputOptional
data: DisableSnapshotCopyCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DisassociateDataShareConsumerCommandOutputOptional
data: DisassociateDataShareConsumerCommandOutputOptional
options: HttpHandlerOptionsOptional
data: EnableLoggingCommandOutputOptional
data: EnableLoggingCommandOutputOptional
options: HttpHandlerOptionsOptional
data: EnableSnapshotCopyCommandOutputOptional
data: EnableSnapshotCopyCommandOutput
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.