com.amazonaws.services.redshift

Interface AmazonRedshift

All Known Subinterfaces:

AmazonRedshiftAsync

All Known Implementing Classes:

AmazonRedshiftAsyncClient, AmazonRedshiftClient

public interface AmazonRedshift

Interface for accessing AmazonRedshift. 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.

Method Summary

Methods

Modifier and Type	Method and Description
ClusterSecurityGroup	authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest) Adds an inbound (ingress) rule to an Amazon Redshift security group.
Snapshot	authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest) Authorizes the specified AWS customer account to restore the specified snapshot.
Snapshot	copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest) Copies the specified automated cluster snapshot to a new manual cluster snapshot.
Cluster	createCluster(CreateClusterRequest createClusterRequest) Creates a new cluster.
ClusterParameterGroup	createClusterParameterGroup(CreateClusterParameterGroupRequest createClusterParameterGroupRequest) Creates an Amazon Redshift parameter group.
ClusterSecurityGroup	createClusterSecurityGroup(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest) Creates a new Amazon Redshift security group.
Snapshot	createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest) Creates a manual snapshot of the specified cluster.
ClusterSubnetGroup	createClusterSubnetGroup(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest) Creates a new Amazon Redshift subnet group.
EventSubscription	createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an Amazon Redshift event notification subscription.
HsmClientCertificate	createHsmClientCertificate(CreateHsmClientCertificateRequest 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.
HsmConfiguration	createHsmConfiguration(CreateHsmConfigurationRequest 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).
Cluster	deleteCluster(DeleteClusterRequest deleteClusterRequest) Deletes a previously provisioned cluster.
void	deleteClusterParameterGroup(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest) Deletes a specified Amazon Redshift parameter group.
void	deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest) Deletes an Amazon Redshift security group.
Snapshot	deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest) Deletes the specified manual snapshot.
void	deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest) Deletes the specified cluster subnet group.
void	deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an Amazon Redshift event notification subscription.
void	deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest) Deletes the specified HSM client certificate.
void	deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest) Deletes the specified Amazon Redshift HSM configuration.
DescribeClusterParameterGroupsResult	describeClusterParameterGroups() Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.
DescribeClusterParameterGroupsResult	describeClusterParameterGroups(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.
DescribeClusterParametersResult	describeClusterParameters(DescribeClusterParametersRequest describeClusterParametersRequest) Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
DescribeClustersResult	describeClusters() Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties.
DescribeClustersResult	describeClusters(DescribeClustersRequest describeClustersRequest) Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties.
DescribeClusterSecurityGroupsResult	describeClusterSecurityGroups() Returns information about Amazon Redshift security groups.
DescribeClusterSecurityGroupsResult	describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) Returns information about Amazon Redshift security groups.
DescribeClusterSnapshotsResult	describeClusterSnapshots() Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
DescribeClusterSnapshotsResult	describeClusterSnapshots(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
DescribeClusterSubnetGroupsResult	describeClusterSubnetGroups() Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
DescribeClusterSubnetGroupsResult	describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
DescribeClusterVersionsResult	describeClusterVersions() Returns descriptions of the available Amazon Redshift cluster versions.
DescribeClusterVersionsResult	describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest) Returns descriptions of the available Amazon Redshift cluster versions.
DefaultClusterParameters	describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) Returns a list of parameter settings for the specified parameter group family.
DescribeEventCategoriesResult	describeEventCategories() Displays a list of event categories for all event source types, or for a specified source type.
DescribeEventCategoriesResult	describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of event categories for all event source types, or for a specified source type.
DescribeEventsResult	describeEvents() Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
DescribeEventsResult	describeEvents(DescribeEventsRequest describeEventsRequest) Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
DescribeEventSubscriptionsResult	describeEventSubscriptions() Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account.
DescribeEventSubscriptionsResult	describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account.
DescribeHsmClientCertificatesResult	describeHsmClientCertificates() Returns information about the specified HSM client certificate.
DescribeHsmClientCertificatesResult	describeHsmClientCertificates(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) Returns information about the specified HSM client certificate.
DescribeHsmConfigurationsResult	describeHsmConfigurations() Returns information about the specified Amazon Redshift HSM configuration.
DescribeHsmConfigurationsResult	describeHsmConfigurations(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) Returns information about the specified Amazon Redshift HSM configuration.
DescribeLoggingStatusResult	describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest) Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
DescribeOrderableClusterOptionsResult	describeOrderableClusterOptions() Returns a list of orderable cluster options.
DescribeOrderableClusterOptionsResult	describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) Returns a list of orderable cluster options.
DescribeReservedNodeOfferingsResult	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.
DescribeReservedNodeOfferingsResult	describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest 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.
DescribeReservedNodesResult	describeReservedNodes() Returns the descriptions of the reserved nodes.
DescribeReservedNodesResult	describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest) Returns the descriptions of the reserved nodes.
DescribeResizeResult	describeResize(DescribeResizeRequest describeResizeRequest) Returns information about the last resize operation for the specified cluster.
DisableLoggingResult	disableLogging(DisableLoggingRequest disableLoggingRequest) Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
Cluster	disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest) Disables the automatic copying of snapshots from one region to another region for a specified cluster.
EnableLoggingResult	enableLogging(EnableLoggingRequest enableLoggingRequest) Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
Cluster	enableSnapshotCopy(EnableSnapshotCopyRequest enableSnapshotCopyRequest) Enables the automatic copy of snapshots from one region to another region for a specified cluster.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
Cluster	modifyCluster(ModifyClusterRequest modifyClusterRequest) Modifies the settings for a cluster.
ModifyClusterParameterGroupResult	modifyClusterParameterGroup(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest) Modifies the parameters of a parameter group.
ClusterSubnetGroup	modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest modifyClusterSubnetGroupRequest) Modifies a cluster subnet group to include the specified list of VPC subnets.
EventSubscription	modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing Amazon Redshift event notification subscription.
Cluster	modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest) Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
ReservedNode	purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest purchaseReservedNodeOfferingRequest) Allows you to purchase reserved nodes.
Cluster	rebootCluster(RebootClusterRequest rebootClusterRequest) Reboots a cluster.
ResetClusterParameterGroupResult	resetClusterParameterGroup(ResetClusterParameterGroupRequest 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".
Cluster	restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest) Creates a new cluster from a snapshot.
ClusterSecurityGroup	revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest) Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group.
Snapshot	revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest) Removes the ability of the specified AWS customer account to restore the specified snapshot.
Cluster	rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest) Rotates the encryption keys for a cluster.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://redshift.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://redshift.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "redshift.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://redshift.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "redshift.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://redshift.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

