AWS SDK for .NET Documentation
AmazonRedshiftClient Class
AmazonAmazon.RedshiftAmazonRedshiftClient Did this page help you?   Yes   No    Tell us about it...
Implementation for accessing Redshift 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 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.

Declaration Syntax
C#
public class AmazonRedshiftClient : AmazonWebServiceClient, 
	AmazonRedshift, IDisposable
Members
All MembersConstructorsMethodsEvents



IconMemberDescription
AmazonRedshiftClient()()()()
Constructs AmazonRedshiftClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonRedshiftClient(RegionEndpoint)
Constructs AmazonRedshiftClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonRedshiftClient(AmazonRedshiftConfig)
Constructs AmazonRedshiftClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonRedshiftClient(AWSCredentials)
Constructs AmazonRedshiftClient with AWS Credentials

AmazonRedshiftClient(AWSCredentials, RegionEndpoint)
Constructs AmazonRedshiftClient with AWS Credentials

AmazonRedshiftClient(AWSCredentials, AmazonRedshiftConfig)
Constructs AmazonRedshiftClient with AWS Credentials and an AmazonRedshiftClient Configuration object.

AmazonRedshiftClient(String, String)
Constructs AmazonRedshiftClient with AWS Access Key ID and AWS Secret Key

AmazonRedshiftClient(String, String, RegionEndpoint)
Constructs AmazonRedshiftClient with AWS Access Key ID and AWS Secret Key

AmazonRedshiftClient(String, String, AmazonRedshiftConfig)
Constructs AmazonRedshiftClient with AWS Access Key ID, AWS Secret Key and an AmazonRedshiftClient Configuration object.

AmazonRedshiftClient(String, String, String)
Constructs AmazonRedshiftClient with AWS Access Key ID and AWS Secret Key

AmazonRedshiftClient(String, String, String, RegionEndpoint)
Constructs AmazonRedshiftClient with AWS Access Key ID and AWS Secret Key

AmazonRedshiftClient(String, String, String, AmazonRedshiftConfig)
Constructs AmazonRedshiftClient with AWS Access Key ID, AWS Secret Key and an AmazonRedshiftClient Configuration object.

AfterResponseEvent
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.)
AuthorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest)
Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR) IP address range or an EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
Note:
The EC2 security group must be defined in the AWS region where the cluster resides.

For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.

You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Management Guide.


AuthorizeSnapshotAccess(AuthorizeSnapshotAccessRequest)
Authorizes the specified AWS customer account to restore the specified snapshot.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Management Guide.


BeforeRequestEvent
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.)
BeginAuthorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AuthorizeClusterSecurityGroupIngress operation.

