@aws-sdk/client-redshift-data 3.936.0 → 3.939.0

package/dist-types/commands/ListSchemasCommand.d.ts

@@ -27,43 +27,7 @@ declare const ListSchemasCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Lists the schemas in a database.
- *       A token is returned to page through the schema list.
- *       Depending on the authorization method, use one of the
- *       following combinations of request parameters: </p>
- *          <ul>
- *             <li>
- *                <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
- *                                     stored in Secrets Manager which has <code>username</code> and <code>password</code>.
- *                                     The specified secret contains credentials
- *                                     to connect to the <code>database</code> you specify.
- *                                     When you are connecting to a cluster, you also supply the database name,
- *                                     If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
- *                                     When you are connecting to a serverless workgroup, you also supply the database name.</p>
- *             </li>
- *             <li>
- *                <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
- *                <ul>
- *                   <li>
- *                      <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
- *                                         The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>.
- *                                         Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
- *                   </li>
- *                   <li>
- *                      <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
- *                                         The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>.
- *                                         Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
- *                   </li>
- *                   <li>
- *                      <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
- *                                         Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
- *                   </li>
- *                </ul>
- *             </li>
- *          </ul>
- *          <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
- *        <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
- *        <i>Amazon Redshift Management Guide</i>. </p>
+ * <p>Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -109,6 +73,9 @@ declare const ListSchemasCommand_base: {
  * @throws {@link QueryTimeoutException} (client fault)
  *  <p>The Amazon Redshift Data API operation failed due to timeout.</p>
  *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
  *

package/dist-types/commands/ListStatementsCommand.d.ts

@@ -27,16 +27,7 @@ declare const ListStatementsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>List of SQL statements. By default, only finished statements are shown.
- *         A token is returned to page through the statement list. </p>
- *          <p>When you use identity-enhanced role sessions to list statements, you must provide either the
- *      <code>cluster-identifier</code> or <code>workgroup-name</code> parameter. This ensures that the IdC user
- *      can only access the Amazon Redshift IdC applications they are assigned. For more information, see
- *        <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html">
- *          Trusted identity propagation overview</a>.</p>
- *          <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
- *        <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
- *        <i>Amazon Redshift Management Guide</i>. </p>
+ * <p>List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list. </p> <p>When you use identity-enhanced role sessions to list statements, you must provide either the <code>cluster-identifier</code> or <code>workgroup-name</code> parameter. This ensures that the IdC user can only access the Amazon Redshift IdC applications they are assigned. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html"> Trusted identity propagation overview</a>.</p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -95,6 +86,9 @@ declare const ListStatementsCommand_base: {
  * @throws {@link InternalServerException} (server fault)
  *  <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
  *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
  *

package/dist-types/commands/ListTablesCommand.d.ts

@@ -27,44 +27,7 @@ declare const ListTablesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>List the tables in a database. If neither <code>SchemaPattern</code> nor <code>TablePattern</code> are specified, then
- *        all tables in the database are returned.
- *       A token is returned to page through the table list.
- *       Depending on the authorization method, use one of the
- *       following combinations of request parameters: </p>
- *          <ul>
- *             <li>
- *                <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret
- *                                     stored in Secrets Manager which has <code>username</code> and <code>password</code>.
- *                                     The specified secret contains credentials
- *                                     to connect to the <code>database</code> you specify.
- *                                     When you are connecting to a cluster, you also supply the database name,
- *                                     If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret.
- *                                     When you are connecting to a serverless workgroup, you also supply the database name.</p>
- *             </li>
- *             <li>
- *                <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p>
- *                <ul>
- *                   <li>
- *                      <p>When connecting to a serverless workgroup, specify the workgroup name and database name.
- *                                         The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>.
- *                                         Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p>
- *                   </li>
- *                   <li>
- *                      <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name.
- *                                         The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>.
- *                                         Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p>
- *                   </li>
- *                   <li>
- *                      <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name.
- *                                         Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p>
- *                   </li>
- *                </ul>
- *             </li>
- *          </ul>
- *          <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
- *        <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
- *        <i>Amazon Redshift Management Guide</i>. </p>
+ * <p>List the tables in a database. If neither <code>SchemaPattern</code> nor <code>TablePattern</code> are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters: </p> <ul> <li> <p>Secrets Manager - when connecting to a cluster, provide the <code>secret-arn</code> of a secret stored in Secrets Manager which has <code>username</code> and <code>password</code>. The specified secret contains credentials to connect to the <code>database</code> you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (<code>dbClusterIdentifier</code>), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.</p> </li> <li> <p>Temporary credentials - when connecting to your data warehouse, choose one of the following options:</p> <ul> <li> <p>When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift-serverless:GetCredentials</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, <code>arn:iam::123456789012:user:foo</code> has the database user name <code>IAM:foo</code>. Also, permission to call the <code>redshift:GetClusterCredentialsWithIAM</code> operation is required.</p> </li> <li> <p>When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the <code>redshift:GetClusterCredentials</code> operation is required.</p> </li> </ul> </li> </ul> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -115,6 +78,9 @@ declare const ListTablesCommand_base: {
  * @throws {@link QueryTimeoutException} (client fault)
  *  <p>The Amazon Redshift Data API operation failed due to timeout.</p>
  *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
  *

package/dist-types/index.d.ts

@@ -1,9 +1,5 @@
 /**
- * <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You
- *       can run SQL statements, which are committed if the statement succeeds. </p>
- *          <p>For more information about the Amazon Redshift Data API and CLI usage examples, see
- *        <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the
- *        <i>Amazon Redshift Management Guide</i>. </p>
+ * <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
  *
  * @packageDocumentation
  */
@@ -14,6 +10,7 @@ export type { RuntimeExtension } from "./runtimeExtensions";
 export type { RedshiftDataExtensionConfiguration } from "./extensionConfiguration";
 export * from "./commands";
 export * from "./pagination";
+export * from "./models/enums";
 export * from "./models/errors";
 export type * from "./models/models_0";
 export { RedshiftDataServiceException } from "./models/RedshiftDataServiceException";

package/dist-types/models/enums.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const ResultFormatString: {
+    readonly CSV: "CSV";
+    readonly JSON: "JSON";
+};
+/**
+ * @public
+ */
+export type ResultFormatString = (typeof ResultFormatString)[keyof typeof ResultFormatString];
+/**
+ * @public
+ * @enum
+ */
+export declare const StatusString: {
+    readonly ABORTED: "ABORTED";
+    readonly ALL: "ALL";
+    readonly FAILED: "FAILED";
+    readonly FINISHED: "FINISHED";
+    readonly PICKED: "PICKED";
+    readonly STARTED: "STARTED";
+    readonly SUBMITTED: "SUBMITTED";
+};
+/**
+ * @public
+ */
+export type StatusString = (typeof StatusString)[keyof typeof StatusString];
+/**
+ * @public
+ * @enum
+ */
+export declare const StatementStatusString: {
+    readonly ABORTED: "ABORTED";
+    readonly FAILED: "FAILED";
+    readonly FINISHED: "FINISHED";
+    readonly PICKED: "PICKED";
+    readonly STARTED: "STARTED";
+    readonly SUBMITTED: "SUBMITTED";
+};
+/**
+ * @public
+ */
+export type StatementStatusString = (typeof StatementStatusString)[keyof typeof StatementStatusString];

package/dist-types/models/errors.d.ts

@@ -61,6 +61,28 @@ export declare class InternalServerException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
+/**
+ * <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
+ * @public
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * <p>The exception message.</p>
+     * @public
+     */
+    Message: string | undefined;
+    /**
+     * <p>Resource identifier associated with the exception.</p>
+     * @public
+     */
+    ResourceId: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
 /**
  * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
  * @public
@@ -91,28 +113,6 @@ export declare class DatabaseConnectionException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<DatabaseConnectionException, __BaseException>);
 }
-/**
- * <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
- * @public
- */
-export declare class ResourceNotFoundException extends __BaseException {
-    readonly name: "ResourceNotFoundException";
-    readonly $fault: "client";
-    /**
-     * <p>The exception message.</p>
-     * @public
-     */
-    Message: string | undefined;
-    /**
-     * <p>Resource identifier associated with the exception.</p>
-     * @public
-     */
-    ResourceId: string | undefined;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
-}
 /**
  * <p>The Amazon Redshift Data API operation failed due to timeout.</p>
  * @public