revokeSnapshotAccess

Snapshot revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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 .

Parameters:

revokeSnapshotAccessRequest - Container for the necessary parameters to execute the RevokeSnapshotAccess service method on AmazonRedshift.

Returns:

The response from the RevokeSnapshotAccess service method, as returned by AmazonRedshift.

Throws:

AccessToSnapshotDeniedException

ClusterSnapshotNotFoundException

AuthorizationNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

modifySnapshotCopyRetentionPeriod

Cluster modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

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

Parameters:

modifySnapshotCopyRetentionPeriodRequest - Container for the necessary parameters to execute the ModifySnapshotCopyRetentionPeriod service method on AmazonRedshift.

Returns:

The response from the ModifySnapshotCopyRetentionPeriod service method, as returned by AmazonRedshift.

Throws:

SnapshotCopyDisabledException

UnauthorizedOperationException

InvalidClusterStateException

ClusterNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

modifyClusterSubnetGroup

ClusterSubnetGroup modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest modifyClusterSubnetGroupRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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.

Parameters:

modifyClusterSubnetGroupRequest - Container for the necessary parameters to execute the ModifyClusterSubnetGroup service method on AmazonRedshift.

Returns:

The response from the ModifyClusterSubnetGroup service method, as returned by AmazonRedshift.

Throws:

SubnetAlreadyInUseException

InvalidSubnetException

UnauthorizedOperationException

ClusterSubnetQuotaExceededException

ClusterSubnetGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

deleteHsmConfiguration

void deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes the specified Amazon Redshift HSM configuration.

Parameters:

deleteHsmConfigurationRequest - Container for the necessary parameters to execute the DeleteHsmConfiguration service method on AmazonRedshift.

Throws:

HsmConfigurationNotFoundException

InvalidHsmConfigurationStateException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

purchaseReservedNodeOffering

