AWS SDK Version 2 for .NET
API Reference

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.

.NET Framework 3.5
 
 

Classes

NameDescription
Class AccessToSnapshotDeniedException Redshift exception
Class AccountWithRestoreAccess Describes an AWS customer account authorized to restore a snapshot.
Class AuthorizationAlreadyExistsException Redshift exception
Class AuthorizationNotFoundException Redshift exception
Class AuthorizationQuotaExceededException Redshift exception
Class AuthorizeClusterSecurityGroupIngressRequest Container for the parameters to the AuthorizeClusterSecurityGroupIngress operation. 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. The EC2 security group must be defined in the AWS region where the cluster resides.

For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.

You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.

Class AuthorizeClusterSecurityGroupIngressResponse Configuration for accessing Amazon AuthorizeClusterSecurityGroupIngress service
Class AuthorizeClusterSecurityGroupIngressResult Describes a security group.
Class AuthorizeSnapshotAccessRequest Container for the parameters to the AuthorizeSnapshotAccess operation. 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.

Class AuthorizeSnapshotAccessResponse Configuration for accessing Amazon AuthorizeSnapshotAccess service
Class AuthorizeSnapshotAccessResult Describes a snapshot.
Class AvailabilityZone Describes an availability zone.
Class BucketNotFoundException Redshift exception
Class Cluster Describes a cluster.
Class ClusterAlreadyExistsException Redshift exception
Class ClusterNode The identifier of a node in a cluster.
Class ClusterNotFoundException Redshift exception
Class ClusterParameterGroup Describes a parameter group.
Class ClusterParameterGroupAlreadyExistsException Redshift exception
Class ClusterParameterGroupNotFoundException Redshift exception
Class ClusterParameterGroupQuotaExceededException Redshift exception
Class ClusterParameterGroupStatus Describes the status of a parameter group.
Class ClusterParameterStatus Describes the status of a parameter group.
Class ClusterQuotaExceededException Redshift exception
Class ClusterSecurityGroup Describes a security group.
Class ClusterSecurityGroupAlreadyExistsException Redshift exception
Class ClusterSecurityGroupMembership Describes a security group.
Class ClusterSecurityGroupNotFoundException Redshift exception
Class ClusterSecurityGroupQuotaExceededException Redshift exception
Class ClusterSnapshotAlreadyExistsException Redshift exception
Class ClusterSnapshotCopyStatus Returns the destination region and retention period that are configured for cross-region snapshot copy.
Class ClusterSnapshotNotFoundException Redshift exception
Class ClusterSnapshotQuotaExceededException Redshift exception
Class ClusterSubnetGroup Describes a subnet group.
Class ClusterSubnetGroupAlreadyExistsException Redshift exception
Class ClusterSubnetGroupNotFoundException Redshift exception
Class ClusterSubnetGroupQuotaExceededException Redshift exception
Class ClusterSubnetQuotaExceededException Redshift exception
Class ClusterVersion Describes a cluster version, including the parameter group family and description of the version.
Class CopyClusterSnapshotRequest Container for the parameters to the CopyClusterSnapshot operation. 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.

Class CopyClusterSnapshotResponse Configuration for accessing Amazon CopyClusterSnapshot service
Class CopyClusterSnapshotResult Describes a snapshot.
Class CopyToRegionDisabledException Redshift exception
Class CreateClusterParameterGroupRequest Container for the parameters to the CreateClusterParameterGroup operation. 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.

Class CreateClusterParameterGroupResponse Configuration for accessing Amazon CreateClusterParameterGroup service
Class CreateClusterParameterGroupResult Describes a parameter group.
Class CreateClusterRequest Container for the parameters to the CreateCluster operation. 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 .
Class CreateClusterResponse Configuration for accessing Amazon CreateCluster service
Class CreateClusterResult Describes a cluster.
Class CreateClusterSecurityGroupRequest Container for the parameters to the CreateClusterSecurityGroup operation. 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.

