@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonRedshiftClient extends AmazonWebServiceClient implements AmazonRedshift
Overview
This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces.
Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.
If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide.
If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonRedshiftClient()
Deprecated.
|
AmazonRedshiftClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonRedshiftClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonRedshiftClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonRedshiftClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonRedshiftClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonRedshiftClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonRedshiftClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
ClusterSecurityGroup |
authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest request)
Adds an inbound (ingress) rule to an Amazon Redshift security group.
|
Snapshot |
authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest request)
Authorizes the specified AWS customer account to restore the specified snapshot.
|
static AmazonRedshiftClientBuilder |
builder() |
Snapshot |
copyClusterSnapshot(CopyClusterSnapshotRequest request)
Copies the specified automated cluster snapshot to a new manual cluster snapshot.
|
Cluster |
createCluster(CreateClusterRequest request)
Creates a new cluster.
|
ClusterParameterGroup |
createClusterParameterGroup(CreateClusterParameterGroupRequest request)
Creates an Amazon Redshift parameter group.
|
ClusterSecurityGroup |
createClusterSecurityGroup(CreateClusterSecurityGroupRequest request)
Creates a new Amazon Redshift security group.
|
Snapshot |
createClusterSnapshot(CreateClusterSnapshotRequest request)
Creates a manual snapshot of the specified cluster.
|
ClusterSubnetGroup |
createClusterSubnetGroup(CreateClusterSubnetGroupRequest request)
Creates a new Amazon Redshift subnet group.
|
EventSubscription |
createEventSubscription(CreateEventSubscriptionRequest request)
Creates an Amazon Redshift event notification subscription.
|
HsmClientCertificate |
createHsmClientCertificate(CreateHsmClientCertificateRequest request)
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 request)
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).
|
SnapshotCopyGrant |
createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest request)
Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key
Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
|
CreateTagsResult |
createTags(CreateTagsRequest request)
Adds one or more tags to a specified resource.
|
Cluster |
deleteCluster(DeleteClusterRequest request)
Deletes a previously provisioned cluster.
|
DeleteClusterParameterGroupResult |
deleteClusterParameterGroup(DeleteClusterParameterGroupRequest request)
Deletes a specified Amazon Redshift parameter group.
|
DeleteClusterSecurityGroupResult |
deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest request)
Deletes an Amazon Redshift security group.
|
Snapshot |
deleteClusterSnapshot(DeleteClusterSnapshotRequest request)
Deletes the specified manual snapshot.
|
DeleteClusterSubnetGroupResult |
deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest request)
Deletes the specified cluster subnet group.
|
DeleteEventSubscriptionResult |
deleteEventSubscription(DeleteEventSubscriptionRequest request)
Deletes an Amazon Redshift event notification subscription.
|
DeleteHsmClientCertificateResult |
deleteHsmClientCertificate(DeleteHsmClientCertificateRequest request)
Deletes the specified HSM client certificate.
|
DeleteHsmConfigurationResult |
deleteHsmConfiguration(DeleteHsmConfigurationRequest request)
Deletes the specified Amazon Redshift HSM configuration.
|
DeleteSnapshotCopyGrantResult |
deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest request)
Deletes the specified snapshot copy grant.
|
DeleteTagsResult |
deleteTags(DeleteTagsRequest request)
Deletes a tag or tags from a resource.
|
DescribeClusterParameterGroupsResult |
describeClusterParameterGroups()
Simplified method form for invoking the DescribeClusterParameterGroups operation.
|
DescribeClusterParameterGroupsResult |
describeClusterParameterGroups(DescribeClusterParameterGroupsRequest request)
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default
parameter group.
|
DescribeClusterParametersResult |
describeClusterParameters(DescribeClusterParametersRequest request)
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.
|
DescribeClustersResult |
describeClusters()
Simplified method form for invoking the DescribeClusters operation.
|
DescribeClustersResult |
describeClusters(DescribeClustersRequest request)
Returns properties of provisioned clusters including general cluster properties, cluster database properties,
maintenance and backup properties, and security and access properties.
|
DescribeClusterSecurityGroupsResult |
describeClusterSecurityGroups()
Simplified method form for invoking the DescribeClusterSecurityGroups operation.
|
DescribeClusterSecurityGroupsResult |
describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest request)
Returns information about Amazon Redshift security groups.
|
DescribeClusterSnapshotsResult |
describeClusterSnapshots()
Simplified method form for invoking the DescribeClusterSnapshots operation.
|
DescribeClusterSnapshotsResult |
describeClusterSnapshots(DescribeClusterSnapshotsRequest request)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
|
DescribeClusterSubnetGroupsResult |
describeClusterSubnetGroups()
Simplified method form for invoking the DescribeClusterSubnetGroups operation.
|
DescribeClusterSubnetGroupsResult |
describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest request)
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.
|
DescribeClusterVersionsResult |
describeClusterVersions()
Simplified method form for invoking the DescribeClusterVersions operation.
|
DescribeClusterVersionsResult |
describeClusterVersions(DescribeClusterVersionsRequest request)
Returns descriptions of the available Amazon Redshift cluster versions.
|
DefaultClusterParameters |
describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest request)
Returns a list of parameter settings for the specified parameter group family.
|
DescribeEventCategoriesResult |
describeEventCategories()
Simplified method form for invoking the DescribeEventCategories operation.
|
DescribeEventCategoriesResult |
describeEventCategories(DescribeEventCategoriesRequest request)
Displays a list of event categories for all event source types, or for a specified source type.
|
DescribeEventsResult |
describeEvents()
Simplified method form for invoking the DescribeEvents operation.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest request)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions()
Simplified method form for invoking the DescribeEventSubscriptions operation.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.
|
DescribeHsmClientCertificatesResult |
describeHsmClientCertificates()
Simplified method form for invoking the DescribeHsmClientCertificates operation.
|
DescribeHsmClientCertificatesResult |
describeHsmClientCertificates(DescribeHsmClientCertificatesRequest request)
Returns information about the specified HSM client certificate.
|
DescribeHsmConfigurationsResult |
describeHsmConfigurations()
Simplified method form for invoking the DescribeHsmConfigurations operation.
|
DescribeHsmConfigurationsResult |
describeHsmConfigurations(DescribeHsmConfigurationsRequest request)
Returns information about the specified Amazon Redshift HSM configuration.
|
DescribeLoggingStatusResult |
describeLoggingStatus(DescribeLoggingStatusRequest request)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon
Redshift cluster.
|
DescribeOrderableClusterOptionsResult |
describeOrderableClusterOptions()
Simplified method form for invoking the DescribeOrderableClusterOptions operation.
|
DescribeOrderableClusterOptionsResult |
describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest request)
Returns a list of orderable cluster options.
|
DescribeReservedNodeOfferingsResult |
describeReservedNodeOfferings()
Simplified method form for invoking the DescribeReservedNodeOfferings operation.
|
DescribeReservedNodeOfferingsResult |
describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest request)
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()
Simplified method form for invoking the DescribeReservedNodes operation.
|
DescribeReservedNodesResult |
describeReservedNodes(DescribeReservedNodesRequest request)
Returns the descriptions of the reserved nodes.
|
DescribeResizeResult |
describeResize(DescribeResizeRequest request)
Returns information about the last resize operation for the specified cluster.
|
DescribeSnapshotCopyGrantsResult |
describeSnapshotCopyGrants()
Simplified method form for invoking the DescribeSnapshotCopyGrants operation.
|
DescribeSnapshotCopyGrantsResult |
describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest request)
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
|
DescribeTableRestoreStatusResult |
describeTableRestoreStatus()
Simplified method form for invoking the DescribeTableRestoreStatus operation.
|
DescribeTableRestoreStatusResult |
describeTableRestoreStatus(DescribeTableRestoreStatusRequest request)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action.
|
DescribeTagsResult |
describeTags()
Simplified method form for invoking the DescribeTags operation.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest request)
Returns a list of tags.
|
DisableLoggingResult |
disableLogging(DisableLoggingRequest request)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
Cluster |
disableSnapshotCopy(DisableSnapshotCopyRequest request)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
|
EnableLoggingResult |
enableLogging(EnableLoggingRequest request)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
Cluster |
enableSnapshotCopy(EnableSnapshotCopyRequest request)
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.
|
GetClusterCredentialsResult |
getClusterCredentials(GetClusterCredentialsRequest request)
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database.
|
Cluster |
modifyCluster(ModifyClusterRequest request)
Modifies the settings for a cluster.
|
Cluster |
modifyClusterIamRoles(ModifyClusterIamRolesRequest request)
Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access
other AWS services.
|
ModifyClusterParameterGroupResult |
modifyClusterParameterGroup(ModifyClusterParameterGroupRequest request)
Modifies the parameters of a parameter group.
|
ClusterSubnetGroup |
modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest request)
Modifies a cluster subnet group to include the specified list of VPC subnets.
|
EventSubscription |
modifyEventSubscription(ModifyEventSubscriptionRequest request)
Modifies an existing Amazon Redshift event notification subscription.
|
Cluster |
modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest request)
Modifies the number of days to retain automated snapshots in the destination region after they are copied from
the source region.
|
ReservedNode |
purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest request)
Allows you to purchase reserved nodes.
|
Cluster |
rebootCluster(RebootClusterRequest request)
Reboots a cluster.
|
ResetClusterParameterGroupResult |
resetClusterParameterGroup(ResetClusterParameterGroupRequest request)
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 request)
Creates a new cluster from a snapshot.
|
TableRestoreStatus |
restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest request)
Creates a new table from a table in an Amazon Redshift cluster snapshot.
|
ClusterSecurityGroup |
revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest request)
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2
security group.
|
Snapshot |
revokeSnapshotAccess(RevokeSnapshotAccessRequest request)
Removes the ability of the specified AWS customer account to restore the specified snapshot.
|
Cluster |
rotateEncryptionKey(RotateEncryptionKeyRequest request)
Rotates the encryption keys for a cluster.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
AmazonRedshiftWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonRedshiftClient()
AmazonRedshiftClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonRedshiftClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon Redshift (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonRedshiftClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonRedshiftClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonRedshiftClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 Amazon Redshift (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonRedshiftClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonRedshiftClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 Amazon Redshift (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonRedshiftClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 Amazon Redshift (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonRedshiftClientBuilder builder()
public ClusterSecurityGroup authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest request)
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 Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. 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 Cluster Management Guide.
authorizeClusterSecurityGroupIngress
in interface AmazonRedshift
authorizeClusterSecurityGroupIngressRequest
- ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.AuthorizationAlreadyExistsException
- The specified CIDR block or EC2 security group is already authorized for the specified cluster security
group.AuthorizationQuotaExceededException
- The authorization quota for the cluster security group has been reached.public Snapshot authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest request)
Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
authorizeSnapshotAccess
in interface AmazonRedshift
authorizeSnapshotAccessRequest
- ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.AuthorizationAlreadyExistsException
- The specified CIDR block or EC2 security group is already authorized for the specified cluster security
group.AuthorizationQuotaExceededException
- The authorization quota for the cluster security group has been reached.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.LimitExceededException
- The encryption key has exceeded its grant limit in AWS KMS.public Snapshot copyClusterSnapshot(CopyClusterSnapshotRequest request)
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 Cluster Management Guide.
copyClusterSnapshot
in interface AmazonRedshift
copyClusterSnapshotRequest
- ClusterSnapshotAlreadyExistsException
- The value specified as a snapshot identifier is already used by an existing snapshot.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.ClusterSnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster snapshots.public Cluster createCluster(CreateClusterRequest request)
Creates a new cluster.
To create the cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
createCluster
in interface AmazonRedshift
createClusterRequest
- ClusterAlreadyExistsException
- The account already has a cluster with the given identifier.InsufficientClusterCapacityException
- The number of nodes specified exceeds the allotted capacity of the cluster.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.ClusterQuotaExceededException
- The request would exceed the allowed number of cluster instances for this account. For information about
increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesQuotaExceededException
- The operation would exceed the number of nodes allotted to the account. For information about increasing
your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException
- The operation would exceed the number of nodes allowed for a cluster.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidVPCNetworkStateException
- The cluster subnet group does not cover all Availability Zones.InvalidClusterSubnetGroupStateException
- The cluster subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidElasticIpException
- The Elastic IP (EIP) is invalid or cannot be found.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.LimitExceededException
- The encryption key has exceeded its grant limit in AWS KMS.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.public ClusterParameterGroup createClusterParameterGroup(CreateClusterParameterGroupRequest request)
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
createClusterParameterGroup
in interface AmazonRedshift
createClusterParameterGroupRequest
- ClusterParameterGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster parameter groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.ClusterParameterGroupAlreadyExistsException
- A cluster parameter group with the same name already exists.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.public ClusterSecurityGroup createClusterSecurityGroup(CreateClusterSecurityGroupRequest request)
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 Cluster Management Guide.
createClusterSecurityGroup
in interface AmazonRedshift
createClusterSecurityGroupRequest
- ClusterSecurityGroupAlreadyExistsException
- A cluster security group with the same name already exists.ClusterSecurityGroupQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster security groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.public Snapshot createClusterSnapshot(CreateClusterSnapshotRequest request)
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 Cluster Management Guide.
createClusterSnapshot
in interface AmazonRedshift
createClusterSnapshotRequest
- ClusterSnapshotAlreadyExistsException
- The value specified as a snapshot identifier is already used by an existing snapshot.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.ClusterSnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster snapshots.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.public ClusterSubnetGroup createClusterSubnetGroup(CreateClusterSubnetGroupRequest request)
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 Cluster Management Guide.
createClusterSubnetGroup
in interface AmazonRedshift
createClusterSubnetGroupRequest
- ClusterSubnetGroupAlreadyExistsException
- A ClusterSubnetGroupName is already used by an existing cluster subnet group.ClusterSubnetGroupQuotaExceededException
- The request would result in user exceeding the allowed number of cluster subnet groups. For information
about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.ClusterSubnetQuotaExceededException
- The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.public EventSubscription createEventSubscription(CreateEventSubscriptionRequest request)
Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.
If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.
createEventSubscription
in interface AmazonRedshift
createEventSubscriptionRequest
- EventSubscriptionQuotaExceededException
- The request would exceed the allowed number of event subscriptions for this account. For information
about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.SubscriptionAlreadyExistException
- There is already an existing event notification subscription with the specified name.SNSInvalidTopicException
- Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.SNSNoAuthorizationException
- You do not have permission to publish to the specified Amazon SNS topic.SNSTopicArnNotFoundException
- An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.SubscriptionEventIdNotFoundException
- An Amazon Redshift event with the specified event ID does not exist.SubscriptionCategoryNotFoundException
- The value specified for the event category was not one of the allowed values, or it specified a category
that does not apply to the specified source type. The allowed values are Configuration, Management,
Monitoring, and Security.SubscriptionSeverityNotFoundException
- The value specified for the event severity was not one of the allowed values, or it specified a severity
that does not apply to the specified source type. The allowed values are ERROR and INFO.SourceNotFoundException
- The specified Amazon Redshift event source could not be found.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.public HsmClientCertificate createHsmClientCertificate(CreateHsmClientCertificateRequest request)
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
createHsmClientCertificate
in interface AmazonRedshift
createHsmClientCertificateRequest
- HsmClientCertificateAlreadyExistsException
- There is already an existing Amazon Redshift HSM client certificate with the specified identifier.HsmClientCertificateQuotaExceededException
- The quota for HSM client certificates has been reached. For information about increasing your quota, go
to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.public HsmConfiguration createHsmConfiguration(CreateHsmConfigurationRequest request)
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
createHsmConfiguration
in interface AmazonRedshift
createHsmConfigurationRequest
- HsmConfigurationAlreadyExistsException
- There is already an existing Amazon Redshift HSM configuration with the specified identifier.HsmConfigurationQuotaExceededException
- The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.public SnapshotCopyGrant createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest request)
Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
createSnapshotCopyGrant
in interface AmazonRedshift
createSnapshotCopyGrantRequest
- The result of the CreateSnapshotCopyGrant
action.SnapshotCopyGrantAlreadyExistsException
- The snapshot copy grant can't be created because a grant with the same name already exists.SnapshotCopyGrantQuotaExceededException
- The AWS account has exceeded the maximum number of snapshot copy grants in this region.LimitExceededException
- The encryption key has exceeded its grant limit in AWS KMS.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.InvalidTagException
- The tag is invalid.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.public CreateTagsResult createTags(CreateTagsRequest request)
Adds one or more tags to a specified resource.
A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
createTags
in interface AmazonRedshift
createTagsRequest
- Contains the output from the CreateTags
action.TagLimitExceededException
- The request exceeds the limit of 10 tags for the resource.ResourceNotFoundException
- The resource could not be found.InvalidTagException
- The tag is invalid.public Cluster deleteCluster(DeleteClusterRequest request)
Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. 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 Cluster Management Guide.
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to
false
and specify a name for FinalClusterSnapshotIdentifier. You can later restore this
snapshot to resume using the cluster. 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.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
deleteCluster
in interface AmazonRedshift
deleteClusterRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterSnapshotAlreadyExistsException
- The value specified as a snapshot identifier is already used by an existing snapshot.ClusterSnapshotQuotaExceededException
- The request would result in the user exceeding the allowed number of cluster snapshots.public DeleteClusterParameterGroupResult deleteClusterParameterGroup(DeleteClusterParameterGroupRequest request)
Deletes a specified Amazon Redshift parameter group.
You cannot delete a parameter group if it is associated with a cluster.
deleteClusterParameterGroup
in interface AmazonRedshift
deleteClusterParameterGroupRequest
- InvalidClusterParameterGroupStateException
- The cluster parameter group action can not be completed because another task is in progress that involves
the parameter group. Wait a few moments and try the operation again.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.public DeleteClusterSecurityGroupResult deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest request)
Deletes an Amazon Redshift security group.
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 Cluster Management Guide.
deleteClusterSecurityGroup
in interface AmazonRedshift
deleteClusterSecurityGroupRequest
- InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.public Snapshot deleteClusterSnapshot(DeleteClusterSnapshotRequest request)
Deletes the specified manual snapshot. The snapshot must be in the available
state, with no other
users authorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
deleteClusterSnapshot
in interface AmazonRedshift
deleteClusterSnapshotRequest
- InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.public DeleteClusterSubnetGroupResult deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest request)
Deletes the specified cluster subnet group.
deleteClusterSubnetGroup
in interface AmazonRedshift
deleteClusterSubnetGroupRequest
- InvalidClusterSubnetGroupStateException
- The cluster subnet group cannot be deleted because it is in use.InvalidClusterSubnetStateException
- The state of the subnet is invalid.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.public DeleteEventSubscriptionResult deleteEventSubscription(DeleteEventSubscriptionRequest request)
Deletes an Amazon Redshift event notification subscription.
deleteEventSubscription
in interface AmazonRedshift
deleteEventSubscriptionRequest
- SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidSubscriptionStateException
- The subscription request is invalid because it is a duplicate request. This subscription request is
already in progress.public DeleteHsmClientCertificateResult deleteHsmClientCertificate(DeleteHsmClientCertificateRequest request)
Deletes the specified HSM client certificate.
deleteHsmClientCertificate
in interface AmazonRedshift
deleteHsmClientCertificateRequest
- InvalidHsmClientCertificateStateException
- The specified HSM client certificate is not in the available
state, or it is still in use by
one or more Amazon Redshift clusters.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.public DeleteHsmConfigurationResult deleteHsmConfiguration(DeleteHsmConfigurationRequest request)
Deletes the specified Amazon Redshift HSM configuration.
deleteHsmConfiguration
in interface AmazonRedshift
deleteHsmConfigurationRequest
- InvalidHsmConfigurationStateException
- The specified HSM configuration is not in the available
state, or it is still in use by one
or more Amazon Redshift clusters.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.public DeleteSnapshotCopyGrantResult deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest request)
Deletes the specified snapshot copy grant.
deleteSnapshotCopyGrant
in interface AmazonRedshift
deleteSnapshotCopyGrantRequest
- The result of the DeleteSnapshotCopyGrant
action.InvalidSnapshotCopyGrantStateException
- The snapshot copy grant can't be deleted because it is used by one or more clusters.SnapshotCopyGrantNotFoundException
- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the
grant exists in the destination region.public DeleteTagsResult deleteTags(DeleteTagsRequest request)
Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
deleteTags
in interface AmazonRedshift
deleteTagsRequest
- Contains the output from the DeleteTags
action.ResourceNotFoundException
- The resource could not be found.InvalidTagException
- The tag is invalid.public DescribeClusterParameterGroupsResult describeClusterParameterGroups(DescribeClusterParameterGroupsRequest request)
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups
that match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all parameter
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterParameterGroups
in interface AmazonRedshift
describeClusterParameterGroupsRequest
- ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InvalidTagException
- The tag is invalid.public DescribeClusterParameterGroupsResult describeClusterParameterGroups()
AmazonRedshift
describeClusterParameterGroups
in interface AmazonRedshift
AmazonRedshift.describeClusterParameterGroups(DescribeClusterParameterGroupsRequest)
public DescribeClusterParametersResult describeClusterParameters(DescribeClusterParametersRequest request)
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
describeClusterParameters
in interface AmazonRedshift
describeClusterParametersRequest
- ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.public DescribeClusterSecurityGroupsResult describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest request)
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 Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all security
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterSecurityGroups
in interface AmazonRedshift
describeClusterSecurityGroupsRequest
- ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.InvalidTagException
- The tag is invalid.public DescribeClusterSecurityGroupsResult describeClusterSecurityGroups()
AmazonRedshift
describeClusterSecurityGroups
in interface AmazonRedshift
AmazonRedshift.describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest)
public DescribeClusterSnapshotsResult describeClusterSnapshots(DescribeClusterSnapshotsRequest request)
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots that you own are returned in the response;
shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
describeClusterSnapshots
in interface AmazonRedshift
describeClusterSnapshotsRequest
- ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.InvalidTagException
- The tag is invalid.public DescribeClusterSnapshotsResult describeClusterSnapshots()
AmazonRedshift
describeClusterSnapshots
in interface AmazonRedshift
AmazonRedshift.describeClusterSnapshots(DescribeClusterSnapshotsRequest)
public DescribeClusterSubnetGroupsResult describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest request)
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.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all subnet
groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
describeClusterSubnetGroups
in interface AmazonRedshift
describeClusterSubnetGroupsRequest
- ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.InvalidTagException
- The tag is invalid.public DescribeClusterSubnetGroupsResult describeClusterSubnetGroups()
AmazonRedshift
describeClusterSubnetGroups
in interface AmazonRedshift
AmazonRedshift.describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest)
public DescribeClusterVersionsResult describeClusterVersions(DescribeClusterVersionsRequest request)
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 Cluster Management Guide.
describeClusterVersions
in interface AmazonRedshift
describeClusterVersionsRequest
- public DescribeClusterVersionsResult describeClusterVersions()
AmazonRedshift
describeClusterVersions
in interface AmazonRedshift
AmazonRedshift.describeClusterVersions(DescribeClusterVersionsRequest)
public DescribeClustersResult describeClusters(DescribeClustersRequest request)
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 Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all clusters
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
describeClusters
in interface AmazonRedshift
describeClustersRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidTagException
- The tag is invalid.public DescribeClustersResult describeClusters()
AmazonRedshift
describeClusters
in interface AmazonRedshift
AmazonRedshift.describeClusters(DescribeClustersRequest)
public DefaultClusterParameters describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest request)
Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
describeDefaultClusterParameters
in interface AmazonRedshift
describeDefaultClusterParametersRequest
- public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
describeEventCategories
in interface AmazonRedshift
describeEventCategoriesRequest
- public DescribeEventCategoriesResult describeEventCategories()
AmazonRedshift
describeEventCategories
in interface AmazonRedshift
AmazonRedshift.describeEventCategories(DescribeEventCategoriesRequest)
public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification
subscriptions that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all subscriptions that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
describeEventSubscriptions
in interface AmazonRedshift
describeEventSubscriptionsRequest
- SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.InvalidTagException
- The tag is invalid.public DescribeEventSubscriptionsResult describeEventSubscriptions()
AmazonRedshift
describeEventSubscriptions
in interface AmazonRedshift
AmazonRedshift.describeEventSubscriptions(DescribeEventSubscriptionsRequest)
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
describeEvents
in interface AmazonRedshift
describeEventsRequest
- public DescribeEventsResult describeEvents()
AmazonRedshift
describeEvents
in interface AmazonRedshift
AmazonRedshift.describeEvents(DescribeEventsRequest)
public DescribeHsmClientCertificatesResult describeHsmClientCertificates(DescribeHsmClientCertificatesRequest request)
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client
certificates that match any combination of the specified keys and values. For example, if you have
owner
and environment
for tag keys, and admin
and test
for
tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
describeHsmClientCertificates
in interface AmazonRedshift
describeHsmClientCertificatesRequest
- HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.InvalidTagException
- The tag is invalid.public DescribeHsmClientCertificatesResult describeHsmClientCertificates()
AmazonRedshift
describeHsmClientCertificates
in interface AmazonRedshift
AmazonRedshift.describeHsmClientCertificates(DescribeHsmClientCertificatesRequest)
public DescribeHsmConfigurationsResult describeHsmConfigurations(DescribeHsmConfigurationsRequest request)
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that
match any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all HSM
connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
describeHsmConfigurations
in interface AmazonRedshift
describeHsmConfigurationsRequest
- HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidTagException
- The tag is invalid.public DescribeHsmConfigurationsResult describeHsmConfigurations()
AmazonRedshift
describeHsmConfigurations
in interface AmazonRedshift
AmazonRedshift.describeHsmConfigurations(DescribeHsmConfigurationsRequest)
public DescribeLoggingStatusResult describeLoggingStatus(DescribeLoggingStatusRequest request)
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
describeLoggingStatus
in interface AmazonRedshift
describeLoggingStatusRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.public DescribeOrderableClusterOptionsResult describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest request)
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 Cluster Management Guide.
describeOrderableClusterOptions
in interface AmazonRedshift
describeOrderableClusterOptionsRequest
- public DescribeOrderableClusterOptionsResult describeOrderableClusterOptions()
AmazonRedshift
describeOrderableClusterOptions
in interface AmazonRedshift
AmazonRedshift.describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest)
public DescribeReservedNodeOfferingsResult describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest request)
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 reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
describeReservedNodeOfferings
in interface AmazonRedshift
describeReservedNodeOfferingsRequest
- ReservedNodeOfferingNotFoundException
- Specified offering does not exist.UnsupportedOperationException
- The requested operation isn't supported.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.public DescribeReservedNodeOfferingsResult describeReservedNodeOfferings()
AmazonRedshift
describeReservedNodeOfferings
in interface AmazonRedshift
AmazonRedshift.describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest)
public DescribeReservedNodesResult describeReservedNodes(DescribeReservedNodesRequest request)
Returns the descriptions of the reserved nodes.
describeReservedNodes
in interface AmazonRedshift
describeReservedNodesRequest
- ReservedNodeNotFoundException
- The specified reserved compute node not found.DependentServiceUnavailableException
- Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30
to 60 seconds and try again.public DescribeReservedNodesResult describeReservedNodes()
AmazonRedshift
describeReservedNodes
in interface AmazonRedshift
AmazonRedshift.describeReservedNodes(DescribeReservedNodesRequest)
public DescribeResizeResult describeResize(DescribeResizeRequest request)
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.
describeResize
in interface AmazonRedshift
describeResizeRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.ResizeNotFoundException
- A resize operation for the specified cluster is not found.public DescribeSnapshotCopyGrantsResult describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest request)
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
describeSnapshotCopyGrants
in interface AmazonRedshift
describeSnapshotCopyGrantsRequest
- The result of the DescribeSnapshotCopyGrants
action.SnapshotCopyGrantNotFoundException
- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the
grant exists in the destination region.InvalidTagException
- The tag is invalid.public DescribeSnapshotCopyGrantsResult describeSnapshotCopyGrants()
AmazonRedshift
describeSnapshotCopyGrants
in interface AmazonRedshift
AmazonRedshift.describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest)
public DescribeTableRestoreStatusResult describeTableRestoreStatus(DescribeTableRestoreStatusRequest request)
Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API
action. If you don't specify a value for the TableRestoreRequestId
parameter, then
DescribeTableRestoreStatus
returns the status of all table restore requests ordered by the date and
time of the request in ascending order. Otherwise DescribeTableRestoreStatus
returns the status of
the table specified by TableRestoreRequestId
.
describeTableRestoreStatus
in interface AmazonRedshift
describeTableRestoreStatusRequest
- TableRestoreNotFoundException
- The specified TableRestoreRequestId
value was not found.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.public DescribeTableRestoreStatusResult describeTableRestoreStatus()
AmazonRedshift
describeTableRestoreStatus
in interface AmazonRedshift
AmazonRedshift.describeTableRestoreStatus(DescribeTableRestoreStatusRequest)
public DescribeTagsResult describeTags(DescribeTagsRequest request)
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags
:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords
and Marker
parameters together with the ARN parameter.
The MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match
any combination of the specified keys and values. For example, if you have owner
and
environment
for tag keys, and admin
and test
for tag values, all resources
that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
describeTags
in interface AmazonRedshift
describeTagsRequest
- ResourceNotFoundException
- The resource could not be found.InvalidTagException
- The tag is invalid.public DescribeTagsResult describeTags()
AmazonRedshift
describeTags
in interface AmazonRedshift
AmazonRedshift.describeTags(DescribeTagsRequest)
public DisableLoggingResult disableLogging(DisableLoggingRequest request)
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
disableLogging
in interface AmazonRedshift
disableLoggingRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.public Cluster disableSnapshotCopy(DisableSnapshotCopyRequest request)
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
disableSnapshotCopy
in interface AmazonRedshift
disableSnapshotCopyRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SnapshotCopyAlreadyDisabledException
- The cluster already has cross-region snapshot copy disabled.InvalidClusterStateException
- The specified cluster is not in the available
state.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.public EnableLoggingResult enableLogging(EnableLoggingRequest request)
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
enableLogging
in interface AmazonRedshift
enableLoggingRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.BucketNotFoundException
- Could not find the specified S3 bucket.InsufficientS3BucketPolicyException
- The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling
logging.InvalidS3KeyPrefixException
- The string specified for the logging S3 key prefix does not comply with the documented constraints.InvalidS3BucketNameException
- The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and
Limitations in the Amazon Simple Storage Service (S3) Developer Guide.public Cluster enableSnapshotCopy(EnableSnapshotCopyRequest request)
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
enableSnapshotCopy
in interface AmazonRedshift
enableSnapshotCopyRequest
- IncompatibleOrderableOptionsException
- The specified options are incompatible.InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.CopyToRegionDisabledException
- Cross-region snapshot copy was temporarily disabled. Try your request again.SnapshotCopyAlreadyEnabledException
- The cluster already has cross-region snapshot copy enabled.UnknownSnapshotCopyRegionException
- The specified region is incorrect or does not exist.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.SnapshotCopyGrantNotFoundException
- The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the
grant exists in the destination region.LimitExceededException
- The encryption key has exceeded its grant limit in AWS KMS.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.public GetClusterCredentialsResult getClusterCredentials(GetClusterCredentialsRequest request)
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift
database. The action returns the database user name prefixed with IAM:
if AutoCreate
is
False
or IAMA:
if AutoCreate
is True
. You can optionally
specify one or more database user groups that the user will join at log on. By default, the temporary credentials
expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds
(60 minutes). For more information, see Using IAM Authentication
to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups
parameter is specified, the IAM policy must allow the
redshift:JoinGroup
action with access to the listed dbgroups
.
In addition, if the AutoCreate
parameter is set to True
, then the policy must include
the redshift:CreateClusterUser
privilege.
If the DbName
parameter is specified, the IAM policy must allow access to the resource
dbname
for the specified database name.
getClusterCredentials
in interface AmazonRedshift
getClusterCredentialsRequest
- The request parameters to get cluster credentials.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.UnsupportedOperationException
- The requested operation isn't supported.public Cluster modifyCluster(ModifyClusterRequest request)
Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster 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.
modifyCluster
in interface AmazonRedshift
modifyClusterRequest
- InvalidClusterStateException
- The specified cluster is not in the available
state.InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.NumberOfNodesQuotaExceededException
- The operation would exceed the number of nodes allotted to the account. For information about increasing
your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException
- The operation would exceed the number of nodes allowed for a cluster.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InsufficientClusterCapacityException
- The number of nodes specified exceeds the allotted capacity of the cluster.UnsupportedOptionException
- A request option was specified that is not supported.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.ClusterAlreadyExistsException
- The account already has a cluster with the given identifier.LimitExceededException
- The encryption key has exceeded its grant limit in AWS KMS.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.InvalidElasticIpException
- The Elastic IP (EIP) is invalid or cannot be found.public Cluster modifyClusterIamRoles(ModifyClusterIamRolesRequest request)
Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
A cluster can have up to 10 IAM roles associated at any time.
modifyClusterIamRoles
in interface AmazonRedshift
modifyClusterIamRolesRequest
- InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.public ModifyClusterParameterGroupResult modifyClusterParameterGroup(ModifyClusterParameterGroupRequest request)
Modifies the parameters of a parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
modifyClusterParameterGroup
in interface AmazonRedshift
modifyClusterParameterGroupRequest
- ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.InvalidClusterParameterGroupStateException
- The cluster parameter group action can not be completed because another task is in progress that involves
the parameter group. Wait a few moments and try the operation again.public ClusterSubnetGroup modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest request)
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.
modifyClusterSubnetGroup
in interface AmazonRedshift
modifyClusterSubnetGroupRequest
- ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.ClusterSubnetQuotaExceededException
- The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For
information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.SubnetAlreadyInUseException
- A specified subnet is already in use by another cluster.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.public EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest request)
Modifies an existing Amazon Redshift event notification subscription.
modifyEventSubscription
in interface AmazonRedshift
modifyEventSubscriptionRequest
- SubscriptionNotFoundException
- An Amazon Redshift event notification subscription with the specified name does not exist.SNSInvalidTopicException
- Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.SNSNoAuthorizationException
- You do not have permission to publish to the specified Amazon SNS topic.SNSTopicArnNotFoundException
- An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.SubscriptionEventIdNotFoundException
- An Amazon Redshift event with the specified event ID does not exist.SubscriptionCategoryNotFoundException
- The value specified for the event category was not one of the allowed values, or it specified a category
that does not apply to the specified source type. The allowed values are Configuration, Management,
Monitoring, and Security.SubscriptionSeverityNotFoundException
- The value specified for the event severity was not one of the allowed values, or it specified a severity
that does not apply to the specified source type. The allowed values are ERROR and INFO.SourceNotFoundException
- The specified Amazon Redshift event source could not be found.InvalidSubscriptionStateException
- The subscription request is invalid because it is a duplicate request. This subscription request is
already in progress.public Cluster modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest request)
Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
modifySnapshotCopyRetentionPeriod
in interface AmazonRedshift
modifySnapshotCopyRetentionPeriodRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.SnapshotCopyDisabledException
- Cross-region snapshot copy was temporarily disabled. Try your request again.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.InvalidClusterStateException
- The specified cluster is not in the available
state.public ReservedNode purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest request)
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more 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 reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
purchaseReservedNodeOffering
in interface AmazonRedshift
purchaseReservedNodeOfferingRequest
- ReservedNodeOfferingNotFoundException
- Specified offering does not exist.ReservedNodeAlreadyExistsException
- User already has a reservation with the given identifier.ReservedNodeQuotaExceededException
- Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.UnsupportedOperationException
- The requested operation isn't supported.public Cluster rebootCluster(RebootClusterRequest request)
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 Cluster Management Guide.
rebootCluster
in interface AmazonRedshift
rebootClusterRequest
- InvalidClusterStateException
- The specified cluster is not in the available
state.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.public ResetClusterParameterGroupResult resetClusterParameterGroup(ResetClusterParameterGroupRequest request)
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.
resetClusterParameterGroup
in interface AmazonRedshift
resetClusterParameterGroupRequest
- InvalidClusterParameterGroupStateException
- The cluster parameter group action can not be completed because another task is in progress that involves
the parameter group. Wait a few moments and try the operation again.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.public Cluster restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest request)
Creates a new cluster from a snapshot. By default, 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 groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.
If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
restoreFromClusterSnapshot
in interface AmazonRedshift
restoreFromClusterSnapshotRequest
- AccessToSnapshotDeniedException
- The owner of the specified snapshot has not authorized your account to access the snapshot.ClusterAlreadyExistsException
- The account already has a cluster with the given identifier.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.ClusterQuotaExceededException
- The request would exceed the allowed number of cluster instances for this account. For information about
increasing your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.InsufficientClusterCapacityException
- The number of nodes specified exceeds the allotted capacity of the cluster.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.InvalidRestoreException
- The restore is invalid.NumberOfNodesQuotaExceededException
- The operation would exceed the number of nodes allotted to the account. For information about increasing
your quota, go to Limits in Amazon
Redshift in the Amazon Redshift Cluster Management Guide.NumberOfNodesPerClusterLimitExceededException
- The operation would exceed the number of nodes allowed for a cluster.InvalidVPCNetworkStateException
- The cluster subnet group does not cover all Availability Zones.InvalidClusterSubnetGroupStateException
- The cluster subnet group cannot be deleted because it is in use.InvalidSubnetException
- The requested subnet is not valid, or not all of the subnets are in the same VPC.ClusterSubnetGroupNotFoundException
- The cluster subnet group name does not refer to an existing cluster subnet group.UnauthorizedOperationException
- Your account is not authorized to perform the requested operation.HsmClientCertificateNotFoundException
- There is no Amazon Redshift HSM client certificate with the specified identifier.HsmConfigurationNotFoundException
- There is no Amazon Redshift HSM configuration with the specified identifier.InvalidElasticIpException
- The Elastic IP (EIP) is invalid or cannot be found.ClusterParameterGroupNotFoundException
- The parameter group name does not refer to an existing parameter group.ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.LimitExceededException
- The encryption key has exceeded its grant limit in AWS KMS.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.public TableRestoreStatus restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest request)
Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.
You cannot use RestoreTableFromClusterSnapshot
to restore a table with the same name as an existing
table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored
table. If you want to replace your original table with a new, restored table, then rename or drop your original
table before you call RestoreTableFromClusterSnapshot
. When you have renamed your original table,
then you can pass the original name of the table as the NewTableName
parameter value in the call to
RestoreTableFromClusterSnapshot
. This way, you can replace the original table with the table created
from the snapshot.
restoreTableFromClusterSnapshot
in interface AmazonRedshift
restoreTableFromClusterSnapshotRequest
- ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.InProgressTableRestoreQuotaExceededException
- You have exceeded the allowed number of table restore requests. Wait for your current table restore
requests to complete before making a new request.InvalidClusterSnapshotStateException
- The specified cluster snapshot is not in the available
state, or other accounts are
authorized to access the snapshot.InvalidTableRestoreArgumentException
- The value specified for the sourceDatabaseName
, sourceSchemaName
, or
sourceTableName
parameter, or a combination of these, doesn't exist in the snapshot.ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidClusterStateException
- The specified cluster is not in the available
state.UnsupportedOperationException
- The requested operation isn't supported.public ClusterSecurityGroup revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest request)
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 Cluster Management Guide.
revokeClusterSecurityGroupIngress
in interface AmazonRedshift
revokeClusterSecurityGroupIngressRequest
- ClusterSecurityGroupNotFoundException
- The cluster security group name does not refer to an existing cluster security group.AuthorizationNotFoundException
- The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security
group.InvalidClusterSecurityGroupStateException
- The state of the cluster security group is not available
.public Snapshot revokeSnapshotAccess(RevokeSnapshotAccessRequest request)
Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
revokeSnapshotAccess
in interface AmazonRedshift
revokeSnapshotAccessRequest
- AccessToSnapshotDeniedException
- The owner of the specified snapshot has not authorized your account to access the snapshot.AuthorizationNotFoundException
- The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security
group.ClusterSnapshotNotFoundException
- The snapshot identifier does not refer to an existing cluster snapshot.public Cluster rotateEncryptionKey(RotateEncryptionKeyRequest request)
Rotates the encryption keys for a cluster.
rotateEncryptionKey
in interface AmazonRedshift
rotateEncryptionKeyRequest
- ClusterNotFoundException
- The ClusterIdentifier
parameter does not refer to an existing cluster.InvalidClusterStateException
- The specified cluster is not in the available
state.DependentServiceRequestThrottlingException
- The request cannot be completed because a dependent service is throttling requests made by Amazon
Redshift on your behalf. Wait and retry the request.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonRedshift
request
- The originally executed requestpublic AmazonRedshiftWaiters waiters()
waiters
in interface AmazonRedshift
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonRedshift
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.