BeginAuthorizeSnapshotAccess(AuthorizeSnapshotAccessRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the AuthorizeSnapshotAccess operation.

BeginCopyClusterSnapshot(CopyClusterSnapshotRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CopyClusterSnapshot operation.

BeginCreateCluster(CreateClusterRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateCluster operation.

BeginCreateClusterParameterGroup(CreateClusterParameterGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateClusterParameterGroup operation.

BeginCreateClusterSecurityGroup(CreateClusterSecurityGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateClusterSecurityGroup operation.

BeginCreateClusterSnapshot(CreateClusterSnapshotRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateClusterSnapshot operation.

BeginCreateClusterSubnetGroup(CreateClusterSubnetGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateClusterSubnetGroup operation.

BeginCreateEventSubscription(CreateEventSubscriptionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateEventSubscription operation.

BeginCreateHsmClientCertificate(CreateHsmClientCertificateRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateHsmClientCertificate operation.

BeginCreateHsmConfiguration(CreateHsmConfigurationRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateHsmConfiguration operation.

BeginDeleteCluster(DeleteClusterRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteCluster operation.

BeginDeleteClusterParameterGroup(DeleteClusterParameterGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteClusterParameterGroup operation.

BeginDeleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteClusterSecurityGroup operation.

BeginDeleteClusterSnapshot(DeleteClusterSnapshotRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteClusterSnapshot operation.

BeginDeleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteClusterSubnetGroup operation.

BeginDeleteEventSubscription(DeleteEventSubscriptionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteEventSubscription operation.

BeginDeleteHsmClientCertificate(DeleteHsmClientCertificateRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteHsmClientCertificate operation.

BeginDeleteHsmConfiguration(DeleteHsmConfigurationRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteHsmConfiguration operation.

BeginDescribeClusterParameterGroups(DescribeClusterParameterGroupsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeClusterParameterGroups operation.

BeginDescribeClusterParameters(DescribeClusterParametersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeClusterParameters operation.

BeginDescribeClusters(DescribeClustersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeClusters operation.

BeginDescribeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeClusterSecurityGroups operation.

BeginDescribeClusterSnapshots(DescribeClusterSnapshotsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeClusterSnapshots operation.

BeginDescribeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeClusterSubnetGroups operation.

BeginDescribeClusterVersions(DescribeClusterVersionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeClusterVersions operation.

BeginDescribeDefaultClusterParameters(DescribeDefaultClusterParametersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeDefaultClusterParameters operation.

BeginDescribeEventCategories(DescribeEventCategoriesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeEventCategories operation.

BeginDescribeEvents(DescribeEventsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeEvents operation.

BeginDescribeEventSubscriptions(DescribeEventSubscriptionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeEventSubscriptions operation.

BeginDescribeHsmClientCertificates(DescribeHsmClientCertificatesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeHsmClientCertificates operation.

BeginDescribeHsmConfigurations(DescribeHsmConfigurationsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeHsmConfigurations operation.

BeginDescribeLoggingStatus(DescribeLoggingStatusRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeLoggingStatus operation.

BeginDescribeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeOrderableClusterOptions operation.

BeginDescribeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeReservedNodeOfferings operation.

BeginDescribeReservedNodes(DescribeReservedNodesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeReservedNodes operation.

BeginDescribeResize(DescribeResizeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeResize operation.

BeginDisableLogging(DisableLoggingRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DisableLogging operation.

BeginDisableSnapshotCopy(DisableSnapshotCopyRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DisableSnapshotCopy operation.

BeginEnableLogging(EnableLoggingRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the EnableLogging operation.

BeginEnableSnapshotCopy(EnableSnapshotCopyRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the EnableSnapshotCopy operation.

BeginModifyCluster(ModifyClusterRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ModifyCluster operation.

BeginModifyClusterParameterGroup(ModifyClusterParameterGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ModifyClusterParameterGroup operation.

BeginModifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ModifyClusterSubnetGroup operation.

BeginModifyEventSubscription(ModifyEventSubscriptionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ModifyEventSubscription operation.

BeginModifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ModifySnapshotCopyRetentionPeriod operation.

BeginPurchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the PurchaseReservedNodeOffering operation.

BeginRebootCluster(RebootClusterRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RebootCluster operation.

BeginResetClusterParameterGroup(ResetClusterParameterGroupRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ResetClusterParameterGroup operation.

BeginRestoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RestoreFromClusterSnapshot operation.

BeginRevokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RevokeClusterSecurityGroupIngress operation.

BeginRevokeSnapshotAccess(RevokeSnapshotAccessRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RevokeSnapshotAccess operation.

BeginRotateEncryptionKey(RotateEncryptionKeyRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RotateEncryptionKey operation.

CopyClusterSnapshot(CopyClusterSnapshotRequest)
Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.

When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Management Guide.


CreateCluster(CreateClusterRequest)
Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide.

CreateClusterParameterGroup(CreateClusterParameterGroupRequest)
Creates an Amazon Redshift parameter group.

Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.

Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.


CreateClusterSecurityGroup(CreateClusterSecurityGroupRequest)
Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.

For information about managing security groups, go toAmazon Redshift Cluster Security Groups in the Amazon Redshift Management Guide.


CreateClusterSnapshot(CreateClusterSnapshotRequest)
Creates a manual snapshot of the specified cluster. The cluster must be in the
CopyC#
available
state.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Management Guide.


CreateClusterSubnetGroup(CreateClusterSubnetGroupRequest)
Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.

For information about subnet groups, go toAmazon Redshift Cluster Subnet Groups in the Amazon Redshift Management Guide.


CreateEventSubscription(CreateEventSubscriptionRequest)
Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.


CreateHsmClientCertificate(CreateHsmClientCertificateRequest)
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.

The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Management Guide.


CreateHsmConfiguration(CreateHsmConfigurationRequest)
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Management Guide.


DeleteCluster(DeleteClusterRequest)
Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. If a final cluster snapshot is requested the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide.

DeleteClusterParameterGroup(DeleteClusterParameterGroupRequest)
Deletes a specified Amazon Redshift parameter group.
Note:
You cannot delete a parameter group if it is associated with a cluster.

DeleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest)
Deletes an Amazon Redshift security group.
Note:
You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.

For information about managing security groups, go toAmazon Redshift Cluster Security Groups in the Amazon Redshift Management Guide.


DeleteClusterSnapshot(DeleteClusterSnapshotRequest)
Deletes the specified manual snapshot. The snapshot must be in the
CopyC#
available
state, with no other users authorized to access the snapshot.

Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.


DeleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest)
Deletes the specified cluster subnet group.

DeleteEventSubscription(DeleteEventSubscriptionRequest)
Deletes an Amazon Redshift event notification subscription.

DeleteHsmClientCertificate(DeleteHsmClientCertificateRequest)
Deletes the specified HSM client certificate.

DeleteHsmConfiguration(DeleteHsmConfigurationRequest)
Deletes the specified Amazon Redshift HSM configuration.

DescribeClusterParameterGroups()()()()
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.


DescribeClusterParameterGroups(DescribeClusterParameterGroupsRequest)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.


DescribeClusterParameters(DescribeClusterParametersRequest)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.


DescribeClusters()()()()
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide.

DescribeClusters(DescribeClustersRequest)
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide.

DescribeClusterSecurityGroups()()()()
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

For information about managing security groups, go toAmazon Redshift Cluster Security Groups in the Amazon Redshift Management Guide.


DescribeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest)
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

For information about managing security groups, go toAmazon Redshift Cluster Security Groups in the Amazon Redshift Management Guide.


DescribeClusterSnapshots()()()()
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.

DescribeClusterSnapshots(DescribeClusterSnapshotsRequest)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.

DescribeClusterSubnetGroups()()()()
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.

DescribeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.

DescribeClusterVersions()()()()
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide

DescribeClusterVersions(DescribeClusterVersionsRequest)
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide

DescribeDefaultClusterParameters(DescribeDefaultClusterParametersRequest)
Returns a list of parameter settings for the specified parameter group family.

For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.


DescribeEventCategories()()()()
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.

DescribeEventCategories(DescribeEventCategoriesRequest)
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.

DescribeEvents()()()()
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

DescribeEvents(DescribeEventsRequest)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

DescribeEventSubscriptions()()()()
Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription.

DescribeEventSubscriptions(DescribeEventSubscriptionsRequest)
Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription.

DescribeHsmClientCertificates()()()()
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.

DescribeHsmClientCertificates(DescribeHsmClientCertificatesRequest)
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.

DescribeHsmConfigurations()()()()
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.

DescribeHsmConfigurations(DescribeHsmConfigurationsRequest)
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.

DescribeLoggingStatus(DescribeLoggingStatusRequest)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

DescribeOrderableClusterOptions()()()()
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide

DescribeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest)
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide

DescribeReservedNodeOfferings()()()()
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.

For more information about managing parameter groups, go to Purchasing Reserved Nodes in the Amazon Redshift Management Guide.


DescribeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest)
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.

For more information about managing parameter groups, go to Purchasing Reserved Nodes in the Amazon Redshift Management Guide.


DescribeReservedNodes()()()()
Returns the descriptions of the reserved nodes.

DescribeReservedNodes(DescribeReservedNodesRequest)
Returns the descriptions of the reserved nodes.

DescribeResize(DescribeResizeRequest)
Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a
CopyC#
HTTP 404
error is returned. If a resize operation was initiated and completed, the status of the resize remains as
CopyC#
SUCCEEDED
until the next resize.

A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.


DisableLogging(DisableLoggingRequest)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

DisableSnapshotCopy(DisableSnapshotCopyRequest)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.

Dispose()()()()
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.)
EnableLogging(EnableLoggingRequest)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

EnableSnapshotCopy(EnableSnapshotCopyRequest)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.

EndAuthorizeClusterSecurityGroupIngress(IAsyncResult)
Finishes the asynchronous execution of the AuthorizeClusterSecurityGroupIngress operation.

EndAuthorizeSnapshotAccess(IAsyncResult)
Finishes the asynchronous execution of the AuthorizeSnapshotAccess operation.

EndCopyClusterSnapshot(IAsyncResult)
Finishes the asynchronous execution of the CopyClusterSnapshot operation.

EndCreateCluster(IAsyncResult)
Finishes the asynchronous execution of the CreateCluster operation.

EndCreateClusterParameterGroup(IAsyncResult)
Finishes the asynchronous execution of the CreateClusterParameterGroup operation.

EndCreateClusterSecurityGroup(IAsyncResult)
Finishes the asynchronous execution of the CreateClusterSecurityGroup operation.

EndCreateClusterSnapshot(IAsyncResult)
Finishes the asynchronous execution of the CreateClusterSnapshot operation.

EndCreateClusterSubnetGroup(IAsyncResult)
Finishes the asynchronous execution of the CreateClusterSubnetGroup operation.

EndCreateEventSubscription(IAsyncResult)
Finishes the asynchronous execution of the CreateEventSubscription operation.

EndCreateHsmClientCertificate(IAsyncResult)
Finishes the asynchronous execution of the CreateHsmClientCertificate operation.

EndCreateHsmConfiguration(IAsyncResult)
Finishes the asynchronous execution of the CreateHsmConfiguration operation.

EndDeleteCluster(IAsyncResult)
Finishes the asynchronous execution of the DeleteCluster operation.

EndDeleteClusterParameterGroup(IAsyncResult)
Finishes the asynchronous execution of the DeleteClusterParameterGroup operation.

EndDeleteClusterSecurityGroup(IAsyncResult)
Finishes the asynchronous execution of the DeleteClusterSecurityGroup operation.

EndDeleteClusterSnapshot(IAsyncResult)
Finishes the asynchronous execution of the DeleteClusterSnapshot operation.

EndDeleteClusterSubnetGroup(IAsyncResult)
Finishes the asynchronous execution of the DeleteClusterSubnetGroup operation.

EndDeleteEventSubscription(IAsyncResult)
Finishes the asynchronous execution of the DeleteEventSubscription operation.

EndDeleteHsmClientCertificate(IAsyncResult)
Finishes the asynchronous execution of the DeleteHsmClientCertificate operation.

EndDeleteHsmConfiguration(IAsyncResult)
Finishes the asynchronous execution of the DeleteHsmConfiguration operation.

EndDescribeClusterParameterGroups(IAsyncResult)
Finishes the asynchronous execution of the DescribeClusterParameterGroups operation.

EndDescribeClusterParameters(IAsyncResult)
Finishes the asynchronous execution of the DescribeClusterParameters operation.

EndDescribeClusters(IAsyncResult)
Finishes the asynchronous execution of the DescribeClusters operation.

EndDescribeClusterSecurityGroups(IAsyncResult)
Finishes the asynchronous execution of the DescribeClusterSecurityGroups operation.

EndDescribeClusterSnapshots(IAsyncResult)
Finishes the asynchronous execution of the DescribeClusterSnapshots operation.

EndDescribeClusterSubnetGroups(IAsyncResult)
Finishes the asynchronous execution of the DescribeClusterSubnetGroups operation.

EndDescribeClusterVersions(IAsyncResult)
Finishes the asynchronous execution of the DescribeClusterVersions operation.

EndDescribeDefaultClusterParameters(IAsyncResult)
Finishes the asynchronous execution of the DescribeDefaultClusterParameters operation.

EndDescribeEventCategories(IAsyncResult)
Finishes the asynchronous execution of the DescribeEventCategories operation.

EndDescribeEvents(IAsyncResult)
Finishes the asynchronous execution of the DescribeEvents operation.

EndDescribeEventSubscriptions(IAsyncResult)
Finishes the asynchronous execution of the DescribeEventSubscriptions operation.

EndDescribeHsmClientCertificates(IAsyncResult)
Finishes the asynchronous execution of the DescribeHsmClientCertificates operation.

EndDescribeHsmConfigurations(IAsyncResult)
Finishes the asynchronous execution of the DescribeHsmConfigurations operation.

EndDescribeLoggingStatus(IAsyncResult)
Finishes the asynchronous execution of the DescribeLoggingStatus operation.

EndDescribeOrderableClusterOptions(IAsyncResult)
Finishes the asynchronous execution of the DescribeOrderableClusterOptions operation.

EndDescribeReservedNodeOfferings(IAsyncResult)
Finishes the asynchronous execution of the DescribeReservedNodeOfferings operation.

EndDescribeReservedNodes(IAsyncResult)
Finishes the asynchronous execution of the DescribeReservedNodes operation.

EndDescribeResize(IAsyncResult)
Finishes the asynchronous execution of the DescribeResize operation.

EndDisableLogging(IAsyncResult)
Finishes the asynchronous execution of the DisableLogging operation.

EndDisableSnapshotCopy(IAsyncResult)
Finishes the asynchronous execution of the DisableSnapshotCopy operation.

EndEnableLogging(IAsyncResult)
Finishes the asynchronous execution of the EnableLogging operation.

EndEnableSnapshotCopy(IAsyncResult)
Finishes the asynchronous execution of the EnableSnapshotCopy operation.

EndModifyCluster(IAsyncResult)
Finishes the asynchronous execution of the ModifyCluster operation.

EndModifyClusterParameterGroup(IAsyncResult)
Finishes the asynchronous execution of the ModifyClusterParameterGroup operation.

EndModifyClusterSubnetGroup(IAsyncResult)
Finishes the asynchronous execution of the ModifyClusterSubnetGroup operation.

EndModifyEventSubscription(IAsyncResult)
Finishes the asynchronous execution of the ModifyEventSubscription operation.

EndModifySnapshotCopyRetentionPeriod(IAsyncResult)
Finishes the asynchronous execution of the ModifySnapshotCopyRetentionPeriod operation.

EndPurchaseReservedNodeOffering(IAsyncResult)
Finishes the asynchronous execution of the PurchaseReservedNodeOffering operation.

EndRebootCluster(IAsyncResult)
Finishes the asynchronous execution of the RebootCluster operation.

EndResetClusterParameterGroup(IAsyncResult)
Finishes the asynchronous execution of the ResetClusterParameterGroup operation.

EndRestoreFromClusterSnapshot(IAsyncResult)
Finishes the asynchronous execution of the RestoreFromClusterSnapshot operation.

EndRevokeClusterSecurityGroupIngress(IAsyncResult)
Finishes the asynchronous execution of the RevokeClusterSecurityGroupIngress operation.

EndRevokeSnapshotAccess(IAsyncResult)
Finishes the asynchronous execution of the RevokeSnapshotAccess operation.

EndRotateEncryptionKey(IAsyncResult)
Finishes the asynchronous execution of the RotateEncryptionKey operation.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExceptionEvent
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
ModifyCluster(ModifyClusterRequest)
Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide

You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. If you specify the same number of nodes and node type that are already configured for the cluster, an error is returned.


ModifyClusterParameterGroup(ModifyClusterParameterGroupRequest)
Modifies the parameters of a parameter group.

For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.


ModifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest)
Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.

ModifyEventSubscription(ModifyEventSubscriptionRequest)
Modifies an existing Amazon Redshift event notification subscription.

ModifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest)
Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.

PurchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest)
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.

For more information about managing parameter groups, go to Purchasing Reserved Nodes in the Amazon Redshift Management Guide.


RebootCluster(RebootClusterRequest)
Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to
CopyC#
rebooting
. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide

ResetClusterParameterGroup(ResetClusterParameterGroupRequest)
Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

RestoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest)
Creates a new cluster from a snapshot. Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter group. After Amazon Redshift creates the cluster you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster.

If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Management Guide.


RevokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest)
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go toAmazon Redshift Cluster Security Groups in the Amazon Redshift Management Guide.

RevokeSnapshotAccess(RevokeSnapshotAccessRequest)
Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Management Guide.


RotateEncryptionKey(RotateEncryptionKeyRequest)
Rotates the encryption keys for a cluster.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Inheritance Hierarchy
Object
AmazonWebServiceClient
 AmazonRedshiftClient

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)