Class CreateClusterSecurityGroupResponse Configuration for accessing Amazon CreateClusterSecurityGroup service
Class CreateClusterSecurityGroupResult Describes a security group.
Class CreateClusterSnapshotRequest Container for the parameters to the CreateClusterSnapshot operation. 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.

Class CreateClusterSnapshotResponse Configuration for accessing Amazon CreateClusterSnapshot service
Class CreateClusterSnapshotResult Describes a snapshot.
Class CreateClusterSubnetGroupRequest Container for the parameters to the CreateClusterSubnetGroup operation. 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.

Class CreateClusterSubnetGroupResponse Configuration for accessing Amazon CreateClusterSubnetGroup service
Class CreateClusterSubnetGroupResult Describes a subnet group.
Class CreateEventSubscriptionRequest Container for the parameters to the CreateEventSubscription operation. 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.

Class CreateEventSubscriptionResponse Configuration for accessing Amazon CreateEventSubscription service
Class CreateEventSubscriptionResult
Class CreateHsmClientCertificateRequest Container for the parameters to the CreateHsmClientCertificate operation. 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.

Class CreateHsmClientCertificateResponse Configuration for accessing Amazon CreateHsmClientCertificate service
Class CreateHsmClientCertificateResult Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.
Class CreateHsmConfigurationRequest Container for the parameters to the CreateHsmConfiguration operation. 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.

Class CreateHsmConfigurationResponse Configuration for accessing Amazon CreateHsmConfiguration service
Class CreateHsmConfigurationResult Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.
Class CreateSnapshotCopyGrantRequest Container for the parameters to the CreateSnapshotCopyGrant operation. 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.

Class CreateSnapshotCopyGrantResponse Configuration for accessing Amazon CreateSnapshotCopyGrant service
Class CreateSnapshotCopyGrantResult The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS 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.

Class CreateTagsRequest Container for the parameters to the CreateTags operation. 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.

Class CreateTagsResponse
Class DefaultClusterParameters Describes the default cluster parameters for a parameter group family.
Class DeleteClusterParameterGroupRequest Container for the parameters to the DeleteClusterParameterGroup operation. Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster.
Class DeleteClusterParameterGroupResponse
Class DeleteClusterRequest Container for the parameters to the DeleteCluster operation. 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 .

Class DeleteClusterResponse Configuration for accessing Amazon DeleteCluster service
Class DeleteClusterResult Describes a cluster.
Class DeleteClusterSecurityGroupRequest Container for the parameters to the DeleteClusterSecurityGroup operation. Deletes an Amazon Redshift security group. You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Class DeleteClusterSecurityGroupResponse
Class DeleteClusterSnapshotRequest Container for the parameters to the DeleteClusterSnapshot operation. 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.

Class DeleteClusterSnapshotResponse Configuration for accessing Amazon DeleteClusterSnapshot service
Class DeleteClusterSnapshotResult Describes a snapshot.
Class DeleteClusterSubnetGroupRequest Container for the parameters to the DeleteClusterSubnetGroup operation. Deletes the specified cluster subnet group.
Class DeleteClusterSubnetGroupResponse
Class DeleteEventSubscriptionRequest Container for the parameters to the DeleteEventSubscription operation. Deletes an Amazon Redshift event notification subscription.
Class DeleteEventSubscriptionResponse
Class DeleteHsmClientCertificateRequest Container for the parameters to the DeleteHsmClientCertificate operation. Deletes the specified HSM client certificate.
Class DeleteHsmClientCertificateResponse
Class DeleteHsmConfigurationRequest Container for the parameters to the DeleteHsmConfiguration operation. Deletes the specified Amazon Redshift HSM configuration.
Class DeleteHsmConfigurationResponse
Class DeleteSnapshotCopyGrantRequest Container for the parameters to the DeleteSnapshotCopyGrant operation. Deletes the specified snapshot copy grant.
Class DeleteSnapshotCopyGrantResponse
Class DeleteTagsRequest Container for the parameters to the DeleteTags operation. 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.
Class DeleteTagsResponse
Class DescribeClusterParameterGroupsRequest Container for the parameters to the DescribeClusterParameterGroups operation. 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.

