feat(client-glue): This release adds additional configurations for Query Session Context on the following APIs: GetUnfilteredTableMetadata, GetUnfilteredPartitionMetadata, GetUnfilteredPartitionsMetadata.

awstools · awstools · commit c1607f62644b · 2023-12-22T19:16:31.000Z
diff --git a/clients/client-glue/src/commands/BatchGetPartitionCommand.ts b/clients/client-glue/src/commands/BatchGetPartitionCommand.ts
@@ -155,6 +155,7 @@ export interface BatchGetPartitionCommandOutput extends BatchGetPartitionRespons
  *  <p>A federation source failed.</p>
  *
  * @throws {@link FederationSourceRetryableException} (client fault)
+ *  <p>A federation source failed, but the operation may be retried.</p>
  *
  * @throws {@link GlueEncryptionException} (client fault)
  *  <p>An encryption operation failed.</p>
diff --git a/clients/client-glue/src/commands/CreateConnectionCommand.ts b/clients/client-glue/src/commands/CreateConnectionCommand.ts
@@ -38,6 +38,7 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
 /**
  * @public
  * <p>Creates a connection definition in the Data Catalog.</p>
+ *          <p>Connections used for creating federated resources require the IAM <code>glue:PassConnection</code> permission.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-glue/src/commands/GetPartitionCommand.ts b/clients/client-glue/src/commands/GetPartitionCommand.ts
@@ -142,6 +142,7 @@ export interface GetPartitionCommandOutput extends GetPartitionResponse, __Metad
  *  <p>A federation source failed.</p>
  *
  * @throws {@link FederationSourceRetryableException} (client fault)
+ *  <p>A federation source failed, but the operation may be retried.</p>
  *
  * @throws {@link GlueEncryptionException} (client fault)
  *  <p>An encryption operation failed.</p>
diff --git a/clients/client-glue/src/commands/GetPartitionsCommand.ts b/clients/client-glue/src/commands/GetPartitionsCommand.ts
@@ -152,6 +152,7 @@ export interface GetPartitionsCommandOutput extends GetPartitionsResponse, __Met
  *  <p>A federation source failed.</p>
  *
  * @throws {@link FederationSourceRetryableException} (client fault)
+ *  <p>A federation source failed, but the operation may be retried.</p>
  *
  * @throws {@link GlueEncryptionException} (client fault)
  *  <p>An encryption operation failed.</p>
diff --git a/clients/client-glue/src/commands/GetTableCommand.ts b/clients/client-glue/src/commands/GetTableCommand.ts
@@ -168,6 +168,7 @@ export interface GetTableCommandOutput extends GetTableResponse, __MetadataBeare
  *  <p>A federation source failed.</p>
  *
  * @throws {@link FederationSourceRetryableException} (client fault)
+ *  <p>A federation source failed, but the operation may be retried.</p>
  *
  * @throws {@link GlueEncryptionException} (client fault)
  *  <p>An encryption operation failed.</p>
diff --git a/clients/client-glue/src/commands/GetTablesCommand.ts b/clients/client-glue/src/commands/GetTablesCommand.ts
@@ -173,6 +173,7 @@ export interface GetTablesCommandOutput extends GetTablesResponse, __MetadataBea
  *  <p>A federation source failed.</p>
  *
  * @throws {@link FederationSourceRetryableException} (client fault)
+ *  <p>A federation source failed, but the operation may be retried.</p>
  *
  * @throws {@link GlueEncryptionException} (client fault)
  *  <p>An encryption operation failed.</p>
diff --git a/clients/client-glue/src/commands/GetUnfilteredPartitionMetadataCommand.ts b/clients/client-glue/src/commands/GetUnfilteredPartitionMetadataCommand.ts
@@ -52,6 +52,7 @@ export interface GetUnfilteredPartitionMetadataCommandOutput
  * // const { GlueClient, GetUnfilteredPartitionMetadataCommand } = require("@aws-sdk/client-glue"); // CommonJS import
  * const client = new GlueClient(config);
  * const input = { // GetUnfilteredPartitionMetadataRequest
+ *   Region: "STRING_VALUE",
  *   CatalogId: "STRING_VALUE", // required
  *   DatabaseName: "STRING_VALUE", // required
  *   TableName: "STRING_VALUE", // required
@@ -68,6 +69,15 @@ export interface GetUnfilteredPartitionMetadataCommandOutput
  *   SupportedPermissionTypes: [ // PermissionTypeList // required
  *     "COLUMN_PERMISSION" || "CELL_FILTER_PERMISSION" || "NESTED_PERMISSION" || "NESTED_CELL_PERMISSION",
  *   ],
+ *   QuerySessionContext: { // QuerySessionContext
+ *     QueryId: "STRING_VALUE",
+ *     QueryStartTime: new Date("TIMESTAMP"),
+ *     ClusterId: "STRING_VALUE",
+ *     QueryAuthorizationId: "STRING_VALUE",
+ *     AdditionalContext: { // AdditionalContextMap
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *   },
  * };
  * const command = new GetUnfilteredPartitionMetadataCommand(input);
  * const response = await client.send(command);
@@ -161,6 +171,7 @@ export interface GetUnfilteredPartitionMetadataCommandOutput
  *  <p>A federation source failed.</p>
  *
  * @throws {@link FederationSourceRetryableException} (client fault)
+ *  <p>A federation source failed, but the operation may be retried.</p>
  *
  * @throws {@link GlueEncryptionException} (client fault)
  *  <p>An encryption operation failed.</p>
diff --git a/clients/client-glue/src/commands/GetUnfilteredPartitionsMetadataCommand.ts b/clients/client-glue/src/commands/GetUnfilteredPartitionsMetadataCommand.ts
@@ -52,6 +52,7 @@ export interface GetUnfilteredPartitionsMetadataCommandOutput
  * // const { GlueClient, GetUnfilteredPartitionsMetadataCommand } = require("@aws-sdk/client-glue"); // CommonJS import
  * const client = new GlueClient(config);
  * const input = { // GetUnfilteredPartitionsMetadataRequest
+ *   Region: "STRING_VALUE",
  *   CatalogId: "STRING_VALUE", // required
  *   DatabaseName: "STRING_VALUE", // required
  *   TableName: "STRING_VALUE", // required
@@ -72,6 +73,15 @@ export interface GetUnfilteredPartitionsMetadataCommandOutput
  *     TotalSegments: Number("int"), // required
  *   },
  *   MaxResults: Number("int"),
+ *   QuerySessionContext: { // QuerySessionContext
+ *     QueryId: "STRING_VALUE",
+ *     QueryStartTime: new Date("TIMESTAMP"),
+ *     ClusterId: "STRING_VALUE",
+ *     QueryAuthorizationId: "STRING_VALUE",
+ *     AdditionalContext: { // AdditionalContextMap
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *   },
  * };
  * const command = new GetUnfilteredPartitionsMetadataCommand(input);
  * const response = await client.send(command);
@@ -170,6 +180,7 @@ export interface GetUnfilteredPartitionsMetadataCommandOutput
  *  <p>A federation source failed.</p>
  *
  * @throws {@link FederationSourceRetryableException} (client fault)
+ *  <p>A federation source failed, but the operation may be retried.</p>
  *
  * @throws {@link GlueEncryptionException} (client fault)
  *  <p>An encryption operation failed.</p>
diff --git a/clients/client-glue/src/commands/GetUnfilteredTableMetadataCommand.ts b/clients/client-glue/src/commands/GetUnfilteredTableMetadataCommand.ts
@@ -47,6 +47,7 @@ export interface GetUnfilteredTableMetadataCommandOutput extends GetUnfilteredTa
  * // const { GlueClient, GetUnfilteredTableMetadataCommand } = require("@aws-sdk/client-glue"); // CommonJS import
  * const client = new GlueClient(config);
  * const input = { // GetUnfilteredTableMetadataRequest
+ *   Region: "STRING_VALUE",
  *   CatalogId: "STRING_VALUE", // required
  *   DatabaseName: "STRING_VALUE", // required
  *   Name: "STRING_VALUE", // required
@@ -60,6 +61,22 @@ export interface GetUnfilteredTableMetadataCommandOutput extends GetUnfilteredTa
  *   SupportedPermissionTypes: [ // PermissionTypeList // required
  *     "COLUMN_PERMISSION" || "CELL_FILTER_PERMISSION" || "NESTED_PERMISSION" || "NESTED_CELL_PERMISSION",
  *   ],
+ *   SupportedDialect: { // SupportedDialect
+ *     Dialect: "REDSHIFT" || "ATHENA" || "SPARK",
+ *     DialectVersion: "STRING_VALUE",
+ *   },
+ *   Permissions: [ // PermissionList
+ *     "ALL" || "SELECT" || "ALTER" || "DROP" || "DELETE" || "INSERT" || "CREATE_DATABASE" || "CREATE_TABLE" || "DATA_LOCATION_ACCESS",
+ *   ],
+ *   QuerySessionContext: { // QuerySessionContext
+ *     QueryId: "STRING_VALUE",
+ *     QueryStartTime: new Date("TIMESTAMP"),
+ *     ClusterId: "STRING_VALUE",
+ *     QueryAuthorizationId: "STRING_VALUE",
+ *     AdditionalContext: { // AdditionalContextMap
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *   },
  * };
  * const command = new GetUnfilteredTableMetadataCommand(input);
  * const response = await client.send(command);
@@ -168,6 +185,11 @@ export interface GetUnfilteredTableMetadataCommandOutput extends GetUnfilteredTa
  * //       RowFilterExpression: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   QueryAuthorizationId: "STRING_VALUE",
+ * //   ResourceArn: "STRING_VALUE",
+ * //   Permissions: [ // PermissionList
+ * //     "ALL" || "SELECT" || "ALTER" || "DROP" || "DELETE" || "INSERT" || "CREATE_DATABASE" || "CREATE_TABLE" || "DATA_LOCATION_ACCESS",
+ * //   ],
  * // };
  *
  * ```
@@ -185,6 +207,7 @@ export interface GetUnfilteredTableMetadataCommandOutput extends GetUnfilteredTa
  *  <p>A federation source failed.</p>
  *
  * @throws {@link FederationSourceRetryableException} (client fault)
+ *  <p>A federation source failed, but the operation may be retried.</p>
  *
  * @throws {@link GlueEncryptionException} (client fault)
  *  <p>An encryption operation failed.</p>
diff --git a/clients/client-glue/src/models/models_0.ts b/clients/client-glue/src/models/models_0.ts
@@ -7034,10 +7034,15 @@ export class FederationSourceException extends __BaseException {
 
 /**
  * @public
+ * <p>A federation source failed, but the operation may be retried.</p>
  */
 export class FederationSourceRetryableException extends __BaseException {
   readonly name: "FederationSourceRetryableException" = "FederationSourceRetryableException";
   readonly $fault: "client" = "client";
+  /**
+   * @public
+   * <p>A message describing the problem.</p>
+   */
   Message?: string;
   /**
    * @internal
diff --git a/clients/client-glue/src/models/models_2.ts b/clients/client-glue/src/models/models_2.ts
@@ -121,6 +121,7 @@ import {
   DataQualityEvaluationRunAdditionalRunOptions,
   DataQualityTargetTable,
   JobBookmarkEntry,
+  Permission,
   PrincipalType,
   RegistryId,
   RegistryStatus,
@@ -902,6 +903,42 @@ export interface GetTriggersResponse {
   NextToken?: string;
 }
 
+/**
+ * @public
+ * <p>A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.</p>
+ */
+export interface QuerySessionContext {
+  /**
+   * @public
+   * <p>A unique identifier generated by the query engine for the query.</p>
+   */
+  QueryId?: string;
+
+  /**
+   * @public
+   * <p>A timestamp provided by the query engine for when the query started.</p>
+   */
+  QueryStartTime?: Date;
+
+  /**
+   * @public
+   * <p>An identifier string for the consumer cluster.</p>
+   */
+  ClusterId?: string;
+
+  /**
+   * @public
+   * <p>A cryptographically generated query identifier generated by Glue or Lake Formation.</p>
+   */
+  QueryAuthorizationId?: string;
+
+  /**
+   * @public
+   * <p>An opaque string-string map passed by the query engine.</p>
+   */
+  AdditionalContext?: Record<string, string>;
+}
+
 /**
  * @public
  * @enum
@@ -922,6 +959,12 @@ export type PermissionType = (typeof PermissionType)[keyof typeof PermissionType
  * @public
  */
 export interface GetUnfilteredPartitionMetadataRequest {
+  /**
+   * @public
+   * <p>Specified only if the base tables belong to a different Amazon Web Services Region.</p>
+   */
+  Region?: string;
+
   /**
    * @public
    * <p>The catalog ID where the partition resides.</p>
@@ -957,6 +1000,12 @@ export interface GetUnfilteredPartitionMetadataRequest {
    * <p>(Required) A list of supported permission types. </p>
    */
   SupportedPermissionTypes: PermissionType[] | undefined;
+
+  /**
+   * @public
+   * <p>A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.</p>
+   */
+  QuerySessionContext?: QuerySessionContext;
 }
 
 /**
@@ -1014,6 +1063,12 @@ export class PermissionTypeMismatchException extends __BaseException {
  * @public
  */
 export interface GetUnfilteredPartitionsMetadataRequest {
+  /**
+   * @public
+   * <p>Specified only if the base tables belong to a different Amazon Web Services Region.</p>
+   */
+  Region?: string;
+
   /**
    * @public
    * <p>The ID of the Data Catalog where the partitions in question reside. If none is provided,
@@ -1168,6 +1223,12 @@ export interface GetUnfilteredPartitionsMetadataRequest {
    * <p>The maximum number of partitions to return in a single response.</p>
    */
   MaxResults?: number;
+
+  /**
+   * @public
+   * <p>A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.</p>
+   */
+  QuerySessionContext?: QuerySessionContext;
 }
 
 /**
@@ -1212,10 +1273,49 @@ export interface GetUnfilteredPartitionsMetadataResponse {
   NextToken?: string;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const ViewDialect = {
+  ATHENA: "ATHENA",
+  REDSHIFT: "REDSHIFT",
+  SPARK: "SPARK",
+} as const;
+
+/**
+ * @public
+ */
+export type ViewDialect = (typeof ViewDialect)[keyof typeof ViewDialect];
+
+/**
+ * @public
+ * <p>A structure specifying the dialect and dialect version used by the query engine.</p>
+ */
+export interface SupportedDialect {
+  /**
+   * @public
+   * <p>The dialect of the query engine.</p>
+   */
+  Dialect?: ViewDialect;
+
+  /**
+   * @public
+   * <p>The version of the dialect of the query engine. For example, 3.0.0.</p>
+   */
+  DialectVersion?: string;
+}
+
 /**
  * @public
  */
 export interface GetUnfilteredTableMetadataRequest {
+  /**
+   * @public
+   * <p>Specified only if the base tables belong to a different Amazon Web Services Region.</p>
+   */
+  Region?: string;
+
   /**
    * @public
    * <p>The catalog ID where the table resides.</p>
@@ -1245,6 +1345,24 @@ export interface GetUnfilteredTableMetadataRequest {
    * <p>(Required) A list of supported permission types. </p>
    */
   SupportedPermissionTypes: PermissionType[] | undefined;
+
+  /**
+   * @public
+   * <p>A structure specifying the dialect and dialect version used by the query engine.</p>
+   */
+  SupportedDialect?: SupportedDialect;
+
+  /**
+   * @public
+   * <p>The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.</p>
+   */
+  Permissions?: Permission[];
+
+  /**
+   * @public
+   * <p>A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.</p>
+   */
+  QuerySessionContext?: QuerySessionContext;
 }
 
 /**
@@ -1293,6 +1411,24 @@ export interface GetUnfilteredTableMetadataResponse {
    * <p>A list of column row filters.</p>
    */
   CellFilters?: ColumnRowFilter[];
+
+  /**
+   * @public
+   * <p>A cryptographically generated query identifier generated by Glue or Lake Formation.</p>
+   */
+  QueryAuthorizationId?: string;
+
+  /**
+   * @public
+   * <p>The resource ARN of the parent resource extracted from the request.</p>
+   */
+  ResourceArn?: string;
+
+  /**
+   * @public
+   * <p>The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.</p>
+   */
+  Permissions?: Permission[];
 }
 
 /**
diff --git a/clients/client-glue/src/protocols/Aws_json1_1.ts b/clients/client-glue/src/protocols/Aws_json1_1.ts
diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json

Original file line number	Diff line number	Diff line change
`@@ -155,6 +155,7 @@ export interface BatchGetPartitionCommandOutput extends BatchGetPartitionRespons`
`155`	`155`	`* <p>A federation source failed.</p>`
`156`	`156`	`*`
`157`	`157`	`* @throws {@link FederationSourceRetryableException} (client fault)`
	`158`	`+ * <p>A federation source failed, but the operation may be retried.</p>`
`158`	`159`	`*`
`159`	`160`	`* @throws {@link GlueEncryptionException} (client fault)`
`160`	`161`	`* <p>An encryption operation failed.</p>`
Original file line number	Diff line number	Diff line change
`@@ -142,6 +142,7 @@ export interface GetPartitionCommandOutput extends GetPartitionResponse, __Metad`
`142`	`142`	`* <p>A federation source failed.</p>`
`143`	`143`	`*`
`144`	`144`	`* @throws {@link FederationSourceRetryableException} (client fault)`
	`145`	`+ * <p>A federation source failed, but the operation may be retried.</p>`
`145`	`146`	`*`
`146`	`147`	`* @throws {@link GlueEncryptionException} (client fault)`
`147`	`148`	`* <p>An encryption operation failed.</p>`
Original file line number	Diff line number	Diff line change
`@@ -152,6 +152,7 @@ export interface GetPartitionsCommandOutput extends GetPartitionsResponse, __Met`
`152`	`152`	`* <p>A federation source failed.</p>`
`153`	`153`	`*`
`154`	`154`	`* @throws {@link FederationSourceRetryableException} (client fault)`
	`155`	`+ * <p>A federation source failed, but the operation may be retried.</p>`
`155`	`156`	`*`
`156`	`157`	`* @throws {@link GlueEncryptionException} (client fault)`
`157`	`158`	`* <p>An encryption operation failed.</p>`
Original file line number	Diff line number	Diff line change
`@@ -168,6 +168,7 @@ export interface GetTableCommandOutput extends GetTableResponse, __MetadataBeare`
`168`	`168`	`* <p>A federation source failed.</p>`
`169`	`169`	`*`
`170`	`170`	`* @throws {@link FederationSourceRetryableException} (client fault)`
	`171`	`+ * <p>A federation source failed, but the operation may be retried.</p>`
`171`	`172`	`*`
`172`	`173`	`* @throws {@link GlueEncryptionException} (client fault)`
`173`	`174`	`* <p>An encryption operation failed.</p>`
Original file line number	Diff line number	Diff line change
`@@ -173,6 +173,7 @@ export interface GetTablesCommandOutput extends GetTablesResponse, __MetadataBea`
`173`	`173`	`* <p>A federation source failed.</p>`
`174`	`174`	`*`
`175`	`175`	`* @throws {@link FederationSourceRetryableException} (client fault)`
	`176`	`+ * <p>A federation source failed, but the operation may be retried.</p>`
`176`	`177`	`*`
`177`	`178`	`* @throws {@link GlueEncryptionException} (client fault)`
`178`	`179`	`* <p>An encryption operation failed.</p>`