public interface AmazonRedshift
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.
| Modifier and Type | Method and Description |
|---|---|
ClusterSecurityGroup |
authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest)
Adds an inbound (ingress) rule to an Amazon Redshift security group.
|
Snapshot |
authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest)
Authorizes the specified AWS customer account to restore the
specified snapshot.
|
Snapshot |
copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest)
Copies the specified automated cluster snapshot to a new manual
cluster snapshot.
|
Cluster |
createCluster(CreateClusterRequest createClusterRequest)
Creates a new cluster.
|
ClusterParameterGroup |
createClusterParameterGroup(CreateClusterParameterGroupRequest createClusterParameterGroupRequest)
Creates an Amazon Redshift parameter group.
|
ClusterSecurityGroup |
createClusterSecurityGroup(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest)
Creates a new Amazon Redshift security group.
|
Snapshot |
createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)
Creates a manual snapshot of the specified cluster.
|
ClusterSubnetGroup |
createClusterSubnetGroup(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest)
Creates a new Amazon Redshift subnet group.
|
EventSubscription |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an Amazon Redshift event notification subscription.
|
HsmClientCertificate |
createHsmClientCertificate(CreateHsmClientCertificateRequest createHsmClientCertificateRequest)
Creates an HSM client certificate that an Amazon Redshift cluster
will use to connect to the client's HSM in order to store and retrieve
the keys used to encrypt the cluster databases.
|
HsmConfiguration |
createHsmConfiguration(CreateHsmConfigurationRequest createHsmConfigurationRequest)
Creates an HSM configuration that contains the information required
by an Amazon Redshift cluster to store and use database encryption
keys in a Hardware Security Module (HSM).
|
SnapshotCopyGrant |
createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest createSnapshotCopyGrantRequest)
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.
|
void |
createTags(CreateTagsRequest createTagsRequest)
Adds one or more tags to a specified resource.
|
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.
|
void |
deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest)
Deletes the specified snapshot copy grant.
|
void |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes a tag or tags from a resource.
|
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.
|
DescribeSnapshotCopyGrantsResult |
describeSnapshotCopyGrants()
Returns a list of snapshot copy grants owned by the AWS account in
the destination region.
|
DescribeSnapshotCopyGrantsResult |
describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest)
Returns a list of snapshot copy grants owned by the AWS account in
the destination region.
|
DescribeTableRestoreStatusResult |
describeTableRestoreStatus()
Lists the status of one or more table restore requests made using the
RestoreTableFromClusterSnapshot API action.
|
DescribeTableRestoreStatusResult |
describeTableRestoreStatus(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest)
Lists the status of one or more table restore requests made using the
RestoreTableFromClusterSnapshot API action.
|
DescribeTagsResult |
describeTags()
Returns a list of tags.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest describeTagsRequest)
Returns a list of tags.
|
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.
|
TableRestoreStatus |
restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest)
Creates a new table from a table in an Amazon Redshift cluster
snapshot.
|
ClusterSecurityGroup |
revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest)
Revokes an ingress rule in an Amazon Redshift security group for a
previously authorized IP range or Amazon EC2 security group.
|
Snapshot |
revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest)
Removes the ability of the specified AWS customer account to restore
the specified snapshot.
|
Cluster |
rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest)
Rotates the encryption keys for a cluster.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://redshift.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String), sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
Callers can pass in just the endpoint (ex: "redshift.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex: "https://redshift.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "redshift.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "https://redshift.us-east-1.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.IllegalArgumentException - If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
setEndpoint(String), sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.IllegalArgumentException - If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)Snapshot revokeSnapshotAccess(RevokeSnapshotAccessRequest revokeSnapshotAccessRequest) throws AmazonServiceException, AmazonClientException
Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide .
revokeSnapshotAccessRequest - Container for the necessary
parameters to execute the RevokeSnapshotAccess service method on
AmazonRedshift.AccessToSnapshotDeniedExceptionClusterSnapshotNotFoundExceptionAuthorizationNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Cluster modifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest modifySnapshotCopyRetentionPeriodRequest) throws AmazonServiceException, AmazonClientException
Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
modifySnapshotCopyRetentionPeriodRequest - Container for the
necessary parameters to execute the ModifySnapshotCopyRetentionPeriod
service method on AmazonRedshift.SnapshotCopyDisabledExceptionUnauthorizedOperationExceptionInvalidClusterStateExceptionClusterNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.ClusterSubnetGroup modifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest modifyClusterSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
modifyClusterSubnetGroupRequest - Container for the necessary
parameters to execute the ModifyClusterSubnetGroup service method on
AmazonRedshift.SubnetAlreadyInUseExceptionInvalidSubnetExceptionUnauthorizedOperationExceptionDependentServiceRequestThrottlingExceptionClusterSubnetQuotaExceededExceptionClusterSubnetGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.ReservedNode purchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest purchaseReservedNodeOfferingRequest) throws AmazonServiceException, AmazonClientException
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one 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 .
purchaseReservedNodeOfferingRequest - Container for the necessary
parameters to execute the PurchaseReservedNodeOffering service method
on AmazonRedshift.UnsupportedOperationExceptionReservedNodeAlreadyExistsExceptionReservedNodeOfferingNotFoundExceptionReservedNodeQuotaExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.void deleteHsmConfiguration(DeleteHsmConfigurationRequest deleteHsmConfigurationRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified Amazon Redshift HSM configuration.
deleteHsmConfigurationRequest - Container for the necessary
parameters to execute the DeleteHsmConfiguration service method on
AmazonRedshift.HsmConfigurationNotFoundExceptionInvalidHsmConfigurationStateExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DisableLoggingResult disableLogging(DisableLoggingRequest disableLoggingRequest) throws AmazonServiceException, AmazonClientException
Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
disableLoggingRequest - Container for the necessary parameters to
execute the DisableLogging service method on AmazonRedshift.ClusterNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.void deleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest deleteSnapshotCopyGrantRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified snapshot copy grant.
deleteSnapshotCopyGrantRequest - Container for the necessary
parameters to execute the DeleteSnapshotCopyGrant service method on
AmazonRedshift.InvalidSnapshotCopyGrantStateExceptionSnapshotCopyGrantNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Cluster modifyCluster(ModifyClusterRequest modifyClusterRequest) throws AmazonServiceException, AmazonClientException
Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift 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.
modifyClusterRequest - Container for the necessary parameters to
execute the ModifyCluster service method on AmazonRedshift.InvalidElasticIpExceptionInvalidClusterSecurityGroupStateExceptionHsmConfigurationNotFoundExceptionDependentServiceRequestThrottlingExceptionInvalidClusterStateExceptionUnsupportedOptionExceptionClusterAlreadyExistsExceptionClusterParameterGroupNotFoundExceptionInsufficientClusterCapacityExceptionUnauthorizedOperationExceptionNumberOfNodesQuotaExceededExceptionClusterNotFoundExceptionLimitExceededExceptionHsmClientCertificateNotFoundExceptionClusterSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.void deleteTags(DeleteTagsRequest deleteTagsRequest) throws AmazonServiceException, AmazonClientException
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.
deleteTagsRequest - Container for the necessary parameters to
execute the DeleteTags service method on AmazonRedshift.ResourceNotFoundExceptionInvalidTagExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Snapshot copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest) throws AmazonServiceException, AmazonClientException
Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide .
copyClusterSnapshotRequest - Container for the necessary
parameters to execute the CopyClusterSnapshot service method on
AmazonRedshift.ClusterSnapshotAlreadyExistsExceptionClusterSnapshotNotFoundExceptionClusterSnapshotQuotaExceededExceptionInvalidClusterSnapshotStateExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeOrderableClusterOptionsResult describeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest describeOrderableClusterOptionsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide
describeOrderableClusterOptionsRequest - Container for the
necessary parameters to execute the DescribeOrderableClusterOptions
service method on AmazonRedshift.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.EnableLoggingResult enableLogging(EnableLoggingRequest enableLoggingRequest) throws AmazonServiceException, AmazonClientException
Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
enableLoggingRequest - Container for the necessary parameters to
execute the EnableLogging service method on AmazonRedshift.InvalidS3KeyPrefixExceptionInvalidS3BucketNameExceptionBucketNotFoundExceptionClusterNotFoundExceptionInsufficientS3BucketPolicyExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.ClusterSubnetGroup createClusterSubnetGroup(CreateClusterSubnetGroupRequest createClusterSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide .
createClusterSubnetGroupRequest - Container for the necessary
parameters to execute the CreateClusterSubnetGroup service method on
AmazonRedshift.TagLimitExceededExceptionInvalidSubnetExceptionInvalidTagExceptionUnauthorizedOperationExceptionDependentServiceRequestThrottlingExceptionClusterSubnetQuotaExceededExceptionClusterSubnetGroupAlreadyExistsExceptionClusterSubnetGroupQuotaExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeTableRestoreStatusResult describeTableRestoreStatus(DescribeTableRestoreStatusRequest describeTableRestoreStatusRequest) throws AmazonServiceException, AmazonClientException
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
in-progress table restore requests. Otherwise
DescribeTableRestoreStatus returns the status of the
table specified by TableRestoreRequestId .
describeTableRestoreStatusRequest - Container for the necessary
parameters to execute the DescribeTableRestoreStatus service method on
AmazonRedshift.ClusterNotFoundExceptionTableRestoreNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.void deleteHsmClientCertificate(DeleteHsmClientCertificateRequest deleteHsmClientCertificateRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified HSM client certificate.
deleteHsmClientCertificateRequest - Container for the necessary
parameters to execute the DeleteHsmClientCertificate service method on
AmazonRedshift.InvalidHsmClientCertificateStateExceptionHsmClientCertificateNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Cluster rebootCluster(RebootClusterRequest rebootClusterRequest) throws AmazonServiceException, AmazonClientException
Reboots a cluster. This action is taken as soon as possible. It
results in a momentary outage to the cluster, during which the cluster
status is set to rebooting . A cluster event is created
when the reboot is completed. Any pending cluster modifications (see
ModifyCluster) are applied at this reboot. For more information about
managing clusters, go to
Amazon Redshift Clusters
in the Amazon Redshift Cluster Management Guide
rebootClusterRequest - Container for the necessary parameters to
execute the RebootCluster service method on AmazonRedshift.InvalidClusterStateExceptionClusterNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.void deleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest deleteClusterSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified cluster subnet group.
deleteClusterSubnetGroupRequest - Container for the necessary
parameters to execute the DeleteClusterSubnetGroup service method on
AmazonRedshift.InvalidClusterSubnetStateExceptionClusterSubnetGroupNotFoundExceptionInvalidClusterSubnetGroupStateExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Snapshot createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest) throws AmazonServiceException, AmazonClientException
Creates a manual snapshot of the specified cluster. The cluster must
be in the available state.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide .
createClusterSnapshotRequest - Container for the necessary
parameters to execute the CreateClusterSnapshot service method on
AmazonRedshift.TagLimitExceededExceptionClusterSnapshotAlreadyExistsExceptionInvalidTagExceptionInvalidClusterStateExceptionClusterNotFoundExceptionClusterSnapshotQuotaExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Cluster deleteCluster(DeleteClusterRequest deleteClusterRequest) throws AmazonServiceException, AmazonClientException
Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. 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 .
deleteClusterRequest - Container for the necessary parameters to
execute the DeleteCluster service method on AmazonRedshift.ClusterSnapshotAlreadyExistsExceptionInvalidClusterStateExceptionClusterNotFoundExceptionClusterSnapshotQuotaExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Cluster createCluster(CreateClusterRequest createClusterRequest) throws AmazonServiceException, AmazonClientException
Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
createClusterRequest - Container for the necessary parameters to
execute the CreateCluster service method on AmazonRedshift.InvalidElasticIpExceptionInvalidSubnetExceptionHsmConfigurationNotFoundExceptionInvalidTagExceptionDependentServiceRequestThrottlingExceptionClusterSubnetGroupNotFoundExceptionInvalidClusterSubnetGroupStateExceptionClusterAlreadyExistsExceptionInvalidVPCNetworkStateExceptionClusterParameterGroupNotFoundExceptionTagLimitExceededExceptionUnauthorizedOperationExceptionInsufficientClusterCapacityExceptionNumberOfNodesQuotaExceededExceptionNumberOfNodesPerClusterLimitExceededExceptionLimitExceededExceptionClusterQuotaExceededExceptionClusterSecurityGroupNotFoundExceptionHsmClientCertificateNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest) throws AmazonServiceException, AmazonClientException
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
describeEventsRequest - Container for the necessary parameters to
execute the DescribeEvents service method on AmazonRedshift.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.ClusterSecurityGroup authorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest authorizeClusterSecurityGroupIngressRequest) throws AmazonServiceException, AmazonClientException
Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an 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 .
authorizeClusterSecurityGroupIngressRequest - Container for the
necessary parameters to execute the
AuthorizeClusterSecurityGroupIngress service method on AmazonRedshift.InvalidClusterSecurityGroupStateExceptionAuthorizationAlreadyExistsExceptionAuthorizationQuotaExceededExceptionClusterSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Cluster rotateEncryptionKey(RotateEncryptionKeyRequest rotateEncryptionKeyRequest) throws AmazonServiceException, AmazonClientException
Rotates the encryption keys for a cluster.
rotateEncryptionKeyRequest - Container for the necessary
parameters to execute the RotateEncryptionKey service method on
AmazonRedshift.InvalidClusterStateExceptionDependentServiceRequestThrottlingExceptionClusterNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.void deleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest deleteClusterSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes an Amazon Redshift security group.
NOTE:You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide .
deleteClusterSecurityGroupRequest - Container for the necessary
parameters to execute the DeleteClusterSecurityGroup service method on
AmazonRedshift.InvalidClusterSecurityGroupStateExceptionClusterSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeReservedNodesResult describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest) throws AmazonServiceException, AmazonClientException
Returns the descriptions of the reserved nodes.
describeReservedNodesRequest - Container for the necessary
parameters to execute the DescribeReservedNodes service method on
AmazonRedshift.ReservedNodeNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DefaultClusterParameters describeDefaultClusterParameters(DescribeDefaultClusterParametersRequest describeDefaultClusterParametersRequest) throws AmazonServiceException, AmazonClientException
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 .
describeDefaultClusterParametersRequest - Container for the
necessary parameters to execute the DescribeDefaultClusterParameters
service method on AmazonRedshift.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Modifies an existing Amazon Redshift event notification subscription.
modifyEventSubscriptionRequest - Container for the necessary
parameters to execute the ModifyEventSubscription service method on
AmazonRedshift.SubscriptionCategoryNotFoundExceptionInvalidSubscriptionStateExceptionSubscriptionEventIdNotFoundExceptionSubscriptionSeverityNotFoundExceptionSourceNotFoundExceptionSNSNoAuthorizationExceptionSNSTopicArnNotFoundExceptionSubscriptionNotFoundExceptionSNSInvalidTopicExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.ClusterSecurityGroup createClusterSecurityGroup(CreateClusterSecurityGroupRequest createClusterSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide .
createClusterSecurityGroupRequest - Container for the necessary
parameters to execute the CreateClusterSecurityGroup service method on
AmazonRedshift.TagLimitExceededExceptionInvalidTagExceptionClusterSecurityGroupQuotaExceededExceptionClusterSecurityGroupAlreadyExistsExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeResizeResult describeResize(DescribeResizeRequest describeResizeRequest) throws AmazonServiceException, AmazonClientException
Returns information about the last resize operation for the specified
cluster. If no resize operation has ever been initiated for the
specified cluster, a HTTP 404 error is returned. If a
resize operation was initiated and completed, the status of the resize
remains as SUCCEEDED until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
describeResizeRequest - Container for the necessary parameters to
execute the DescribeResize service method on AmazonRedshift.ClusterNotFoundExceptionResizeNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterVersionsResult describeClusterVersions(DescribeClusterVersionsRequest describeClusterVersionsRequest) throws AmazonServiceException, AmazonClientException
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide
describeClusterVersionsRequest - Container for the necessary
parameters to execute the DescribeClusterVersions service method on
AmazonRedshift.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.TableRestoreStatus restoreTableFromClusterSnapshot(RestoreTableFromClusterSnapshotRequest restoreTableFromClusterSnapshotRequest) throws AmazonServiceException, AmazonClientException
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.
restoreTableFromClusterSnapshotRequest - Container for the
necessary parameters to execute the RestoreTableFromClusterSnapshot
service method on AmazonRedshift.InProgressTableRestoreQuotaExceededExceptionInvalidClusterStateExceptionUnsupportedOperationExceptionClusterNotFoundExceptionClusterSnapshotNotFoundExceptionInvalidTableRestoreArgumentExceptionInvalidClusterSnapshotStateExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Cluster restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest restoreFromClusterSnapshotRequest) throws AmazonServiceException, AmazonClientException
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 .
restoreFromClusterSnapshotRequest - Container for the necessary
parameters to execute the RestoreFromClusterSnapshot service method on
AmazonRedshift.InvalidElasticIpExceptionInvalidSubnetExceptionHsmConfigurationNotFoundExceptionDependentServiceRequestThrottlingExceptionClusterSubnetGroupNotFoundExceptionInvalidClusterSubnetGroupStateExceptionClusterAlreadyExistsExceptionInvalidVPCNetworkStateExceptionClusterParameterGroupNotFoundExceptionInvalidClusterSnapshotStateExceptionAccessToSnapshotDeniedExceptionInvalidRestoreExceptionInsufficientClusterCapacityExceptionUnauthorizedOperationExceptionNumberOfNodesQuotaExceededExceptionNumberOfNodesPerClusterLimitExceededExceptionLimitExceededExceptionClusterSnapshotNotFoundExceptionClusterQuotaExceededExceptionHsmClientCertificateNotFoundExceptionClusterSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.void createTags(CreateTagsRequest createTagsRequest) throws AmazonServiceException, AmazonClientException
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.
createTagsRequest - Container for the necessary parameters to
execute the CreateTags service method on AmazonRedshift.TagLimitExceededExceptionResourceNotFoundExceptionInvalidTagExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest) throws AmazonServiceException, AmazonClientException
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 :
MaxRecords and
Marker parameters together with the ARN parameter.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.
describeTagsRequest - Container for the necessary parameters to
execute the DescribeTags service method on AmazonRedshift.ResourceNotFoundExceptionInvalidTagExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.ModifyClusterParameterGroupResult modifyClusterParameterGroup(ModifyClusterParameterGroupRequest modifyClusterParameterGroupRequest) throws AmazonServiceException, AmazonClientException
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 .
modifyClusterParameterGroupRequest - Container for the necessary
parameters to execute the ModifyClusterParameterGroup service method
on AmazonRedshift.InvalidClusterParameterGroupStateExceptionClusterParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AmazonServiceException, AmazonClientException
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications .
describeEventCategoriesRequest - Container for the necessary
parameters to execute the DescribeEventCategories service method on
AmazonRedshift.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterSecurityGroupsResult describeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest describeClusterSecurityGroupsRequest) throws AmazonServiceException, AmazonClientException
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift 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.
describeClusterSecurityGroupsRequest - Container for the
necessary parameters to execute the DescribeClusterSecurityGroups
service method on AmazonRedshift.InvalidTagExceptionClusterSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterSubnetGroupsResult describeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest describeClusterSubnetGroupsRequest) throws AmazonServiceException, AmazonClientException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
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.
describeClusterSubnetGroupsRequest - Container for the necessary
parameters to execute the DescribeClusterSubnetGroups service method
on AmazonRedshift.InvalidTagExceptionClusterSubnetGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeHsmConfigurationsResult describeHsmConfigurations(DescribeHsmConfigurationsRequest describeHsmConfigurationsRequest) throws AmazonServiceException, AmazonClientException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
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.
describeHsmConfigurationsRequest - Container for the necessary
parameters to execute the DescribeHsmConfigurations service method on
AmazonRedshift.HsmConfigurationNotFoundExceptionInvalidTagExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Snapshot deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest) throws AmazonServiceException, AmazonClientException
Deletes the specified manual snapshot. The snapshot must be in the
available state, with no other users authorized to access
the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
deleteClusterSnapshotRequest - Container for the necessary
parameters to execute the DeleteClusterSnapshot service method on
AmazonRedshift.ClusterSnapshotNotFoundExceptionInvalidClusterSnapshotStateExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.void deleteClusterParameterGroup(DeleteClusterParameterGroupRequest deleteClusterParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes a specified Amazon Redshift parameter group.
NOTE:You cannot delete a parameter group if it is associated with a cluster.
deleteClusterParameterGroupRequest - Container for the necessary
parameters to execute the DeleteClusterParameterGroup service method
on AmazonRedshift.InvalidClusterParameterGroupStateExceptionClusterParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Cluster disableSnapshotCopy(DisableSnapshotCopyRequest disableSnapshotCopyRequest) throws AmazonServiceException, AmazonClientException
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.
disableSnapshotCopyRequest - Container for the necessary
parameters to execute the DisableSnapshotCopy service method on
AmazonRedshift.SnapshotCopyAlreadyDisabledExceptionUnauthorizedOperationExceptionInvalidClusterStateExceptionClusterNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.EventSubscription createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.
If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.
createEventSubscriptionRequest - Container for the necessary
parameters to execute the CreateEventSubscription service method on
AmazonRedshift.TagLimitExceededExceptionSubscriptionCategoryNotFoundExceptionSubscriptionAlreadyExistExceptionInvalidTagExceptionEventSubscriptionQuotaExceededExceptionSubscriptionEventIdNotFoundExceptionSubscriptionSeverityNotFoundExceptionSourceNotFoundExceptionSNSNoAuthorizationExceptionSNSTopicArnNotFoundExceptionSNSInvalidTopicExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.ResetClusterParameterGroupResult resetClusterParameterGroup(ResetClusterParameterGroupRequest resetClusterParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.
resetClusterParameterGroupRequest - Container for the necessary
parameters to execute the ResetClusterParameterGroup service method on
AmazonRedshift.InvalidClusterParameterGroupStateExceptionClusterParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeSnapshotCopyGrantsResult describeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest describeSnapshotCopyGrantsRequest) throws AmazonServiceException, AmazonClientException
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 .
describeSnapshotCopyGrantsRequest - Container for the necessary
parameters to execute the DescribeSnapshotCopyGrants service method on
AmazonRedshift.InvalidTagExceptionSnapshotCopyGrantNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Snapshot authorizeSnapshotAccess(AuthorizeSnapshotAccessRequest authorizeSnapshotAccessRequest) throws AmazonServiceException, AmazonClientException
Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide .
authorizeSnapshotAccessRequest - Container for the necessary
parameters to execute the AuthorizeSnapshotAccess service method on
AmazonRedshift.DependentServiceRequestThrottlingExceptionAuthorizationAlreadyExistsExceptionLimitExceededExceptionClusterSnapshotNotFoundExceptionAuthorizationQuotaExceededExceptionInvalidClusterSnapshotStateExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.Cluster enableSnapshotCopy(EnableSnapshotCopyRequest enableSnapshotCopyRequest) throws AmazonServiceException, AmazonClientException
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
enableSnapshotCopyRequest - Container for the necessary
parameters to execute the EnableSnapshotCopy service method on
AmazonRedshift.CopyToRegionDisabledExceptionUnauthorizedOperationExceptionInvalidClusterStateExceptionDependentServiceRequestThrottlingExceptionClusterNotFoundExceptionLimitExceededExceptionIncompatibleOrderableOptionsExceptionSnapshotCopyAlreadyEnabledExceptionUnknownSnapshotCopyRegionExceptionSnapshotCopyGrantNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeReservedNodeOfferingsResult describeReservedNodeOfferings(DescribeReservedNodeOfferingsRequest describeReservedNodeOfferingsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide .
describeReservedNodeOfferingsRequest - Container for the
necessary parameters to execute the DescribeReservedNodeOfferings
service method on AmazonRedshift.UnsupportedOperationExceptionReservedNodeOfferingNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws AmazonServiceException, AmazonClientException
Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription.
describeEventSubscriptionsRequest - Container for the necessary
parameters to execute the DescribeEventSubscriptions service method on
AmazonRedshift.SubscriptionNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeLoggingStatusResult describeLoggingStatus(DescribeLoggingStatusRequest describeLoggingStatusRequest) throws AmazonServiceException, AmazonClientException
Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
describeLoggingStatusRequest - Container for the necessary
parameters to execute the DescribeLoggingStatus service method on
AmazonRedshift.ClusterNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.void deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Deletes an Amazon Redshift event notification subscription.
deleteEventSubscriptionRequest - Container for the necessary
parameters to execute the DeleteEventSubscription service method on
AmazonRedshift.InvalidSubscriptionStateExceptionSubscriptionNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.HsmClientCertificate createHsmClientCertificate(CreateHsmClientCertificateRequest createHsmClientCertificateRequest) throws AmazonServiceException, AmazonClientException
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
createHsmClientCertificateRequest - Container for the necessary
parameters to execute the CreateHsmClientCertificate service method on
AmazonRedshift.TagLimitExceededExceptionInvalidTagExceptionHsmClientCertificateQuotaExceededExceptionHsmClientCertificateAlreadyExistsExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeHsmClientCertificatesResult describeHsmClientCertificates(DescribeHsmClientCertificatesRequest describeHsmClientCertificatesRequest) throws AmazonServiceException, AmazonClientException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
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.
describeHsmClientCertificatesRequest - Container for the
necessary parameters to execute the DescribeHsmClientCertificates
service method on AmazonRedshift.InvalidTagExceptionHsmClientCertificateNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterParametersResult describeClusterParameters(DescribeClusterParametersRequest describeClusterParametersRequest) throws AmazonServiceException, AmazonClientException
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user .
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide .
describeClusterParametersRequest - Container for the necessary
parameters to execute the DescribeClusterParameters service method on
AmazonRedshift.ClusterParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.ClusterSecurityGroup revokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest revokeClusterSecurityGroupIngressRequest) throws AmazonServiceException, AmazonClientException
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide .
revokeClusterSecurityGroupIngressRequest - Container for the
necessary parameters to execute the RevokeClusterSecurityGroupIngress
service method on AmazonRedshift.InvalidClusterSecurityGroupStateExceptionAuthorizationNotFoundExceptionClusterSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClustersResult describeClusters(DescribeClustersRequest describeClustersRequest) throws AmazonServiceException, AmazonClientException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift 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.
describeClustersRequest - Container for the necessary parameters
to execute the DescribeClusters service method on AmazonRedshift.InvalidTagExceptionClusterNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.HsmConfiguration createHsmConfiguration(CreateHsmConfigurationRequest createHsmConfigurationRequest) throws AmazonServiceException, AmazonClientException
Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
createHsmConfigurationRequest - Container for the necessary
parameters to execute the CreateHsmConfiguration service method on
AmazonRedshift.TagLimitExceededExceptionHsmConfigurationQuotaExceededExceptionInvalidTagExceptionHsmConfigurationAlreadyExistsExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterSnapshotsResult describeClusterSnapshots(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) throws AmazonServiceException, AmazonClientException
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
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.
describeClusterSnapshotsRequest - Container for the necessary
parameters to execute the DescribeClusterSnapshots service method on
AmazonRedshift.InvalidTagExceptionClusterSnapshotNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.ClusterParameterGroup createClusterParameterGroup(CreateClusterParameterGroupRequest createClusterParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.
Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide .
createClusterParameterGroupRequest - Container for the necessary
parameters to execute the CreateClusterParameterGroup service method
on AmazonRedshift.TagLimitExceededExceptionClusterParameterGroupQuotaExceededExceptionInvalidTagExceptionClusterParameterGroupAlreadyExistsExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterParameterGroupsResult describeClusterParameterGroups(DescribeClusterParameterGroupsRequest describeClusterParameterGroupsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about 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.
describeClusterParameterGroupsRequest - Container for the
necessary parameters to execute the DescribeClusterParameterGroups
service method on AmazonRedshift.InvalidTagExceptionClusterParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.SnapshotCopyGrant createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest createSnapshotCopyGrantRequest) throws AmazonServiceException, AmazonClientException
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 .
createSnapshotCopyGrantRequest - Container for the necessary
parameters to execute the CreateSnapshotCopyGrant service method on
AmazonRedshift.TagLimitExceededExceptionInvalidTagExceptionDependentServiceRequestThrottlingExceptionLimitExceededExceptionSnapshotCopyGrantAlreadyExistsExceptionSnapshotCopyGrantQuotaExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeOrderableClusterOptionsResult describeOrderableClusterOptions() throws AmazonServiceException, AmazonClientException
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeTableRestoreStatusResult describeTableRestoreStatus() throws AmazonServiceException, AmazonClientException
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
in-progress table restore requests. Otherwise
DescribeTableRestoreStatus returns the status of the
table specified by TableRestoreRequestId .
ClusterNotFoundExceptionTableRestoreNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeEventsResult describeEvents() throws AmazonServiceException, AmazonClientException
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeReservedNodesResult describeReservedNodes() throws AmazonServiceException, AmazonClientException
Returns the descriptions of the reserved nodes.
ReservedNodeNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterVersionsResult describeClusterVersions() throws AmazonServiceException, AmazonClientException
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeTagsResult describeTags() throws AmazonServiceException, AmazonClientException
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 :
MaxRecords and
Marker parameters together with the ARN parameter.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.
ResourceNotFoundExceptionInvalidTagExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeEventCategoriesResult describeEventCategories() throws AmazonServiceException, AmazonClientException
Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications .
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterSecurityGroupsResult describeClusterSecurityGroups() throws AmazonServiceException, AmazonClientException
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift 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.
InvalidTagExceptionClusterSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterSubnetGroupsResult describeClusterSubnetGroups() throws AmazonServiceException, AmazonClientException
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
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.
InvalidTagExceptionClusterSubnetGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeHsmConfigurationsResult describeHsmConfigurations() throws AmazonServiceException, AmazonClientException
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
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.
HsmConfigurationNotFoundExceptionInvalidTagExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeSnapshotCopyGrantsResult describeSnapshotCopyGrants() throws AmazonServiceException, AmazonClientException
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 .
InvalidTagExceptionSnapshotCopyGrantNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeReservedNodeOfferingsResult describeReservedNodeOfferings() throws AmazonServiceException, AmazonClientException
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide .
UnsupportedOperationExceptionReservedNodeOfferingNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeEventSubscriptionsResult describeEventSubscriptions() throws AmazonServiceException, AmazonClientException
Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription.
SubscriptionNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeHsmClientCertificatesResult describeHsmClientCertificates() throws AmazonServiceException, AmazonClientException
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
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.
InvalidTagExceptionHsmClientCertificateNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClustersResult describeClusters() throws AmazonServiceException, AmazonClientException
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift 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.
InvalidTagExceptionClusterNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterSnapshotsResult describeClusterSnapshots() throws AmazonServiceException, AmazonClientException
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
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.
InvalidTagExceptionClusterSnapshotNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.DescribeClusterParameterGroupsResult describeClusterParameterGroups() throws AmazonServiceException, AmazonClientException
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about 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.
InvalidTagExceptionClusterParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonRedshift indicating
either a problem with the data in the request, or a server side issue.void shutdown()
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 a request.
request - The originally executed request.Copyright © 2016. All rights reserved.