Class DescribeClusterParameterGroupsResponse Configuration for accessing Amazon DescribeClusterParameterGroups service
Class DescribeClusterParameterGroupsResult Contains the output from the DescribeClusterParameterGroups action.
Class DescribeClusterParametersRequest Container for the parameters to the DescribeClusterParameters operation. 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.

Class DescribeClusterParametersResponse Configuration for accessing Amazon DescribeClusterParameters service
Class DescribeClusterParametersResult Contains the output from the DescribeClusterParameters action.
Class DescribeClusterSecurityGroupsRequest Container for the parameters to the DescribeClusterSecurityGroups operation. 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.

Class DescribeClusterSecurityGroupsResponse Configuration for accessing Amazon DescribeClusterSecurityGroups service
Class DescribeClusterSecurityGroupsResult Contains the output from the DescribeClusterSecurityGroups action.
Class DescribeClusterSnapshotsRequest Container for the parameters to the DescribeClusterSnapshots operation. 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.

Class DescribeClusterSnapshotsResponse Configuration for accessing Amazon DescribeClusterSnapshots service
Class DescribeClusterSnapshotsResult Contains the output from the DescribeClusterSnapshots action.
Class DescribeClustersRequest Container for the parameters to the DescribeClusters operation. 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.

Class DescribeClustersResponse Configuration for accessing Amazon DescribeClusters service
Class DescribeClustersResult Contains the output from the DescribeClusters action.
Class DescribeClusterSubnetGroupsRequest Container for the parameters to the DescribeClusterSubnetGroups operation. 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.

Class DescribeClusterSubnetGroupsResponse Configuration for accessing Amazon DescribeClusterSubnetGroups service
Class DescribeClusterSubnetGroupsResult Contains the output from the DescribeClusterSubnetGroups action.
Class DescribeClusterVersionsRequest Container for the parameters to the DescribeClusterVersions operation. 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
Class DescribeClusterVersionsResponse Configuration for accessing Amazon DescribeClusterVersions service
Class DescribeClusterVersionsResult Contains the output from the DescribeClusterVersions action.
Class DescribeDefaultClusterParametersRequest Container for the parameters to the DescribeDefaultClusterParameters operation. 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.

Class DescribeDefaultClusterParametersResponse Configuration for accessing Amazon DescribeDefaultClusterParameters service
Class DescribeDefaultClusterParametersResult Describes the default cluster parameters for a parameter group family.
Class DescribeEventCategoriesRequest Container for the parameters to the DescribeEventCategories operation. 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.
Class DescribeEventCategoriesResponse Configuration for accessing Amazon DescribeEventCategories service
Class DescribeEventCategoriesResult
Class DescribeEventsRequest Container for the parameters to the DescribeEvents operation. 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.
Class DescribeEventsResponse Configuration for accessing Amazon DescribeEvents service
Class DescribeEventsResult Contains the output from the DescribeEvents action.
Class DescribeEventSubscriptionsRequest Container for the parameters to the DescribeEventSubscriptions operation. 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.
Class DescribeEventSubscriptionsResponse Configuration for accessing Amazon DescribeEventSubscriptions service
Class DescribeEventSubscriptionsResult
Class DescribeHsmClientCertificatesRequest Container for the parameters to the DescribeHsmClientCertificates operation. 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.

Class DescribeHsmClientCertificatesResponse Configuration for accessing Amazon DescribeHsmClientCertificates service
Class DescribeHsmClientCertificatesResult
Class DescribeHsmConfigurationsRequest Container for the parameters to the DescribeHsmConfigurations operation. 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.

