GetConfiguredTableCommand

Suggest an Edit

Retrieves a configured table.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CleanRoomsClient, GetConfiguredTableCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
// const { CleanRoomsClient, GetConfiguredTableCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
const client = new CleanRoomsClient(config);
const input = { // GetConfiguredTableInput
  configuredTableIdentifier: "STRING_VALUE", // required
};
const command = new GetConfiguredTableCommand(input);
const response = await client.send(command);
// { // GetConfiguredTableOutput
//   configuredTable: { // ConfiguredTable
//     id: "STRING_VALUE", // required
//     arn: "STRING_VALUE", // required
//     name: "STRING_VALUE", // required
//     description: "STRING_VALUE",
//     tableReference: { // TableReference Union: only one key present
//       glue: { // GlueTableReference
//         tableName: "STRING_VALUE", // required
//         databaseName: "STRING_VALUE", // required
//       },
//       snowflake: { // SnowflakeTableReference
//         secretArn: "STRING_VALUE", // required
//         accountIdentifier: "STRING_VALUE", // required
//         databaseName: "STRING_VALUE", // required
//         tableName: "STRING_VALUE", // required
//         schemaName: "STRING_VALUE", // required
//         tableSchema: { // SnowflakeTableSchema Union: only one key present
//           v1: [ // SnowflakeTableSchemaList
//             { // SnowflakeTableSchemaV1
//               columnName: "STRING_VALUE", // required
//               columnType: "STRING_VALUE", // required
//             },
//           ],
//         },
//       },
//       athena: { // AthenaTableReference
//         workGroup: "STRING_VALUE", // required
//         outputLocation: "STRING_VALUE",
//         databaseName: "STRING_VALUE", // required
//         tableName: "STRING_VALUE", // required
//       },
//     },
//     createTime: new Date("TIMESTAMP"), // required
//     updateTime: new Date("TIMESTAMP"), // required
//     analysisRuleTypes: [ // ConfiguredTableAnalysisRuleTypeList // required
//       "AGGREGATION" || "LIST" || "CUSTOM",
//     ],
//     analysisMethod: "DIRECT_QUERY" || "DIRECT_JOB" || "MULTIPLE", // required
//     allowedColumns: [ // AllowedColumnList // required
//       "STRING_VALUE",
//     ],
//     selectedAnalysisMethods: [ // SelectedAnalysisMethods
//       "DIRECT_QUERY" || "DIRECT_JOB",
//     ],
//   },
// };

GetConfiguredTableCommand Input

See GetConfiguredTableCommandInput for more details

Parameter
Type
Description
configuredTableIdentifier
Required
string | undefined

The unique ID for the configured table to retrieve.

GetConfiguredTableCommand Output

See GetConfiguredTableCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
configuredTable
Required
ConfiguredTable | undefined

The retrieved configured table.

Throws

Name
Fault
Details
AccessDeniedException
client

Caller does not have sufficient access to perform this action.

InternalServerException
server

Unexpected error during processing of request.

ResourceNotFoundException
client

Request references a resource which does not exist.

ThrottlingException
client

Request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the specified constraints.

CleanRoomsServiceException
Base exception class for all service exceptions from CleanRooms service.