ReservedNode purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest purchaseReservedNodeOfferingRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

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 .

Parameters:

purchaseReservedNodeOfferingRequest - Container for the necessary parameters to execute the PurchaseReservedNodeOffering service method on AmazonRedshift.

Returns:

The response from the PurchaseReservedNodeOffering service method, as returned by AmazonRedshift.

Throws:

ReservedNodeAlreadyExistsException

ReservedNodeOfferingNotFoundException

ReservedNodeQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

disableLogging

DisableLoggingResult disableLogging(DisableLoggingRequest disableLoggingRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

Parameters:

disableLoggingRequest - Container for the necessary parameters to execute the DisableLogging service method on AmazonRedshift.

Returns:

The response from the DisableLogging service method, as returned by AmazonRedshift.

Throws:

ClusterNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

modifyCluster

Cluster modifyCluster(ModifyClusterRequest modifyClusterRequest)
                      throws AmazonServiceException,
                             AmazonClientException

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.

Parameters:

modifyClusterRequest - Container for the necessary parameters to execute the ModifyCluster service method on AmazonRedshift.

Returns:

The response from the ModifyCluster service method, as returned by AmazonRedshift.

Throws:

InvalidClusterSecurityGroupStateException

HsmConfigurationNotFoundException

InsufficientClusterCapacityException

UnauthorizedOperationException

InvalidClusterStateException

NumberOfNodesQuotaExceededException

ClusterNotFoundException

UnsupportedOptionException

ClusterSecurityGroupNotFoundException

HsmClientCertificateNotFoundException

ClusterAlreadyExistsException

ClusterParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

copyClusterSnapshot

Snapshot copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

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 .

Parameters:

copyClusterSnapshotRequest - Container for the necessary parameters to execute the CopyClusterSnapshot service method on AmazonRedshift.

Returns:

The response from the CopyClusterSnapshot service method, as returned by AmazonRedshift.

Throws:

ClusterSnapshotAlreadyExistsException

ClusterSnapshotNotFoundException

ClusterSnapshotQuotaExceededException

InvalidClusterSnapshotStateException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeOrderableClusterOptions

DescribeOrderableClusterOptionsResult describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest)
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException

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

Parameters:

describeOrderableClusterOptionsRequest - Container for the necessary parameters to execute the DescribeOrderableClusterOptions service method on AmazonRedshift.

Returns:

The response from the DescribeOrderableClusterOptions service method, as returned by AmazonRedshift.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

enableLogging