Class DescribeHsmConfigurationsResponse Configuration for accessing Amazon DescribeHsmConfigurations service
Class DescribeHsmConfigurationsResult
Class DescribeLoggingStatusRequest Container for the parameters to the DescribeLoggingStatus operation. Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
Class DescribeLoggingStatusResponse Configuration for accessing Amazon DescribeLoggingStatus service
Class DescribeLoggingStatusResult Describes the status of logging for a cluster.
Class DescribeOrderableClusterOptionsRequest Container for the parameters to the DescribeOrderableClusterOptions operation. 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
Class DescribeOrderableClusterOptionsResponse Configuration for accessing Amazon DescribeOrderableClusterOptions service
Class DescribeOrderableClusterOptionsResult Contains the output from the DescribeOrderableClusterOptions action.
Class DescribeReservedNodeOfferingsRequest Container for the parameters to the DescribeReservedNodeOfferings operation. 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.

Class DescribeReservedNodeOfferingsResponse Configuration for accessing Amazon DescribeReservedNodeOfferings service
Class DescribeReservedNodeOfferingsResult Contains the output from the DescribeReservedNodeOfferings action.
Class DescribeReservedNodesRequest Container for the parameters to the DescribeReservedNodes operation. Returns the descriptions of the reserved nodes.
Class DescribeReservedNodesResponse Configuration for accessing Amazon DescribeReservedNodes service
Class DescribeReservedNodesResult Contains the output from the DescribeReservedNodes action.
Class DescribeResizeRequest Container for the parameters to the DescribeResize operation. 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.

Class DescribeResizeResponse Configuration for accessing Amazon DescribeResize service
Class DescribeResizeResult Describes the result of a cluster resize operation.
Class DescribeSnapshotCopyGrantsRequest Container for the parameters to the DescribeSnapshotCopyGrants operation. 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.

Class DescribeSnapshotCopyGrantsResponse Configuration for accessing Amazon DescribeSnapshotCopyGrants service
Class DescribeSnapshotCopyGrantsResult The result of the snapshot copy grant.
Class DescribeTagsRequest Container for the parameters to the DescribeTags operation. Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.

The following are limitations for DescribeTags:

  • You cannot specify an ARN and a resource-type value together in the same request.
  • You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
  • The MaxRecords parameter can be a range from 10 to 50 results to return in a request.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.

If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.

Class DescribeTagsResponse Configuration for accessing Amazon DescribeTags service
Class DescribeTagsResult Contains the output from the DescribeTags action.
Class DisableLoggingRequest Container for the parameters to the DisableLogging operation. Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
Class DisableLoggingResponse Configuration for accessing Amazon DisableLogging service
Class DisableLoggingResult Describes the status of logging for a cluster.
Class DisableSnapshotCopyRequest Container for the parameters to the DisableSnapshotCopy operation. 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.

