@aws-sdk/client-redshift 3.262.0 → 3.264.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -1
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/Redshift.d.ts +104 -105
- package/dist-types/RedshiftClient.d.ts +6 -7
- package/dist-types/commands/AuthorizeClusterSecurityGroupIngressCommand.d.ts +3 -3
- package/dist-types/commands/AuthorizeSnapshotAccessCommand.d.ts +1 -1
- package/dist-types/commands/CopyClusterSnapshotCommand.d.ts +2 -2
- package/dist-types/commands/CreateClusterCommand.d.ts +1 -1
- package/dist-types/commands/CreateClusterParameterGroupCommand.d.ts +2 -2
- package/dist-types/commands/CreateClusterSecurityGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateClusterSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/CreateClusterSubnetGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +2 -2
- package/dist-types/commands/CreateHsmClientCertificateCommand.d.ts +1 -1
- package/dist-types/commands/CreateHsmConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/CreateSnapshotCopyGrantCommand.d.ts +1 -1
- package/dist-types/commands/CreateTagsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteClusterCommand.d.ts +2 -2
- package/dist-types/commands/DeleteClusterParameterGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteClusterSecurityGroupCommand.d.ts +3 -3
- package/dist-types/commands/DeleteClusterSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/DescribeClusterParameterGroupsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeClusterParametersCommand.d.ts +2 -2
- package/dist-types/commands/DescribeClusterSecurityGroupsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeClusterSnapshotsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeClusterSubnetGroupsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeClustersCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDefaultClusterParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeHsmClientCertificatesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeHsmConfigurationsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeReservedNodeOfferingsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeResizeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSnapshotCopyGrantsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTagsCommand.d.ts +7 -7
- package/dist-types/commands/DescribeUsageLimitsCommand.d.ts +1 -1
- package/dist-types/commands/DisableSnapshotCopyCommand.d.ts +1 -1
- package/dist-types/commands/GetClusterCredentialsCommand.d.ts +4 -4
- package/dist-types/commands/GetClusterCredentialsWithIAMCommand.d.ts +1 -1
- package/dist-types/commands/ModifyClusterCommand.d.ts +2 -2
- package/dist-types/commands/ModifyClusterIamRolesCommand.d.ts +1 -1
- package/dist-types/commands/ModifyClusterParameterGroupCommand.d.ts +1 -1
- package/dist-types/commands/ModifyClusterSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/PurchaseReservedNodeOfferingCommand.d.ts +1 -1
- package/dist-types/commands/ResizeClusterCommand.d.ts +23 -23
- package/dist-types/commands/RestoreFromClusterSnapshotCommand.d.ts +2 -2
- package/dist-types/commands/RestoreTableFromClusterSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/RevokeSnapshotAccessCommand.d.ts +1 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +392 -398
- package/dist-types/models/models_1.d.ts +218 -223
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +4 -4
|
@@ -243,10 +243,10 @@ export interface RedshiftClientResolvedConfig extends RedshiftClientResolvedConf
|
|
|
243
243
|
}
|
|
244
244
|
/**
|
|
245
245
|
* <fullname>Amazon Redshift</fullname>
|
|
246
|
-
*
|
|
246
|
+
* <p>
|
|
247
247
|
* <b>Overview</b>
|
|
248
|
-
*
|
|
249
|
-
*
|
|
248
|
+
* </p>
|
|
249
|
+
* <p>This is an interface reference for Amazon Redshift. It contains documentation for one of
|
|
250
250
|
* the programming or command line interfaces you can use to manage Amazon Redshift clusters.
|
|
251
251
|
* Note that Amazon Redshift is asynchronous, which means that some interfaces may require
|
|
252
252
|
* techniques, such as polling or asynchronous callback handlers, to determine when a
|
|
@@ -255,14 +255,13 @@ export interface RedshiftClientResolvedConfig extends RedshiftClientResolvedConf
|
|
|
255
255
|
* maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to
|
|
256
256
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/using-aws-sdk.html">Using the
|
|
257
257
|
* Amazon Redshift Management Interfaces</a>.</p>
|
|
258
|
-
*
|
|
258
|
+
* <p>Amazon Redshift manages all the work of setting up, operating, and scaling a data
|
|
259
259
|
* warehouse: provisioning capacity, monitoring and backing up the cluster, and applying
|
|
260
260
|
* patches and upgrades to the Amazon Redshift engine. You can focus on using your data to
|
|
261
261
|
* acquire new insights for your business and customers.</p>
|
|
262
|
-
*
|
|
262
|
+
* <p>If you are a first-time user of Amazon Redshift, we recommend that you begin by reading
|
|
263
263
|
* the <a href="https://docs.aws.amazon.com/redshift/latest/gsg/getting-started.html">Amazon Redshift Getting Started Guide</a>.</p>
|
|
264
|
-
*
|
|
265
|
-
* <p>If you are a database developer, the <a href="https://docs.aws.amazon.com/redshift/latest/dg/welcome.html">Amazon Redshift Database Developer Guide</a> explains how to design,
|
|
264
|
+
* <p>If you are a database developer, the <a href="https://docs.aws.amazon.com/redshift/latest/dg/welcome.html">Amazon Redshift Database Developer Guide</a> explains how to design,
|
|
266
265
|
* build, query, and maintain the databases that make up your data warehouse. </p>
|
|
267
266
|
*/
|
|
268
267
|
export declare class RedshiftClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, RedshiftClientResolvedConfig> {
|
|
@@ -13,14 +13,14 @@ export interface AuthorizeClusterSecurityGroupIngressCommandOutput extends Autho
|
|
|
13
13
|
* instance, you can authorize inbound access to either a Classless Interdomain Routing
|
|
14
14
|
* (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as
|
|
15
15
|
* many as 20 ingress rules to an Amazon Redshift security group.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>If you authorize access to an Amazon EC2 security group, specify
|
|
17
17
|
* <i>EC2SecurityGroupName</i> and
|
|
18
18
|
* <i>EC2SecurityGroupOwnerId</i>. The Amazon EC2 security group and
|
|
19
19
|
* Amazon Redshift cluster must be in the same Amazon Web Services Region. </p>
|
|
20
|
-
*
|
|
20
|
+
* <p>If you authorize access to a CIDR/IP address range, specify
|
|
21
21
|
* <i>CIDRIP</i>. For an overview of CIDR blocks, see the Wikipedia
|
|
22
22
|
* article on <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>. </p>
|
|
23
|
-
*
|
|
23
|
+
* <p>You must also associate the security group with a cluster so that clients running
|
|
24
24
|
* on these IP addresses or the EC2 instance are authorized to connect to the cluster. For
|
|
25
25
|
* information about managing security groups, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Working with Security
|
|
26
26
|
* Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -10,7 +10,7 @@ export interface AuthorizeSnapshotAccessCommandOutput extends AuthorizeSnapshotA
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Authorizes the specified Amazon Web Services account to restore the specified
|
|
12
12
|
* snapshot.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>
|
|
14
14
|
* For more information about working with snapshots, go to
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a>
|
|
16
16
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -11,12 +11,12 @@ export interface CopyClusterSnapshotCommandOutput extends CopyClusterSnapshotRes
|
|
|
11
11
|
* <p>Copies the specified automated cluster snapshot to a new manual cluster snapshot.
|
|
12
12
|
* The source must be an automated snapshot and it must be in the available
|
|
13
13
|
* state.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>When you delete a cluster, Amazon Redshift deletes any automated snapshots of the
|
|
15
15
|
* cluster. Also, when the retention period of the snapshot expires, Amazon Redshift
|
|
16
16
|
* automatically deletes it. If you want to keep an automated snapshot for a longer period,
|
|
17
17
|
* you can make a manual copy of the snapshot. Manual snapshots are retained until you
|
|
18
18
|
* delete them.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>
|
|
20
20
|
* For more information about working with snapshots, go to
|
|
21
21
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a>
|
|
22
22
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -9,7 +9,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResult, __Metad
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a new cluster with the specified parameters.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster
|
|
13
13
|
* subnet group name. The cluster subnet group identifies the subnets of your VPC that
|
|
14
14
|
* Amazon Redshift uses when creating the cluster.
|
|
15
15
|
* For more information about managing clusters, go to
|
|
@@ -9,10 +9,10 @@ export interface CreateClusterParameterGroupCommandOutput extends CreateClusterP
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an Amazon Redshift parameter group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Creating parameter groups is independent of creating clusters. You can associate a
|
|
13
13
|
* cluster with a parameter group when you create the cluster. You can also associate an
|
|
14
14
|
* existing cluster with a parameter group after the cluster is created by using <a>ModifyCluster</a>. </p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Parameters in the parameter group define specific behavior that applies to the
|
|
16
16
|
* databases you create on the cluster.
|
|
17
17
|
* For more information about parameters and parameter groups, go to
|
|
18
18
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a>
|
|
@@ -10,7 +10,7 @@ export interface CreateClusterSecurityGroupCommandOutput extends CreateClusterSe
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a new Amazon Redshift security group. You use security groups to control access
|
|
12
12
|
* to non-VPC clusters.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>
|
|
14
14
|
* For information about managing security groups, go to
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the
|
|
16
16
|
* <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -10,7 +10,7 @@ export interface CreateClusterSnapshotCommandOutput extends CreateClusterSnapsho
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a manual snapshot of the specified cluster. The cluster must be in the
|
|
12
12
|
* <code>available</code> state. </p>
|
|
13
|
-
*
|
|
13
|
+
* <p>
|
|
14
14
|
* For more information about working with snapshots, go to
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a>
|
|
16
16
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -11,7 +11,7 @@ export interface CreateClusterSubnetGroupCommandOutput extends CreateClusterSubn
|
|
|
11
11
|
* <p>Creates a new Amazon Redshift subnet group. You must provide a list of one or more
|
|
12
12
|
* subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating
|
|
13
13
|
* Amazon Redshift subnet group.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>
|
|
15
15
|
* For information about subnet groups, go to
|
|
16
16
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html">Amazon Redshift Cluster Subnet Groups</a> in the
|
|
17
17
|
* <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -13,13 +13,13 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri
|
|
|
13
13
|
* the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you
|
|
14
14
|
* must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in
|
|
15
15
|
* the SNS console.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>You can specify the source type, and lists of Amazon Redshift source IDs, event
|
|
17
17
|
* categories, and event severities. Notifications will be sent for all events you want
|
|
18
18
|
* that match those criteria. For example, you can specify source type = cluster, source ID
|
|
19
19
|
* = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity =
|
|
20
20
|
* ERROR. The subscription will only send notifications for those ERROR events in the
|
|
21
21
|
* Availability and Backup categories for the specified clusters.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>If you specify both the source type and source IDs, such as source type = cluster
|
|
23
23
|
* and source identifier = my-cluster-1, notifications will be sent for all the cluster
|
|
24
24
|
* events for my-cluster-1. If you specify a source type but do not specify a source
|
|
25
25
|
* identifier, you will receive notice of the events for the objects of that type in your
|
|
@@ -11,7 +11,7 @@ export interface CreateHsmClientCertificateCommandOutput extends CreateHsmClient
|
|
|
11
11
|
* <p>Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to
|
|
12
12
|
* the client's HSM in order to store and retrieve the keys used to encrypt the cluster
|
|
13
13
|
* databases.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>The command returns a public key, which you must store in the HSM. In addition to
|
|
15
15
|
* creating the HSM certificate, you must create an Amazon Redshift HSM configuration that
|
|
16
16
|
* provides a cluster the information needed to store and use encryption keys in the HSM.
|
|
17
17
|
* For more information, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html#working-with-HSM">Hardware Security Modules</a>
|
|
@@ -12,7 +12,7 @@ export interface CreateHsmConfigurationCommandOutput extends CreateHsmConfigurat
|
|
|
12
12
|
* cluster to store and use database encryption keys in a Hardware Security Module (HSM).
|
|
13
13
|
* After creating the HSM configuration, you can specify it as a parameter when creating a
|
|
14
14
|
* cluster. The cluster will then store its encryption keys in the HSM.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>In addition to creating an HSM configuration, you must also create an HSM client
|
|
16
16
|
* certificate. For more information, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html">Hardware Security Modules</a>
|
|
17
17
|
* in the Amazon Redshift Cluster Management Guide.</p>
|
|
18
18
|
* @example
|
|
@@ -11,7 +11,7 @@ export interface CreateSnapshotCopyGrantCommandOutput extends CreateSnapshotCopy
|
|
|
11
11
|
* <p>Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key
|
|
12
12
|
* from Key Management Service (KMS) to encrypt copied snapshots in a
|
|
13
13
|
* destination region.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>
|
|
15
15
|
* For more information about managing snapshot copy grants, go to
|
|
16
16
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a>
|
|
17
17
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.
|
|
@@ -9,9 +9,9 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds tags to a cluster.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>A resource can have up to 50 tags. If you try to create more than 50 tags for a
|
|
13
13
|
* resource, you will receive an error and the attempt will fail.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>If you specify a key that already exists for the resource, the value for that key
|
|
15
15
|
* will be updated with the new value.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -14,13 +14,13 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResult, __Metad
|
|
|
14
14
|
* For more information about managing clusters, go to
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a>
|
|
16
16
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>If you want to shut down the cluster and retain it for future use, set
|
|
18
18
|
* <i>SkipFinalClusterSnapshot</i> to <code>false</code> and specify a
|
|
19
19
|
* name for <i>FinalClusterSnapshotIdentifier</i>. You can later restore this
|
|
20
20
|
* snapshot to resume using the cluster. If a final cluster snapshot is requested, the
|
|
21
21
|
* status of the cluster will be "final-snapshot" while the snapshot is being taken, then
|
|
22
22
|
* it's "deleting" once Amazon Redshift begins deleting the cluster. </p>
|
|
23
|
-
*
|
|
23
|
+
* <p>
|
|
24
24
|
* For more information about managing clusters, go to
|
|
25
25
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a>
|
|
26
26
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -9,10 +9,10 @@ export interface DeleteClusterParameterGroupCommandOutput extends __MetadataBear
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a specified Amazon Redshift parameter group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <p>You cannot delete a parameter group if it is associated with a
|
|
14
14
|
* cluster.</p>
|
|
15
|
-
*
|
|
15
|
+
* </note>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -9,11 +9,11 @@ export interface DeleteClusterSecurityGroupCommandOutput extends __MetadataBeare
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes an Amazon Redshift security group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <p>You cannot delete a security group that is associated with any clusters. You
|
|
14
14
|
* cannot delete the default security group.</p>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* </note>
|
|
16
|
+
* <p>
|
|
17
17
|
* For information about managing security groups, go to
|
|
18
18
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the
|
|
19
19
|
* <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -10,7 +10,7 @@ export interface DeleteClusterSnapshotCommandOutput extends DeleteClusterSnapsho
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified manual snapshot. The snapshot must be in the
|
|
12
12
|
* <code>available</code> state, with no other users authorized to access the snapshot. </p>
|
|
13
|
-
*
|
|
13
|
+
* <p>Unlike automated snapshots, manual snapshots are retained even after you delete
|
|
14
14
|
* your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual
|
|
15
15
|
* snapshot explicitly to avoid getting charged. If other accounts are authorized to access
|
|
16
16
|
* the snapshot, you must revoke all of the authorizations before you can delete the
|
|
@@ -13,16 +13,16 @@ export interface DescribeClusterParameterGroupsCommandOutput extends ClusterPara
|
|
|
13
13
|
* the parameter group name, description, and parameter group family name. You can
|
|
14
14
|
* optionally specify a name to retrieve the description of a specific parameter
|
|
15
15
|
* group.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>
|
|
17
17
|
* For more information about parameters and parameter groups, go to
|
|
18
18
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a>
|
|
19
19
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns
|
|
21
21
|
* all parameter groups that match any combination of the specified keys and values. For
|
|
22
22
|
* example, if you have <code>owner</code> and <code>environment</code> for tag keys, and
|
|
23
23
|
* <code>admin</code> and <code>test</code> for tag values, all parameter groups that
|
|
24
24
|
* have any combination of those values are returned.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>If both tag keys and values are omitted from the request, parameter groups are
|
|
26
26
|
* returned regardless of whether they have tag keys or values associated with
|
|
27
27
|
* them.</p>
|
|
28
28
|
* @example
|
|
@@ -12,11 +12,11 @@ export interface DescribeClusterParametersCommandOutput extends ClusterParameter
|
|
|
12
12
|
* parameter group. For each parameter the response includes information such as parameter
|
|
13
13
|
* name, description, data type, value, whether the parameter value is modifiable, and so
|
|
14
14
|
* on.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>You can specify <i>source</i> filter to retrieve parameters of only
|
|
16
16
|
* specific type. For example, to retrieve parameters that were modified by a user action
|
|
17
17
|
* such as from <a>ModifyClusterParameterGroup</a>, you can specify
|
|
18
18
|
* <i>source</i> equal to <i>user</i>.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>
|
|
20
20
|
* For more information about parameters and parameter groups, go to
|
|
21
21
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a>
|
|
22
22
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -11,16 +11,16 @@ export interface DescribeClusterSecurityGroupsCommandOutput extends ClusterSecur
|
|
|
11
11
|
* <p>Returns information about Amazon Redshift security groups. If the name of a security
|
|
12
12
|
* group is specified, the response will contain only information about only that security
|
|
13
13
|
* group.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>
|
|
15
15
|
* For information about managing security groups, go to
|
|
16
16
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the
|
|
17
17
|
* <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns
|
|
19
19
|
* all security groups that match any combination of the specified keys and values. For
|
|
20
20
|
* example, if you have <code>owner</code> and <code>environment</code> for tag keys, and
|
|
21
21
|
* <code>admin</code> and <code>test</code> for tag values, all security groups that
|
|
22
22
|
* have any combination of those values are returned.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>If both tag keys and values are omitted from the request, security groups are
|
|
24
24
|
* returned regardless of whether they have tag keys or values associated with
|
|
25
25
|
* them.</p>
|
|
26
26
|
* @example
|
|
@@ -12,14 +12,14 @@ export interface DescribeClusterSnapshotsCommandOutput extends SnapshotMessage,
|
|
|
12
12
|
* snapshots. By default, this operation returns information about all snapshots of all
|
|
13
13
|
* clusters that are owned by your Amazon Web Services account. No information is returned for
|
|
14
14
|
* snapshots owned by inactive Amazon Web Services accounts.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns
|
|
16
16
|
* all snapshots that match any combination of the specified keys and values. For example,
|
|
17
17
|
* if you have <code>owner</code> and <code>environment</code> for tag keys, and
|
|
18
18
|
* <code>admin</code> and <code>test</code> for tag values, all snapshots that have any
|
|
19
19
|
* combination of those values are returned. Only snapshots that you own are returned in
|
|
20
20
|
* the response; shared snapshots are not returned with the tag key and tag value request
|
|
21
21
|
* parameters.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>If both tag keys and values are omitted from the request, snapshots are returned
|
|
23
23
|
* regardless of whether they have tag keys or values associated with them.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,12 +11,12 @@ export interface DescribeClusterSubnetGroupsCommandOutput extends ClusterSubnetG
|
|
|
11
11
|
* <p>Returns one or more cluster subnet group objects, which contain metadata about your
|
|
12
12
|
* cluster subnet groups. By default, this operation returns information about all cluster
|
|
13
13
|
* subnet groups that are defined in your Amazon Web Services account.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns
|
|
15
15
|
* all subnet groups that match any combination of the specified keys and values. For
|
|
16
16
|
* example, if you have <code>owner</code> and <code>environment</code> for tag keys, and
|
|
17
17
|
* <code>admin</code> and <code>test</code> for tag values, all subnet groups that have
|
|
18
18
|
* any combination of those values are returned.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>If both tag keys and values are omitted from the request, subnet groups are
|
|
20
20
|
* returned regardless of whether they have tag keys or values associated with
|
|
21
21
|
* them.</p>
|
|
22
22
|
* @example
|
|
@@ -14,12 +14,12 @@ export interface DescribeClustersCommandOutput extends ClustersMessage, __Metada
|
|
|
14
14
|
* For more information about managing clusters, go to
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a>
|
|
16
16
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns
|
|
18
18
|
* all clusters that match any combination of the specified keys and values. For example,
|
|
19
19
|
* if you have <code>owner</code> and <code>environment</code> for tag keys, and
|
|
20
20
|
* <code>admin</code> and <code>test</code> for tag values, all clusters that have any
|
|
21
21
|
* combination of those values are returned.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>If both tag keys and values are omitted from the request, clusters are returned
|
|
23
23
|
* regardless of whether they have tag keys or values associated with them.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,7 +10,7 @@ export interface DescribeDefaultClusterParametersCommandOutput extends DescribeD
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns a list of parameter settings for the specified parameter group
|
|
12
12
|
* family.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>
|
|
14
14
|
* For more information about parameters and parameter groups, go to
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a>
|
|
16
16
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -11,12 +11,12 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti
|
|
|
11
11
|
* <p>Lists descriptions of all the Amazon Redshift event notification subscriptions for a
|
|
12
12
|
* customer account. If you specify a subscription name, lists the description for that
|
|
13
13
|
* subscription.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns
|
|
15
15
|
* all event notification subscriptions that match any combination of the specified keys
|
|
16
16
|
* and values. For example, if you have <code>owner</code> and <code>environment</code> for
|
|
17
17
|
* tag keys, and <code>admin</code> and <code>test</code> for tag values, all subscriptions
|
|
18
18
|
* that have any combination of those values are returned.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>If both tag keys and values are omitted from the request, subscriptions are
|
|
20
20
|
* returned regardless of whether they have tag keys or values associated with
|
|
21
21
|
* them.</p>
|
|
22
22
|
* @example
|
|
@@ -10,12 +10,12 @@ export interface DescribeHsmClientCertificatesCommandOutput extends HsmClientCer
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns information about the specified HSM client certificate. If no certificate
|
|
12
12
|
* ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns
|
|
14
14
|
* all HSM client certificates that match any combination of the specified keys and values.
|
|
15
15
|
* For example, if you have <code>owner</code> and <code>environment</code> for tag keys,
|
|
16
16
|
* and <code>admin</code> and <code>test</code> for tag values, all HSM client certificates
|
|
17
17
|
* that have any combination of those values are returned.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>If both tag keys and values are omitted from the request, HSM client certificates
|
|
19
19
|
* are returned regardless of whether they have tag keys or values associated with
|
|
20
20
|
* them.</p>
|
|
21
21
|
* @example
|
|
@@ -11,12 +11,12 @@ export interface DescribeHsmConfigurationsCommandOutput extends HsmConfiguration
|
|
|
11
11
|
* <p>Returns information about the specified Amazon Redshift HSM configuration. If no
|
|
12
12
|
* configuration ID is specified, returns information about all the HSM configurations
|
|
13
13
|
* owned by your Amazon Web Services account.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns
|
|
15
15
|
* all HSM connections that match any combination of the specified keys and values. For
|
|
16
16
|
* example, if you have <code>owner</code> and <code>environment</code> for tag keys, and
|
|
17
17
|
* <code>admin</code> and <code>test</code> for tag values, all HSM connections that
|
|
18
18
|
* have any combination of those values are returned.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>If both tag keys and values are omitted from the request, HSM connections are
|
|
20
20
|
* returned regardless of whether they have tag keys or values associated with
|
|
21
21
|
* them.</p>
|
|
22
22
|
* @example
|
|
@@ -14,7 +14,7 @@ export interface DescribeReservedNodeOfferingsCommandOutput extends ReservedNode
|
|
|
14
14
|
* determine which reserve node offering you want to purchase. You then use the unique
|
|
15
15
|
* offering ID in you call to <a>PurchaseReservedNodeOffering</a> to reserve one
|
|
16
16
|
* or more nodes for your Amazon Redshift cluster. </p>
|
|
17
|
-
*
|
|
17
|
+
* <p>
|
|
18
18
|
* For more information about reserved node offerings, go to
|
|
19
19
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a>
|
|
20
20
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
@@ -13,7 +13,7 @@ export interface DescribeResizeCommandOutput extends ResizeProgressMessage, __Me
|
|
|
13
13
|
* no resize operation has ever been initiated for the specified cluster, a <code>HTTP
|
|
14
14
|
* 404</code> error is returned. If a resize operation was initiated and completed, the
|
|
15
15
|
* status of the resize remains as <code>SUCCEEDED</code> until the next resize. </p>
|
|
16
|
-
*
|
|
16
|
+
* <p>A resize operation can be requested using <a>ModifyCluster</a> and
|
|
17
17
|
* specifying a different number or type of nodes for the cluster. </p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,7 +10,7 @@ export interface DescribeSnapshotCopyGrantsCommandOutput extends SnapshotCopyGra
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination
|
|
12
12
|
* region.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>
|
|
14
14
|
* For more information about managing snapshot copy grants, go to
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a>
|
|
16
16
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.
|
|
@@ -11,27 +11,27 @@ export interface DescribeTagsCommandOutput extends TaggedResourceListMessage, __
|
|
|
11
11
|
* <p>Returns a list of tags. You can return tags from a specific resource by specifying
|
|
12
12
|
* an ARN, or you can return all tags for a given type of resource, such as clusters,
|
|
13
13
|
* snapshots, and so on.</p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <p>The following are limitations for <code>DescribeTags</code>: </p>
|
|
15
|
+
* <ul>
|
|
16
16
|
* <li>
|
|
17
|
-
*
|
|
17
|
+
* <p>You cannot specify an ARN and a resource-type value together in the same
|
|
18
18
|
* request.</p>
|
|
19
19
|
* </li>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>You cannot use the <code>MaxRecords</code> and <code>Marker</code>
|
|
22
22
|
* parameters together with the ARN parameter.</p>
|
|
23
23
|
* </li>
|
|
24
24
|
* <li>
|
|
25
|
-
*
|
|
25
|
+
* <p>The <code>MaxRecords</code> parameter can be a range from 10 to 50 results
|
|
26
26
|
* to return in a request.</p>
|
|
27
27
|
* </li>
|
|
28
28
|
* </ul>
|
|
29
|
-
*
|
|
29
|
+
* <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns
|
|
30
30
|
* all resources that match any combination of the specified keys and values. For example,
|
|
31
31
|
* if you have <code>owner</code> and <code>environment</code> for tag keys, and
|
|
32
32
|
* <code>admin</code> and <code>test</code> for tag values, all resources that have any
|
|
33
33
|
* combination of those values are returned.</p>
|
|
34
|
-
*
|
|
34
|
+
* <p>If both tag keys and values are omitted from the request, resources are returned
|
|
35
35
|
* regardless of whether they have tag keys or values associated with them.</p>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,7 +10,7 @@ export interface DescribeUsageLimitsCommandOutput extends UsageLimitList, __Meta
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Shows usage limits on a cluster.
|
|
12
12
|
* Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:</p>
|
|
13
|
-
*
|
|
13
|
+
* <ul>
|
|
14
14
|
* <li>
|
|
15
15
|
* <p>If usage limit identifier, cluster identifier, and feature type are not provided,
|
|
16
16
|
* then all usage limit objects for the current account in the current region are returned.</p>
|
|
@@ -10,7 +10,7 @@ export interface DisableSnapshotCopyCommandOutput extends DisableSnapshotCopyRes
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Disables the automatic copying of snapshots from one region to another region for a
|
|
12
12
|
* specified cluster.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>If your cluster and its snapshots are encrypted using an encrypted symmetric key
|
|
14
14
|
* from Key Management Service, use <a>DeleteSnapshotCopyGrant</a> to delete the grant that
|
|
15
15
|
* grants Amazon Redshift permission to the key in the destination region. </p>
|
|
16
16
|
* @example
|
|
@@ -18,17 +18,17 @@ export interface GetClusterCredentialsCommandOutput extends ClusterCredentials,
|
|
|
18
18
|
* a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more
|
|
19
19
|
* information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html">Using IAM Authentication
|
|
20
20
|
* to Generate Database User Credentials</a> in the Amazon Redshift Cluster Management Guide.</p>
|
|
21
|
-
*
|
|
21
|
+
* <p>The Identity and Access Management (IAM) user or role that runs
|
|
22
22
|
* GetClusterCredentials must have an IAM policy attached that allows access to all
|
|
23
23
|
* necessary actions and resources. For more information about permissions, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources">Resource Policies for GetClusterCredentials</a> in the
|
|
24
24
|
* Amazon Redshift Cluster Management Guide.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>If the <code>DbGroups</code> parameter is specified, the IAM policy must allow the
|
|
26
26
|
* <code>redshift:JoinGroup</code> action with access to the listed
|
|
27
27
|
* <code>dbgroups</code>. </p>
|
|
28
|
-
*
|
|
28
|
+
* <p>In addition, if the <code>AutoCreate</code> parameter is set to <code>True</code>,
|
|
29
29
|
* then the policy must include the <code>redshift:CreateClusterUser</code>
|
|
30
30
|
* permission.</p>
|
|
31
|
-
*
|
|
31
|
+
* <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access
|
|
32
32
|
* to the resource <code>dbname</code> for the specified database name. </p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -14,7 +14,7 @@ export interface GetClusterCredentialsWithIAMCommandOutput extends ClusterExtend
|
|
|
14
14
|
* The database user is mapped 1:1 to the source Identity and Access Management (IAM) identity.
|
|
15
15
|
* For more information about IAM identities, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html">IAM Identities (users, user groups, and roles)</a> in the
|
|
16
16
|
* Amazon Web Services Identity and Access Management User Guide.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>The Identity and Access Management (IAM) identity that runs
|
|
18
18
|
* this operation must have an IAM policy attached that allows access to all
|
|
19
19
|
* necessary actions and resources.
|
|
20
20
|
* For more information about permissions, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using identity-based policies (IAM policies)</a> in the
|
|
@@ -9,10 +9,10 @@ export interface ModifyClusterCommandOutput extends ModifyClusterResult, __Metad
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Modifies the settings for a cluster.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You can also change node type and the number of nodes to scale up or down the
|
|
13
13
|
* cluster. When resizing a cluster, you must specify both the number of nodes and the node
|
|
14
14
|
* type even if one of the parameters does not change.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>You can add another security or
|
|
16
16
|
* parameter group, or change the admin 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.
|
|
17
17
|
* For more information about managing clusters, go to
|
|
18
18
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a>
|
|
@@ -10,7 +10,7 @@ export interface ModifyClusterIamRolesCommandOutput extends ModifyClusterIamRole
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Modifies the list of Identity and Access Management (IAM) roles that can be
|
|
12
12
|
* used by the cluster to access other Amazon Web Services services.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>The maximum number of IAM roles that you can associate is subject to a quota.
|
|
14
14
|
* For more information, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Quotas and limits</a>
|
|
15
15
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|
|
16
16
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface ModifyClusterParameterGroupCommandOutput extends ClusterParamet
|
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
12
|
* <p>Modifies the parameters of a parameter group. For the parameters parameter, it can't contain ASCII characters.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>
|
|
14
14
|
* For more information about parameters and parameter groups, go to
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a>
|
|
16
16
|
* in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
|