EnableLoggingResult enableLogging(EnableLoggingRequest enableLoggingRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Parameters:

enableLoggingRequest - Container for the necessary parameters to execute the EnableLogging service method on AmazonRedshift.

Returns:

The response from the EnableLogging service method, as returned by AmazonRedshift.

Throws:

InvalidS3KeyPrefixException

InvalidS3BucketNameException

BucketNotFoundException

ClusterNotFoundException

InsufficientS3BucketPolicyException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

createClusterSubnetGroup

ClusterSubnetGroup createClusterSubnetGroup(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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 to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Management Guide .

Parameters:

createClusterSubnetGroupRequest - Container for the necessary parameters to execute the CreateClusterSubnetGroup service method on AmazonRedshift.

Returns:

The response from the CreateClusterSubnetGroup service method, as returned by AmazonRedshift.

Throws:

InvalidSubnetException

UnauthorizedOperationException

ClusterSubnetQuotaExceededException

ClusterSubnetGroupAlreadyExistsException

ClusterSubnetGroupQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

deleteHsmClientCertificate

void deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Deletes the specified HSM client certificate.

Parameters:

deleteHsmClientCertificateRequest - Container for the necessary parameters to execute the DeleteHsmClientCertificate service method on AmazonRedshift.

Throws:

InvalidHsmClientCertificateStateException

HsmClientCertificateNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

rebootCluster

Cluster rebootCluster(RebootClusterRequest rebootClusterRequest)
                      throws AmazonServiceException,
                             AmazonClientException

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 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

Parameters:

rebootClusterRequest - Container for the necessary parameters to execute the RebootCluster service method on AmazonRedshift.

Returns:

The response from the RebootCluster service method, as returned by AmazonRedshift.

Throws:

InvalidClusterStateException

ClusterNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

deleteClusterSubnetGroup

void deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Deletes the specified cluster subnet group.

Parameters:

deleteClusterSubnetGroupRequest - Container for the necessary parameters to execute the DeleteClusterSubnetGroup service method on AmazonRedshift.

Throws:

InvalidClusterSubnetStateException

ClusterSubnetGroupNotFoundException

InvalidClusterSubnetGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

deleteCluster

Cluster deleteCluster(DeleteClusterRequest deleteClusterRequest)
                      throws AmazonServiceException,
                             AmazonClientException

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 .

Parameters:

deleteClusterRequest - Container for the necessary parameters to execute the DeleteCluster service method on AmazonRedshift.

Returns:

The response from the DeleteCluster service method, as returned by AmazonRedshift.

Throws:

ClusterSnapshotAlreadyExistsException

InvalidClusterStateException

ClusterNotFoundException

ClusterSnapshotQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

createClusterSnapshot

Snapshot createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Creates a manual snapshot of the specified cluster. The cluster must be in the available state.

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

Parameters:

createClusterSnapshotRequest - Container for the necessary parameters to execute the CreateClusterSnapshot service method on AmazonRedshift.

Returns:

The response from the CreateClusterSnapshot service method, as returned by AmazonRedshift.

Throws:

ClusterSnapshotAlreadyExistsException

InvalidClusterStateException

ClusterNotFoundException

ClusterSnapshotQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

createCluster

Cluster createCluster(CreateClusterRequest createClusterRequest)
                      throws AmazonServiceException,
                             AmazonClientException

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 .

Parameters:

createClusterRequest - Container for the necessary parameters to execute the CreateCluster service method on AmazonRedshift.

Returns:

The response from the CreateCluster service method, as returned by AmazonRedshift.

Throws:

InvalidElasticIpException

InvalidSubnetException

HsmConfigurationNotFoundException

ClusterSubnetGroupNotFoundException

InvalidClusterSubnetGroupStateException

ClusterAlreadyExistsException

InvalidVPCNetworkStateException

ClusterParameterGroupNotFoundException

InsufficientClusterCapacityException

UnauthorizedOperationException

NumberOfNodesQuotaExceededException

NumberOfNodesPerClusterLimitExceededException

HsmClientCertificateNotFoundException

ClusterQuotaExceededException

ClusterSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeEvents

DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Parameters:

describeEventsRequest - Container for the necessary parameters to execute the DescribeEvents service method on AmazonRedshift.

Returns:

The response from the DescribeEvents service method, as returned by AmazonRedshift.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

authorizeClusterSecurityGroupIngress

ClusterSecurityGroup authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

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 .

Parameters:

authorizeClusterSecurityGroupIngressRequest - Container for the necessary parameters to execute the AuthorizeClusterSecurityGroupIngress service method on AmazonRedshift.

Returns:

The response from the AuthorizeClusterSecurityGroupIngress service method, as returned by AmazonRedshift.

Throws:

InvalidClusterSecurityGroupStateException

AuthorizationAlreadyExistsException

AuthorizationQuotaExceededException

ClusterSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

rotateEncryptionKey

Cluster rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Rotates the encryption keys for a cluster.

Parameters:

rotateEncryptionKeyRequest - Container for the necessary parameters to execute the RotateEncryptionKey service method on AmazonRedshift.

Returns:

The response from the RotateEncryptionKey service method, as returned by AmazonRedshift.

Throws:

InvalidClusterStateException

ClusterNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

deleteClusterSecurityGroup

void deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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 to Amazon Redshift Cluster Security Groups in the Amazon Redshift Management Guide .

Parameters:

deleteClusterSecurityGroupRequest - Container for the necessary parameters to execute the DeleteClusterSecurityGroup service method on AmazonRedshift.

Throws:

InvalidClusterSecurityGroupStateException

ClusterSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeReservedNodes

DescribeReservedNodesResult describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns the descriptions of the reserved nodes.

Parameters:

describeReservedNodesRequest - Container for the necessary parameters to execute the DescribeReservedNodes service method on AmazonRedshift.

Returns:

The response from the DescribeReservedNodes service method, as returned by AmazonRedshift.

Throws:

ReservedNodeNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeDefaultClusterParameters

DefaultClusterParameters describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

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 .

Parameters:

describeDefaultClusterParametersRequest - Container for the necessary parameters to execute the DescribeDefaultClusterParameters service method on AmazonRedshift.

Returns:

The response from the DescribeDefaultClusterParameters service method, as returned by AmazonRedshift.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

modifyEventSubscription

EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Modifies an existing Amazon Redshift event notification subscription.

Parameters:

modifyEventSubscriptionRequest - Container for the necessary parameters to execute the ModifyEventSubscription service method on AmazonRedshift.

Returns:

The response from the ModifyEventSubscription service method, as returned by AmazonRedshift.

Throws:

SubscriptionCategoryNotFoundException

InvalidSubscriptionStateException

SubscriptionEventIdNotFoundException

SubscriptionSeverityNotFoundException

SourceNotFoundException

SNSNoAuthorizationException

SNSTopicArnNotFoundException

SubscriptionNotFoundException

SNSInvalidTopicException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

createClusterSecurityGroup

ClusterSecurityGroup createClusterSecurityGroup(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

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 to Amazon Redshift Cluster Security Groups in the Amazon Redshift Management Guide .

Parameters:

createClusterSecurityGroupRequest - Container for the necessary parameters to execute the CreateClusterSecurityGroup service method on AmazonRedshift.

Returns:

The response from the CreateClusterSecurityGroup service method, as returned by AmazonRedshift.

Throws:

ClusterSecurityGroupQuotaExceededException

ClusterSecurityGroupAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeResize

DescribeResizeResult describeResize(DescribeResizeRequest describeResizeRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as 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.

Parameters:

describeResizeRequest - Container for the necessary parameters to execute the DescribeResize service method on AmazonRedshift.

Returns:

The response from the DescribeResize service method, as returned by AmazonRedshift.

Throws:

ClusterNotFoundException

ResizeNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterVersions

DescribeClusterVersionsResult describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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

Parameters:

describeClusterVersionsRequest - Container for the necessary parameters to execute the DescribeClusterVersions service method on AmazonRedshift.

Returns:

The response from the DescribeClusterVersions service method, as returned by AmazonRedshift.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

restoreFromClusterSnapshot

Cluster restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException

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 .

Parameters:

restoreFromClusterSnapshotRequest - Container for the necessary parameters to execute the RestoreFromClusterSnapshot service method on AmazonRedshift.

Returns:

The response from the RestoreFromClusterSnapshot service method, as returned by AmazonRedshift.

Throws:

InvalidElasticIpException

InvalidSubnetException

HsmConfigurationNotFoundException

ClusterSubnetGroupNotFoundException

InvalidClusterSubnetGroupStateException

ClusterAlreadyExistsException

InvalidVPCNetworkStateException

ClusterParameterGroupNotFoundException

InvalidClusterSnapshotStateException

AccessToSnapshotDeniedException

InvalidRestoreException

UnauthorizedOperationException

InsufficientClusterCapacityException

NumberOfNodesQuotaExceededException

NumberOfNodesPerClusterLimitExceededException

ClusterSnapshotNotFoundException

ClusterQuotaExceededException

HsmClientCertificateNotFoundException

ClusterSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

modifyClusterParameterGroup

ModifyClusterParameterGroupResult modifyClusterParameterGroup(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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 .

Parameters:

modifyClusterParameterGroupRequest - Container for the necessary parameters to execute the ModifyClusterParameterGroup service method on AmazonRedshift.

Returns:

The response from the ModifyClusterParameterGroup service method, as returned by AmazonRedshift.

Throws:

InvalidClusterParameterGroupStateException

ClusterParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeEventCategories

DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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 .

Parameters:

describeEventCategoriesRequest - Container for the necessary parameters to execute the DescribeEventCategories service method on AmazonRedshift.

Returns:

The response from the DescribeEventCategories service method, as returned by AmazonRedshift.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterSecurityGroups

DescribeClusterSecurityGroupsResult describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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 to Amazon Redshift Cluster Security Groups in the Amazon Redshift Management Guide .

Parameters:

describeClusterSecurityGroupsRequest - Container for the necessary parameters to execute the DescribeClusterSecurityGroups service method on AmazonRedshift.

Returns:

The response from the DescribeClusterSecurityGroups service method, as returned by AmazonRedshift.

Throws:

ClusterSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterSubnetGroups

DescribeClusterSubnetGroupsResult describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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.

Parameters:

describeClusterSubnetGroupsRequest - Container for the necessary parameters to execute the DescribeClusterSubnetGroups service method on AmazonRedshift.

Returns:

The response from the DescribeClusterSubnetGroups service method, as returned by AmazonRedshift.

Throws:

ClusterSubnetGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeHsmConfigurations

DescribeHsmConfigurationsResult describeHsmConfigurations(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

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.

Parameters:

describeHsmConfigurationsRequest - Container for the necessary parameters to execute the DescribeHsmConfigurations service method on AmazonRedshift.

Returns:

The response from the DescribeHsmConfigurations service method, as returned by AmazonRedshift.

Throws:

HsmConfigurationNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

deleteClusterSnapshot

Snapshot deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Deletes the specified manual snapshot. The snapshot must be in the 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.

Parameters:

deleteClusterSnapshotRequest - Container for the necessary parameters to execute the DeleteClusterSnapshot service method on AmazonRedshift.

Returns:

The response from the DeleteClusterSnapshot service method, as returned by AmazonRedshift.

Throws:

ClusterSnapshotNotFoundException

InvalidClusterSnapshotStateException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

deleteClusterParameterGroup

void deleteClusterParameterGroup(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Deletes a specified Amazon Redshift parameter group.

NOTE:You cannot delete a parameter group if it is associated with a cluster.

Parameters:

deleteClusterParameterGroupRequest - Container for the necessary parameters to execute the DeleteClusterParameterGroup service method on AmazonRedshift.

Throws:

InvalidClusterParameterGroupStateException

ClusterParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

disableSnapshotCopy

Cluster disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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

Parameters:

disableSnapshotCopyRequest - Container for the necessary parameters to execute the DisableSnapshotCopy service method on AmazonRedshift.

Returns:

The response from the DisableSnapshotCopy service method, as returned by AmazonRedshift.

Throws:

SnapshotCopyAlreadyDisabledException

UnauthorizedOperationException

InvalidClusterStateException

ClusterNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

createEventSubscription

EventSubscription createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

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.

Parameters:

createEventSubscriptionRequest - Container for the necessary parameters to execute the CreateEventSubscription service method on AmazonRedshift.

Returns:

The response from the CreateEventSubscription service method, as returned by AmazonRedshift.

Throws:

SubscriptionCategoryNotFoundException

SubscriptionAlreadyExistException

EventSubscriptionQuotaExceededException

SubscriptionEventIdNotFoundException

SubscriptionSeverityNotFoundException

SourceNotFoundException

SNSNoAuthorizationException

SNSTopicArnNotFoundException

SNSInvalidTopicException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

resetClusterParameterGroup

ResetClusterParameterGroupResult resetClusterParameterGroup(ResetClusterParameterGroupRequest resetClusterParameterGroupRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

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.

Parameters:

resetClusterParameterGroupRequest - Container for the necessary parameters to execute the ResetClusterParameterGroup service method on AmazonRedshift.

Returns:

The response from the ResetClusterParameterGroup service method, as returned by AmazonRedshift.

Throws:

InvalidClusterParameterGroupStateException

ClusterParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

authorizeSnapshotAccess

Snapshot authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

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 .

Parameters:

authorizeSnapshotAccessRequest - Container for the necessary parameters to execute the AuthorizeSnapshotAccess service method on AmazonRedshift.

Returns:

The response from the AuthorizeSnapshotAccess service method, as returned by AmazonRedshift.

Throws:

AuthorizationAlreadyExistsException

ClusterSnapshotNotFoundException

AuthorizationQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

enableSnapshotCopy

Cluster enableSnapshotCopy(EnableSnapshotCopyRequest enableSnapshotCopyRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

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

Parameters:

enableSnapshotCopyRequest - Container for the necessary parameters to execute the EnableSnapshotCopy service method on AmazonRedshift.

Returns:

The response from the EnableSnapshotCopy service method, as returned by AmazonRedshift.

Throws:

CopyToRegionDisabledException

UnauthorizedOperationException

InvalidClusterStateException

ClusterNotFoundException

IncompatibleOrderableOptionsException

SnapshotCopyAlreadyEnabledException

UnknownSnapshotCopyRegionException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeReservedNodeOfferings

DescribeReservedNodeOfferingsResult describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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 .

Parameters:

describeReservedNodeOfferingsRequest - Container for the necessary parameters to execute the DescribeReservedNodeOfferings service method on AmazonRedshift.

Returns:

The response from the DescribeReservedNodeOfferings service method, as returned by AmazonRedshift.

Throws:

ReservedNodeOfferingNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeEventSubscriptions

DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

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.

Parameters:

describeEventSubscriptionsRequest - Container for the necessary parameters to execute the DescribeEventSubscriptions service method on AmazonRedshift.

Returns:

The response from the DescribeEventSubscriptions service method, as returned by AmazonRedshift.

Throws:

SubscriptionNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeLoggingStatus

DescribeLoggingStatusResult describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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

Parameters:

describeLoggingStatusRequest - Container for the necessary parameters to execute the DescribeLoggingStatus service method on AmazonRedshift.

Returns:

The response from the DescribeLoggingStatus service method, as returned by AmazonRedshift.

Throws:

ClusterNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

deleteEventSubscription

void deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

Deletes an Amazon Redshift event notification subscription.

Parameters:

deleteEventSubscriptionRequest - Container for the necessary parameters to execute the DeleteEventSubscription service method on AmazonRedshift.

Throws:

InvalidSubscriptionStateException

SubscriptionNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

createHsmClientCertificate

HsmClientCertificate createHsmClientCertificate(CreateHsmClientCertificateRequest createHsmClientCertificateRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

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.

Parameters:

createHsmClientCertificateRequest - Container for the necessary parameters to execute the CreateHsmClientCertificate service method on AmazonRedshift.

Returns:

The response from the CreateHsmClientCertificate service method, as returned by AmazonRedshift.

Throws:

HsmClientCertificateQuotaExceededException

HsmClientCertificateAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

revokeClusterSecurityGroupIngress

ClusterSecurityGroup revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

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 to Amazon Redshift Cluster Security Groups in the Amazon Redshift Management Guide .

Parameters:

revokeClusterSecurityGroupIngressRequest - Container for the necessary parameters to execute the RevokeClusterSecurityGroupIngress service method on AmazonRedshift.

Returns:

The response from the RevokeClusterSecurityGroupIngress service method, as returned by AmazonRedshift.

Throws:

InvalidClusterSecurityGroupStateException

AuthorizationNotFoundException

ClusterSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterParameters

DescribeClusterParametersResult describeClusterParameters(DescribeClusterParametersRequest describeClusterParametersRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

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 .

Parameters:

describeClusterParametersRequest - Container for the necessary parameters to execute the DescribeClusterParameters service method on AmazonRedshift.

Returns:

The response from the DescribeClusterParameters service method, as returned by AmazonRedshift.

Throws:

ClusterParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeHsmClientCertificates

DescribeHsmClientCertificatesResult describeHsmClientCertificates(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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.

Parameters:

describeHsmClientCertificatesRequest - Container for the necessary parameters to execute the DescribeHsmClientCertificates service method on AmazonRedshift.

Returns:

The response from the DescribeHsmClientCertificates service method, as returned by AmazonRedshift.

Throws:

HsmClientCertificateNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

createHsmConfiguration

HsmConfiguration createHsmConfiguration(CreateHsmConfigurationRequest createHsmConfigurationRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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.

Parameters:

createHsmConfigurationRequest - Container for the necessary parameters to execute the CreateHsmConfiguration service method on AmazonRedshift.

Returns:

The response from the CreateHsmConfiguration service method, as returned by AmazonRedshift.

Throws:

HsmConfigurationQuotaExceededException

HsmConfigurationAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusters

DescribeClustersResult describeClusters(DescribeClustersRequest describeClustersRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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 .

Parameters:

describeClustersRequest - Container for the necessary parameters to execute the DescribeClusters service method on AmazonRedshift.

Returns:

The response from the DescribeClusters service method, as returned by AmazonRedshift.

Throws:

ClusterNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterSnapshots

DescribeClusterSnapshotsResult describeClusterSnapshots(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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.

Parameters:

describeClusterSnapshotsRequest - Container for the necessary parameters to execute the DescribeClusterSnapshots service method on AmazonRedshift.

Returns:

The response from the DescribeClusterSnapshots service method, as returned by AmazonRedshift.

Throws:

ClusterSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

createClusterParameterGroup

ClusterParameterGroup createClusterParameterGroup(CreateClusterParameterGroupRequest createClusterParameterGroupRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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 .

Parameters:

createClusterParameterGroupRequest - Container for the necessary parameters to execute the CreateClusterParameterGroup service method on AmazonRedshift.

Returns:

The response from the CreateClusterParameterGroup service method, as returned by AmazonRedshift.

Throws:

ClusterParameterGroupQuotaExceededException

ClusterParameterGroupAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterParameterGroups

DescribeClusterParameterGroupsResult describeClusterParameterGroups(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

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 .

Parameters:

describeClusterParameterGroupsRequest - Container for the necessary parameters to execute the DescribeClusterParameterGroups service method on AmazonRedshift.

Returns:

The response from the DescribeClusterParameterGroups service method, as returned by AmazonRedshift.

Throws:

ClusterParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeOrderableClusterOptions

DescribeOrderableClusterOptionsResult describeOrderableClusterOptions()
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException

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

Returns:

The response from the DescribeOrderableClusterOptions service method, as returned by AmazonRedshift.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeEvents

DescribeEventsResult describeEvents()
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Returns:

The response from the DescribeEvents service method, as returned by AmazonRedshift.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeReservedNodes

DescribeReservedNodesResult describeReservedNodes()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns the descriptions of the reserved nodes.

Returns:

The response from the DescribeReservedNodes service method, as returned by AmazonRedshift.

Throws:

ReservedNodeNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterVersions

DescribeClusterVersionsResult describeClusterVersions()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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

Returns:

The response from the DescribeClusterVersions service method, as returned by AmazonRedshift.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeEventCategories

DescribeEventCategoriesResult describeEventCategories()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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 .

Returns:

The response from the DescribeEventCategories service method, as returned by AmazonRedshift.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterSecurityGroups

DescribeClusterSecurityGroupsResult describeClusterSecurityGroups()
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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 to Amazon Redshift Cluster Security Groups in the Amazon Redshift Management Guide .

Returns:

The response from the DescribeClusterSecurityGroups service method, as returned by AmazonRedshift.

Throws:

ClusterSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterSubnetGroups

DescribeClusterSubnetGroupsResult describeClusterSubnetGroups()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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.

Returns:

The response from the DescribeClusterSubnetGroups service method, as returned by AmazonRedshift.

Throws:

ClusterSubnetGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeHsmConfigurations

DescribeHsmConfigurationsResult describeHsmConfigurations()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

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.

Returns:

The response from the DescribeHsmConfigurations service method, as returned by AmazonRedshift.

Throws:

HsmConfigurationNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeReservedNodeOfferings

DescribeReservedNodeOfferingsResult describeReservedNodeOfferings()
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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 .

Returns:

The response from the DescribeReservedNodeOfferings service method, as returned by AmazonRedshift.

Throws:

ReservedNodeOfferingNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeEventSubscriptions

DescribeEventSubscriptionsResult describeEventSubscriptions()
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

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.

Returns:

The response from the DescribeEventSubscriptions service method, as returned by AmazonRedshift.

Throws:

SubscriptionNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeHsmClientCertificates

DescribeHsmClientCertificatesResult describeHsmClientCertificates()
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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.

Returns:

The response from the DescribeHsmClientCertificates service method, as returned by AmazonRedshift.

Throws:

HsmClientCertificateNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusters

DescribeClustersResult describeClusters()
                                        throws AmazonServiceException,
                                               AmazonClientException

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 .

Returns:

The response from the DescribeClusters service method, as returned by AmazonRedshift.

Throws:

ClusterNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterSnapshots

DescribeClusterSnapshotsResult describeClusterSnapshots()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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.

Returns:

The response from the DescribeClusterSnapshots service method, as returned by AmazonRedshift.

Throws:

ClusterSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

describeClusterParameterGroups

DescribeClusterParameterGroupsResult describeClusterParameterGroups()
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

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 .

Returns:

The response from the DescribeClusterParameterGroups service method, as returned by AmazonRedshift.

Throws:

ClusterParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRedshift indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.