Class DisableSnapshotCopyResponse Configuration for accessing Amazon DisableSnapshotCopy service
Class DisableSnapshotCopyResult Describes a cluster.
Class EC2SecurityGroup Describes an Amazon EC2 security group.
Class ElasticIpStatus Describes the status of the elastic IP (EIP) address.
Class EnableLoggingRequest Container for the parameters to the EnableLogging operation. Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
Class EnableLoggingResponse Configuration for accessing Amazon EnableLogging service
Class EnableLoggingResult Describes the status of logging for a cluster.
Class EnableSnapshotCopyRequest Container for the parameters to the EnableSnapshotCopy operation. Enables the automatic copy of snapshots from one region to another region for a specified cluster.
Class EnableSnapshotCopyResponse Configuration for accessing Amazon EnableSnapshotCopy service
Class EnableSnapshotCopyResult Describes a cluster.
Class Endpoint Describes a connection endpoint.
Class Event Describes an event.
Class EventCategoriesMap
Class EventInfoMap
Class EventSubscription
Class EventSubscriptionQuotaExceededException Redshift exception
Class HsmClientCertificate Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.
Class HsmClientCertificateAlreadyExistsException Redshift exception
Class HsmClientCertificateNotFoundException Redshift exception
Class HsmClientCertificateQuotaExceededException Redshift exception
Class HsmConfiguration Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.
Class HsmConfigurationAlreadyExistsException Redshift exception
Class HsmConfigurationNotFoundException Redshift exception
Class HsmConfigurationQuotaExceededException Redshift exception
Class HsmStatus
Class IncompatibleOrderableOptionsException Redshift exception
Class InsufficientClusterCapacityException Redshift exception
Class InsufficientS3BucketPolicyException Redshift exception
Class InvalidClusterParameterGroupStateException Redshift exception
Class InvalidClusterSecurityGroupStateException Redshift exception
Class InvalidClusterSnapshotStateException Redshift exception
Class InvalidClusterStateException Redshift exception
Class InvalidClusterSubnetGroupStateException Redshift exception
Class InvalidClusterSubnetStateException Redshift exception
Class InvalidElasticIpException Redshift exception
Class InvalidHsmClientCertificateStateException Redshift exception
Class InvalidHsmConfigurationStateException Redshift exception
Class InvalidRestoreException Redshift exception
Class InvalidS3BucketNameException Redshift exception
Class InvalidS3KeyPrefixException Redshift exception
Class InvalidSnapshotCopyGrantStateException Redshift exception
Class InvalidSubnetException Redshift exception
Class InvalidSubscriptionStateException Redshift exception
Class InvalidTagException Redshift exception
Class InvalidVPCNetworkStateException Redshift exception
Class IPRange Describes an IP range used in a security group.
Class LimitExceededException Redshift exception
Class ModifyClusterParameterGroupRequest Container for the parameters to the ModifyClusterParameterGroup operation. 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.

Class ModifyClusterParameterGroupResponse Configuration for accessing Amazon ModifyClusterParameterGroup service
Class ModifyClusterParameterGroupResult Contains the output from the ModifyClusterParameterGroup and ResetClusterParameterGroup actions and indicate the parameter group involved and the status of the operation on the parameter group.
Class ModifyClusterRequest Container for the parameters to the ModifyCluster operation. 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.

Class ModifyClusterResponse Configuration for accessing Amazon ModifyCluster service
Class ModifyClusterResult Describes a cluster.
Class ModifyClusterSubnetGroupRequest Container for the parameters to the ModifyClusterSubnetGroup operation. 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.
Class ModifyClusterSubnetGroupResponse Configuration for accessing Amazon ModifyClusterSubnetGroup service
Class ModifyClusterSubnetGroupResult Describes a subnet group.
Class ModifyEventSubscriptionRequest Container for the parameters to the ModifyEventSubscription operation. Modifies an existing Amazon Redshift event notification subscription.
Class ModifyEventSubscriptionResponse Configuration for accessing Amazon ModifyEventSubscription service
Class ModifyEventSubscriptionResult
Class ModifySnapshotCopyRetentionPeriodRequest Container for the parameters to the ModifySnapshotCopyRetentionPeriod operation. Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
Class ModifySnapshotCopyRetentionPeriodResponse Configuration for accessing Amazon ModifySnapshotCopyRetentionPeriod service
Class ModifySnapshotCopyRetentionPeriodResult Describes a cluster.
Class NumberOfNodesPerClusterLimitExceededException Redshift exception
Class NumberOfNodesQuotaExceededException Redshift exception
Class OrderableClusterOption Describes an orderable cluster option.
Class Parameter Describes a parameter in a cluster parameter group.
Class PendingModifiedValues Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.
Class PurchaseReservedNodeOfferingRequest Container for the parameters to the PurchaseReservedNodeOffering operation. 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.

