com.amazonaws.services.redshift
Class AmazonRedshiftClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.redshift.AmazonRedshiftClient

All Implemented Interfaces:

AmazonRedshift

Direct Known Subclasses:

AmazonRedshiftAsyncClient

public class AmazonRedshiftClient
extends AmazonWebServiceClient
implements AmazonRedshift

Client for accessing AmazonRedshift. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Redshift Overview

This is the Amazon Redshift API Reference. This guide provides descriptions and samples of the Amazon Redshift API.

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.

Are You a First-Time Amazon Redshift User?

If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the following sections:

• Service Highlights and Pricing - The product detail page provides the Amazon Redshift value proposition, service highlights and pricing.

• Getting Started - The Getting Started Guide includes an example that walks you through the process of creating a cluster, creating database tables, uploading data, and testing queries.

After you complete the Getting Started Guide, we recommend that you explore one of the following guides:

• Cluster Management - If you are responsible for managing Amazon Redshift clusters, the Cluster Management Guide shows you how to create and manage Amazon Redshift clusters.

  If you are an application developer, you can use the Amazon Redshift Query API to manage clusters programmatically. Additionally, the AWS SDK libraries that wrap the underlying Amazon Redshift API simplify your programming tasks. If you prefer a more interactive way of managing clusters, you can use the Amazon Redshift console and the AWS command line interface (AWS CLI). For information about the API and CLI, go to the following manuals :

  • API Reference ( this document )

  • CLI Reference

• Amazon Redshift Database Database Developer - 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.

For a list of supported AWS regions where you can provision a cluster, go to the Regions and Endpoints section in the Amazon Web Services Glossary .

Constructor Summary

AmazonRedshiftClient()
Constructs a new client to invoke service methods on AmazonRedshift.

AmazonRedshiftClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonRedshift using the specified AWS account credentials.

AmazonRedshiftClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonRedshift using the specified AWS account credentials and client configuration options.

AmazonRedshiftClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonRedshift using the specified AWS account credentials provider.

AmazonRedshiftClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonRedshift using the specified AWS account credentials provider and client configuration options.

AmazonRedshiftClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonRedshift.

Method Summary

