feat(client-redshift-data): This release adds support for ListStatements API to filter statements by ClusterIdentifier, WorkgroupName, and Database.

awstools · awstools · commit 251c015f76be · 2025-03-06T19:16:19.000Z
diff --git a/clients/client-redshift-data/src/commands/ListStatementsCommand.ts b/clients/client-redshift-data/src/commands/ListStatementsCommand.ts
@@ -30,6 +30,11 @@ export interface ListStatementsCommandOutput extends ListStatementsResponse, __M
 /**
  * <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>
@@ -45,6 +50,9 @@ export interface ListStatementsCommandOutput extends ListStatementsResponse, __M
  *   StatementName: "STRING_VALUE",
  *   Status: "STRING_VALUE",
  *   RoleLevel: true || false,
+ *   Database: "STRING_VALUE",
+ *   ClusterIdentifier: "STRING_VALUE",
+ *   WorkgroupName: "STRING_VALUE",
  * };
  * const command = new ListStatementsCommand(input);
  * const response = await client.send(command);
@@ -68,8 +76,8 @@ export interface ListStatementsCommandOutput extends ListStatementsResponse, __M
  * //         },
  * //       ],
  * //       IsBatchStatement: true || false,
- * //       SessionId: "STRING_VALUE",
  * //       ResultFormat: "STRING_VALUE",
+ * //       SessionId: "STRING_VALUE",
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",
diff --git a/clients/client-redshift-data/src/models/models_0.ts b/clients/client-redshift-data/src/models/models_0.ts
@@ -1526,6 +1526,27 @@ export interface ListStatementsRequest {
    * @public
    */
   RoleLevel?: boolean | undefined;
+
+  /**
+   * <p>The name of the database when listing statements run against a <code>ClusterIdentifier</code> or <code>WorkgroupName</code>.
+   *        </p>
+   * @public
+   */
+  Database?: string | undefined;
+
+  /**
+   * <p>The cluster identifier. Only statements that ran on this cluster are returned.
+   *       When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>
+   * @public
+   */
+  ClusterIdentifier?: string | undefined;
+
+  /**
+   * <p>The serverless workgroup name or Amazon Resource Name (ARN). Only statements that ran on this workgroup are returned.
+   *       When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>
+   * @public
+   */
+  WorkgroupName?: string | undefined;
 }
 
 /**
@@ -1596,16 +1617,16 @@ export interface StatementData {
   IsBatchStatement?: boolean | undefined;
 
   /**
-   * <p>The session identifier of the query.</p>
+   * <p>The data format of the result of the SQL statement.</p>
    * @public
    */
-  SessionId?: string | undefined;
+  ResultFormat?: ResultFormatString | undefined;
 
   /**
-   * <p>The data format of the result of the SQL statement.</p>
+   * <p>The session identifier of the query.</p>
    * @public
    */
-  ResultFormat?: ResultFormatString | undefined;
+  SessionId?: string | undefined;
 }
 
 /**
diff --git a/codegen/sdk-codegen/aws-models/redshift-data.json b/codegen/sdk-codegen/aws-models/redshift-data.json
@@ -1444,7 +1444,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>List of SQL statements. By default, only finished statements are shown. \n        A token is returned to page through the statement list. </p>\n         <p>For more information about the Amazon Redshift Data API and CLI usage examples, see \n       <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html\">Using the Amazon Redshift Data API</a> in the \n       <i>Amazon Redshift Management Guide</i>. </p>",
+        "smithy.api#documentation": "<p>List of SQL statements. By default, only finished statements are shown. \n        A token is returned to page through the statement list. </p>\n         <p>When you use identity-enhanced role sessions to list statements, you must provide either the \n     <code>cluster-identifier</code> or <code>workgroup-name</code> parameter. This ensures that the IdC user\n     can only access the Amazon Redshift IdC applications they are assigned. For more information, see \n       <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html\">\n         Trusted identity propagation overview</a>.</p>\n         <p>For more information about the Amazon Redshift Data API and CLI usage examples, see \n       <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html\">Using the Amazon Redshift Data API</a> in the \n       <i>Amazon Redshift Management Guide</i>. </p>",
         "smithy.api#paginated": {
           "inputToken": "NextToken",
           "outputToken": "NextToken",
@@ -1497,6 +1497,24 @@
           "traits": {
             "smithy.api#documentation": "<p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. \n      If false, only statements run by the caller's IAM role in the current IAM session are returned.  The default is true. </p>"
           }
+        },
+        "Database": {
+          "target": "com.amazonaws.redshiftdata#String",
+          "traits": {
+            "smithy.api#documentation": "<p>The name of the database when listing statements run against a <code>ClusterIdentifier</code> or <code>WorkgroupName</code>. \n       </p>"
+          }
+        },
+        "ClusterIdentifier": {
+          "target": "com.amazonaws.redshiftdata#ClusterIdentifierString",
+          "traits": {
+            "smithy.api#documentation": "<p>The cluster identifier. Only statements that ran on this cluster are returned. \n      When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>"
+          }
+        },
+        "WorkgroupName": {
+          "target": "com.amazonaws.redshiftdata#WorkgroupNameString",
+          "traits": {
+            "smithy.api#documentation": "<p>The serverless workgroup name or Amazon Resource Name (ARN). Only statements that ran on this workgroup are returned. \n      When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>"
+          }
         }
       },
       "traits": {
@@ -2556,17 +2574,17 @@
             "smithy.api#documentation": "<p>A value that indicates whether the statement is a batch query request.</p>"
           }
         },
-        "SessionId": {
-          "target": "com.amazonaws.redshiftdata#UUID",
-          "traits": {
-            "smithy.api#documentation": "<p>The session identifier of the query.</p>"
-          }
-        },
         "ResultFormat": {
           "target": "com.amazonaws.redshiftdata#ResultFormatString",
           "traits": {
             "smithy.api#documentation": "<p>The data format of the result of the SQL statement.</p>"
           }
+        },
+        "SessionId": {
+          "target": "com.amazonaws.redshiftdata#UUID",
+          "traits": {
+            "smithy.api#documentation": "<p>The session identifier of the query.</p>"
+          }
         }
       },
       "traits": {
@@ -2811,7 +2829,7 @@
           "min": 3,
           "max": 128
         },
-        "smithy.api#pattern": "^(([a-z0-9-]+)|(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}))$"
+        "smithy.api#pattern": "^(([a-z0-9-]+)|(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov|(-iso[a-z]?))?-[a-z]+-\\d{1}:\\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}))$"
       }
     },
     "com.amazonaws.redshiftdata#bool": {