Class PurchaseReservedNodeOfferingResponse Configuration for accessing Amazon PurchaseReservedNodeOffering service
Class PurchaseReservedNodeOfferingResult Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.
Class RebootClusterRequest Container for the parameters to the RebootCluster operation. 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
Class RebootClusterResponse Configuration for accessing Amazon RebootCluster service
Class RebootClusterResult Describes a cluster.
Class RecurringCharge Describes a recurring charge.
Class ReservedNode Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.
Class ReservedNodeAlreadyExistsException Redshift exception
Class ReservedNodeNotFoundException Redshift exception
Class ReservedNodeOffering Describes a reserved node offering.
Class ReservedNodeOfferingNotFoundException Redshift exception
Class ReservedNodeQuotaExceededException Redshift exception
Class ResetClusterParameterGroupRequest Container for the parameters to the ResetClusterParameterGroup operation. 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.
Class ResetClusterParameterGroupResponse Configuration for accessing Amazon ResetClusterParameterGroup service
Class ResetClusterParameterGroupResult Contains the output from the ModifyClusterParameterGroup and ResetClusterParameterGroup actions and indicate the parameter group involved and the status of the operation on the parameter group.
Class ResizeNotFoundException Redshift exception
Class ResourceNotFoundException Redshift exception
Class RestoreFromClusterSnapshotRequest Container for the parameters to the RestoreFromClusterSnapshot operation. 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.

Class RestoreFromClusterSnapshotResponse Configuration for accessing Amazon RestoreFromClusterSnapshot service
Class RestoreFromClusterSnapshotResult Describes a cluster.
Class RestoreStatus Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Class RevokeClusterSecurityGroupIngressRequest Container for the parameters to the RevokeClusterSecurityGroupIngress operation. 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.
Class RevokeClusterSecurityGroupIngressResponse Configuration for accessing Amazon RevokeClusterSecurityGroupIngress service
Class RevokeClusterSecurityGroupIngressResult Describes a security group.
Class RevokeSnapshotAccessRequest Container for the parameters to the RevokeSnapshotAccess operation. 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.

Class RevokeSnapshotAccessResponse Configuration for accessing Amazon RevokeSnapshotAccess service
Class RevokeSnapshotAccessResult Describes a snapshot.
Class RotateEncryptionKeyRequest Container for the parameters to the RotateEncryptionKey operation. Rotates the encryption keys for a cluster.
Class RotateEncryptionKeyResponse Configuration for accessing Amazon RotateEncryptionKey service
Class RotateEncryptionKeyResult Describes a cluster.
Class Snapshot Describes a snapshot.
Class SnapshotCopyAlreadyDisabledException Redshift exception
Class SnapshotCopyAlreadyEnabledException Redshift exception
Class SnapshotCopyDisabledException Redshift exception
Class SnapshotCopyGrant The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS 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.

Class SnapshotCopyGrantAlreadyExistsException Redshift exception
Class SnapshotCopyGrantNotFoundException Redshift exception
Class SnapshotCopyGrantQuotaExceededException Redshift exception
Class SNSInvalidTopicException Redshift exception
Class SNSNoAuthorizationException Redshift exception
Class SNSTopicArnNotFoundException Redshift exception
Class SourceNotFoundException Redshift exception
Class Subnet Describes a subnet.
Class SubnetAlreadyInUseException Redshift exception
Class SubscriptionAlreadyExistException Redshift exception
Class SubscriptionCategoryNotFoundException Redshift exception
Class SubscriptionEventIdNotFoundException Redshift exception
Class SubscriptionNotFoundException Redshift exception
Class SubscriptionSeverityNotFoundException Redshift exception
Class Tag A tag consisting of a name/value pair for a resource.
Class TaggedResource A tag and its associated resource.
Class TagLimitExceededException Redshift exception
Class UnauthorizedOperationException Redshift exception
Class UnknownSnapshotCopyRegionException Redshift exception
Class UnsupportedOperationException Redshift exception
Class UnsupportedOptionException Redshift exception
Class VpcSecurityGroupMembership Describes the members of a VPC security group.