ClusterSecurityGroup	authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest) Adds an inbound (ingress) rule to an Amazon Redshift security group.
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.
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.
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.
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.
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.
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.
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.
void	setEndpoint(String endpoint, String serviceName, String regionId) Overrides the default endpoint for this client ("https://redshift.us-east-1.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.redshift.AmazonRedshift

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonRedshiftClient

public AmazonRedshiftClient()

Constructs a new client to invoke service methods on AmazonRedshift. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProvider

AmazonRedshiftClient

public AmazonRedshiftClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonRedshift. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonRedshift (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProvider

AmazonRedshiftClient

public AmazonRedshiftClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonRedshift using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonRedshiftClient

public AmazonRedshiftClient(AWSCredentials awsCredentials,
                            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonRedshift using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonRedshift (ex: proxy settings, retry counts, etc.).

AmazonRedshiftClient

public AmazonRedshiftClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonRedshift using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonRedshiftClient

public AmazonRedshiftClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonRedshift using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonRedshift (ex: proxy settings, retry counts, etc.).

Method Detail

modifyClusterSubnetGroup

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

Specified by:

modifyClusterSubnetGroup in interface AmazonRedshift

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

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.

purchaseReservedNodeOffering

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

Specified by:

purchaseReservedNodeOffering in interface AmazonRedshift

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.

modifyCluster

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

Specified by:

modifyCluster in interface AmazonRedshift

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

InsufficientClusterCapacityException

InvalidClusterStateException

NumberOfNodesQuotaExceededException

ClusterNotFoundException

UnsupportedOptionException

ClusterSecurityGroupNotFoundException

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.

modifyClusterParameterGroup

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

Specified by:

modifyClusterParameterGroup in interface AmazonRedshift

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.

describeClusterSecurityGroups

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

Specified by:

describeClusterSecurityGroups in interface AmazonRedshift

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.

copyClusterSnapshot

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

Specified by:

copyClusterSnapshot in interface AmazonRedshift

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

public 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

Specified by:

describeOrderableClusterOptions in interface AmazonRedshift

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.

createClusterSubnetGroup

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

Specified by:

createClusterSubnetGroup in interface AmazonRedshift

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

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.

rebootCluster

public 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

Specified by:

rebootCluster in interface AmazonRedshift

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

public void deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Deletes the specified cluster subnet group.

Specified by:

deleteClusterSubnetGroup in interface AmazonRedshift

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.

describeClusterSubnetGroups

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

Specified by:

describeClusterSubnetGroups in interface AmazonRedshift

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.

createClusterSnapshot

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

Specified by:

createClusterSnapshot in interface AmazonRedshift

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.

deleteCluster

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

Specified by:

deleteCluster in interface AmazonRedshift

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.

createCluster

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

Specified by:

createCluster in interface AmazonRedshift

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:

InsufficientClusterCapacityException

NumberOfNodesQuotaExceededException

NumberOfNodesPerClusterLimitExceededException

ClusterSubnetGroupNotFoundException

ClusterAlreadyExistsException

ClusterSecurityGroupNotFoundException

ClusterQuotaExceededException

InvalidVPCNetworkStateException

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.

deleteClusterSnapshot

public Snapshot deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Deletes the specified manual snapshot. The snapshot must be in the "available" state.

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.

Specified by:

deleteClusterSnapshot in interface AmazonRedshift

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

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

Specified by:

deleteClusterParameterGroup in interface AmazonRedshift

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.

authorizeClusterSecurityGroupIngress

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

Specified by:

authorizeClusterSecurityGroupIngress in interface AmazonRedshift

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.

describeEvents

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

Specified by:

describeEvents in interface AmazonRedshift

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.

deleteClusterSecurityGroup

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

Specified by:

deleteClusterSecurityGroup in interface AmazonRedshift

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

public DescribeReservedNodesResult describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns the descriptions of the reserved nodes.

Specified by:

describeReservedNodes in interface AmazonRedshift

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.

resetClusterParameterGroup

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

Specified by:

resetClusterParameterGroup in interface AmazonRedshift

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.

describeDefaultClusterParameters

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

Specified by:

describeDefaultClusterParameters in interface AmazonRedshift

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.

createClusterSecurityGroup

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

Specified by:

createClusterSecurityGroup in interface AmazonRedshift

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.

describeReservedNodeOfferings

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

Specified by:

describeReservedNodeOfferings in interface AmazonRedshift

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.

describeResize

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

Specified by:

describeResize in interface AmazonRedshift

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

public 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

Specified by:

describeClusterVersions in interface AmazonRedshift

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.

describeClusterParameters

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

Specified by:

describeClusterParameters in interface AmazonRedshift

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.

revokeClusterSecurityGroupIngress

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

Specified by:

revokeClusterSecurityGroupIngress in interface AmazonRedshift

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.

describeClusters

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

Specified by:

describeClusters in interface AmazonRedshift

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

public 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 the AWS account.

Specified by:

describeClusterSnapshots in interface AmazonRedshift

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

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

Specified by:

createClusterParameterGroup in interface AmazonRedshift

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

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

Specified by:

describeClusterParameterGroups in interface AmazonRedshift

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.

restoreFromClusterSnapshot

public 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 a snapshot is taken of a cluster in VPC, you can restore it only in VPC. In this case, you must provide a cluster subnet group where you want the cluster restored. If snapshot is taken of a cluster outside VPC, then you can restore it only outside VPC.

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

Specified by:

restoreFromClusterSnapshot in interface AmazonRedshift

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:

InvalidRestoreException

InsufficientClusterCapacityException

NumberOfNodesQuotaExceededException

NumberOfNodesPerClusterLimitExceededException

ClusterSnapshotNotFoundException

ClusterAlreadyExistsException

ClusterQuotaExceededException

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.

describeClusterSecurityGroups

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

Specified by:

describeClusterSecurityGroups in interface 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.

describeOrderableClusterOptions

public 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

Specified by:

describeOrderableClusterOptions in interface 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.

describeClusterSubnetGroups

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

Specified by:

describeClusterSubnetGroups in interface 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.

describeEvents

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

Specified by:

describeEvents in interface 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.

describeReservedNodes

public DescribeReservedNodesResult describeReservedNodes()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns the descriptions of the reserved nodes.

Specified by:

describeReservedNodes in interface 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.

describeReservedNodeOfferings

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

Specified by:

describeReservedNodeOfferings in interface 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.

describeClusterVersions

public 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

Specified by:

describeClusterVersions in interface 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.

describeClusters

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

Specified by:

describeClusters in interface 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

public 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 the AWS account.

Specified by:

describeClusterSnapshots in interface 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.

describeClusterParameterGroups

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

Specified by:

describeClusterParameterGroups in interface 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.

setEndpoint

public void setEndpoint(String endpoint,
                        String serviceName,
                        String regionId)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://redshift.us-east-1.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

This method is not threadsafe. Endpoints 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.

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

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.

serviceName - The name of the AWS service to use when signing requests.

regionId - The ID of the region in which this service resides.

Throws:

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonRedshift

Parameters:

request - The originally executed request

Returns:

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