AmazonRedshiftClient (AWS SDK for Java 1.7.15 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

Field Summary
`protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>`	`exceptionUnmarshallers` List of exception unmarshallers for all AmazonRedshift exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient
`client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset`

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(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Constructs a new client to invoke service methods on AmazonRedshift using the specified AWS account credentials provider, client configuration options, and request metric collector.
`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`	`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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.amazonaws.services.redshift.AmazonRedshift
`setEndpoint, setRegion, shutdown`

Field Detail

exceptionUnmarshallers

protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers

List of exception unmarshallers for all AmazonRedshift exceptions.

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