UNPKG

285 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class Redshift extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: Redshift.Types.ClientConfiguration)
14 config: Config & Redshift.Types.ClientConfiguration;
15 /**
16 * Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.
17 */
18 acceptReservedNodeExchange(params: Redshift.Types.AcceptReservedNodeExchangeInputMessage, callback?: (err: AWSError, data: Redshift.Types.AcceptReservedNodeExchangeOutputMessage) => void): Request<Redshift.Types.AcceptReservedNodeExchangeOutputMessage, AWSError>;
19 /**
20 * Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.
21 */
22 acceptReservedNodeExchange(callback?: (err: AWSError, data: Redshift.Types.AcceptReservedNodeExchangeOutputMessage) => void): Request<Redshift.Types.AcceptReservedNodeExchangeOutputMessage, AWSError>;
23 /**
24 * Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region. If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing. You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
25 */
26 authorizeClusterSecurityGroupIngress(params: Redshift.Types.AuthorizeClusterSecurityGroupIngressMessage, callback?: (err: AWSError, data: Redshift.Types.AuthorizeClusterSecurityGroupIngressResult) => void): Request<Redshift.Types.AuthorizeClusterSecurityGroupIngressResult, AWSError>;
27 /**
28 * Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region. If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing. You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
29 */
30 authorizeClusterSecurityGroupIngress(callback?: (err: AWSError, data: Redshift.Types.AuthorizeClusterSecurityGroupIngressResult) => void): Request<Redshift.Types.AuthorizeClusterSecurityGroupIngressResult, AWSError>;
31 /**
32 * 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.
33 */
34 authorizeSnapshotAccess(params: Redshift.Types.AuthorizeSnapshotAccessMessage, callback?: (err: AWSError, data: Redshift.Types.AuthorizeSnapshotAccessResult) => void): Request<Redshift.Types.AuthorizeSnapshotAccessResult, AWSError>;
35 /**
36 * 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.
37 */
38 authorizeSnapshotAccess(callback?: (err: AWSError, data: Redshift.Types.AuthorizeSnapshotAccessResult) => void): Request<Redshift.Types.AuthorizeSnapshotAccessResult, AWSError>;
39 /**
40 * Deletes a set of cluster snapshots.
41 */
42 batchDeleteClusterSnapshots(params: Redshift.Types.BatchDeleteClusterSnapshotsRequest, callback?: (err: AWSError, data: Redshift.Types.BatchDeleteClusterSnapshotsResult) => void): Request<Redshift.Types.BatchDeleteClusterSnapshotsResult, AWSError>;
43 /**
44 * Deletes a set of cluster snapshots.
45 */
46 batchDeleteClusterSnapshots(callback?: (err: AWSError, data: Redshift.Types.BatchDeleteClusterSnapshotsResult) => void): Request<Redshift.Types.BatchDeleteClusterSnapshotsResult, AWSError>;
47 /**
48 * Modifies the settings for a set of cluster snapshots.
49 */
50 batchModifyClusterSnapshots(params: Redshift.Types.BatchModifyClusterSnapshotsMessage, callback?: (err: AWSError, data: Redshift.Types.BatchModifyClusterSnapshotsOutputMessage) => void): Request<Redshift.Types.BatchModifyClusterSnapshotsOutputMessage, AWSError>;
51 /**
52 * Modifies the settings for a set of cluster snapshots.
53 */
54 batchModifyClusterSnapshots(callback?: (err: AWSError, data: Redshift.Types.BatchModifyClusterSnapshotsOutputMessage) => void): Request<Redshift.Types.BatchModifyClusterSnapshotsOutputMessage, AWSError>;
55 /**
56 * Cancels a resize operation for a cluster.
57 */
58 cancelResize(params: Redshift.Types.CancelResizeMessage, callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request<Redshift.Types.ResizeProgressMessage, AWSError>;
59 /**
60 * Cancels a resize operation for a cluster.
61 */
62 cancelResize(callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request<Redshift.Types.ResizeProgressMessage, AWSError>;
63 /**
64 * 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.
65 */
66 copyClusterSnapshot(params: Redshift.Types.CopyClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.CopyClusterSnapshotResult) => void): Request<Redshift.Types.CopyClusterSnapshotResult, AWSError>;
67 /**
68 * 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.
69 */
70 copyClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.CopyClusterSnapshotResult) => void): Request<Redshift.Types.CopyClusterSnapshotResult, AWSError>;
71 /**
72 * Creates a new cluster with the specified parameters. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
73 */
74 createCluster(params: Redshift.Types.CreateClusterMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterResult) => void): Request<Redshift.Types.CreateClusterResult, AWSError>;
75 /**
76 * Creates a new cluster with the specified parameters. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
77 */
78 createCluster(callback?: (err: AWSError, data: Redshift.Types.CreateClusterResult) => void): Request<Redshift.Types.CreateClusterResult, AWSError>;
79 /**
80 * 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.
81 */
82 createClusterParameterGroup(params: Redshift.Types.CreateClusterParameterGroupMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterParameterGroupResult) => void): Request<Redshift.Types.CreateClusterParameterGroupResult, AWSError>;
83 /**
84 * 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.
85 */
86 createClusterParameterGroup(callback?: (err: AWSError, data: Redshift.Types.CreateClusterParameterGroupResult) => void): Request<Redshift.Types.CreateClusterParameterGroupResult, AWSError>;
87 /**
88 * 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.
89 */
90 createClusterSecurityGroup(params: Redshift.Types.CreateClusterSecurityGroupMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterSecurityGroupResult) => void): Request<Redshift.Types.CreateClusterSecurityGroupResult, AWSError>;
91 /**
92 * 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.
93 */
94 createClusterSecurityGroup(callback?: (err: AWSError, data: Redshift.Types.CreateClusterSecurityGroupResult) => void): Request<Redshift.Types.CreateClusterSecurityGroupResult, AWSError>;
95 /**
96 * 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.
97 */
98 createClusterSnapshot(params: Redshift.Types.CreateClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterSnapshotResult) => void): Request<Redshift.Types.CreateClusterSnapshotResult, AWSError>;
99 /**
100 * 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.
101 */
102 createClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.CreateClusterSnapshotResult) => void): Request<Redshift.Types.CreateClusterSnapshotResult, AWSError>;
103 /**
104 * 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.
105 */
106 createClusterSubnetGroup(params: Redshift.Types.CreateClusterSubnetGroupMessage, callback?: (err: AWSError, data: Redshift.Types.CreateClusterSubnetGroupResult) => void): Request<Redshift.Types.CreateClusterSubnetGroupResult, AWSError>;
107 /**
108 * 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.
109 */
110 createClusterSubnetGroup(callback?: (err: AWSError, data: Redshift.Types.CreateClusterSubnetGroupResult) => void): Request<Redshift.Types.CreateClusterSubnetGroupResult, AWSError>;
111 /**
112 * 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.
113 */
114 createEventSubscription(params: Redshift.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: Redshift.Types.CreateEventSubscriptionResult) => void): Request<Redshift.Types.CreateEventSubscriptionResult, AWSError>;
115 /**
116 * 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.
117 */
118 createEventSubscription(callback?: (err: AWSError, data: Redshift.Types.CreateEventSubscriptionResult) => void): Request<Redshift.Types.CreateEventSubscriptionResult, AWSError>;
119 /**
120 * 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.
121 */
122 createHsmClientCertificate(params: Redshift.Types.CreateHsmClientCertificateMessage, callback?: (err: AWSError, data: Redshift.Types.CreateHsmClientCertificateResult) => void): Request<Redshift.Types.CreateHsmClientCertificateResult, AWSError>;
123 /**
124 * 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.
125 */
126 createHsmClientCertificate(callback?: (err: AWSError, data: Redshift.Types.CreateHsmClientCertificateResult) => void): Request<Redshift.Types.CreateHsmClientCertificateResult, AWSError>;
127 /**
128 * 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.
129 */
130 createHsmConfiguration(params: Redshift.Types.CreateHsmConfigurationMessage, callback?: (err: AWSError, data: Redshift.Types.CreateHsmConfigurationResult) => void): Request<Redshift.Types.CreateHsmConfigurationResult, AWSError>;
131 /**
132 * 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.
133 */
134 createHsmConfiguration(callback?: (err: AWSError, data: Redshift.Types.CreateHsmConfigurationResult) => void): Request<Redshift.Types.CreateHsmConfigurationResult, AWSError>;
135 /**
136 * Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.
137 */
138 createScheduledAction(params: Redshift.Types.CreateScheduledActionMessage, callback?: (err: AWSError, data: Redshift.Types.ScheduledAction) => void): Request<Redshift.Types.ScheduledAction, AWSError>;
139 /**
140 * Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.
141 */
142 createScheduledAction(callback?: (err: AWSError, data: Redshift.Types.ScheduledAction) => void): Request<Redshift.Types.ScheduledAction, AWSError>;
143 /**
144 * 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.
145 */
146 createSnapshotCopyGrant(params: Redshift.Types.CreateSnapshotCopyGrantMessage, callback?: (err: AWSError, data: Redshift.Types.CreateSnapshotCopyGrantResult) => void): Request<Redshift.Types.CreateSnapshotCopyGrantResult, AWSError>;
147 /**
148 * 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.
149 */
150 createSnapshotCopyGrant(callback?: (err: AWSError, data: Redshift.Types.CreateSnapshotCopyGrantResult) => void): Request<Redshift.Types.CreateSnapshotCopyGrantResult, AWSError>;
151 /**
152 * Creates a snapshot schedule with the rate of every 12 hours.
153 */
154 createSnapshotSchedule(params: Redshift.Types.CreateSnapshotScheduleMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request<Redshift.Types.SnapshotSchedule, AWSError>;
155 /**
156 * Creates a snapshot schedule with the rate of every 12 hours.
157 */
158 createSnapshotSchedule(callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request<Redshift.Types.SnapshotSchedule, AWSError>;
159 /**
160 * Adds tags to a cluster. A resource can have up to 50 tags. If you try to create more than 50 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.
161 */
162 createTags(params: Redshift.Types.CreateTagsMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
163 /**
164 * Adds tags to a cluster. A resource can have up to 50 tags. If you try to create more than 50 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.
165 */
166 createTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
167 /**
168 * Deletes a previously provisioned cluster without its final snapshot being created. 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.
169 */
170 deleteCluster(params: Redshift.Types.DeleteClusterMessage, callback?: (err: AWSError, data: Redshift.Types.DeleteClusterResult) => void): Request<Redshift.Types.DeleteClusterResult, AWSError>;
171 /**
172 * Deletes a previously provisioned cluster without its final snapshot being created. 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.
173 */
174 deleteCluster(callback?: (err: AWSError, data: Redshift.Types.DeleteClusterResult) => void): Request<Redshift.Types.DeleteClusterResult, AWSError>;
175 /**
176 * Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster.
177 */
178 deleteClusterParameterGroup(params: Redshift.Types.DeleteClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
179 /**
180 * Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster.
181 */
182 deleteClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
183 /**
184 * 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.
185 */
186 deleteClusterSecurityGroup(params: Redshift.Types.DeleteClusterSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
187 /**
188 * 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.
189 */
190 deleteClusterSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
191 /**
192 * 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.
193 */
194 deleteClusterSnapshot(params: Redshift.Types.DeleteClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.DeleteClusterSnapshotResult) => void): Request<Redshift.Types.DeleteClusterSnapshotResult, AWSError>;
195 /**
196 * 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.
197 */
198 deleteClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.DeleteClusterSnapshotResult) => void): Request<Redshift.Types.DeleteClusterSnapshotResult, AWSError>;
199 /**
200 * Deletes the specified cluster subnet group.
201 */
202 deleteClusterSubnetGroup(params: Redshift.Types.DeleteClusterSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
203 /**
204 * Deletes the specified cluster subnet group.
205 */
206 deleteClusterSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
207 /**
208 * Deletes an Amazon Redshift event notification subscription.
209 */
210 deleteEventSubscription(params: Redshift.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
211 /**
212 * Deletes an Amazon Redshift event notification subscription.
213 */
214 deleteEventSubscription(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
215 /**
216 * Deletes the specified HSM client certificate.
217 */
218 deleteHsmClientCertificate(params: Redshift.Types.DeleteHsmClientCertificateMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
219 /**
220 * Deletes the specified HSM client certificate.
221 */
222 deleteHsmClientCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
223 /**
224 * Deletes the specified Amazon Redshift HSM configuration.
225 */
226 deleteHsmConfiguration(params: Redshift.Types.DeleteHsmConfigurationMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
227 /**
228 * Deletes the specified Amazon Redshift HSM configuration.
229 */
230 deleteHsmConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
231 /**
232 * Deletes a scheduled action.
233 */
234 deleteScheduledAction(params: Redshift.Types.DeleteScheduledActionMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
235 /**
236 * Deletes a scheduled action.
237 */
238 deleteScheduledAction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
239 /**
240 * Deletes the specified snapshot copy grant.
241 */
242 deleteSnapshotCopyGrant(params: Redshift.Types.DeleteSnapshotCopyGrantMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
243 /**
244 * Deletes the specified snapshot copy grant.
245 */
246 deleteSnapshotCopyGrant(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
247 /**
248 * Deletes a snapshot schedule.
249 */
250 deleteSnapshotSchedule(params: Redshift.Types.DeleteSnapshotScheduleMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
251 /**
252 * Deletes a snapshot schedule.
253 */
254 deleteSnapshotSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
255 /**
256 * Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
257 */
258 deleteTags(params: Redshift.Types.DeleteTagsMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
259 /**
260 * Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
261 */
262 deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
263 /**
264 * Returns a list of attributes attached to an account
265 */
266 describeAccountAttributes(params: Redshift.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: Redshift.Types.AccountAttributeList) => void): Request<Redshift.Types.AccountAttributeList, AWSError>;
267 /**
268 * Returns a list of attributes attached to an account
269 */
270 describeAccountAttributes(callback?: (err: AWSError, data: Redshift.Types.AccountAttributeList) => void): Request<Redshift.Types.AccountAttributeList, AWSError>;
271 /**
272 * Returns an array of ClusterDbRevision objects.
273 */
274 describeClusterDbRevisions(params: Redshift.Types.DescribeClusterDbRevisionsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterDbRevisionsMessage) => void): Request<Redshift.Types.ClusterDbRevisionsMessage, AWSError>;
275 /**
276 * Returns an array of ClusterDbRevision objects.
277 */
278 describeClusterDbRevisions(callback?: (err: AWSError, data: Redshift.Types.ClusterDbRevisionsMessage) => void): Request<Redshift.Types.ClusterDbRevisionsMessage, AWSError>;
279 /**
280 * 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.
281 */
282 describeClusterParameterGroups(params: Redshift.Types.DescribeClusterParameterGroupsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupsMessage) => void): Request<Redshift.Types.ClusterParameterGroupsMessage, AWSError>;
283 /**
284 * 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.
285 */
286 describeClusterParameterGroups(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupsMessage) => void): Request<Redshift.Types.ClusterParameterGroupsMessage, AWSError>;
287 /**
288 * 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.
289 */
290 describeClusterParameters(params: Redshift.Types.DescribeClusterParametersMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupDetails) => void): Request<Redshift.Types.ClusterParameterGroupDetails, AWSError>;
291 /**
292 * 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.
293 */
294 describeClusterParameters(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupDetails) => void): Request<Redshift.Types.ClusterParameterGroupDetails, AWSError>;
295 /**
296 * 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.
297 */
298 describeClusterSecurityGroups(params: Redshift.Types.DescribeClusterSecurityGroupsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterSecurityGroupMessage) => void): Request<Redshift.Types.ClusterSecurityGroupMessage, AWSError>;
299 /**
300 * 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.
301 */
302 describeClusterSecurityGroups(callback?: (err: AWSError, data: Redshift.Types.ClusterSecurityGroupMessage) => void): Request<Redshift.Types.ClusterSecurityGroupMessage, AWSError>;
303 /**
304 * 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.
305 */
306 describeClusterSnapshots(params: Redshift.Types.DescribeClusterSnapshotsMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request<Redshift.Types.SnapshotMessage, AWSError>;
307 /**
308 * 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.
309 */
310 describeClusterSnapshots(callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request<Redshift.Types.SnapshotMessage, AWSError>;
311 /**
312 * 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.
313 */
314 describeClusterSubnetGroups(params: Redshift.Types.DescribeClusterSubnetGroupsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterSubnetGroupMessage) => void): Request<Redshift.Types.ClusterSubnetGroupMessage, AWSError>;
315 /**
316 * 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.
317 */
318 describeClusterSubnetGroups(callback?: (err: AWSError, data: Redshift.Types.ClusterSubnetGroupMessage) => void): Request<Redshift.Types.ClusterSubnetGroupMessage, AWSError>;
319 /**
320 * Returns a list of all the available maintenance tracks.
321 */
322 describeClusterTracks(params: Redshift.Types.DescribeClusterTracksMessage, callback?: (err: AWSError, data: Redshift.Types.TrackListMessage) => void): Request<Redshift.Types.TrackListMessage, AWSError>;
323 /**
324 * Returns a list of all the available maintenance tracks.
325 */
326 describeClusterTracks(callback?: (err: AWSError, data: Redshift.Types.TrackListMessage) => void): Request<Redshift.Types.TrackListMessage, AWSError>;
327 /**
328 * 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.
329 */
330 describeClusterVersions(params: Redshift.Types.DescribeClusterVersionsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterVersionsMessage) => void): Request<Redshift.Types.ClusterVersionsMessage, AWSError>;
331 /**
332 * 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.
333 */
334 describeClusterVersions(callback?: (err: AWSError, data: Redshift.Types.ClusterVersionsMessage) => void): Request<Redshift.Types.ClusterVersionsMessage, AWSError>;
335 /**
336 * 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.
337 */
338 describeClusters(params: Redshift.Types.DescribeClustersMessage, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
339 /**
340 * 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.
341 */
342 describeClusters(callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
343 /**
344 * 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.
345 */
346 describeDefaultClusterParameters(params: Redshift.Types.DescribeDefaultClusterParametersMessage, callback?: (err: AWSError, data: Redshift.Types.DescribeDefaultClusterParametersResult) => void): Request<Redshift.Types.DescribeDefaultClusterParametersResult, AWSError>;
347 /**
348 * 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.
349 */
350 describeDefaultClusterParameters(callback?: (err: AWSError, data: Redshift.Types.DescribeDefaultClusterParametersResult) => void): Request<Redshift.Types.DescribeDefaultClusterParametersResult, AWSError>;
351 /**
352 * 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.
353 */
354 describeEventCategories(params: Redshift.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: Redshift.Types.EventCategoriesMessage) => void): Request<Redshift.Types.EventCategoriesMessage, AWSError>;
355 /**
356 * 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.
357 */
358 describeEventCategories(callback?: (err: AWSError, data: Redshift.Types.EventCategoriesMessage) => void): Request<Redshift.Types.EventCategoriesMessage, AWSError>;
359 /**
360 * Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned. If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
361 */
362 describeEventSubscriptions(params: Redshift.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: Redshift.Types.EventSubscriptionsMessage) => void): Request<Redshift.Types.EventSubscriptionsMessage, AWSError>;
363 /**
364 * Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned. If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.
365 */
366 describeEventSubscriptions(callback?: (err: AWSError, data: Redshift.Types.EventSubscriptionsMessage) => void): Request<Redshift.Types.EventSubscriptionsMessage, AWSError>;
367 /**
368 * 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.
369 */
370 describeEvents(params: Redshift.Types.DescribeEventsMessage, callback?: (err: AWSError, data: Redshift.Types.EventsMessage) => void): Request<Redshift.Types.EventsMessage, AWSError>;
371 /**
372 * 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.
373 */
374 describeEvents(callback?: (err: AWSError, data: Redshift.Types.EventsMessage) => void): Request<Redshift.Types.EventsMessage, AWSError>;
375 /**
376 * 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.
377 */
378 describeHsmClientCertificates(params: Redshift.Types.DescribeHsmClientCertificatesMessage, callback?: (err: AWSError, data: Redshift.Types.HsmClientCertificateMessage) => void): Request<Redshift.Types.HsmClientCertificateMessage, AWSError>;
379 /**
380 * 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.
381 */
382 describeHsmClientCertificates(callback?: (err: AWSError, data: Redshift.Types.HsmClientCertificateMessage) => void): Request<Redshift.Types.HsmClientCertificateMessage, AWSError>;
383 /**
384 * 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.
385 */
386 describeHsmConfigurations(params: Redshift.Types.DescribeHsmConfigurationsMessage, callback?: (err: AWSError, data: Redshift.Types.HsmConfigurationMessage) => void): Request<Redshift.Types.HsmConfigurationMessage, AWSError>;
387 /**
388 * 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.
389 */
390 describeHsmConfigurations(callback?: (err: AWSError, data: Redshift.Types.HsmConfigurationMessage) => void): Request<Redshift.Types.HsmConfigurationMessage, AWSError>;
391 /**
392 * Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
393 */
394 describeLoggingStatus(params: Redshift.Types.DescribeLoggingStatusMessage, callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
395 /**
396 * Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
397 */
398 describeLoggingStatus(callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
399 /**
400 * Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
401 */
402 describeNodeConfigurationOptions(params: Redshift.Types.DescribeNodeConfigurationOptionsMessage, callback?: (err: AWSError, data: Redshift.Types.NodeConfigurationOptionsMessage) => void): Request<Redshift.Types.NodeConfigurationOptionsMessage, AWSError>;
403 /**
404 * Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.
405 */
406 describeNodeConfigurationOptions(callback?: (err: AWSError, data: Redshift.Types.NodeConfigurationOptionsMessage) => void): Request<Redshift.Types.NodeConfigurationOptionsMessage, AWSError>;
407 /**
408 * 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.
409 */
410 describeOrderableClusterOptions(params: Redshift.Types.DescribeOrderableClusterOptionsMessage, callback?: (err: AWSError, data: Redshift.Types.OrderableClusterOptionsMessage) => void): Request<Redshift.Types.OrderableClusterOptionsMessage, AWSError>;
411 /**
412 * 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.
413 */
414 describeOrderableClusterOptions(callback?: (err: AWSError, data: Redshift.Types.OrderableClusterOptionsMessage) => void): Request<Redshift.Types.OrderableClusterOptionsMessage, AWSError>;
415 /**
416 * 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.
417 */
418 describeReservedNodeOfferings(params: Redshift.Types.DescribeReservedNodeOfferingsMessage, callback?: (err: AWSError, data: Redshift.Types.ReservedNodeOfferingsMessage) => void): Request<Redshift.Types.ReservedNodeOfferingsMessage, AWSError>;
419 /**
420 * 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.
421 */
422 describeReservedNodeOfferings(callback?: (err: AWSError, data: Redshift.Types.ReservedNodeOfferingsMessage) => void): Request<Redshift.Types.ReservedNodeOfferingsMessage, AWSError>;
423 /**
424 * Returns the descriptions of the reserved nodes.
425 */
426 describeReservedNodes(params: Redshift.Types.DescribeReservedNodesMessage, callback?: (err: AWSError, data: Redshift.Types.ReservedNodesMessage) => void): Request<Redshift.Types.ReservedNodesMessage, AWSError>;
427 /**
428 * Returns the descriptions of the reserved nodes.
429 */
430 describeReservedNodes(callback?: (err: AWSError, data: Redshift.Types.ReservedNodesMessage) => void): Request<Redshift.Types.ReservedNodesMessage, AWSError>;
431 /**
432 * 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.
433 */
434 describeResize(params: Redshift.Types.DescribeResizeMessage, callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request<Redshift.Types.ResizeProgressMessage, AWSError>;
435 /**
436 * 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.
437 */
438 describeResize(callback?: (err: AWSError, data: Redshift.Types.ResizeProgressMessage) => void): Request<Redshift.Types.ResizeProgressMessage, AWSError>;
439 /**
440 * Describes properties of scheduled actions.
441 */
442 describeScheduledActions(params: Redshift.Types.DescribeScheduledActionsMessage, callback?: (err: AWSError, data: Redshift.Types.ScheduledActionsMessage) => void): Request<Redshift.Types.ScheduledActionsMessage, AWSError>;
443 /**
444 * Describes properties of scheduled actions.
445 */
446 describeScheduledActions(callback?: (err: AWSError, data: Redshift.Types.ScheduledActionsMessage) => void): Request<Redshift.Types.ScheduledActionsMessage, AWSError>;
447 /**
448 * 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.
449 */
450 describeSnapshotCopyGrants(params: Redshift.Types.DescribeSnapshotCopyGrantsMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotCopyGrantMessage) => void): Request<Redshift.Types.SnapshotCopyGrantMessage, AWSError>;
451 /**
452 * 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.
453 */
454 describeSnapshotCopyGrants(callback?: (err: AWSError, data: Redshift.Types.SnapshotCopyGrantMessage) => void): Request<Redshift.Types.SnapshotCopyGrantMessage, AWSError>;
455 /**
456 * Returns a list of snapshot schedules.
457 */
458 describeSnapshotSchedules(params: Redshift.Types.DescribeSnapshotSchedulesMessage, callback?: (err: AWSError, data: Redshift.Types.DescribeSnapshotSchedulesOutputMessage) => void): Request<Redshift.Types.DescribeSnapshotSchedulesOutputMessage, AWSError>;
459 /**
460 * Returns a list of snapshot schedules.
461 */
462 describeSnapshotSchedules(callback?: (err: AWSError, data: Redshift.Types.DescribeSnapshotSchedulesOutputMessage) => void): Request<Redshift.Types.DescribeSnapshotSchedulesOutputMessage, AWSError>;
463 /**
464 * Returns account level backups storage size and provisional storage.
465 */
466 describeStorage(callback?: (err: AWSError, data: Redshift.Types.CustomerStorageMessage) => void): Request<Redshift.Types.CustomerStorageMessage, AWSError>;
467 /**
468 * Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.
469 */
470 describeTableRestoreStatus(params: Redshift.Types.DescribeTableRestoreStatusMessage, callback?: (err: AWSError, data: Redshift.Types.TableRestoreStatusMessage) => void): Request<Redshift.Types.TableRestoreStatusMessage, AWSError>;
471 /**
472 * Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.
473 */
474 describeTableRestoreStatus(callback?: (err: AWSError, data: Redshift.Types.TableRestoreStatusMessage) => void): Request<Redshift.Types.TableRestoreStatusMessage, AWSError>;
475 /**
476 * 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.
477 */
478 describeTags(params: Redshift.Types.DescribeTagsMessage, callback?: (err: AWSError, data: Redshift.Types.TaggedResourceListMessage) => void): Request<Redshift.Types.TaggedResourceListMessage, AWSError>;
479 /**
480 * 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.
481 */
482 describeTags(callback?: (err: AWSError, data: Redshift.Types.TaggedResourceListMessage) => void): Request<Redshift.Types.TaggedResourceListMessage, AWSError>;
483 /**
484 * Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
485 */
486 disableLogging(params: Redshift.Types.DisableLoggingMessage, callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
487 /**
488 * Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
489 */
490 disableLogging(callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
491 /**
492 * 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.
493 */
494 disableSnapshotCopy(params: Redshift.Types.DisableSnapshotCopyMessage, callback?: (err: AWSError, data: Redshift.Types.DisableSnapshotCopyResult) => void): Request<Redshift.Types.DisableSnapshotCopyResult, AWSError>;
495 /**
496 * 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.
497 */
498 disableSnapshotCopy(callback?: (err: AWSError, data: Redshift.Types.DisableSnapshotCopyResult) => void): Request<Redshift.Types.DisableSnapshotCopyResult, AWSError>;
499 /**
500 * Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
501 */
502 enableLogging(params: Redshift.Types.EnableLoggingMessage, callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
503 /**
504 * Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
505 */
506 enableLogging(callback?: (err: AWSError, data: Redshift.Types.LoggingStatus) => void): Request<Redshift.Types.LoggingStatus, AWSError>;
507 /**
508 * Enables the automatic copy of snapshots from one region to another region for a specified cluster.
509 */
510 enableSnapshotCopy(params: Redshift.Types.EnableSnapshotCopyMessage, callback?: (err: AWSError, data: Redshift.Types.EnableSnapshotCopyResult) => void): Request<Redshift.Types.EnableSnapshotCopyResult, AWSError>;
511 /**
512 * Enables the automatic copy of snapshots from one region to another region for a specified cluster.
513 */
514 enableSnapshotCopy(callback?: (err: AWSError, data: Redshift.Types.EnableSnapshotCopyResult) => void): Request<Redshift.Types.EnableSnapshotCopyResult, AWSError>;
515 /**
516 * Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide. The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide. If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups. In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege. If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.
517 */
518 getClusterCredentials(params: Redshift.Types.GetClusterCredentialsMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterCredentials) => void): Request<Redshift.Types.ClusterCredentials, AWSError>;
519 /**
520 * Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide. The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide. If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups. In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege. If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.
521 */
522 getClusterCredentials(callback?: (err: AWSError, data: Redshift.Types.ClusterCredentials) => void): Request<Redshift.Types.ClusterCredentials, AWSError>;
523 /**
524 * Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
525 */
526 getReservedNodeExchangeOfferings(params: Redshift.Types.GetReservedNodeExchangeOfferingsInputMessage, callback?: (err: AWSError, data: Redshift.Types.GetReservedNodeExchangeOfferingsOutputMessage) => void): Request<Redshift.Types.GetReservedNodeExchangeOfferingsOutputMessage, AWSError>;
527 /**
528 * Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
529 */
530 getReservedNodeExchangeOfferings(callback?: (err: AWSError, data: Redshift.Types.GetReservedNodeExchangeOfferingsOutputMessage) => void): Request<Redshift.Types.GetReservedNodeExchangeOfferingsOutputMessage, AWSError>;
531 /**
532 * Modifies the settings for a cluster. 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. You can add another security or parameter group, 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.
533 */
534 modifyCluster(params: Redshift.Types.ModifyClusterMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterResult) => void): Request<Redshift.Types.ModifyClusterResult, AWSError>;
535 /**
536 * Modifies the settings for a cluster. 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. You can add another security or parameter group, 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.
537 */
538 modifyCluster(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterResult) => void): Request<Redshift.Types.ModifyClusterResult, AWSError>;
539 /**
540 * Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
541 */
542 modifyClusterDbRevision(params: Redshift.Types.ModifyClusterDbRevisionMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterDbRevisionResult) => void): Request<Redshift.Types.ModifyClusterDbRevisionResult, AWSError>;
543 /**
544 * Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
545 */
546 modifyClusterDbRevision(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterDbRevisionResult) => void): Request<Redshift.Types.ModifyClusterDbRevisionResult, AWSError>;
547 /**
548 * Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. A cluster can have up to 10 IAM roles associated at any time.
549 */
550 modifyClusterIamRoles(params: Redshift.Types.ModifyClusterIamRolesMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterIamRolesResult) => void): Request<Redshift.Types.ModifyClusterIamRolesResult, AWSError>;
551 /**
552 * Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. A cluster can have up to 10 IAM roles associated at any time.
553 */
554 modifyClusterIamRoles(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterIamRolesResult) => void): Request<Redshift.Types.ModifyClusterIamRolesResult, AWSError>;
555 /**
556 * Modifies the maintenance settings of a cluster.
557 */
558 modifyClusterMaintenance(params: Redshift.Types.ModifyClusterMaintenanceMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterMaintenanceResult) => void): Request<Redshift.Types.ModifyClusterMaintenanceResult, AWSError>;
559 /**
560 * Modifies the maintenance settings of a cluster.
561 */
562 modifyClusterMaintenance(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterMaintenanceResult) => void): Request<Redshift.Types.ModifyClusterMaintenanceResult, AWSError>;
563 /**
564 * 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.
565 */
566 modifyClusterParameterGroup(params: Redshift.Types.ModifyClusterParameterGroupMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request<Redshift.Types.ClusterParameterGroupNameMessage, AWSError>;
567 /**
568 * 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.
569 */
570 modifyClusterParameterGroup(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request<Redshift.Types.ClusterParameterGroupNameMessage, AWSError>;
571 /**
572 * Modifies the settings for a snapshot. This exanmple modifies the manual retention period setting for a cluster snapshot.
573 */
574 modifyClusterSnapshot(params: Redshift.Types.ModifyClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSnapshotResult) => void): Request<Redshift.Types.ModifyClusterSnapshotResult, AWSError>;
575 /**
576 * Modifies the settings for a snapshot. This exanmple modifies the manual retention period setting for a cluster snapshot.
577 */
578 modifyClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSnapshotResult) => void): Request<Redshift.Types.ModifyClusterSnapshotResult, AWSError>;
579 /**
580 * Modifies a snapshot schedule for a cluster.
581 */
582 modifyClusterSnapshotSchedule(params: Redshift.Types.ModifyClusterSnapshotScheduleMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
583 /**
584 * Modifies a snapshot schedule for a cluster.
585 */
586 modifyClusterSnapshotSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
587 /**
588 * 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.
589 */
590 modifyClusterSubnetGroup(params: Redshift.Types.ModifyClusterSubnetGroupMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSubnetGroupResult) => void): Request<Redshift.Types.ModifyClusterSubnetGroupResult, AWSError>;
591 /**
592 * 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.
593 */
594 modifyClusterSubnetGroup(callback?: (err: AWSError, data: Redshift.Types.ModifyClusterSubnetGroupResult) => void): Request<Redshift.Types.ModifyClusterSubnetGroupResult, AWSError>;
595 /**
596 * Modifies an existing Amazon Redshift event notification subscription.
597 */
598 modifyEventSubscription(params: Redshift.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: Redshift.Types.ModifyEventSubscriptionResult) => void): Request<Redshift.Types.ModifyEventSubscriptionResult, AWSError>;
599 /**
600 * Modifies an existing Amazon Redshift event notification subscription.
601 */
602 modifyEventSubscription(callback?: (err: AWSError, data: Redshift.Types.ModifyEventSubscriptionResult) => void): Request<Redshift.Types.ModifyEventSubscriptionResult, AWSError>;
603 /**
604 * Modifies a scheduled action.
605 */
606 modifyScheduledAction(params: Redshift.Types.ModifyScheduledActionMessage, callback?: (err: AWSError, data: Redshift.Types.ScheduledAction) => void): Request<Redshift.Types.ScheduledAction, AWSError>;
607 /**
608 * Modifies a scheduled action.
609 */
610 modifyScheduledAction(callback?: (err: AWSError, data: Redshift.Types.ScheduledAction) => void): Request<Redshift.Types.ScheduledAction, AWSError>;
611 /**
612 * Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.
613 */
614 modifySnapshotCopyRetentionPeriod(params: Redshift.Types.ModifySnapshotCopyRetentionPeriodMessage, callback?: (err: AWSError, data: Redshift.Types.ModifySnapshotCopyRetentionPeriodResult) => void): Request<Redshift.Types.ModifySnapshotCopyRetentionPeriodResult, AWSError>;
615 /**
616 * Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.
617 */
618 modifySnapshotCopyRetentionPeriod(callback?: (err: AWSError, data: Redshift.Types.ModifySnapshotCopyRetentionPeriodResult) => void): Request<Redshift.Types.ModifySnapshotCopyRetentionPeriodResult, AWSError>;
619 /**
620 * Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
621 */
622 modifySnapshotSchedule(params: Redshift.Types.ModifySnapshotScheduleMessage, callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request<Redshift.Types.SnapshotSchedule, AWSError>;
623 /**
624 * Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
625 */
626 modifySnapshotSchedule(callback?: (err: AWSError, data: Redshift.Types.SnapshotSchedule) => void): Request<Redshift.Types.SnapshotSchedule, AWSError>;
627 /**
628 * Pauses a cluster.
629 */
630 pauseCluster(params: Redshift.Types.PauseClusterMessage, callback?: (err: AWSError, data: Redshift.Types.PauseClusterResult) => void): Request<Redshift.Types.PauseClusterResult, AWSError>;
631 /**
632 * Pauses a cluster.
633 */
634 pauseCluster(callback?: (err: AWSError, data: Redshift.Types.PauseClusterResult) => void): Request<Redshift.Types.PauseClusterResult, AWSError>;
635 /**
636 * 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.
637 */
638 purchaseReservedNodeOffering(params: Redshift.Types.PurchaseReservedNodeOfferingMessage, callback?: (err: AWSError, data: Redshift.Types.PurchaseReservedNodeOfferingResult) => void): Request<Redshift.Types.PurchaseReservedNodeOfferingResult, AWSError>;
639 /**
640 * 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.
641 */
642 purchaseReservedNodeOffering(callback?: (err: AWSError, data: Redshift.Types.PurchaseReservedNodeOfferingResult) => void): Request<Redshift.Types.PurchaseReservedNodeOfferingResult, AWSError>;
643 /**
644 * 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.
645 */
646 rebootCluster(params: Redshift.Types.RebootClusterMessage, callback?: (err: AWSError, data: Redshift.Types.RebootClusterResult) => void): Request<Redshift.Types.RebootClusterResult, AWSError>;
647 /**
648 * 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.
649 */
650 rebootCluster(callback?: (err: AWSError, data: Redshift.Types.RebootClusterResult) => void): Request<Redshift.Types.RebootClusterResult, AWSError>;
651 /**
652 * 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.
653 */
654 resetClusterParameterGroup(params: Redshift.Types.ResetClusterParameterGroupMessage, callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request<Redshift.Types.ClusterParameterGroupNameMessage, AWSError>;
655 /**
656 * 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.
657 */
658 resetClusterParameterGroup(callback?: (err: AWSError, data: Redshift.Types.ClusterParameterGroupNameMessage) => void): Request<Redshift.Types.ClusterParameterGroupNameMessage, AWSError>;
659 /**
660 * Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge ds2.xlarge ds2.8xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster.
661 */
662 resizeCluster(params: Redshift.Types.ResizeClusterMessage, callback?: (err: AWSError, data: Redshift.Types.ResizeClusterResult) => void): Request<Redshift.Types.ResizeClusterResult, AWSError>;
663 /**
664 * Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge ds2.xlarge ds2.8xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster.
665 */
666 resizeCluster(callback?: (err: AWSError, data: Redshift.Types.ResizeClusterResult) => void): Request<Redshift.Types.ResizeClusterResult, AWSError>;
667 /**
668 * 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.
669 */
670 restoreFromClusterSnapshot(params: Redshift.Types.RestoreFromClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.RestoreFromClusterSnapshotResult) => void): Request<Redshift.Types.RestoreFromClusterSnapshotResult, AWSError>;
671 /**
672 * 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.
673 */
674 restoreFromClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.RestoreFromClusterSnapshotResult) => void): Request<Redshift.Types.RestoreFromClusterSnapshotResult, AWSError>;
675 /**
676 * Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.
677 */
678 restoreTableFromClusterSnapshot(params: Redshift.Types.RestoreTableFromClusterSnapshotMessage, callback?: (err: AWSError, data: Redshift.Types.RestoreTableFromClusterSnapshotResult) => void): Request<Redshift.Types.RestoreTableFromClusterSnapshotResult, AWSError>;
679 /**
680 * Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.
681 */
682 restoreTableFromClusterSnapshot(callback?: (err: AWSError, data: Redshift.Types.RestoreTableFromClusterSnapshotResult) => void): Request<Redshift.Types.RestoreTableFromClusterSnapshotResult, AWSError>;
683 /**
684 * Resumes a paused cluster.
685 */
686 resumeCluster(params: Redshift.Types.ResumeClusterMessage, callback?: (err: AWSError, data: Redshift.Types.ResumeClusterResult) => void): Request<Redshift.Types.ResumeClusterResult, AWSError>;
687 /**
688 * Resumes a paused cluster.
689 */
690 resumeCluster(callback?: (err: AWSError, data: Redshift.Types.ResumeClusterResult) => void): Request<Redshift.Types.ResumeClusterResult, AWSError>;
691 /**
692 * 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.
693 */
694 revokeClusterSecurityGroupIngress(params: Redshift.Types.RevokeClusterSecurityGroupIngressMessage, callback?: (err: AWSError, data: Redshift.Types.RevokeClusterSecurityGroupIngressResult) => void): Request<Redshift.Types.RevokeClusterSecurityGroupIngressResult, AWSError>;
695 /**
696 * 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.
697 */
698 revokeClusterSecurityGroupIngress(callback?: (err: AWSError, data: Redshift.Types.RevokeClusterSecurityGroupIngressResult) => void): Request<Redshift.Types.RevokeClusterSecurityGroupIngressResult, AWSError>;
699 /**
700 * 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.
701 */
702 revokeSnapshotAccess(params: Redshift.Types.RevokeSnapshotAccessMessage, callback?: (err: AWSError, data: Redshift.Types.RevokeSnapshotAccessResult) => void): Request<Redshift.Types.RevokeSnapshotAccessResult, AWSError>;
703 /**
704 * 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.
705 */
706 revokeSnapshotAccess(callback?: (err: AWSError, data: Redshift.Types.RevokeSnapshotAccessResult) => void): Request<Redshift.Types.RevokeSnapshotAccessResult, AWSError>;
707 /**
708 * Rotates the encryption keys for a cluster.
709 */
710 rotateEncryptionKey(params: Redshift.Types.RotateEncryptionKeyMessage, callback?: (err: AWSError, data: Redshift.Types.RotateEncryptionKeyResult) => void): Request<Redshift.Types.RotateEncryptionKeyResult, AWSError>;
711 /**
712 * Rotates the encryption keys for a cluster.
713 */
714 rotateEncryptionKey(callback?: (err: AWSError, data: Redshift.Types.RotateEncryptionKeyResult) => void): Request<Redshift.Types.RotateEncryptionKeyResult, AWSError>;
715 /**
716 * Waits for the clusterAvailable state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
717 */
718 waitFor(state: "clusterAvailable", params: Redshift.Types.DescribeClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
719 /**
720 * Waits for the clusterAvailable state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
721 */
722 waitFor(state: "clusterAvailable", callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
723 /**
724 * Waits for the clusterDeleted state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
725 */
726 waitFor(state: "clusterDeleted", params: Redshift.Types.DescribeClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
727 /**
728 * Waits for the clusterDeleted state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
729 */
730 waitFor(state: "clusterDeleted", callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
731 /**
732 * Waits for the clusterRestored state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
733 */
734 waitFor(state: "clusterRestored", params: Redshift.Types.DescribeClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
735 /**
736 * Waits for the clusterRestored state by periodically calling the underlying Redshift.describeClustersoperation every 60 seconds (at most 30 times).
737 */
738 waitFor(state: "clusterRestored", callback?: (err: AWSError, data: Redshift.Types.ClustersMessage) => void): Request<Redshift.Types.ClustersMessage, AWSError>;
739 /**
740 * Waits for the snapshotAvailable state by periodically calling the underlying Redshift.describeClusterSnapshotsoperation every 15 seconds (at most 20 times).
741 */
742 waitFor(state: "snapshotAvailable", params: Redshift.Types.DescribeClusterSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request<Redshift.Types.SnapshotMessage, AWSError>;
743 /**
744 * Waits for the snapshotAvailable state by periodically calling the underlying Redshift.describeClusterSnapshotsoperation every 15 seconds (at most 20 times).
745 */
746 waitFor(state: "snapshotAvailable", callback?: (err: AWSError, data: Redshift.Types.SnapshotMessage) => void): Request<Redshift.Types.SnapshotMessage, AWSError>;
747}
748declare namespace Redshift {
749 export interface AcceptReservedNodeExchangeInputMessage {
750 /**
751 * A string representing the node identifier of the DC1 Reserved Node to be exchanged.
752 */
753 ReservedNodeId: String;
754 /**
755 * The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings
756 */
757 TargetReservedNodeOfferingId: String;
758 }
759 export interface AcceptReservedNodeExchangeOutputMessage {
760 /**
761 *
762 */
763 ExchangedReservedNode?: ReservedNode;
764 }
765 export interface AccountAttribute {
766 /**
767 * The name of the attribute.
768 */
769 AttributeName?: String;
770 /**
771 * A list of attribute values.
772 */
773 AttributeValues?: AttributeValueList;
774 }
775 export interface AccountAttributeList {
776 /**
777 * A list of attributes assigned to an account.
778 */
779 AccountAttributes?: AttributeList;
780 }
781 export interface AccountWithRestoreAccess {
782 /**
783 * The identifier of an AWS customer account authorized to restore a snapshot.
784 */
785 AccountId?: String;
786 /**
787 * The identifier of an AWS support account authorized to restore a snapshot. For AWS support, the identifier is amazon-redshift-support.
788 */
789 AccountAlias?: String;
790 }
791 export type AccountsWithRestoreAccessList = AccountWithRestoreAccess[];
792 export type ActionType = "restore-cluster"|"recommend-node-config"|"resize-cluster"|string;
793 export type AssociatedClusterList = ClusterAssociatedToSchedule[];
794 export type AttributeList = AccountAttribute[];
795 export type AttributeNameList = String[];
796 export type AttributeValueList = AttributeValueTarget[];
797 export interface AttributeValueTarget {
798 /**
799 * The value of the attribute.
800 */
801 AttributeValue?: String;
802 }
803 export interface AuthorizeClusterSecurityGroupIngressMessage {
804 /**
805 * The name of the security group to which the ingress rule is added.
806 */
807 ClusterSecurityGroupName: String;
808 /**
809 * The IP range to be added the Amazon Redshift security group.
810 */
811 CIDRIP?: String;
812 /**
813 * The EC2 security group to be added the Amazon Redshift security group.
814 */
815 EC2SecurityGroupName?: String;
816 /**
817 * The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. Example: 111122223333
818 */
819 EC2SecurityGroupOwnerId?: String;
820 }
821 export interface AuthorizeClusterSecurityGroupIngressResult {
822 ClusterSecurityGroup?: ClusterSecurityGroup;
823 }
824 export interface AuthorizeSnapshotAccessMessage {
825 /**
826 * The identifier of the snapshot the account is authorized to restore.
827 */
828 SnapshotIdentifier: String;
829 /**
830 * The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
831 */
832 SnapshotClusterIdentifier?: String;
833 /**
834 * The identifier of the AWS customer account authorized to restore the specified snapshot. To share a snapshot with AWS support, specify amazon-redshift-support.
835 */
836 AccountWithRestoreAccess: String;
837 }
838 export interface AuthorizeSnapshotAccessResult {
839 Snapshot?: Snapshot;
840 }
841 export interface AvailabilityZone {
842 /**
843 * The name of the availability zone.
844 */
845 Name?: String;
846 /**
847 *
848 */
849 SupportedPlatforms?: SupportedPlatformsList;
850 }
851 export type AvailabilityZoneList = AvailabilityZone[];
852 export interface BatchDeleteClusterSnapshotsRequest {
853 /**
854 * A list of identifiers for the snapshots that you want to delete.
855 */
856 Identifiers: DeleteClusterSnapshotMessageList;
857 }
858 export interface BatchDeleteClusterSnapshotsResult {
859 /**
860 * A list of the snapshot identifiers that were deleted.
861 */
862 Resources?: SnapshotIdentifierList;
863 /**
864 * A list of any errors returned.
865 */
866 Errors?: BatchSnapshotOperationErrorList;
867 }
868 export interface BatchModifyClusterSnapshotsMessage {
869 /**
870 * A list of snapshot identifiers you want to modify.
871 */
872 SnapshotIdentifierList: SnapshotIdentifierList;
873 /**
874 * The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely. The number must be either -1 or an integer between 1 and 3,653. If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.
875 */
876 ManualSnapshotRetentionPeriod?: IntegerOptional;
877 /**
878 * A boolean value indicating whether to override an exception if the retention period has passed.
879 */
880 Force?: Boolean;
881 }
882 export interface BatchModifyClusterSnapshotsOutputMessage {
883 /**
884 * A list of the snapshots that were modified.
885 */
886 Resources?: SnapshotIdentifierList;
887 /**
888 * A list of any errors returned.
889 */
890 Errors?: BatchSnapshotOperationErrors;
891 }
892 export type BatchSnapshotOperationErrorList = SnapshotErrorMessage[];
893 export type BatchSnapshotOperationErrors = SnapshotErrorMessage[];
894 export type Boolean = boolean;
895 export type BooleanOptional = boolean;
896 export interface CancelResizeMessage {
897 /**
898 * The unique identifier for the cluster that you want to cancel a resize operation for.
899 */
900 ClusterIdentifier: String;
901 }
902 export interface Cluster {
903 /**
904 * The unique identifier of the cluster.
905 */
906 ClusterIdentifier?: String;
907 /**
908 * The node type for the nodes in the cluster.
909 */
910 NodeType?: String;
911 /**
912 * The current state of the cluster. Possible values are the following: available available, prep-for-resize available, resize-cleanup cancelling-resize creating deleting final-snapshot hardware-failure incompatible-hsm incompatible-network incompatible-parameters incompatible-restore modifying paused rebooting renaming resizing rotating-keys storage-full updating-hsm
913 */
914 ClusterStatus?: String;
915 /**
916 * The availability status of the cluster for queries. Possible values are the following: Available - The cluster is available for queries. Unavailable - The cluster is not available for queries. Maintenance - The cluster is intermittently available for queries due to maintenance activities. Modifying - The cluster is intermittently available for queries due to changes that modify the cluster. Failed - The cluster failed and is not available for queries.
917 */
918 ClusterAvailabilityStatus?: String;
919 /**
920 * The status of a modify operation, if any, initiated for the cluster.
921 */
922 ModifyStatus?: String;
923 /**
924 * The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
925 */
926 MasterUsername?: String;
927 /**
928 * The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.
929 */
930 DBName?: String;
931 /**
932 * The connection endpoint.
933 */
934 Endpoint?: Endpoint;
935 /**
936 * The date and time that the cluster was created.
937 */
938 ClusterCreateTime?: TStamp;
939 /**
940 * The number of days that automatic cluster snapshots are retained.
941 */
942 AutomatedSnapshotRetentionPeriod?: Integer;
943 /**
944 * The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
945 */
946 ManualSnapshotRetentionPeriod?: Integer;
947 /**
948 * A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
949 */
950 ClusterSecurityGroups?: ClusterSecurityGroupMembershipList;
951 /**
952 * A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
953 */
954 VpcSecurityGroups?: VpcSecurityGroupMembershipList;
955 /**
956 * The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
957 */
958 ClusterParameterGroups?: ClusterParameterGroupStatusList;
959 /**
960 * The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
961 */
962 ClusterSubnetGroupName?: String;
963 /**
964 * The identifier of the VPC the cluster is in, if the cluster is in a VPC.
965 */
966 VpcId?: String;
967 /**
968 * The name of the Availability Zone in which the cluster is located.
969 */
970 AvailabilityZone?: String;
971 /**
972 * The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
973 */
974 PreferredMaintenanceWindow?: String;
975 /**
976 * A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
977 */
978 PendingModifiedValues?: PendingModifiedValues;
979 /**
980 * The version ID of the Amazon Redshift engine that is running on the cluster.
981 */
982 ClusterVersion?: String;
983 /**
984 * A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
985 */
986 AllowVersionUpgrade?: Boolean;
987 /**
988 * The number of compute nodes in the cluster.
989 */
990 NumberOfNodes?: Integer;
991 /**
992 * A boolean value that, if true, indicates that the cluster can be accessed from a public network.
993 */
994 PubliclyAccessible?: Boolean;
995 /**
996 * A boolean value that, if true, indicates that data in the cluster is encrypted at rest.
997 */
998 Encrypted?: Boolean;
999 /**
1000 * A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
1001 */
1002 RestoreStatus?: RestoreStatus;
1003 /**
1004 *
1005 */
1006 DataTransferProgress?: DataTransferProgress;
1007 /**
1008 * A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command. Values: active, applying
1009 */
1010 HsmStatus?: HsmStatus;
1011 /**
1012 * A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
1013 */
1014 ClusterSnapshotCopyStatus?: ClusterSnapshotCopyStatus;
1015 /**
1016 * The public key for the cluster.
1017 */
1018 ClusterPublicKey?: String;
1019 /**
1020 * The nodes in the cluster.
1021 */
1022 ClusterNodes?: ClusterNodesList;
1023 /**
1024 * The status of the elastic IP (EIP) address.
1025 */
1026 ElasticIpStatus?: ElasticIpStatus;
1027 /**
1028 * The specific revision number of the database in the cluster.
1029 */
1030 ClusterRevisionNumber?: String;
1031 /**
1032 * The list of tags for the cluster.
1033 */
1034 Tags?: TagList;
1035 /**
1036 * The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
1037 */
1038 KmsKeyId?: String;
1039 /**
1040 * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
1041 */
1042 EnhancedVpcRouting?: Boolean;
1043 /**
1044 * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
1045 */
1046 IamRoles?: ClusterIamRoleList;
1047 /**
1048 * Cluster operations that are waiting to be started.
1049 */
1050 PendingActions?: PendingActionsList;
1051 /**
1052 * The name of the maintenance track for the cluster.
1053 */
1054 MaintenanceTrackName?: String;
1055 /**
1056 * The number of nodes that you can resize the cluster to with the elastic resize method.
1057 */
1058 ElasticResizeNumberOfNodeOptions?: String;
1059 /**
1060 * Describes a group of DeferredMaintenanceWindow objects.
1061 */
1062 DeferredMaintenanceWindows?: DeferredMaintenanceWindowsList;
1063 /**
1064 * A unique identifier for the cluster snapshot schedule.
1065 */
1066 SnapshotScheduleIdentifier?: String;
1067 /**
1068 * The current state of the cluster snapshot schedule.
1069 */
1070 SnapshotScheduleState?: ScheduleState;
1071 /**
1072 * The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
1073 */
1074 ExpectedNextSnapshotScheduleTime?: TStamp;
1075 /**
1076 * The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following: OnTrack - The next snapshot is expected to be taken on time. Pending - The next snapshot is pending to be taken.
1077 */
1078 ExpectedNextSnapshotScheduleTimeStatus?: String;
1079 /**
1080 * The date and time in UTC when system maintenance can begin.
1081 */
1082 NextMaintenanceWindowStartTime?: TStamp;
1083 /**
1084 * Returns the following: AllowCancelResize: a boolean value indicating if the resize operation can be cancelled. ResizeType: Returns ClassicResize
1085 */
1086 ResizeInfo?: ResizeInfo;
1087 }
1088 export interface ClusterAssociatedToSchedule {
1089 /**
1090 *
1091 */
1092 ClusterIdentifier?: String;
1093 /**
1094 *
1095 */
1096 ScheduleAssociationState?: ScheduleState;
1097 }
1098 export interface ClusterCredentials {
1099 /**
1100 * A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials.
1101 */
1102 DbUser?: String;
1103 /**
1104 * A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.
1105 */
1106 DbPassword?: SensitiveString;
1107 /**
1108 * The date and time the password in DbPassword expires.
1109 */
1110 Expiration?: TStamp;
1111 }
1112 export interface ClusterDbRevision {
1113 /**
1114 * The unique identifier of the cluster.
1115 */
1116 ClusterIdentifier?: String;
1117 /**
1118 * A string representing the current cluster version.
1119 */
1120 CurrentDatabaseRevision?: String;
1121 /**
1122 * The date on which the database revision was released.
1123 */
1124 DatabaseRevisionReleaseDate?: TStamp;
1125 /**
1126 * A list of RevisionTarget objects, where each object describes the database revision that a cluster can be updated to.
1127 */
1128 RevisionTargets?: RevisionTargetsList;
1129 }
1130 export type ClusterDbRevisionsList = ClusterDbRevision[];
1131 export interface ClusterDbRevisionsMessage {
1132 /**
1133 * A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the marker parameter and retrying the command. If the marker field is empty, all revisions have already been returned.
1134 */
1135 Marker?: String;
1136 /**
1137 * A list of revisions.
1138 */
1139 ClusterDbRevisions?: ClusterDbRevisionsList;
1140 }
1141 export interface ClusterIamRole {
1142 /**
1143 * The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.
1144 */
1145 IamRoleArn?: String;
1146 /**
1147 * A value that describes the status of the IAM role's association with an Amazon Redshift cluster. The following are possible statuses and descriptions. in-sync: The role is available for use by the cluster. adding: The role is in the process of being associated with the cluster. removing: The role is in the process of being disassociated with the cluster.
1148 */
1149 ApplyStatus?: String;
1150 }
1151 export type ClusterIamRoleList = ClusterIamRole[];
1152 export type ClusterList = Cluster[];
1153 export interface ClusterNode {
1154 /**
1155 * Whether the node is a leader node or a compute node.
1156 */
1157 NodeRole?: String;
1158 /**
1159 * The private IP address of a node within a cluster.
1160 */
1161 PrivateIPAddress?: String;
1162 /**
1163 * The public IP address of a node within a cluster.
1164 */
1165 PublicIPAddress?: String;
1166 }
1167 export type ClusterNodesList = ClusterNode[];
1168 export interface ClusterParameterGroup {
1169 /**
1170 * The name of the cluster parameter group.
1171 */
1172 ParameterGroupName?: String;
1173 /**
1174 * The name of the cluster parameter group family that this cluster parameter group is compatible with.
1175 */
1176 ParameterGroupFamily?: String;
1177 /**
1178 * The description of the parameter group.
1179 */
1180 Description?: String;
1181 /**
1182 * The list of tags for the cluster parameter group.
1183 */
1184 Tags?: TagList;
1185 }
1186 export interface ClusterParameterGroupDetails {
1187 /**
1188 * A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.
1189 */
1190 Parameters?: ParametersList;
1191 /**
1192 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
1193 */
1194 Marker?: String;
1195 }
1196 export interface ClusterParameterGroupNameMessage {
1197 /**
1198 * The name of the cluster parameter group.
1199 */
1200 ParameterGroupName?: String;
1201 /**
1202 * The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
1203 */
1204 ParameterGroupStatus?: String;
1205 }
1206 export interface ClusterParameterGroupStatus {
1207 /**
1208 * The name of the cluster parameter group.
1209 */
1210 ParameterGroupName?: String;
1211 /**
1212 * The status of parameter updates.
1213 */
1214 ParameterApplyStatus?: String;
1215 /**
1216 * The list of parameter statuses. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
1217 */
1218 ClusterParameterStatusList?: ClusterParameterStatusList;
1219 }
1220 export type ClusterParameterGroupStatusList = ClusterParameterGroupStatus[];
1221 export interface ClusterParameterGroupsMessage {
1222 /**
1223 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
1224 */
1225 Marker?: String;
1226 /**
1227 * A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.
1228 */
1229 ParameterGroups?: ParameterGroupList;
1230 }
1231 export interface ClusterParameterStatus {
1232 /**
1233 * The name of the parameter.
1234 */
1235 ParameterName?: String;
1236 /**
1237 * The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied. The following are possible statuses and descriptions. in-sync: The parameter value is in sync with the database. pending-reboot: The parameter value will be applied after the cluster reboots. applying: The parameter value is being applied to the database. invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax. apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots. apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots. unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
1238 */
1239 ParameterApplyStatus?: String;
1240 /**
1241 * The error that prevented the parameter from being applied to the database.
1242 */
1243 ParameterApplyErrorDescription?: String;
1244 }
1245 export type ClusterParameterStatusList = ClusterParameterStatus[];
1246 export interface ClusterSecurityGroup {
1247 /**
1248 * The name of the cluster security group to which the operation was applied.
1249 */
1250 ClusterSecurityGroupName?: String;
1251 /**
1252 * A description of the security group.
1253 */
1254 Description?: String;
1255 /**
1256 * A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.
1257 */
1258 EC2SecurityGroups?: EC2SecurityGroupList;
1259 /**
1260 * A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.
1261 */
1262 IPRanges?: IPRangeList;
1263 /**
1264 * The list of tags for the cluster security group.
1265 */
1266 Tags?: TagList;
1267 }
1268 export interface ClusterSecurityGroupMembership {
1269 /**
1270 * The name of the cluster security group.
1271 */
1272 ClusterSecurityGroupName?: String;
1273 /**
1274 * The status of the cluster security group.
1275 */
1276 Status?: String;
1277 }
1278 export type ClusterSecurityGroupMembershipList = ClusterSecurityGroupMembership[];
1279 export interface ClusterSecurityGroupMessage {
1280 /**
1281 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
1282 */
1283 Marker?: String;
1284 /**
1285 * A list of ClusterSecurityGroup instances.
1286 */
1287 ClusterSecurityGroups?: ClusterSecurityGroups;
1288 }
1289 export type ClusterSecurityGroupNameList = String[];
1290 export type ClusterSecurityGroups = ClusterSecurityGroup[];
1291 export interface ClusterSnapshotCopyStatus {
1292 /**
1293 * The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
1294 */
1295 DestinationRegion?: String;
1296 /**
1297 * The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
1298 */
1299 RetentionPeriod?: Long;
1300 /**
1301 * The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
1302 */
1303 ManualSnapshotRetentionPeriod?: Integer;
1304 /**
1305 * The name of the snapshot copy grant.
1306 */
1307 SnapshotCopyGrantName?: String;
1308 }
1309 export interface ClusterSubnetGroup {
1310 /**
1311 * The name of the cluster subnet group.
1312 */
1313 ClusterSubnetGroupName?: String;
1314 /**
1315 * The description of the cluster subnet group.
1316 */
1317 Description?: String;
1318 /**
1319 * The VPC ID of the cluster subnet group.
1320 */
1321 VpcId?: String;
1322 /**
1323 * The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.
1324 */
1325 SubnetGroupStatus?: String;
1326 /**
1327 * A list of the VPC Subnet elements.
1328 */
1329 Subnets?: SubnetList;
1330 /**
1331 * The list of tags for the cluster subnet group.
1332 */
1333 Tags?: TagList;
1334 }
1335 export interface ClusterSubnetGroupMessage {
1336 /**
1337 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
1338 */
1339 Marker?: String;
1340 /**
1341 * A list of ClusterSubnetGroup instances.
1342 */
1343 ClusterSubnetGroups?: ClusterSubnetGroups;
1344 }
1345 export type ClusterSubnetGroups = ClusterSubnetGroup[];
1346 export interface ClusterVersion {
1347 /**
1348 * The version number used by the cluster.
1349 */
1350 ClusterVersion?: String;
1351 /**
1352 * The name of the cluster parameter group family for the cluster.
1353 */
1354 ClusterParameterGroupFamily?: String;
1355 /**
1356 * The description of the cluster version.
1357 */
1358 Description?: String;
1359 }
1360 export type ClusterVersionList = ClusterVersion[];
1361 export interface ClusterVersionsMessage {
1362 /**
1363 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
1364 */
1365 Marker?: String;
1366 /**
1367 * A list of Version elements.
1368 */
1369 ClusterVersions?: ClusterVersionList;
1370 }
1371 export interface ClustersMessage {
1372 /**
1373 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
1374 */
1375 Marker?: String;
1376 /**
1377 * A list of Cluster objects, where each object describes one cluster.
1378 */
1379 Clusters?: ClusterList;
1380 }
1381 export interface CopyClusterSnapshotMessage {
1382 /**
1383 * The identifier for the source snapshot. Constraints: Must be the identifier for a valid automated snapshot whose state is available.
1384 */
1385 SourceSnapshotIdentifier: String;
1386 /**
1387 * The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the identifier for a valid cluster.
1388 */
1389 SourceSnapshotClusterIdentifier?: String;
1390 /**
1391 * The identifier given to the new manual snapshot. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for the AWS account that is making the request.
1392 */
1393 TargetSnapshotIdentifier: String;
1394 /**
1395 * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
1396 */
1397 ManualSnapshotRetentionPeriod?: IntegerOptional;
1398 }
1399 export interface CopyClusterSnapshotResult {
1400 Snapshot?: Snapshot;
1401 }
1402 export interface CreateClusterMessage {
1403 /**
1404 * The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: dev Constraints: Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters. Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
1405 */
1406 DBName?: String;
1407 /**
1408 * A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: myexamplecluster
1409 */
1410 ClusterIdentifier: String;
1411 /**
1412 * The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required. multi-node, the NumberOfNodes parameter is required. Valid Values: multi-node | single-node Default: multi-node
1413 */
1414 ClusterType?: String;
1415 /**
1416 * The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.16xlarge
1417 */
1418 NodeType: String;
1419 /**
1420 * The user name associated with the master user account for the cluster that is being created. Constraints: Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC. First character must be a letter. Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
1421 */
1422 MasterUsername: String;
1423 /**
1424 * The password associated with the master user account for the cluster that is being created. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
1425 */
1426 MasterUserPassword: String;
1427 /**
1428 * A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift.
1429 */
1430 ClusterSecurityGroups?: ClusterSecurityGroupNameList;
1431 /**
1432 * A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster.
1433 */
1434 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
1435 /**
1436 * The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
1437 */
1438 ClusterSubnetGroupName?: String;
1439 /**
1440 * The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: us-east-2d Constraint: The specified Availability Zone must be in the same region as the current endpoint.
1441 */
1442 AvailabilityZone?: String;
1443 /**
1444 * The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
1445 */
1446 PreferredMaintenanceWindow?: String;
1447 /**
1448 * The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
1449 */
1450 ClusterParameterGroupName?: String;
1451 /**
1452 * The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: 1 Constraints: Must be a value from 0 to 35.
1453 */
1454 AutomatedSnapshotRetentionPeriod?: IntegerOptional;
1455 /**
1456 * The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
1457 */
1458 ManualSnapshotRetentionPeriod?: IntegerOptional;
1459 /**
1460 * The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: 5439 Valid Values: 1150-65535
1461 */
1462 Port?: IntegerOptional;
1463 /**
1464 * The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster. Constraints: Only version 1.0 is currently available. Example: 1.0
1465 */
1466 ClusterVersion?: String;
1467 /**
1468 * If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: true
1469 */
1470 AllowVersionUpgrade?: BooleanOptional;
1471 /**
1472 * The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: 1 Constraints: Value must be at least 1 and no more than 100.
1473 */
1474 NumberOfNodes?: IntegerOptional;
1475 /**
1476 * If true, the cluster can be accessed from a public network.
1477 */
1478 PubliclyAccessible?: BooleanOptional;
1479 /**
1480 * If true, the data in the cluster is encrypted at rest. Default: false
1481 */
1482 Encrypted?: BooleanOptional;
1483 /**
1484 * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
1485 */
1486 HsmClientCertificateIdentifier?: String;
1487 /**
1488 * Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
1489 */
1490 HsmConfigurationIdentifier?: String;
1491 /**
1492 * The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
1493 */
1494 ElasticIp?: String;
1495 /**
1496 * A list of tag instances.
1497 */
1498 Tags?: TagList;
1499 /**
1500 * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
1501 */
1502 KmsKeyId?: String;
1503 /**
1504 * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
1505 */
1506 EnhancedVpcRouting?: BooleanOptional;
1507 /**
1508 * Reserved.
1509 */
1510 AdditionalInfo?: String;
1511 /**
1512 * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated with it at any time.
1513 */
1514 IamRoles?: IamRoleArnList;
1515 /**
1516 * An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.
1517 */
1518 MaintenanceTrackName?: String;
1519 /**
1520 * A unique identifier for the snapshot schedule.
1521 */
1522 SnapshotScheduleIdentifier?: String;
1523 }
1524 export interface CreateClusterParameterGroupMessage {
1525 /**
1526 * The name of the cluster parameter group. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique withing your AWS account. This value is stored as a lower-case string.
1527 */
1528 ParameterGroupName: String;
1529 /**
1530 * The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".
1531 */
1532 ParameterGroupFamily: String;
1533 /**
1534 * A description of the parameter group.
1535 */
1536 Description: String;
1537 /**
1538 * A list of tag instances.
1539 */
1540 Tags?: TagList;
1541 }
1542 export interface CreateClusterParameterGroupResult {
1543 ClusterParameterGroup?: ClusterParameterGroup;
1544 }
1545 export interface CreateClusterResult {
1546 Cluster?: Cluster;
1547 }
1548 export interface CreateClusterSecurityGroupMessage {
1549 /**
1550 * The name for the security group. Amazon Redshift stores the value as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Must be unique for all security groups that are created by your AWS account. Example: examplesecuritygroup
1551 */
1552 ClusterSecurityGroupName: String;
1553 /**
1554 * A description for the security group.
1555 */
1556 Description: String;
1557 /**
1558 * A list of tag instances.
1559 */
1560 Tags?: TagList;
1561 }
1562 export interface CreateClusterSecurityGroupResult {
1563 ClusterSecurityGroup?: ClusterSecurityGroup;
1564 }
1565 export interface CreateClusterSnapshotMessage {
1566 /**
1567 * A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
1568 */
1569 SnapshotIdentifier: String;
1570 /**
1571 * The cluster identifier for which you want a snapshot.
1572 */
1573 ClusterIdentifier: String;
1574 /**
1575 * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
1576 */
1577 ManualSnapshotRetentionPeriod?: IntegerOptional;
1578 /**
1579 * A list of tag instances.
1580 */
1581 Tags?: TagList;
1582 }
1583 export interface CreateClusterSnapshotResult {
1584 Snapshot?: Snapshot;
1585 }
1586 export interface CreateClusterSubnetGroupMessage {
1587 /**
1588 * The name for the subnet group. Amazon Redshift stores the value as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default". Must be unique for all subnet groups that are created by your AWS account. Example: examplesubnetgroup
1589 */
1590 ClusterSubnetGroupName: String;
1591 /**
1592 * A description for the subnet group.
1593 */
1594 Description: String;
1595 /**
1596 * An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
1597 */
1598 SubnetIds: SubnetIdentifierList;
1599 /**
1600 * A list of tag instances.
1601 */
1602 Tags?: TagList;
1603 }
1604 export interface CreateClusterSubnetGroupResult {
1605 ClusterSubnetGroup?: ClusterSubnetGroup;
1606 }
1607 export interface CreateEventSubscriptionMessage {
1608 /**
1609 * The name of the event subscription to be created. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
1610 */
1611 SubscriptionName: String;
1612 /**
1613 * The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
1614 */
1615 SnsTopicArn: String;
1616 /**
1617 * The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
1618 */
1619 SourceType?: String;
1620 /**
1621 * A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010
1622 */
1623 SourceIds?: SourceIdsList;
1624 /**
1625 * Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: configuration, management, monitoring, security
1626 */
1627 EventCategories?: EventCategoriesList;
1628 /**
1629 * Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO
1630 */
1631 Severity?: String;
1632 /**
1633 * A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
1634 */
1635 Enabled?: BooleanOptional;
1636 /**
1637 * A list of tag instances.
1638 */
1639 Tags?: TagList;
1640 }
1641 export interface CreateEventSubscriptionResult {
1642 EventSubscription?: EventSubscription;
1643 }
1644 export interface CreateHsmClientCertificateMessage {
1645 /**
1646 * The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.
1647 */
1648 HsmClientCertificateIdentifier: String;
1649 /**
1650 * A list of tag instances.
1651 */
1652 Tags?: TagList;
1653 }
1654 export interface CreateHsmClientCertificateResult {
1655 HsmClientCertificate?: HsmClientCertificate;
1656 }
1657 export interface CreateHsmConfigurationMessage {
1658 /**
1659 * The identifier to be assigned to the new Amazon Redshift HSM configuration.
1660 */
1661 HsmConfigurationIdentifier: String;
1662 /**
1663 * A text description of the HSM configuration to be created.
1664 */
1665 Description: String;
1666 /**
1667 * The IP address that the Amazon Redshift cluster must use to access the HSM.
1668 */
1669 HsmIpAddress: String;
1670 /**
1671 * The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
1672 */
1673 HsmPartitionName: String;
1674 /**
1675 * The password required to access the HSM partition.
1676 */
1677 HsmPartitionPassword: String;
1678 /**
1679 * The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.
1680 */
1681 HsmServerPublicCertificate: String;
1682 /**
1683 * A list of tag instances.
1684 */
1685 Tags?: TagList;
1686 }
1687 export interface CreateHsmConfigurationResult {
1688 HsmConfiguration?: HsmConfiguration;
1689 }
1690 export interface CreateScheduledActionMessage {
1691 /**
1692 * The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.
1693 */
1694 ScheduledActionName: String;
1695 /**
1696 * A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.
1697 */
1698 TargetAction: ScheduledActionType;
1699 /**
1700 * The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
1701 */
1702 Schedule: String;
1703 /**
1704 * The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
1705 */
1706 IamRole: String;
1707 /**
1708 * The description of the scheduled action.
1709 */
1710 ScheduledActionDescription?: String;
1711 /**
1712 * The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
1713 */
1714 StartTime?: TStamp;
1715 /**
1716 * The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
1717 */
1718 EndTime?: TStamp;
1719 /**
1720 * If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.
1721 */
1722 Enable?: BooleanOptional;
1723 }
1724 export interface CreateSnapshotCopyGrantMessage {
1725 /**
1726 * The name of the snapshot copy grant. This name must be unique in the region for the AWS account. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account.
1727 */
1728 SnapshotCopyGrantName: String;
1729 /**
1730 * The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
1731 */
1732 KmsKeyId?: String;
1733 /**
1734 * A list of tag instances.
1735 */
1736 Tags?: TagList;
1737 }
1738 export interface CreateSnapshotCopyGrantResult {
1739 SnapshotCopyGrant?: SnapshotCopyGrant;
1740 }
1741 export interface CreateSnapshotScheduleMessage {
1742 /**
1743 * The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".
1744 */
1745 ScheduleDefinitions?: ScheduleDefinitionList;
1746 /**
1747 * A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
1748 */
1749 ScheduleIdentifier?: String;
1750 /**
1751 * The description of the snapshot schedule.
1752 */
1753 ScheduleDescription?: String;
1754 /**
1755 * An optional set of tags you can use to search for the schedule.
1756 */
1757 Tags?: TagList;
1758 /**
1759 *
1760 */
1761 DryRun?: BooleanOptional;
1762 /**
1763 *
1764 */
1765 NextInvocations?: IntegerOptional;
1766 }
1767 export interface CreateTagsMessage {
1768 /**
1769 * The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
1770 */
1771 ResourceName: String;
1772 /**
1773 * One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".
1774 */
1775 Tags: TagList;
1776 }
1777 export interface CustomerStorageMessage {
1778 /**
1779 * The total amount of storage currently used for snapshots.
1780 */
1781 TotalBackupSizeInMegaBytes?: Double;
1782 /**
1783 * The total amount of storage currently provisioned.
1784 */
1785 TotalProvisionedStorageInMegaBytes?: Double;
1786 }
1787 export interface DataTransferProgress {
1788 /**
1789 * Describes the status of the cluster. While the transfer is in progress the status is transferringdata.
1790 */
1791 Status?: String;
1792 /**
1793 * Describes the data transfer rate in MB's per second.
1794 */
1795 CurrentRateInMegaBytesPerSecond?: DoubleOptional;
1796 /**
1797 * Describes the total amount of data to be transfered in megabytes.
1798 */
1799 TotalDataInMegaBytes?: Long;
1800 /**
1801 * Describes the total amount of data that has been transfered in MB's.
1802 */
1803 DataTransferredInMegaBytes?: Long;
1804 /**
1805 * Describes the estimated number of seconds remaining to complete the transfer.
1806 */
1807 EstimatedTimeToCompletionInSeconds?: LongOptional;
1808 /**
1809 * Describes the number of seconds that have elapsed during the data transfer.
1810 */
1811 ElapsedTimeInSeconds?: LongOptional;
1812 }
1813 export type DbGroupList = String[];
1814 export interface DefaultClusterParameters {
1815 /**
1816 * The name of the cluster parameter group family to which the engine default parameters apply.
1817 */
1818 ParameterGroupFamily?: String;
1819 /**
1820 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
1821 */
1822 Marker?: String;
1823 /**
1824 * The list of cluster default parameters.
1825 */
1826 Parameters?: ParametersList;
1827 }
1828 export interface DeferredMaintenanceWindow {
1829 /**
1830 * A unique identifier for the maintenance window.
1831 */
1832 DeferMaintenanceIdentifier?: String;
1833 /**
1834 * A timestamp for the beginning of the time period when we defer maintenance.
1835 */
1836 DeferMaintenanceStartTime?: TStamp;
1837 /**
1838 * A timestamp for the end of the time period when we defer maintenance.
1839 */
1840 DeferMaintenanceEndTime?: TStamp;
1841 }
1842 export type DeferredMaintenanceWindowsList = DeferredMaintenanceWindow[];
1843 export interface DeleteClusterMessage {
1844 /**
1845 * The identifier of the cluster to be deleted. Constraints: Must contain lowercase characters. Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
1846 */
1847 ClusterIdentifier: String;
1848 /**
1849 * Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false. Default: false
1850 */
1851 SkipFinalClusterSnapshot?: Boolean;
1852 /**
1853 * The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false. Constraints: Must be 1 to 255 alphanumeric characters. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
1854 */
1855 FinalClusterSnapshotIdentifier?: String;
1856 /**
1857 * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
1858 */
1859 FinalClusterSnapshotRetentionPeriod?: IntegerOptional;
1860 }
1861 export interface DeleteClusterParameterGroupMessage {
1862 /**
1863 * The name of the parameter group to be deleted. Constraints: Must be the name of an existing cluster parameter group. Cannot delete a default cluster parameter group.
1864 */
1865 ParameterGroupName: String;
1866 }
1867 export interface DeleteClusterResult {
1868 Cluster?: Cluster;
1869 }
1870 export interface DeleteClusterSecurityGroupMessage {
1871 /**
1872 * The name of the cluster security group to be deleted.
1873 */
1874 ClusterSecurityGroupName: String;
1875 }
1876 export interface DeleteClusterSnapshotMessage {
1877 /**
1878 * The unique identifier of the manual snapshot to be deleted. Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.
1879 */
1880 SnapshotIdentifier: String;
1881 /**
1882 * The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the name of valid cluster.
1883 */
1884 SnapshotClusterIdentifier?: String;
1885 }
1886 export type DeleteClusterSnapshotMessageList = DeleteClusterSnapshotMessage[];
1887 export interface DeleteClusterSnapshotResult {
1888 Snapshot?: Snapshot;
1889 }
1890 export interface DeleteClusterSubnetGroupMessage {
1891 /**
1892 * The name of the cluster subnet group name to be deleted.
1893 */
1894 ClusterSubnetGroupName: String;
1895 }
1896 export interface DeleteEventSubscriptionMessage {
1897 /**
1898 * The name of the Amazon Redshift event notification subscription to be deleted.
1899 */
1900 SubscriptionName: String;
1901 }
1902 export interface DeleteHsmClientCertificateMessage {
1903 /**
1904 * The identifier of the HSM client certificate to be deleted.
1905 */
1906 HsmClientCertificateIdentifier: String;
1907 }
1908 export interface DeleteHsmConfigurationMessage {
1909 /**
1910 * The identifier of the Amazon Redshift HSM configuration to be deleted.
1911 */
1912 HsmConfigurationIdentifier: String;
1913 }
1914 export interface DeleteScheduledActionMessage {
1915 /**
1916 * The name of the scheduled action to delete.
1917 */
1918 ScheduledActionName: String;
1919 }
1920 export interface DeleteSnapshotCopyGrantMessage {
1921 /**
1922 * The name of the snapshot copy grant to delete.
1923 */
1924 SnapshotCopyGrantName: String;
1925 }
1926 export interface DeleteSnapshotScheduleMessage {
1927 /**
1928 * A unique identifier of the snapshot schedule to delete.
1929 */
1930 ScheduleIdentifier: String;
1931 }
1932 export interface DeleteTagsMessage {
1933 /**
1934 * The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
1935 */
1936 ResourceName: String;
1937 /**
1938 * The tag key that you want to delete.
1939 */
1940 TagKeys: TagKeyList;
1941 }
1942 export interface DescribeAccountAttributesMessage {
1943 /**
1944 * A list of attribute names.
1945 */
1946 AttributeNames?: AttributeNameList;
1947 }
1948 export interface DescribeClusterDbRevisionsMessage {
1949 /**
1950 * A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
1951 */
1952 ClusterIdentifier?: String;
1953 /**
1954 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.
1955 */
1956 MaxRecords?: IntegerOptional;
1957 /**
1958 * An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
1959 */
1960 Marker?: String;
1961 }
1962 export interface DescribeClusterParameterGroupsMessage {
1963 /**
1964 * The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
1965 */
1966 ParameterGroupName?: String;
1967 /**
1968 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
1969 */
1970 MaxRecords?: IntegerOptional;
1971 /**
1972 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
1973 */
1974 Marker?: String;
1975 /**
1976 * A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
1977 */
1978 TagKeys?: TagKeyList;
1979 /**
1980 * A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
1981 */
1982 TagValues?: TagValueList;
1983 }
1984 export interface DescribeClusterParametersMessage {
1985 /**
1986 * The name of a cluster parameter group for which to return details.
1987 */
1988 ParameterGroupName: String;
1989 /**
1990 * The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group. Default: All parameter types returned. Valid Values: user | engine-default
1991 */
1992 Source?: String;
1993 /**
1994 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
1995 */
1996 MaxRecords?: IntegerOptional;
1997 /**
1998 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
1999 */
2000 Marker?: String;
2001 }
2002 export interface DescribeClusterSecurityGroupsMessage {
2003 /**
2004 * The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both. Example: securitygroup1
2005 */
2006 ClusterSecurityGroupName?: String;
2007 /**
2008 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2009 */
2010 MaxRecords?: IntegerOptional;
2011 /**
2012 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
2013 */
2014 Marker?: String;
2015 /**
2016 * A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.
2017 */
2018 TagKeys?: TagKeyList;
2019 /**
2020 * A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.
2021 */
2022 TagValues?: TagValueList;
2023 }
2024 export interface DescribeClusterSnapshotsMessage {
2025 /**
2026 * The identifier of the cluster which generated the requested snapshots.
2027 */
2028 ClusterIdentifier?: String;
2029 /**
2030 * The snapshot identifier of the snapshot about which to return information.
2031 */
2032 SnapshotIdentifier?: String;
2033 /**
2034 * The type of snapshots for which you are requesting information. By default, snapshots of all types are returned. Valid Values: automated | manual
2035 */
2036 SnapshotType?: String;
2037 /**
2038 * A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z
2039 */
2040 StartTime?: TStamp;
2041 /**
2042 * A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z
2043 */
2044 EndTime?: TStamp;
2045 /**
2046 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2047 */
2048 MaxRecords?: IntegerOptional;
2049 /**
2050 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2051 */
2052 Marker?: String;
2053 /**
2054 * The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.
2055 */
2056 OwnerAccount?: String;
2057 /**
2058 * A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.
2059 */
2060 TagKeys?: TagKeyList;
2061 /**
2062 * A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.
2063 */
2064 TagValues?: TagValueList;
2065 /**
2066 * A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows: If ClusterExists is set to true, ClusterIdentifier is required. If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned. If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned. If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.
2067 */
2068 ClusterExists?: BooleanOptional;
2069 /**
2070 *
2071 */
2072 SortingEntities?: SnapshotSortingEntityList;
2073 }
2074 export interface DescribeClusterSubnetGroupsMessage {
2075 /**
2076 * The name of the cluster subnet group for which information is requested.
2077 */
2078 ClusterSubnetGroupName?: String;
2079 /**
2080 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2081 */
2082 MaxRecords?: IntegerOptional;
2083 /**
2084 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2085 */
2086 Marker?: String;
2087 /**
2088 * A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.
2089 */
2090 TagKeys?: TagKeyList;
2091 /**
2092 * A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.
2093 */
2094 TagValues?: TagValueList;
2095 }
2096 export interface DescribeClusterTracksMessage {
2097 /**
2098 * The name of the maintenance track.
2099 */
2100 MaintenanceTrackName?: String;
2101 /**
2102 * An integer value for the maximum number of maintenance tracks to return.
2103 */
2104 MaxRecords?: IntegerOptional;
2105 /**
2106 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2107 */
2108 Marker?: String;
2109 }
2110 export interface DescribeClusterVersionsMessage {
2111 /**
2112 * The specific cluster version to return. Example: 1.0
2113 */
2114 ClusterVersion?: String;
2115 /**
2116 * The name of a specific cluster parameter group family to return details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2117 */
2118 ClusterParameterGroupFamily?: String;
2119 /**
2120 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2121 */
2122 MaxRecords?: IntegerOptional;
2123 /**
2124 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2125 */
2126 Marker?: String;
2127 }
2128 export interface DescribeClustersMessage {
2129 /**
2130 * The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. The default is that all clusters defined for an account are returned.
2131 */
2132 ClusterIdentifier?: String;
2133 /**
2134 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2135 */
2136 MaxRecords?: IntegerOptional;
2137 /**
2138 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
2139 */
2140 Marker?: String;
2141 /**
2142 * A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
2143 */
2144 TagKeys?: TagKeyList;
2145 /**
2146 * A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
2147 */
2148 TagValues?: TagValueList;
2149 }
2150 export interface DescribeDefaultClusterParametersMessage {
2151 /**
2152 * The name of the cluster parameter group family.
2153 */
2154 ParameterGroupFamily: String;
2155 /**
2156 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2157 */
2158 MaxRecords?: IntegerOptional;
2159 /**
2160 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2161 */
2162 Marker?: String;
2163 }
2164 export interface DescribeDefaultClusterParametersResult {
2165 DefaultClusterParameters?: DefaultClusterParameters;
2166 }
2167 export interface DescribeEventCategoriesMessage {
2168 /**
2169 * The source type, such as cluster or parameter group, to which the described event categories apply. Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.
2170 */
2171 SourceType?: String;
2172 }
2173 export interface DescribeEventSubscriptionsMessage {
2174 /**
2175 * The name of the Amazon Redshift event notification subscription to be described.
2176 */
2177 SubscriptionName?: String;
2178 /**
2179 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2180 */
2181 MaxRecords?: IntegerOptional;
2182 /**
2183 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2184 */
2185 Marker?: String;
2186 /**
2187 * A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them.
2188 */
2189 TagKeys?: TagKeyList;
2190 /**
2191 * A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them.
2192 */
2193 TagValues?: TagValueList;
2194 }
2195 export interface DescribeEventsMessage {
2196 /**
2197 * The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. Specify a cluster identifier when SourceType is cluster. Specify a cluster security group name when SourceType is cluster-security-group. Specify a cluster parameter group name when SourceType is cluster-parameter-group. Specify a cluster snapshot identifier when SourceType is cluster-snapshot.
2198 */
2199 SourceIdentifier?: String;
2200 /**
2201 * The event source to retrieve events for. If no value is specified, all events are returned. Constraints: If SourceType is supplied, SourceIdentifier must also be provided. Specify cluster when SourceIdentifier is a cluster identifier. Specify cluster-security-group when SourceIdentifier is a cluster security group name. Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name. Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.
2202 */
2203 SourceType?: SourceType;
2204 /**
2205 * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
2206 */
2207 StartTime?: TStamp;
2208 /**
2209 * The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
2210 */
2211 EndTime?: TStamp;
2212 /**
2213 * The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned. Default: 60
2214 */
2215 Duration?: IntegerOptional;
2216 /**
2217 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2218 */
2219 MaxRecords?: IntegerOptional;
2220 /**
2221 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2222 */
2223 Marker?: String;
2224 }
2225 export interface DescribeHsmClientCertificatesMessage {
2226 /**
2227 * The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.
2228 */
2229 HsmClientCertificateIdentifier?: String;
2230 /**
2231 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2232 */
2233 MaxRecords?: IntegerOptional;
2234 /**
2235 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2236 */
2237 Marker?: String;
2238 /**
2239 * A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.
2240 */
2241 TagKeys?: TagKeyList;
2242 /**
2243 * A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.
2244 */
2245 TagValues?: TagValueList;
2246 }
2247 export interface DescribeHsmConfigurationsMessage {
2248 /**
2249 * The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
2250 */
2251 HsmConfigurationIdentifier?: String;
2252 /**
2253 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2254 */
2255 MaxRecords?: IntegerOptional;
2256 /**
2257 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2258 */
2259 Marker?: String;
2260 /**
2261 * A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.
2262 */
2263 TagKeys?: TagKeyList;
2264 /**
2265 * A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.
2266 */
2267 TagValues?: TagValueList;
2268 }
2269 export interface DescribeLoggingStatusMessage {
2270 /**
2271 * The identifier of the cluster from which to get the logging status. Example: examplecluster
2272 */
2273 ClusterIdentifier: String;
2274 }
2275 export interface DescribeNodeConfigurationOptionsMessage {
2276 /**
2277 * The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
2278 */
2279 ActionType: ActionType;
2280 /**
2281 * The identifier of the cluster to evaluate for possible node configurations.
2282 */
2283 ClusterIdentifier?: String;
2284 /**
2285 * The identifier of the snapshot to evaluate for possible node configurations.
2286 */
2287 SnapshotIdentifier?: String;
2288 /**
2289 * The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
2290 */
2291 OwnerAccount?: String;
2292 /**
2293 * A set of name, operator, and value items to filter the results.
2294 */
2295 Filters?: NodeConfigurationOptionsFilterList;
2296 /**
2297 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2298 */
2299 Marker?: String;
2300 /**
2301 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 500 Constraints: minimum 100, maximum 500.
2302 */
2303 MaxRecords?: IntegerOptional;
2304 }
2305 export interface DescribeOrderableClusterOptionsMessage {
2306 /**
2307 * The version filter value. Specify this parameter to show only the available offerings matching the specified version. Default: All versions. Constraints: Must be one of the version returned from DescribeClusterVersions.
2308 */
2309 ClusterVersion?: String;
2310 /**
2311 * The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
2312 */
2313 NodeType?: String;
2314 /**
2315 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2316 */
2317 MaxRecords?: IntegerOptional;
2318 /**
2319 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2320 */
2321 Marker?: String;
2322 }
2323 export interface DescribeReservedNodeOfferingsMessage {
2324 /**
2325 * The unique identifier for the offering.
2326 */
2327 ReservedNodeOfferingId?: String;
2328 /**
2329 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2330 */
2331 MaxRecords?: IntegerOptional;
2332 /**
2333 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2334 */
2335 Marker?: String;
2336 }
2337 export interface DescribeReservedNodesMessage {
2338 /**
2339 * Identifier for the node reservation.
2340 */
2341 ReservedNodeId?: String;
2342 /**
2343 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2344 */
2345 MaxRecords?: IntegerOptional;
2346 /**
2347 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2348 */
2349 Marker?: String;
2350 }
2351 export interface DescribeResizeMessage {
2352 /**
2353 * The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. By default, resize operations for all clusters defined for an AWS account are returned.
2354 */
2355 ClusterIdentifier: String;
2356 }
2357 export interface DescribeScheduledActionsMessage {
2358 /**
2359 * The name of the scheduled action to retrieve.
2360 */
2361 ScheduledActionName?: String;
2362 /**
2363 * The type of the scheduled actions to retrieve.
2364 */
2365 TargetActionType?: ScheduledActionTypeValues;
2366 /**
2367 * The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
2368 */
2369 StartTime?: TStamp;
2370 /**
2371 * The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
2372 */
2373 EndTime?: TStamp;
2374 /**
2375 * If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
2376 */
2377 Active?: BooleanOptional;
2378 /**
2379 * List of scheduled action filters.
2380 */
2381 Filters?: ScheduledActionFilterList;
2382 /**
2383 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
2384 */
2385 Marker?: String;
2386 /**
2387 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2388 */
2389 MaxRecords?: IntegerOptional;
2390 }
2391 export interface DescribeSnapshotCopyGrantsMessage {
2392 /**
2393 * The name of the snapshot copy grant.
2394 */
2395 SnapshotCopyGrantName?: String;
2396 /**
2397 * The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
2398 */
2399 MaxRecords?: IntegerOptional;
2400 /**
2401 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
2402 */
2403 Marker?: String;
2404 /**
2405 * A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
2406 */
2407 TagKeys?: TagKeyList;
2408 /**
2409 * A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
2410 */
2411 TagValues?: TagValueList;
2412 }
2413 export interface DescribeSnapshotSchedulesMessage {
2414 /**
2415 * The unique identifier for the cluster whose snapshot schedules you want to view.
2416 */
2417 ClusterIdentifier?: String;
2418 /**
2419 * A unique identifier for a snapshot schedule.
2420 */
2421 ScheduleIdentifier?: String;
2422 /**
2423 * The key value for a snapshot schedule tag.
2424 */
2425 TagKeys?: TagKeyList;
2426 /**
2427 * The value corresponding to the key of the snapshot schedule tag.
2428 */
2429 TagValues?: TagValueList;
2430 /**
2431 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
2432 */
2433 Marker?: String;
2434 /**
2435 * The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
2436 */
2437 MaxRecords?: IntegerOptional;
2438 }
2439 export interface DescribeSnapshotSchedulesOutputMessage {
2440 /**
2441 * A list of SnapshotSchedules.
2442 */
2443 SnapshotSchedules?: SnapshotScheduleList;
2444 /**
2445 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
2446 */
2447 Marker?: String;
2448 }
2449 export interface DescribeTableRestoreStatusMessage {
2450 /**
2451 * The Amazon Redshift cluster that the table is being restored to.
2452 */
2453 ClusterIdentifier?: String;
2454 /**
2455 * The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
2456 */
2457 TableRestoreRequestId?: String;
2458 /**
2459 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
2460 */
2461 MaxRecords?: IntegerOptional;
2462 /**
2463 * An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
2464 */
2465 Marker?: String;
2466 }
2467 export interface DescribeTagsMessage {
2468 /**
2469 * The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
2470 */
2471 ResourceName?: String;
2472 /**
2473 * The type of resource with which you want to view tags. Valid resource types are: Cluster CIDR/IP EC2 security group Snapshot Cluster security group Subnet group HSM connection HSM certificate Parameter group Snapshot copy grant For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.
2474 */
2475 ResourceType?: String;
2476 /**
2477 * The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
2478 */
2479 MaxRecords?: IntegerOptional;
2480 /**
2481 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
2482 */
2483 Marker?: String;
2484 /**
2485 * A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
2486 */
2487 TagKeys?: TagKeyList;
2488 /**
2489 * A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
2490 */
2491 TagValues?: TagValueList;
2492 }
2493 export interface DisableLoggingMessage {
2494 /**
2495 * The identifier of the cluster on which logging is to be stopped. Example: examplecluster
2496 */
2497 ClusterIdentifier: String;
2498 }
2499 export interface DisableSnapshotCopyMessage {
2500 /**
2501 * The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
2502 */
2503 ClusterIdentifier: String;
2504 }
2505 export interface DisableSnapshotCopyResult {
2506 Cluster?: Cluster;
2507 }
2508 export type Double = number;
2509 export type DoubleOptional = number;
2510 export interface EC2SecurityGroup {
2511 /**
2512 * The status of the EC2 security group.
2513 */
2514 Status?: String;
2515 /**
2516 * The name of the EC2 Security Group.
2517 */
2518 EC2SecurityGroupName?: String;
2519 /**
2520 * The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
2521 */
2522 EC2SecurityGroupOwnerId?: String;
2523 /**
2524 * The list of tags for the EC2 security group.
2525 */
2526 Tags?: TagList;
2527 }
2528 export type EC2SecurityGroupList = EC2SecurityGroup[];
2529 export interface ElasticIpStatus {
2530 /**
2531 * The elastic IP (EIP) address for the cluster.
2532 */
2533 ElasticIp?: String;
2534 /**
2535 * The status of the elastic IP (EIP) address.
2536 */
2537 Status?: String;
2538 }
2539 export type EligibleTracksToUpdateList = UpdateTarget[];
2540 export interface EnableLoggingMessage {
2541 /**
2542 * The identifier of the cluster on which logging is to be started. Example: examplecluster
2543 */
2544 ClusterIdentifier: String;
2545 /**
2546 * The name of an existing S3 bucket where the log files are to be stored. Constraints: Must be in the same region as the cluster The cluster must have read bucket and put object permissions
2547 */
2548 BucketName: String;
2549 /**
2550 * The prefix applied to the log file names. Constraints: Cannot exceed 512 characters Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are: x00 to x20 x22 x27 x5c x7f or larger
2551 */
2552 S3KeyPrefix?: String;
2553 }
2554 export interface EnableSnapshotCopyMessage {
2555 /**
2556 * The unique identifier of the source cluster to copy snapshots from. Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
2557 */
2558 ClusterIdentifier: String;
2559 /**
2560 * The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
2561 */
2562 DestinationRegion: String;
2563 /**
2564 * The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default: 7. Constraints: Must be at least 1 and no more than 35.
2565 */
2566 RetentionPeriod?: IntegerOptional;
2567 /**
2568 * The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
2569 */
2570 SnapshotCopyGrantName?: String;
2571 /**
2572 * The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
2573 */
2574 ManualSnapshotRetentionPeriod?: IntegerOptional;
2575 }
2576 export interface EnableSnapshotCopyResult {
2577 Cluster?: Cluster;
2578 }
2579 export interface Endpoint {
2580 /**
2581 * The DNS address of the Cluster.
2582 */
2583 Address?: String;
2584 /**
2585 * The port that the database engine is listening on.
2586 */
2587 Port?: Integer;
2588 }
2589 export interface Event {
2590 /**
2591 * The identifier for the source of the event.
2592 */
2593 SourceIdentifier?: String;
2594 /**
2595 * The source type for this event.
2596 */
2597 SourceType?: SourceType;
2598 /**
2599 * The text of this event.
2600 */
2601 Message?: String;
2602 /**
2603 * A list of the event categories. Values: Configuration, Management, Monitoring, Security
2604 */
2605 EventCategories?: EventCategoriesList;
2606 /**
2607 * The severity of the event. Values: ERROR, INFO
2608 */
2609 Severity?: String;
2610 /**
2611 * The date and time of the event.
2612 */
2613 Date?: TStamp;
2614 /**
2615 * The identifier of the event.
2616 */
2617 EventId?: String;
2618 }
2619 export type EventCategoriesList = String[];
2620 export interface EventCategoriesMap {
2621 /**
2622 * The source type, such as cluster or cluster-snapshot, that the returned categories belong to.
2623 */
2624 SourceType?: String;
2625 /**
2626 * The events in the event category.
2627 */
2628 Events?: EventInfoMapList;
2629 }
2630 export type EventCategoriesMapList = EventCategoriesMap[];
2631 export interface EventCategoriesMessage {
2632 /**
2633 * A list of event categories descriptions.
2634 */
2635 EventCategoriesMapList?: EventCategoriesMapList;
2636 }
2637 export interface EventInfoMap {
2638 /**
2639 * The identifier of an Amazon Redshift event.
2640 */
2641 EventId?: String;
2642 /**
2643 * The category of an Amazon Redshift event.
2644 */
2645 EventCategories?: EventCategoriesList;
2646 /**
2647 * The description of an Amazon Redshift event.
2648 */
2649 EventDescription?: String;
2650 /**
2651 * The severity of the event. Values: ERROR, INFO
2652 */
2653 Severity?: String;
2654 }
2655 export type EventInfoMapList = EventInfoMap[];
2656 export type EventList = Event[];
2657 export interface EventSubscription {
2658 /**
2659 * The AWS customer account associated with the Amazon Redshift event notification subscription.
2660 */
2661 CustomerAwsId?: String;
2662 /**
2663 * The name of the Amazon Redshift event notification subscription.
2664 */
2665 CustSubscriptionId?: String;
2666 /**
2667 * The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
2668 */
2669 SnsTopicArn?: String;
2670 /**
2671 * The status of the Amazon Redshift event notification subscription. Constraints: Can be one of the following: active | no-permission | topic-not-exist The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
2672 */
2673 Status?: String;
2674 /**
2675 * The date and time the Amazon Redshift event notification subscription was created.
2676 */
2677 SubscriptionCreationTime?: TStamp;
2678 /**
2679 * The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.
2680 */
2681 SourceType?: String;
2682 /**
2683 * A list of the sources that publish events to the Amazon Redshift event notification subscription.
2684 */
2685 SourceIdsList?: SourceIdsList;
2686 /**
2687 * The list of Amazon Redshift event categories specified in the event notification subscription. Values: Configuration, Management, Monitoring, Security
2688 */
2689 EventCategoriesList?: EventCategoriesList;
2690 /**
2691 * The event severity specified in the Amazon Redshift event notification subscription. Values: ERROR, INFO
2692 */
2693 Severity?: String;
2694 /**
2695 * A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.
2696 */
2697 Enabled?: Boolean;
2698 /**
2699 * The list of tags for the event subscription.
2700 */
2701 Tags?: TagList;
2702 }
2703 export type EventSubscriptionsList = EventSubscription[];
2704 export interface EventSubscriptionsMessage {
2705 /**
2706 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
2707 */
2708 Marker?: String;
2709 /**
2710 * A list of event subscriptions.
2711 */
2712 EventSubscriptionsList?: EventSubscriptionsList;
2713 }
2714 export interface EventsMessage {
2715 /**
2716 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
2717 */
2718 Marker?: String;
2719 /**
2720 * A list of Event instances.
2721 */
2722 Events?: EventList;
2723 }
2724 export interface GetClusterCredentialsMessage {
2725 /**
2726 * The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database. For more information, see CREATE USER in the Amazon Redshift Database Developer Guide. Constraints: Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be PUBLIC. Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
2727 */
2728 DbUser: String;
2729 /**
2730 * The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database. Constraints: Must be 1 to 64 alphanumeric characters or hyphens Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
2731 */
2732 DbName?: String;
2733 /**
2734 * The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
2735 */
2736 ClusterIdentifier: String;
2737 /**
2738 * The number of seconds until the returned temporary password expires. Constraint: minimum 900, maximum 3600. Default: 900
2739 */
2740 DurationSeconds?: IntegerOptional;
2741 /**
2742 * Create a database user with the name specified for the user named in DbUser if one does not exist.
2743 */
2744 AutoCreate?: BooleanOptional;
2745 /**
2746 * A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC. Database group name constraints Must be 1 to 64 alphanumeric characters or hyphens Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
2747 */
2748 DbGroups?: DbGroupList;
2749 }
2750 export interface GetReservedNodeExchangeOfferingsInputMessage {
2751 /**
2752 * A string representing the node identifier for the DC1 Reserved Node to be exchanged.
2753 */
2754 ReservedNodeId: String;
2755 /**
2756 * An integer setting the maximum number of ReservedNodeOfferings to retrieve.
2757 */
2758 MaxRecords?: IntegerOptional;
2759 /**
2760 * A value that indicates the starting point for the next set of ReservedNodeOfferings.
2761 */
2762 Marker?: String;
2763 }
2764 export interface GetReservedNodeExchangeOfferingsOutputMessage {
2765 /**
2766 * An optional parameter that specifies the starting point for returning a set of response records. When the results of a GetReservedNodeExchangeOfferings request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
2767 */
2768 Marker?: String;
2769 /**
2770 * Returns an array of ReservedNodeOffering objects.
2771 */
2772 ReservedNodeOfferings?: ReservedNodeOfferingList;
2773 }
2774 export interface HsmClientCertificate {
2775 /**
2776 * The identifier of the HSM client certificate.
2777 */
2778 HsmClientCertificateIdentifier?: String;
2779 /**
2780 * The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
2781 */
2782 HsmClientCertificatePublicKey?: String;
2783 /**
2784 * The list of tags for the HSM client certificate.
2785 */
2786 Tags?: TagList;
2787 }
2788 export type HsmClientCertificateList = HsmClientCertificate[];
2789 export interface HsmClientCertificateMessage {
2790 /**
2791 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
2792 */
2793 Marker?: String;
2794 /**
2795 * A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.
2796 */
2797 HsmClientCertificates?: HsmClientCertificateList;
2798 }
2799 export interface HsmConfiguration {
2800 /**
2801 * The name of the Amazon Redshift HSM configuration.
2802 */
2803 HsmConfigurationIdentifier?: String;
2804 /**
2805 * A text description of the HSM configuration.
2806 */
2807 Description?: String;
2808 /**
2809 * The IP address that the Amazon Redshift cluster must use to access the HSM.
2810 */
2811 HsmIpAddress?: String;
2812 /**
2813 * The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
2814 */
2815 HsmPartitionName?: String;
2816 /**
2817 * The list of tags for the HSM configuration.
2818 */
2819 Tags?: TagList;
2820 }
2821 export type HsmConfigurationList = HsmConfiguration[];
2822 export interface HsmConfigurationMessage {
2823 /**
2824 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
2825 */
2826 Marker?: String;
2827 /**
2828 * A list of HsmConfiguration objects.
2829 */
2830 HsmConfigurations?: HsmConfigurationList;
2831 }
2832 export interface HsmStatus {
2833 /**
2834 * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
2835 */
2836 HsmClientCertificateIdentifier?: String;
2837 /**
2838 * Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
2839 */
2840 HsmConfigurationIdentifier?: String;
2841 /**
2842 * Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command. Values: active, applying
2843 */
2844 Status?: String;
2845 }
2846 export interface IPRange {
2847 /**
2848 * The status of the IP range, for example, "authorized".
2849 */
2850 Status?: String;
2851 /**
2852 * The IP range in Classless Inter-Domain Routing (CIDR) notation.
2853 */
2854 CIDRIP?: String;
2855 /**
2856 * The list of tags for the IP range.
2857 */
2858 Tags?: TagList;
2859 }
2860 export type IPRangeList = IPRange[];
2861 export type IamRoleArnList = String[];
2862 export type ImportTablesCompleted = String[];
2863 export type ImportTablesInProgress = String[];
2864 export type ImportTablesNotStarted = String[];
2865 export type Integer = number;
2866 export type IntegerOptional = number;
2867 export interface LoggingStatus {
2868 /**
2869 * true if logging is on, false if logging is off.
2870 */
2871 LoggingEnabled?: Boolean;
2872 /**
2873 * The name of the S3 bucket where the log files are stored.
2874 */
2875 BucketName?: String;
2876 /**
2877 * The prefix applied to the log file names.
2878 */
2879 S3KeyPrefix?: String;
2880 /**
2881 * The last time that logs were delivered.
2882 */
2883 LastSuccessfulDeliveryTime?: TStamp;
2884 /**
2885 * The last time when logs failed to be delivered.
2886 */
2887 LastFailureTime?: TStamp;
2888 /**
2889 * The message indicating that logs failed to be delivered.
2890 */
2891 LastFailureMessage?: String;
2892 }
2893 export type Long = number;
2894 export type LongOptional = number;
2895 export interface MaintenanceTrack {
2896 /**
2897 * The name of the maintenance track. Possible values are current and trailing.
2898 */
2899 MaintenanceTrackName?: String;
2900 /**
2901 * The version number for the cluster release.
2902 */
2903 DatabaseVersion?: String;
2904 /**
2905 * An array of UpdateTarget objects to update with the maintenance track.
2906 */
2907 UpdateTargets?: EligibleTracksToUpdateList;
2908 }
2909 export type Mode = "standard"|"high-performance"|string;
2910 export interface ModifyClusterDbRevisionMessage {
2911 /**
2912 * The unique identifier of a cluster whose database revision you want to modify. Example: examplecluster
2913 */
2914 ClusterIdentifier: String;
2915 /**
2916 * The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
2917 */
2918 RevisionTarget: String;
2919 }
2920 export interface ModifyClusterDbRevisionResult {
2921 Cluster?: Cluster;
2922 }
2923 export interface ModifyClusterIamRolesMessage {
2924 /**
2925 * The unique identifier of the cluster for which you want to associate or disassociate IAM roles.
2926 */
2927 ClusterIdentifier: String;
2928 /**
2929 * Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.
2930 */
2931 AddIamRoles?: IamRoleArnList;
2932 /**
2933 * Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.
2934 */
2935 RemoveIamRoles?: IamRoleArnList;
2936 }
2937 export interface ModifyClusterIamRolesResult {
2938 Cluster?: Cluster;
2939 }
2940 export interface ModifyClusterMaintenanceMessage {
2941 /**
2942 * A unique identifier for the cluster.
2943 */
2944 ClusterIdentifier: String;
2945 /**
2946 * A boolean indicating whether to enable the deferred maintenance window.
2947 */
2948 DeferMaintenance?: BooleanOptional;
2949 /**
2950 * A unique identifier for the deferred maintenance window.
2951 */
2952 DeferMaintenanceIdentifier?: String;
2953 /**
2954 * A timestamp indicating the start time for the deferred maintenance window.
2955 */
2956 DeferMaintenanceStartTime?: TStamp;
2957 /**
2958 * A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
2959 */
2960 DeferMaintenanceEndTime?: TStamp;
2961 /**
2962 * An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
2963 */
2964 DeferMaintenanceDuration?: IntegerOptional;
2965 }
2966 export interface ModifyClusterMaintenanceResult {
2967 Cluster?: Cluster;
2968 }
2969 export interface ModifyClusterMessage {
2970 /**
2971 * The unique identifier of the cluster to be modified. Example: examplecluster
2972 */
2973 ClusterIdentifier: String;
2974 /**
2975 * The new cluster type. When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request. Valid Values: multi-node | single-node
2976 */
2977 ClusterType?: String;
2978 /**
2979 * The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide. Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.16xlarge
2980 */
2981 NodeType?: String;
2982 /**
2983 * The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter. For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide. Valid Values: Integer greater than 0.
2984 */
2985 NumberOfNodes?: IntegerOptional;
2986 /**
2987 * A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible. Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2988 */
2989 ClusterSecurityGroups?: ClusterSecurityGroupNameList;
2990 /**
2991 * A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.
2992 */
2993 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
2994 /**
2995 * The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost. Default: Uses existing setting. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
2996 */
2997 MasterUserPassword?: String;
2998 /**
2999 * The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster. Default: Uses existing setting. Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
3000 */
3001 ClusterParameterGroupName?: String;
3002 /**
3003 * The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted. Default: Uses existing setting. Constraints: Must be a value from 0 to 35.
3004 */
3005 AutomatedSnapshotRetentionPeriod?: IntegerOptional;
3006 /**
3007 * The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots. The value must be either -1 or an integer between 1 and 3,653. The default value is -1.
3008 */
3009 ManualSnapshotRetentionPeriod?: IntegerOptional;
3010 /**
3011 * The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage. This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied. Default: Uses existing setting. Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes.
3012 */
3013 PreferredMaintenanceWindow?: String;
3014 /**
3015 * The new version number of the Amazon Redshift engine to upgrade to. For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. Example: 1.0
3016 */
3017 ClusterVersion?: String;
3018 /**
3019 * If true, major version upgrades will be applied automatically to the cluster during the maintenance window. Default: false
3020 */
3021 AllowVersionUpgrade?: BooleanOptional;
3022 /**
3023 * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
3024 */
3025 HsmClientCertificateIdentifier?: String;
3026 /**
3027 * Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
3028 */
3029 HsmConfigurationIdentifier?: String;
3030 /**
3031 * The new identifier for the cluster. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: examplecluster
3032 */
3033 NewClusterIdentifier?: String;
3034 /**
3035 * If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
3036 */
3037 PubliclyAccessible?: BooleanOptional;
3038 /**
3039 * The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
3040 */
3041 ElasticIp?: String;
3042 /**
3043 * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
3044 */
3045 EnhancedVpcRouting?: BooleanOptional;
3046 /**
3047 * The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
3048 */
3049 MaintenanceTrackName?: String;
3050 /**
3051 * Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the KmsKeyId parameter, we encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we encrypt with the default key. In the China region we use legacy encryption if you specify that the cluster is encrypted. If the value is not encrypted (false), then the cluster is decrypted.
3052 */
3053 Encrypted?: BooleanOptional;
3054 /**
3055 * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
3056 */
3057 KmsKeyId?: String;
3058 }
3059 export interface ModifyClusterParameterGroupMessage {
3060 /**
3061 * The name of the parameter group to be modified.
3062 */
3063 ParameterGroupName: String;
3064 /**
3065 * An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional. For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
3066 */
3067 Parameters: ParametersList;
3068 }
3069 export interface ModifyClusterResult {
3070 Cluster?: Cluster;
3071 }
3072 export interface ModifyClusterSnapshotMessage {
3073 /**
3074 * The identifier of the snapshot whose setting you want to modify.
3075 */
3076 SnapshotIdentifier: String;
3077 /**
3078 * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot. The value must be either -1 or an integer between 1 and 3,653.
3079 */
3080 ManualSnapshotRetentionPeriod?: IntegerOptional;
3081 /**
3082 * A Boolean option to override an exception if the retention period has already passed.
3083 */
3084 Force?: Boolean;
3085 }
3086 export interface ModifyClusterSnapshotResult {
3087 Snapshot?: Snapshot;
3088 }
3089 export interface ModifyClusterSnapshotScheduleMessage {
3090 /**
3091 * A unique identifier for the cluster whose snapshot schedule you want to modify.
3092 */
3093 ClusterIdentifier: String;
3094 /**
3095 * A unique alphanumeric identifier for the schedule that you want to associate with the cluster.
3096 */
3097 ScheduleIdentifier?: String;
3098 /**
3099 * A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.
3100 */
3101 DisassociateSchedule?: BooleanOptional;
3102 }
3103 export interface ModifyClusterSubnetGroupMessage {
3104 /**
3105 * The name of the subnet group to be modified.
3106 */
3107 ClusterSubnetGroupName: String;
3108 /**
3109 * A text description of the subnet group to be modified.
3110 */
3111 Description?: String;
3112 /**
3113 * An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
3114 */
3115 SubnetIds: SubnetIdentifierList;
3116 }
3117 export interface ModifyClusterSubnetGroupResult {
3118 ClusterSubnetGroup?: ClusterSubnetGroup;
3119 }
3120 export interface ModifyEventSubscriptionMessage {
3121 /**
3122 * The name of the modified Amazon Redshift event notification subscription.
3123 */
3124 SubscriptionName: String;
3125 /**
3126 * The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.
3127 */
3128 SnsTopicArn?: String;
3129 /**
3130 * The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
3131 */
3132 SourceType?: String;
3133 /**
3134 * A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010
3135 */
3136 SourceIds?: SourceIdsList;
3137 /**
3138 * Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: configuration, management, monitoring, security
3139 */
3140 EventCategories?: EventCategoriesList;
3141 /**
3142 * Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO
3143 */
3144 Severity?: String;
3145 /**
3146 * A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled
3147 */
3148 Enabled?: BooleanOptional;
3149 }
3150 export interface ModifyEventSubscriptionResult {
3151 EventSubscription?: EventSubscription;
3152 }
3153 export interface ModifyScheduledActionMessage {
3154 /**
3155 * The name of the scheduled action to modify.
3156 */
3157 ScheduledActionName: String;
3158 /**
3159 * A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.
3160 */
3161 TargetAction?: ScheduledActionType;
3162 /**
3163 * A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
3164 */
3165 Schedule?: String;
3166 /**
3167 * A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
3168 */
3169 IamRole?: String;
3170 /**
3171 * A modified description of the scheduled action.
3172 */
3173 ScheduledActionDescription?: String;
3174 /**
3175 * A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.
3176 */
3177 StartTime?: TStamp;
3178 /**
3179 * A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.
3180 */
3181 EndTime?: TStamp;
3182 /**
3183 * A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.
3184 */
3185 Enable?: BooleanOptional;
3186 }
3187 export interface ModifySnapshotCopyRetentionPeriodMessage {
3188 /**
3189 * The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
3190 */
3191 ClusterIdentifier: String;
3192 /**
3193 * The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this only changes the retention period of copied automated snapshots. If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period. Constraints: Must be at least 1 and no more than 35 for automated snapshots. If you specify the manual option, only newly copied manual snapshots will have the new retention period. If you specify the value of -1 newly copied manual snapshots are retained indefinitely. Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
3194 */
3195 RetentionPeriod: Integer;
3196 /**
3197 * Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
3198 */
3199 Manual?: Boolean;
3200 }
3201 export interface ModifySnapshotCopyRetentionPeriodResult {
3202 Cluster?: Cluster;
3203 }
3204 export interface ModifySnapshotScheduleMessage {
3205 /**
3206 * A unique alphanumeric identifier of the schedule to modify.
3207 */
3208 ScheduleIdentifier: String;
3209 /**
3210 * An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
3211 */
3212 ScheduleDefinitions: ScheduleDefinitionList;
3213 }
3214 export interface NodeConfigurationOption {
3215 /**
3216 * The node type, such as, "ds2.8xlarge".
3217 */
3218 NodeType?: String;
3219 /**
3220 * The number of nodes.
3221 */
3222 NumberOfNodes?: Integer;
3223 /**
3224 * The estimated disk utilizaton percentage.
3225 */
3226 EstimatedDiskUtilizationPercent?: DoubleOptional;
3227 /**
3228 * The category of the node configuration recommendation.
3229 */
3230 Mode?: Mode;
3231 }
3232 export type NodeConfigurationOptionList = NodeConfigurationOption[];
3233 export interface NodeConfigurationOptionsFilter {
3234 /**
3235 * The name of the element to filter.
3236 */
3237 Name?: NodeConfigurationOptionsFilterName;
3238 /**
3239 * The filter operator. If filter Name is NodeType only the 'in' operator is supported. Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'. Provide two values to evaluate for 'between'. Provide a list of values for 'in'.
3240 */
3241 Operator?: OperatorType;
3242 /**
3243 * List of values. Compare Name using Operator to Values. If filter Name is NumberOfNodes, then values can range from 0 to 200. If filter Name is EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For example, filter NumberOfNodes (name) GT (operator) 3 (values).
3244 */
3245 Values?: ValueStringList;
3246 }
3247 export type NodeConfigurationOptionsFilterList = NodeConfigurationOptionsFilter[];
3248 export type NodeConfigurationOptionsFilterName = "NodeType"|"NumberOfNodes"|"EstimatedDiskUtilizationPercent"|"Mode"|string;
3249 export interface NodeConfigurationOptionsMessage {
3250 /**
3251 * A list of valid node configurations.
3252 */
3253 NodeConfigurationOptionList?: NodeConfigurationOptionList;
3254 /**
3255 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
3256 */
3257 Marker?: String;
3258 }
3259 export type OperatorType = "eq"|"lt"|"gt"|"le"|"ge"|"in"|"between"|string;
3260 export interface OrderableClusterOption {
3261 /**
3262 * The version of the orderable cluster.
3263 */
3264 ClusterVersion?: String;
3265 /**
3266 * The cluster type, for example multi-node.
3267 */
3268 ClusterType?: String;
3269 /**
3270 * The node type for the orderable cluster.
3271 */
3272 NodeType?: String;
3273 /**
3274 * A list of availability zones for the orderable cluster.
3275 */
3276 AvailabilityZones?: AvailabilityZoneList;
3277 }
3278 export type OrderableClusterOptionsList = OrderableClusterOption[];
3279 export interface OrderableClusterOptionsMessage {
3280 /**
3281 * An OrderableClusterOption structure containing information about orderable options for the cluster.
3282 */
3283 OrderableClusterOptions?: OrderableClusterOptionsList;
3284 /**
3285 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
3286 */
3287 Marker?: String;
3288 }
3289 export interface Parameter {
3290 /**
3291 * The name of the parameter.
3292 */
3293 ParameterName?: String;
3294 /**
3295 * The value of the parameter.
3296 */
3297 ParameterValue?: String;
3298 /**
3299 * A description of the parameter.
3300 */
3301 Description?: String;
3302 /**
3303 * The source of the parameter value, such as "engine-default" or "user".
3304 */
3305 Source?: String;
3306 /**
3307 * The data type of the parameter.
3308 */
3309 DataType?: String;
3310 /**
3311 * The valid range of values for the parameter.
3312 */
3313 AllowedValues?: String;
3314 /**
3315 * Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
3316 */
3317 ApplyType?: ParameterApplyType;
3318 /**
3319 * If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
3320 */
3321 IsModifiable?: Boolean;
3322 /**
3323 * The earliest engine version to which the parameter can apply.
3324 */
3325 MinimumEngineVersion?: String;
3326 }
3327 export type ParameterApplyType = "static"|"dynamic"|string;
3328 export type ParameterGroupList = ClusterParameterGroup[];
3329 export type ParametersList = Parameter[];
3330 export interface PauseClusterMessage {
3331 /**
3332 * The identifier of the cluster to be paused.
3333 */
3334 ClusterIdentifier: String;
3335 }
3336 export interface PauseClusterResult {
3337 Cluster?: Cluster;
3338 }
3339 export type PendingActionsList = String[];
3340 export interface PendingModifiedValues {
3341 /**
3342 * The pending or in-progress change of the master user password for the cluster.
3343 */
3344 MasterUserPassword?: String;
3345 /**
3346 * The pending or in-progress change of the cluster's node type.
3347 */
3348 NodeType?: String;
3349 /**
3350 * The pending or in-progress change of the number of nodes in the cluster.
3351 */
3352 NumberOfNodes?: IntegerOptional;
3353 /**
3354 * The pending or in-progress change of the cluster type.
3355 */
3356 ClusterType?: String;
3357 /**
3358 * The pending or in-progress change of the service version.
3359 */
3360 ClusterVersion?: String;
3361 /**
3362 * The pending or in-progress change of the automated snapshot retention period.
3363 */
3364 AutomatedSnapshotRetentionPeriod?: IntegerOptional;
3365 /**
3366 * The pending or in-progress change of the new identifier for the cluster.
3367 */
3368 ClusterIdentifier?: String;
3369 /**
3370 * The pending or in-progress change of the ability to connect to the cluster from the public network.
3371 */
3372 PubliclyAccessible?: BooleanOptional;
3373 /**
3374 * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
3375 */
3376 EnhancedVpcRouting?: BooleanOptional;
3377 /**
3378 * The name of the maintenance track that the cluster will change to during the next maintenance window.
3379 */
3380 MaintenanceTrackName?: String;
3381 /**
3382 * The encryption type for a cluster. Possible values are: KMS and None. For the China region the possible values are None, and Legacy.
3383 */
3384 EncryptionType?: String;
3385 }
3386 export interface PurchaseReservedNodeOfferingMessage {
3387 /**
3388 * The unique identifier of the reserved node offering you want to purchase.
3389 */
3390 ReservedNodeOfferingId: String;
3391 /**
3392 * The number of reserved nodes that you want to purchase. Default: 1
3393 */
3394 NodeCount?: IntegerOptional;
3395 }
3396 export interface PurchaseReservedNodeOfferingResult {
3397 ReservedNode?: ReservedNode;
3398 }
3399 export interface RebootClusterMessage {
3400 /**
3401 * The cluster identifier.
3402 */
3403 ClusterIdentifier: String;
3404 }
3405 export interface RebootClusterResult {
3406 Cluster?: Cluster;
3407 }
3408 export interface RecurringCharge {
3409 /**
3410 * The amount charged per the period of time specified by the recurring charge frequency.
3411 */
3412 RecurringChargeAmount?: Double;
3413 /**
3414 * The frequency at which the recurring charge amount is applied.
3415 */
3416 RecurringChargeFrequency?: String;
3417 }
3418 export type RecurringChargeList = RecurringCharge[];
3419 export interface ReservedNode {
3420 /**
3421 * The unique identifier for the reservation.
3422 */
3423 ReservedNodeId?: String;
3424 /**
3425 * The identifier for the reserved node offering.
3426 */
3427 ReservedNodeOfferingId?: String;
3428 /**
3429 * The node type of the reserved node.
3430 */
3431 NodeType?: String;
3432 /**
3433 * The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.
3434 */
3435 StartTime?: TStamp;
3436 /**
3437 * The duration of the node reservation in seconds.
3438 */
3439 Duration?: Integer;
3440 /**
3441 * The fixed cost Amazon Redshift charges you for this reserved node.
3442 */
3443 FixedPrice?: Double;
3444 /**
3445 * The hourly rate Amazon Redshift charges you for this reserved node.
3446 */
3447 UsagePrice?: Double;
3448 /**
3449 * The currency code for the reserved cluster.
3450 */
3451 CurrencyCode?: String;
3452 /**
3453 * The number of reserved compute nodes.
3454 */
3455 NodeCount?: Integer;
3456 /**
3457 * The state of the reserved compute node. Possible Values: pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed. active-This reserved node is owned by the caller and is available for use. payment-failed-Payment failed for the purchase attempt. retired-The reserved node is no longer available. exchanging-The owner is exchanging the reserved node for another reserved node.
3458 */
3459 State?: String;
3460 /**
3461 * The anticipated utilization of the reserved node, as defined in the reserved node offering.
3462 */
3463 OfferingType?: String;
3464 /**
3465 * The recurring charges for the reserved node.
3466 */
3467 RecurringCharges?: RecurringChargeList;
3468 /**
3469 *
3470 */
3471 ReservedNodeOfferingType?: ReservedNodeOfferingType;
3472 }
3473 export type ReservedNodeList = ReservedNode[];
3474 export interface ReservedNodeOffering {
3475 /**
3476 * The offering identifier.
3477 */
3478 ReservedNodeOfferingId?: String;
3479 /**
3480 * The node type offered by the reserved node offering.
3481 */
3482 NodeType?: String;
3483 /**
3484 * The duration, in seconds, for which the offering will reserve the node.
3485 */
3486 Duration?: Integer;
3487 /**
3488 * The upfront fixed charge you will pay to purchase the specific reserved node offering.
3489 */
3490 FixedPrice?: Double;
3491 /**
3492 * The rate you are charged for each hour the cluster that is using the offering is running.
3493 */
3494 UsagePrice?: Double;
3495 /**
3496 * The currency code for the compute nodes offering.
3497 */
3498 CurrencyCode?: String;
3499 /**
3500 * The anticipated utilization of the reserved node, as defined in the reserved node offering.
3501 */
3502 OfferingType?: String;
3503 /**
3504 * The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.
3505 */
3506 RecurringCharges?: RecurringChargeList;
3507 /**
3508 *
3509 */
3510 ReservedNodeOfferingType?: ReservedNodeOfferingType;
3511 }
3512 export type ReservedNodeOfferingList = ReservedNodeOffering[];
3513 export type ReservedNodeOfferingType = "Regular"|"Upgradable"|string;
3514 export interface ReservedNodeOfferingsMessage {
3515 /**
3516 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
3517 */
3518 Marker?: String;
3519 /**
3520 * A list of ReservedNodeOffering objects.
3521 */
3522 ReservedNodeOfferings?: ReservedNodeOfferingList;
3523 }
3524 export interface ReservedNodesMessage {
3525 /**
3526 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
3527 */
3528 Marker?: String;
3529 /**
3530 * The list of ReservedNode objects.
3531 */
3532 ReservedNodes?: ReservedNodeList;
3533 }
3534 export interface ResetClusterParameterGroupMessage {
3535 /**
3536 * The name of the cluster parameter group to be reset.
3537 */
3538 ParameterGroupName: String;
3539 /**
3540 * If true, all parameters in the specified parameter group will be reset to their default values. Default: true
3541 */
3542 ResetAllParameters?: Boolean;
3543 /**
3544 * An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied. Constraints: A maximum of 20 parameters can be reset in a single request.
3545 */
3546 Parameters?: ParametersList;
3547 }
3548 export interface ResizeClusterMessage {
3549 /**
3550 * The unique identifier for the cluster to resize.
3551 */
3552 ClusterIdentifier: String;
3553 /**
3554 * The new cluster type for the specified cluster.
3555 */
3556 ClusterType?: String;
3557 /**
3558 * The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
3559 */
3560 NodeType?: String;
3561 /**
3562 * The new number of nodes for the cluster.
3563 */
3564 NumberOfNodes?: Integer;
3565 /**
3566 * A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.
3567 */
3568 Classic?: BooleanOptional;
3569 }
3570 export interface ResizeClusterResult {
3571 Cluster?: Cluster;
3572 }
3573 export interface ResizeInfo {
3574 /**
3575 * Returns the value ClassicResize.
3576 */
3577 ResizeType?: String;
3578 /**
3579 * A boolean value indicating if the resize operation can be cancelled.
3580 */
3581 AllowCancelResize?: Boolean;
3582 }
3583 export interface ResizeProgressMessage {
3584 /**
3585 * The node type that the cluster will have after the resize operation is complete.
3586 */
3587 TargetNodeType?: String;
3588 /**
3589 * The number of nodes that the cluster will have after the resize operation is complete.
3590 */
3591 TargetNumberOfNodes?: IntegerOptional;
3592 /**
3593 * The cluster type after the resize operation is complete. Valid Values: multi-node | single-node
3594 */
3595 TargetClusterType?: String;
3596 /**
3597 * The status of the resize operation. Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING
3598 */
3599 Status?: String;
3600 /**
3601 * The names of tables that have been completely imported . Valid Values: List of table names.
3602 */
3603 ImportTablesCompleted?: ImportTablesCompleted;
3604 /**
3605 * The names of tables that are being currently imported. Valid Values: List of table names.
3606 */
3607 ImportTablesInProgress?: ImportTablesInProgress;
3608 /**
3609 * The names of tables that have not been yet imported. Valid Values: List of table names
3610 */
3611 ImportTablesNotStarted?: ImportTablesNotStarted;
3612 /**
3613 * The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.
3614 */
3615 AvgResizeRateInMegaBytesPerSecond?: DoubleOptional;
3616 /**
3617 * The estimated total amount of data, in megabytes, on the cluster before the resize operation began.
3618 */
3619 TotalResizeDataInMegaBytes?: LongOptional;
3620 /**
3621 * While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).
3622 */
3623 ProgressInMegaBytes?: LongOptional;
3624 /**
3625 * The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.
3626 */
3627 ElapsedTimeInSeconds?: LongOptional;
3628 /**
3629 * The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.
3630 */
3631 EstimatedTimeToCompletionInSeconds?: LongOptional;
3632 /**
3633 * An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.
3634 */
3635 ResizeType?: String;
3636 /**
3637 * An optional string to provide additional details about the resize action.
3638 */
3639 Message?: String;
3640 /**
3641 * The type of encryption for the cluster after the resize is complete. Possible values are KMS and None. In the China region possible values are: Legacy and None.
3642 */
3643 TargetEncryptionType?: String;
3644 /**
3645 * The percent of data transferred from source cluster to target cluster.
3646 */
3647 DataTransferProgressPercent?: DoubleOptional;
3648 }
3649 export type RestorableNodeTypeList = String[];
3650 export interface RestoreFromClusterSnapshotMessage {
3651 /**
3652 * The identifier of the cluster that will be created from restoring the snapshot. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account.
3653 */
3654 ClusterIdentifier: String;
3655 /**
3656 * The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. Example: my-snapshot-id
3657 */
3658 SnapshotIdentifier: String;
3659 /**
3660 * The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
3661 */
3662 SnapshotClusterIdentifier?: String;
3663 /**
3664 * The port number on which the cluster accepts connections. Default: The same port as the original cluster. Constraints: Must be between 1115 and 65535.
3665 */
3666 Port?: IntegerOptional;
3667 /**
3668 * The Amazon EC2 Availability Zone in which to restore the cluster. Default: A random, system-chosen Availability Zone. Example: us-east-2a
3669 */
3670 AvailabilityZone?: String;
3671 /**
3672 * If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default: true
3673 */
3674 AllowVersionUpgrade?: BooleanOptional;
3675 /**
3676 * The name of the subnet group where you want to cluster restored. A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
3677 */
3678 ClusterSubnetGroupName?: String;
3679 /**
3680 * If true, the cluster can be accessed from a public network.
3681 */
3682 PubliclyAccessible?: BooleanOptional;
3683 /**
3684 * The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
3685 */
3686 OwnerAccount?: String;
3687 /**
3688 * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
3689 */
3690 HsmClientCertificateIdentifier?: String;
3691 /**
3692 * Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
3693 */
3694 HsmConfigurationIdentifier?: String;
3695 /**
3696 * The elastic IP (EIP) address for the cluster.
3697 */
3698 ElasticIp?: String;
3699 /**
3700 * The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups. Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
3701 */
3702 ClusterParameterGroupName?: String;
3703 /**
3704 * A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. Cluster security groups only apply to clusters outside of VPCs.
3705 */
3706 ClusterSecurityGroups?: ClusterSecurityGroupNameList;
3707 /**
3708 * A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster. VPC security groups only apply to clusters in VPCs.
3709 */
3710 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
3711 /**
3712 * The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
3713 */
3714 PreferredMaintenanceWindow?: String;
3715 /**
3716 * The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: The value selected for the cluster from which the snapshot was taken. Constraints: Must be a value from 0 to 35.
3717 */
3718 AutomatedSnapshotRetentionPeriod?: IntegerOptional;
3719 /**
3720 * The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
3721 */
3722 ManualSnapshotRetentionPeriod?: IntegerOptional;
3723 /**
3724 * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.
3725 */
3726 KmsKeyId?: String;
3727 /**
3728 * The node type that the restored cluster will be provisioned with. Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlareg cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
3729 */
3730 NodeType?: String;
3731 /**
3732 * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
3733 */
3734 EnhancedVpcRouting?: BooleanOptional;
3735 /**
3736 * Reserved.
3737 */
3738 AdditionalInfo?: String;
3739 /**
3740 * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated at any time.
3741 */
3742 IamRoles?: IamRoleArnList;
3743 /**
3744 * The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.
3745 */
3746 MaintenanceTrackName?: String;
3747 /**
3748 * A unique identifier for the snapshot schedule.
3749 */
3750 SnapshotScheduleIdentifier?: String;
3751 /**
3752 * The number of nodes specified when provisioning the restored cluster.
3753 */
3754 NumberOfNodes?: IntegerOptional;
3755 }
3756 export interface RestoreFromClusterSnapshotResult {
3757 Cluster?: Cluster;
3758 }
3759 export interface RestoreStatus {
3760 /**
3761 * The status of the restore action. Returns starting, restoring, completed, or failed.
3762 */
3763 Status?: String;
3764 /**
3765 * The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.
3766 */
3767 CurrentRestoreRateInMegaBytesPerSecond?: Double;
3768 /**
3769 * The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
3770 */
3771 SnapshotSizeInMegaBytes?: Long;
3772 /**
3773 * The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
3774 */
3775 ProgressInMegaBytes?: Long;
3776 /**
3777 * The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.
3778 */
3779 ElapsedTimeInSeconds?: Long;
3780 /**
3781 * The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
3782 */
3783 EstimatedTimeToCompletionInSeconds?: Long;
3784 }
3785 export interface RestoreTableFromClusterSnapshotMessage {
3786 /**
3787 * The identifier of the Amazon Redshift cluster to restore the table to.
3788 */
3789 ClusterIdentifier: String;
3790 /**
3791 * The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
3792 */
3793 SnapshotIdentifier: String;
3794 /**
3795 * The name of the source database that contains the table to restore from.
3796 */
3797 SourceDatabaseName: String;
3798 /**
3799 * The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.
3800 */
3801 SourceSchemaName?: String;
3802 /**
3803 * The name of the source table to restore from.
3804 */
3805 SourceTableName: String;
3806 /**
3807 * The name of the database to restore the table to.
3808 */
3809 TargetDatabaseName?: String;
3810 /**
3811 * The name of the schema to restore the table to.
3812 */
3813 TargetSchemaName?: String;
3814 /**
3815 * The name of the table to create as a result of the current request.
3816 */
3817 NewTableName: String;
3818 }
3819 export interface RestoreTableFromClusterSnapshotResult {
3820 TableRestoreStatus?: TableRestoreStatus;
3821 }
3822 export interface ResumeClusterMessage {
3823 /**
3824 * The identifier of the cluster to be resumed.
3825 */
3826 ClusterIdentifier: String;
3827 }
3828 export interface ResumeClusterResult {
3829 Cluster?: Cluster;
3830 }
3831 export interface RevisionTarget {
3832 /**
3833 * A unique string that identifies the version to update the cluster to. You can use this value in ModifyClusterDbRevision.
3834 */
3835 DatabaseRevision?: String;
3836 /**
3837 * A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding ClusterDbRevision.
3838 */
3839 Description?: String;
3840 /**
3841 * The date on which the database revision was released.
3842 */
3843 DatabaseRevisionReleaseDate?: TStamp;
3844 }
3845 export type RevisionTargetsList = RevisionTarget[];
3846 export interface RevokeClusterSecurityGroupIngressMessage {
3847 /**
3848 * The name of the security Group from which to revoke the ingress rule.
3849 */
3850 ClusterSecurityGroupName: String;
3851 /**
3852 * The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
3853 */
3854 CIDRIP?: String;
3855 /**
3856 * The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.
3857 */
3858 EC2SecurityGroupName?: String;
3859 /**
3860 * The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided. Example: 111122223333
3861 */
3862 EC2SecurityGroupOwnerId?: String;
3863 }
3864 export interface RevokeClusterSecurityGroupIngressResult {
3865 ClusterSecurityGroup?: ClusterSecurityGroup;
3866 }
3867 export interface RevokeSnapshotAccessMessage {
3868 /**
3869 * The identifier of the snapshot that the account can no longer access.
3870 */
3871 SnapshotIdentifier: String;
3872 /**
3873 * The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
3874 */
3875 SnapshotClusterIdentifier?: String;
3876 /**
3877 * The identifier of the AWS customer account that can no longer restore the specified snapshot.
3878 */
3879 AccountWithRestoreAccess: String;
3880 }
3881 export interface RevokeSnapshotAccessResult {
3882 Snapshot?: Snapshot;
3883 }
3884 export interface RotateEncryptionKeyMessage {
3885 /**
3886 * The unique identifier of the cluster that you want to rotate the encryption keys for. Constraints: Must be the name of valid cluster that has encryption enabled.
3887 */
3888 ClusterIdentifier: String;
3889 }
3890 export interface RotateEncryptionKeyResult {
3891 Cluster?: Cluster;
3892 }
3893 export type ScheduleDefinitionList = String[];
3894 export type ScheduleState = "MODIFYING"|"ACTIVE"|"FAILED"|string;
3895 export interface ScheduledAction {
3896 /**
3897 * The name of the scheduled action.
3898 */
3899 ScheduledActionName?: String;
3900 /**
3901 * A JSON format string of the Amazon Redshift API operation with input parameters. "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".
3902 */
3903 TargetAction?: ScheduledActionType;
3904 /**
3905 * The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)". Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
3906 */
3907 Schedule?: String;
3908 /**
3909 * The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.
3910 */
3911 IamRole?: String;
3912 /**
3913 * The description of the scheduled action.
3914 */
3915 ScheduledActionDescription?: String;
3916 /**
3917 * The state of the scheduled action. For example, DISABLED.
3918 */
3919 State?: ScheduledActionState;
3920 /**
3921 * List of times when the scheduled action will run.
3922 */
3923 NextInvocations?: ScheduledActionTimeList;
3924 /**
3925 * The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
3926 */
3927 StartTime?: TStamp;
3928 /**
3929 * The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
3930 */
3931 EndTime?: TStamp;
3932 }
3933 export interface ScheduledActionFilter {
3934 /**
3935 * The type of element to filter.
3936 */
3937 Name: ScheduledActionFilterName;
3938 /**
3939 * List of values. Compare if the value (of type defined by Name) equals an item in the list of scheduled actions.
3940 */
3941 Values: ValueStringList;
3942 }
3943 export type ScheduledActionFilterList = ScheduledActionFilter[];
3944 export type ScheduledActionFilterName = "cluster-identifier"|"iam-role"|string;
3945 export type ScheduledActionList = ScheduledAction[];
3946 export type ScheduledActionState = "ACTIVE"|"DISABLED"|string;
3947 export type ScheduledActionTimeList = TStamp[];
3948 export interface ScheduledActionType {
3949 /**
3950 * An action that runs a ResizeCluster API operation.
3951 */
3952 ResizeCluster?: ResizeClusterMessage;
3953 /**
3954 * An action that runs a PauseCluster API operation.
3955 */
3956 PauseCluster?: PauseClusterMessage;
3957 /**
3958 * An action that runs a ResumeCluster API operation.
3959 */
3960 ResumeCluster?: ResumeClusterMessage;
3961 }
3962 export type ScheduledActionTypeValues = "ResizeCluster"|"PauseCluster"|"ResumeCluster"|string;
3963 export interface ScheduledActionsMessage {
3964 /**
3965 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
3966 */
3967 Marker?: String;
3968 /**
3969 * List of retrieved scheduled actions.
3970 */
3971 ScheduledActions?: ScheduledActionList;
3972 }
3973 export type ScheduledSnapshotTimeList = TStamp[];
3974 export type SensitiveString = string;
3975 export interface Snapshot {
3976 /**
3977 * The snapshot identifier that is provided in the request.
3978 */
3979 SnapshotIdentifier?: String;
3980 /**
3981 * The identifier of the cluster for which the snapshot was taken.
3982 */
3983 ClusterIdentifier?: String;
3984 /**
3985 * The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
3986 */
3987 SnapshotCreateTime?: TStamp;
3988 /**
3989 * The snapshot status. The value of the status depends on the API operation used: CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating". DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed". DeleteClusterSnapshot returns status as "deleted".
3990 */
3991 Status?: String;
3992 /**
3993 * The port that the cluster is listening on.
3994 */
3995 Port?: Integer;
3996 /**
3997 * The Availability Zone in which the cluster was created.
3998 */
3999 AvailabilityZone?: String;
4000 /**
4001 * The time (UTC) when the cluster was originally created.
4002 */
4003 ClusterCreateTime?: TStamp;
4004 /**
4005 * The master user name for the cluster.
4006 */
4007 MasterUsername?: String;
4008 /**
4009 * The version ID of the Amazon Redshift engine that is running on the cluster.
4010 */
4011 ClusterVersion?: String;
4012 /**
4013 * The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".
4014 */
4015 SnapshotType?: String;
4016 /**
4017 * The node type of the nodes in the cluster.
4018 */
4019 NodeType?: String;
4020 /**
4021 * The number of nodes in the cluster.
4022 */
4023 NumberOfNodes?: Integer;
4024 /**
4025 * The name of the database that was created when the cluster was created.
4026 */
4027 DBName?: String;
4028 /**
4029 * The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
4030 */
4031 VpcId?: String;
4032 /**
4033 * If true, the data in the snapshot is encrypted at rest.
4034 */
4035 Encrypted?: Boolean;
4036 /**
4037 * The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
4038 */
4039 KmsKeyId?: String;
4040 /**
4041 * A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
4042 */
4043 EncryptedWithHSM?: Boolean;
4044 /**
4045 * A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
4046 */
4047 AccountsWithRestoreAccess?: AccountsWithRestoreAccessList;
4048 /**
4049 * For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
4050 */
4051 OwnerAccount?: String;
4052 /**
4053 * The size of the complete set of backup data that would be used to restore the cluster.
4054 */
4055 TotalBackupSizeInMegaBytes?: Double;
4056 /**
4057 * The size of the incremental backup.
4058 */
4059 ActualIncrementalBackupSizeInMegaBytes?: Double;
4060 /**
4061 * The number of megabytes that have been transferred to the snapshot backup.
4062 */
4063 BackupProgressInMegaBytes?: Double;
4064 /**
4065 * The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
4066 */
4067 CurrentBackupRateInMegaBytesPerSecond?: Double;
4068 /**
4069 * The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
4070 */
4071 EstimatedSecondsToCompletion?: Long;
4072 /**
4073 * The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
4074 */
4075 ElapsedTimeInSeconds?: Long;
4076 /**
4077 * The source region from which the snapshot was copied.
4078 */
4079 SourceRegion?: String;
4080 /**
4081 * The list of tags for the cluster snapshot.
4082 */
4083 Tags?: TagList;
4084 /**
4085 * The list of node types that this cluster snapshot is able to restore into.
4086 */
4087 RestorableNodeTypes?: RestorableNodeTypeList;
4088 /**
4089 * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false
4090 */
4091 EnhancedVpcRouting?: Boolean;
4092 /**
4093 * The name of the maintenance track for the snapshot.
4094 */
4095 MaintenanceTrackName?: String;
4096 /**
4097 * The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
4098 */
4099 ManualSnapshotRetentionPeriod?: IntegerOptional;
4100 /**
4101 * The number of days until a manual snapshot will pass its retention period.
4102 */
4103 ManualSnapshotRemainingDays?: IntegerOptional;
4104 /**
4105 * A timestamp representing the start of the retention period for the snapshot.
4106 */
4107 SnapshotRetentionStartTime?: TStamp;
4108 }
4109 export type SnapshotAttributeToSortBy = "SOURCE_TYPE"|"TOTAL_SIZE"|"CREATE_TIME"|string;
4110 export interface SnapshotCopyGrant {
4111 /**
4112 * The name of the snapshot copy grant.
4113 */
4114 SnapshotCopyGrantName?: String;
4115 /**
4116 * The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.
4117 */
4118 KmsKeyId?: String;
4119 /**
4120 * A list of tag instances.
4121 */
4122 Tags?: TagList;
4123 }
4124 export type SnapshotCopyGrantList = SnapshotCopyGrant[];
4125 export interface SnapshotCopyGrantMessage {
4126 /**
4127 * An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
4128 */
4129 Marker?: String;
4130 /**
4131 * The list of SnapshotCopyGrant objects.
4132 */
4133 SnapshotCopyGrants?: SnapshotCopyGrantList;
4134 }
4135 export interface SnapshotErrorMessage {
4136 /**
4137 * A unique identifier for the snapshot returning the error.
4138 */
4139 SnapshotIdentifier?: String;
4140 /**
4141 * A unique identifier for the cluster.
4142 */
4143 SnapshotClusterIdentifier?: String;
4144 /**
4145 * The failure code for the error.
4146 */
4147 FailureCode?: String;
4148 /**
4149 * The text message describing the error.
4150 */
4151 FailureReason?: String;
4152 }
4153 export type SnapshotIdentifierList = String[];
4154 export type SnapshotList = Snapshot[];
4155 export interface SnapshotMessage {
4156 /**
4157 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
4158 */
4159 Marker?: String;
4160 /**
4161 * A list of Snapshot instances.
4162 */
4163 Snapshots?: SnapshotList;
4164 }
4165 export interface SnapshotSchedule {
4166 /**
4167 * A list of ScheduleDefinitions.
4168 */
4169 ScheduleDefinitions?: ScheduleDefinitionList;
4170 /**
4171 * A unique identifier for the schedule.
4172 */
4173 ScheduleIdentifier?: String;
4174 /**
4175 * The description of the schedule.
4176 */
4177 ScheduleDescription?: String;
4178 /**
4179 * An optional set of tags describing the schedule.
4180 */
4181 Tags?: TagList;
4182 /**
4183 *
4184 */
4185 NextInvocations?: ScheduledSnapshotTimeList;
4186 /**
4187 * The number of clusters associated with the schedule.
4188 */
4189 AssociatedClusterCount?: IntegerOptional;
4190 /**
4191 * A list of clusters associated with the schedule. A maximum of 100 clusters is returned.
4192 */
4193 AssociatedClusters?: AssociatedClusterList;
4194 }
4195 export type SnapshotScheduleList = SnapshotSchedule[];
4196 export interface SnapshotSortingEntity {
4197 /**
4198 * The category for sorting the snapshots.
4199 */
4200 Attribute: SnapshotAttributeToSortBy;
4201 /**
4202 * The order for listing the attributes.
4203 */
4204 SortOrder?: SortByOrder;
4205 }
4206 export type SnapshotSortingEntityList = SnapshotSortingEntity[];
4207 export type SortByOrder = "ASC"|"DESC"|string;
4208 export type SourceIdsList = String[];
4209 export type SourceType = "cluster"|"cluster-parameter-group"|"cluster-security-group"|"cluster-snapshot"|"scheduled-action"|string;
4210 export type String = string;
4211 export interface Subnet {
4212 /**
4213 * The identifier of the subnet.
4214 */
4215 SubnetIdentifier?: String;
4216 /**
4217 *
4218 */
4219 SubnetAvailabilityZone?: AvailabilityZone;
4220 /**
4221 * The status of the subnet.
4222 */
4223 SubnetStatus?: String;
4224 }
4225 export type SubnetIdentifierList = String[];
4226 export type SubnetList = Subnet[];
4227 export interface SupportedOperation {
4228 /**
4229 * A list of the supported operations.
4230 */
4231 OperationName?: String;
4232 }
4233 export type SupportedOperationList = SupportedOperation[];
4234 export interface SupportedPlatform {
4235 /**
4236 *
4237 */
4238 Name?: String;
4239 }
4240 export type SupportedPlatformsList = SupportedPlatform[];
4241 export type TStamp = Date;
4242 export interface TableRestoreStatus {
4243 /**
4244 * The unique identifier for the table restore request.
4245 */
4246 TableRestoreRequestId?: String;
4247 /**
4248 * A value that describes the current state of the table restore request. Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS
4249 */
4250 Status?: TableRestoreStatusType;
4251 /**
4252 * A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.
4253 */
4254 Message?: String;
4255 /**
4256 * The time that the table restore request was made, in Universal Coordinated Time (UTC).
4257 */
4258 RequestTime?: TStamp;
4259 /**
4260 * The amount of data restored to the new table so far, in megabytes (MB).
4261 */
4262 ProgressInMegaBytes?: LongOptional;
4263 /**
4264 * The total amount of data to restore to the new table, in megabytes (MB).
4265 */
4266 TotalDataInMegaBytes?: LongOptional;
4267 /**
4268 * The identifier of the Amazon Redshift cluster that the table is being restored to.
4269 */
4270 ClusterIdentifier?: String;
4271 /**
4272 * The identifier of the snapshot that the table is being restored from.
4273 */
4274 SnapshotIdentifier?: String;
4275 /**
4276 * The name of the source database that contains the table being restored.
4277 */
4278 SourceDatabaseName?: String;
4279 /**
4280 * The name of the source schema that contains the table being restored.
4281 */
4282 SourceSchemaName?: String;
4283 /**
4284 * The name of the source table being restored.
4285 */
4286 SourceTableName?: String;
4287 /**
4288 * The name of the database to restore the table to.
4289 */
4290 TargetDatabaseName?: String;
4291 /**
4292 * The name of the schema to restore the table to.
4293 */
4294 TargetSchemaName?: String;
4295 /**
4296 * The name of the table to create as a result of the table restore request.
4297 */
4298 NewTableName?: String;
4299 }
4300 export type TableRestoreStatusList = TableRestoreStatus[];
4301 export interface TableRestoreStatusMessage {
4302 /**
4303 * A list of status details for one or more table restore requests.
4304 */
4305 TableRestoreStatusDetails?: TableRestoreStatusList;
4306 /**
4307 * A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.
4308 */
4309 Marker?: String;
4310 }
4311 export type TableRestoreStatusType = "PENDING"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"CANCELED"|string;
4312 export interface Tag {
4313 /**
4314 * The key, or name, for the resource tag.
4315 */
4316 Key?: String;
4317 /**
4318 * The value for the resource tag.
4319 */
4320 Value?: String;
4321 }
4322 export type TagKeyList = String[];
4323 export type TagList = Tag[];
4324 export type TagValueList = String[];
4325 export interface TaggedResource {
4326 /**
4327 * The tag for the resource.
4328 */
4329 Tag?: Tag;
4330 /**
4331 * The Amazon Resource Name (ARN) with which the tag is associated, for example: arn:aws:redshift:us-east-2:123456789:cluster:t1.
4332 */
4333 ResourceName?: String;
4334 /**
4335 * The type of resource with which the tag is associated. Valid resource types are: Cluster CIDR/IP EC2 security group Snapshot Cluster security group Subnet group HSM connection HSM certificate Parameter group For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
4336 */
4337 ResourceType?: String;
4338 }
4339 export type TaggedResourceList = TaggedResource[];
4340 export interface TaggedResourceListMessage {
4341 /**
4342 * A list of tags with their associated resources.
4343 */
4344 TaggedResources?: TaggedResourceList;
4345 /**
4346 * A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
4347 */
4348 Marker?: String;
4349 }
4350 export type TrackList = MaintenanceTrack[];
4351 export interface TrackListMessage {
4352 /**
4353 * A list of maintenance tracks output by the DescribeClusterTracks operation.
4354 */
4355 MaintenanceTracks?: TrackList;
4356 /**
4357 * The starting point to return a set of response tracklist records. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
4358 */
4359 Marker?: String;
4360 }
4361 export interface UpdateTarget {
4362 /**
4363 * The name of the new maintenance track.
4364 */
4365 MaintenanceTrackName?: String;
4366 /**
4367 * The cluster version for the new maintenance track.
4368 */
4369 DatabaseVersion?: String;
4370 /**
4371 * A list of operations supported by the maintenance track.
4372 */
4373 SupportedOperations?: SupportedOperationList;
4374 }
4375 export type ValueStringList = String[];
4376 export type VpcSecurityGroupIdList = String[];
4377 export interface VpcSecurityGroupMembership {
4378 /**
4379 * The identifier of the VPC security group.
4380 */
4381 VpcSecurityGroupId?: String;
4382 /**
4383 * The status of the VPC security group.
4384 */
4385 Status?: String;
4386 }
4387 export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[];
4388 /**
4389 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
4390 */
4391 export type apiVersion = "2012-12-01"|"latest"|string;
4392 export interface ClientApiVersions {
4393 /**
4394 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
4395 */
4396 apiVersion?: apiVersion;
4397 }
4398 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
4399 /**
4400 * Contains interfaces for use with the Redshift client.
4401 */
4402 export import Types = Redshift;
4403}
4404export = Redshift;