AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
Namespace: Amazon.Redshift
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonRedshift IDisposable
The IAmazonRedshift type exposes the following members
Name | Description | |
---|---|---|
AuthorizeClusterSecurityGroupIngress(AuthorizeClusterSecurityGroupIngressRequest) |
Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on
whether the application accessing your cluster is running on the Internet or an EC2
instance, you can authorize inbound access to either a Classless Interdomain Routing
(CIDR) IP address range or an EC2 security group. You can add as many as 20 ingress
rules to an Amazon Redshift security group.
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. |
|
AuthorizeClusterSecurityGroupIngressAsync(AuthorizeClusterSecurityGroupIngressRequest, CancellationToken) | Initiates the asynchronous execution of the AuthorizeClusterSecurityGroupIngress operation. | |
AuthorizeSnapshotAccess(AuthorizeSnapshotAccessRequest) |
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. |
|
AuthorizeSnapshotAccessAsync(AuthorizeSnapshotAccessRequest, CancellationToken) | Initiates the asynchronous execution of the AuthorizeSnapshotAccess operation. | |
CopyClusterSnapshot(CopyClusterSnapshotRequest) |
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. |
|
CopyClusterSnapshotAsync(CopyClusterSnapshotRequest, CancellationToken) | Initiates the asynchronous execution of the CopyClusterSnapshot operation. | |
CreateCluster(CreateClusterRequest) | 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 . | |
CreateClusterAsync(CreateClusterRequest, CancellationToken) | Initiates the asynchronous execution of the CreateCluster operation. | |
CreateClusterParameterGroup(CreateClusterParameterGroupRequest) |
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. |
|
CreateClusterParameterGroupAsync(CreateClusterParameterGroupRequest, CancellationToken) | Initiates the asynchronous execution of the CreateClusterParameterGroup operation. | |
CreateClusterSecurityGroup(CreateClusterSecurityGroupRequest) |
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. |
|
CreateClusterSecurityGroupAsync(CreateClusterSecurityGroupRequest, CancellationToken) | Initiates the asynchronous execution of the CreateClusterSecurityGroup operation. | |
CreateClusterSnapshot(CreateClusterSnapshotRequest) |
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. |
|
CreateClusterSnapshotAsync(CreateClusterSnapshotRequest, CancellationToken) | Initiates the asynchronous execution of the CreateClusterSnapshot operation. | |
CreateClusterSubnetGroup(CreateClusterSubnetGroupRequest) |
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. |
|
CreateClusterSubnetGroupAsync(CreateClusterSubnetGroupRequest, CancellationToken) | Initiates the asynchronous execution of the CreateClusterSubnetGroup operation. | |
CreateEventSubscription(CreateEventSubscriptionRequest) |
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. |
|
CreateEventSubscriptionAsync(CreateEventSubscriptionRequest, CancellationToken) | Initiates the asynchronous execution of the CreateEventSubscription operation. | |
CreateHsmClientCertificate(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.
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. |
|
CreateHsmClientCertificateAsync(CreateHsmClientCertificateRequest, CancellationToken) | Initiates the asynchronous execution of the CreateHsmClientCertificate operation. | |
CreateHsmConfiguration(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).
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. |
|
CreateHsmConfigurationAsync(CreateHsmConfigurationRequest, CancellationToken) | Initiates the asynchronous execution of the CreateHsmConfiguration operation. | |
CreateSnapshotCopyGrant(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.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide. |
|
CreateSnapshotCopyGrantAsync(CreateSnapshotCopyGrantRequest, CancellationToken) | Initiates the asynchronous execution of the CreateSnapshotCopyGrant operation. | |
CreateTags(CreateTagsRequest) |
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. |
|
CreateTagsAsync(CreateTagsRequest, CancellationToken) | Initiates the asynchronous execution of the CreateTags operation. | |
DeleteCluster(DeleteClusterRequest) |
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 For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide . |
|
DeleteClusterAsync(DeleteClusterRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteCluster operation. | |
DeleteClusterParameterGroup(DeleteClusterParameterGroupRequest) |
Deletes a specified Amazon Redshift parameter group. |
|
DeleteClusterParameterGroupAsync(DeleteClusterParameterGroupRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteClusterParameterGroup operation. | |
DeleteClusterSecurityGroup(DeleteClusterSecurityGroupRequest) |
Deletes an Amazon Redshift security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide. |
|
DeleteClusterSecurityGroupAsync(DeleteClusterSecurityGroupRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteClusterSecurityGroup operation. | |
DeleteClusterSnapshot(DeleteClusterSnapshotRequest) |
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. |
|
DeleteClusterSnapshotAsync(DeleteClusterSnapshotRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteClusterSnapshot operation. | |
DeleteClusterSubnetGroup(DeleteClusterSubnetGroupRequest) | Deletes the specified cluster subnet group. | |
DeleteClusterSubnetGroupAsync(DeleteClusterSubnetGroupRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteClusterSubnetGroup operation. | |
DeleteEventSubscription(DeleteEventSubscriptionRequest) | Deletes an Amazon Redshift event notification subscription. | |
DeleteEventSubscriptionAsync(DeleteEventSubscriptionRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteEventSubscription operation. | |
DeleteHsmClientCertificate(DeleteHsmClientCertificateRequest) | Deletes the specified HSM client certificate. | |
DeleteHsmClientCertificateAsync(DeleteHsmClientCertificateRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteHsmClientCertificate operation. | |
DeleteHsmConfiguration(DeleteHsmConfigurationRequest) | Deletes the specified Amazon Redshift HSM configuration. | |
DeleteHsmConfigurationAsync(DeleteHsmConfigurationRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteHsmConfiguration operation. | |
DeleteSnapshotCopyGrant(DeleteSnapshotCopyGrantRequest) | Deletes the specified snapshot copy grant. | |
DeleteSnapshotCopyGrantAsync(DeleteSnapshotCopyGrantRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteSnapshotCopyGrant operation. | |
DeleteTags(DeleteTagsRequest) | 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. | |
DeleteTagsAsync(DeleteTagsRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteTags operation. | |
DescribeClusterParameterGroups() |
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 If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them. |
|
DescribeClusterParameterGroups(DescribeClusterParameterGroupsRequest) |
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 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. |
|
DescribeClusterParameterGroupsAsync(DescribeClusterParameterGroupsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeClusterParameterGroups operation. | |
DescribeClusterParameters(DescribeClusterParametersRequest) |
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. |
|
DescribeClusterParametersAsync(DescribeClusterParametersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeClusterParameters operation. | |
DescribeClusters() |
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 If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them. |
|
DescribeClusters(DescribeClustersRequest) |
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 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. |
|
DescribeClustersAsync(DescribeClustersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeClusters operation. | |
DescribeClusterSecurityGroups() |
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 If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them. |
|
DescribeClusterSecurityGroups(DescribeClusterSecurityGroupsRequest) |
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 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. |
|
DescribeClusterSecurityGroupsAsync(DescribeClusterSecurityGroupsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeClusterSecurityGroups operation. | |
DescribeClusterSnapshots() |
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 If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them. |
|
DescribeClusterSnapshots(DescribeClusterSnapshotsRequest) |
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 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. |
|
DescribeClusterSnapshotsAsync(DescribeClusterSnapshotsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeClusterSnapshots operation. | |
DescribeClusterSubnetGroups() |
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 If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them. |
|
DescribeClusterSubnetGroups(DescribeClusterSubnetGroupsRequest) |
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 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. |
|
DescribeClusterSubnetGroupsAsync(DescribeClusterSubnetGroupsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeClusterSubnetGroups operation. | |
DescribeClusterVersions() | Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide | |
DescribeClusterVersions(DescribeClusterVersionsRequest) | 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 | |
DescribeClusterVersionsAsync(DescribeClusterVersionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeClusterVersions operation. | |
DescribeDefaultClusterParameters(DescribeDefaultClusterParametersRequest) |
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. |
|
DescribeDefaultClusterParametersAsync(DescribeDefaultClusterParametersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeDefaultClusterParameters operation. | |
DescribeEventCategories() | Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications. | |
DescribeEventCategories(DescribeEventCategoriesRequest) | 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. | |
DescribeEventCategoriesAsync(DescribeEventCategoriesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeEventCategories operation. | |
DescribeEvents() | Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. | |
DescribeEvents(DescribeEventsRequest) | 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. | |
DescribeEventsAsync(DescribeEventsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeEvents operation. | |
DescribeEventSubscriptions() | 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. | |
DescribeEventSubscriptions(DescribeEventSubscriptionsRequest) | 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. | |
DescribeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeEventSubscriptions operation. | |
DescribeHsmClientCertificates() |
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 If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them. |
|
DescribeHsmClientCertificates(DescribeHsmClientCertificatesRequest) |
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 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. |
|
DescribeHsmClientCertificatesAsync(DescribeHsmClientCertificatesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeHsmClientCertificates operation. | |
DescribeHsmConfigurations() |
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 If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them. |
|
DescribeHsmConfigurations(DescribeHsmConfigurationsRequest) |
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 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. |
|
DescribeHsmConfigurationsAsync(DescribeHsmConfigurationsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeHsmConfigurations operation. | |
DescribeLoggingStatus(DescribeLoggingStatusRequest) | Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster. | |
DescribeLoggingStatusAsync(DescribeLoggingStatusRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeLoggingStatus operation. | |
DescribeOrderableClusterOptions() | Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide | |
DescribeOrderableClusterOptions(DescribeOrderableClusterOptionsRequest) | 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 | |
DescribeOrderableClusterOptionsAsync(DescribeOrderableClusterOptionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeOrderableClusterOptions operation. | |
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. These descriptions help you determine
which reserve node offering you want to purchase. You then use the unique offering
ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes
for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide. |
|
DescribeReservedNodeOfferings(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. 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. |
|
DescribeReservedNodeOfferingsAsync(DescribeReservedNodeOfferingsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeReservedNodeOfferings operation. | |
DescribeReservedNodes() | Returns the descriptions of the reserved nodes. | |
DescribeReservedNodes(DescribeReservedNodesRequest) | Returns the descriptions of the reserved nodes. | |
DescribeReservedNodesAsync(DescribeReservedNodesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeReservedNodes operation. | |
DescribeResize(DescribeResizeRequest) |
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 404error 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. |
|
DescribeResizeAsync(DescribeResizeRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeResize operation. | |
DescribeSnapshotCopyGrants(DescribeSnapshotCopyGrantsRequest) |
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. |
|
DescribeSnapshotCopyGrantsAsync(DescribeSnapshotCopyGrantsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeSnapshotCopyGrants operation. | |
DescribeTags(DescribeTagsRequest) |
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
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 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. |
|
DescribeTagsAsync(DescribeTagsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeTags operation. | |
DisableLogging(DisableLoggingRequest) | Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. | |
DisableLoggingAsync(DisableLoggingRequest, CancellationToken) | Initiates the asynchronous execution of the DisableLogging operation. | |
DisableSnapshotCopy(DisableSnapshotCopyRequest) |
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. |
|
DisableSnapshotCopyAsync(DisableSnapshotCopyRequest, CancellationToken) | Initiates the asynchronous execution of the DisableSnapshotCopy operation. | |
EnableLogging(EnableLoggingRequest) | Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. | |
EnableLoggingAsync(EnableLoggingRequest, CancellationToken) | Initiates the asynchronous execution of the EnableLogging operation. | |
EnableSnapshotCopy(EnableSnapshotCopyRequest) | Enables the automatic copy of snapshots from one region to another region for a specified cluster. | |
EnableSnapshotCopyAsync(EnableSnapshotCopyRequest, CancellationToken) | Initiates the asynchronous execution of the EnableSnapshotCopy operation. | |
ModifyCluster(ModifyClusterRequest) |
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. |
|
ModifyClusterAsync(ModifyClusterRequest, CancellationToken) | Initiates the asynchronous execution of the ModifyCluster operation. | |
ModifyClusterParameterGroup(ModifyClusterParameterGroupRequest) |
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. |
|
ModifyClusterParameterGroupAsync(ModifyClusterParameterGroupRequest, CancellationToken) | Initiates the asynchronous execution of the ModifyClusterParameterGroup operation. | |
ModifyClusterSubnetGroup(ModifyClusterSubnetGroupRequest) | 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. | |
ModifyClusterSubnetGroupAsync(ModifyClusterSubnetGroupRequest, CancellationToken) | Initiates the asynchronous execution of the ModifyClusterSubnetGroup operation. | |
ModifyEventSubscription(ModifyEventSubscriptionRequest) | Modifies an existing Amazon Redshift event notification subscription. | |
ModifyEventSubscriptionAsync(ModifyEventSubscriptionRequest, CancellationToken) | Initiates the asynchronous execution of the ModifyEventSubscription operation. | |
ModifySnapshotCopyRetentionPeriod(ModifySnapshotCopyRetentionPeriodRequest) | Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region. | |
ModifySnapshotCopyRetentionPeriodAsync(ModifySnapshotCopyRetentionPeriodRequest, CancellationToken) | Initiates the asynchronous execution of the ModifySnapshotCopyRetentionPeriod operation. | |
PurchaseReservedNodeOffering(PurchaseReservedNodeOfferingRequest) |
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. |
|
PurchaseReservedNodeOfferingAsync(PurchaseReservedNodeOfferingRequest, CancellationToken) | Initiates the asynchronous execution of the PurchaseReservedNodeOffering operation. | |
RebootCluster(RebootClusterRequest) |
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
|
|
RebootClusterAsync(RebootClusterRequest, CancellationToken) | Initiates the asynchronous execution of the RebootCluster operation. | |
ResetClusterParameterGroup(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". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters. | |
ResetClusterParameterGroupAsync(ResetClusterParameterGroupRequest, CancellationToken) | Initiates the asynchronous execution of the ResetClusterParameterGroup operation. | |
RestoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest) |
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. |
|
RestoreFromClusterSnapshotAsync(RestoreFromClusterSnapshotRequest, CancellationToken) | Initiates the asynchronous execution of the RestoreFromClusterSnapshot operation. | |
RevokeClusterSecurityGroupIngress(RevokeClusterSecurityGroupIngressRequest) | 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. | |
RevokeClusterSecurityGroupIngressAsync(RevokeClusterSecurityGroupIngressRequest, CancellationToken) | Initiates the asynchronous execution of the RevokeClusterSecurityGroupIngress operation. | |
RevokeSnapshotAccess(RevokeSnapshotAccessRequest) |
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. |
|
RevokeSnapshotAccessAsync(RevokeSnapshotAccessRequest, CancellationToken) | Initiates the asynchronous execution of the RevokeSnapshotAccess operation. | |
RotateEncryptionKey(RotateEncryptionKeyRequest) | Rotates the encryption keys for a cluster. | |
RotateEncryptionKeyAsync(RotateEncryptionKeyRequest, CancellationToken) | Initiates the asynchronous execution of the RotateEncryptionKey operation. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8