import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetAnalysisTemplateInput, GetAnalysisTemplateOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetAnalysisTemplateCommand}. */ export interface GetAnalysisTemplateCommandInput extends GetAnalysisTemplateInput { } /** * @public * * The output of {@link GetAnalysisTemplateCommand}. */ export interface GetAnalysisTemplateCommandOutput extends GetAnalysisTemplateOutput, __MetadataBearer { } declare const GetAnalysisTemplateCommand_base: { new (input: GetAnalysisTemplateCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetAnalysisTemplateCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Retrieves an analysis template.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CleanRoomsClient, GetAnalysisTemplateCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import * // const { CleanRoomsClient, GetAnalysisTemplateCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import * // import type { CleanRoomsClientConfig } from "@aws-sdk/client-cleanrooms"; * const config = {}; // type is CleanRoomsClientConfig * const client = new CleanRoomsClient(config); * const input = { // GetAnalysisTemplateInput * membershipIdentifier: "STRING_VALUE", // required * analysisTemplateIdentifier: "STRING_VALUE", // required * }; * const command = new GetAnalysisTemplateCommand(input); * const response = await client.send(command); * // { // GetAnalysisTemplateOutput * // analysisTemplate: { // AnalysisTemplate * // id: "STRING_VALUE", // required * // arn: "STRING_VALUE", // required * // collaborationId: "STRING_VALUE", // required * // collaborationArn: "STRING_VALUE", // required * // membershipId: "STRING_VALUE", // required * // membershipArn: "STRING_VALUE", // required * // description: "STRING_VALUE", * // name: "STRING_VALUE", // required * // createTime: new Date("TIMESTAMP"), // required * // updateTime: new Date("TIMESTAMP"), // required * // schema: { // AnalysisSchema * // referencedTables: [ // QueryTables * // "STRING_VALUE", * // ], * // }, * // format: "SQL" || "PYSPARK_1_0", // required * // source: { // AnalysisSource Union: only one key present * // text: "STRING_VALUE", * // artifacts: { // AnalysisTemplateArtifacts * // entryPoint: { // AnalysisTemplateArtifact * // location: { // S3Location * // bucket: "STRING_VALUE", // required * // key: "STRING_VALUE", // required * // }, * // }, * // additionalArtifacts: [ // AnalysisTemplateArtifactList * // { * // location: { * // bucket: "STRING_VALUE", // required * // key: "STRING_VALUE", // required * // }, * // }, * // ], * // roleArn: "STRING_VALUE", // required * // }, * // }, * // sourceMetadata: { // AnalysisSourceMetadata Union: only one key present * // artifacts: { // AnalysisTemplateArtifactMetadata * // entryPointHash: { // Hash * // sha256: "STRING_VALUE", * // }, * // additionalArtifactHashes: [ // HashList * // { * // sha256: "STRING_VALUE", * // }, * // ], * // }, * // }, * // analysisParameters: [ // AnalysisParameterList * // { // AnalysisParameter * // name: "STRING_VALUE", // required * // type: "SMALLINT" || "INTEGER" || "BIGINT" || "DECIMAL" || "REAL" || "DOUBLE_PRECISION" || "BOOLEAN" || "CHAR" || "VARCHAR" || "DATE" || "TIMESTAMP" || "TIMESTAMPTZ" || "TIME" || "TIMETZ" || "VARBYTE" || "BINARY" || "BYTE" || "CHARACTER" || "DOUBLE" || "FLOAT" || "INT" || "LONG" || "NUMERIC" || "SHORT" || "STRING" || "TIMESTAMP_LTZ" || "TIMESTAMP_NTZ" || "TINYINT", // required * // defaultValue: "STRING_VALUE", * // }, * // ], * // validations: [ // AnalysisTemplateValidationStatusDetailList * // { // AnalysisTemplateValidationStatusDetail * // type: "DIFFERENTIAL_PRIVACY", // required * // status: "VALID" || "INVALID" || "UNABLE_TO_VALIDATE", // required * // reasons: [ // AnalysisTemplateValidationStatusReasonList * // { // AnalysisTemplateValidationStatusReason * // message: "STRING_VALUE", // required * // }, * // ], * // }, * // ], * // errorMessageConfiguration: { // ErrorMessageConfiguration * // type: "DETAILED", // required * // }, * // syntheticDataParameters: { // SyntheticDataParameters Union: only one key present * // mlSyntheticDataParameters: { // MLSyntheticDataParameters * // epsilon: Number("double"), // required * // maxMembershipInferenceAttackScore: Number("double"), // required * // columnClassification: { // ColumnClassificationDetails * // columnMapping: [ // ColumnMappingList // required * // { // SyntheticDataColumnProperties * // columnName: "STRING_VALUE", // required * // columnType: "CATEGORICAL" || "NUMERICAL", // required * // isPredictiveValue: true || false, // required * // }, * // ], * // }, * // }, * // }, * // }, * // }; * * ``` * * @param GetAnalysisTemplateCommandInput - {@link GetAnalysisTemplateCommandInput} * @returns {@link GetAnalysisTemplateCommandOutput} * @see {@link GetAnalysisTemplateCommandInput} for command's `input` shape. * @see {@link GetAnalysisTemplateCommandOutput} for command's `response` shape. * @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Caller does not have sufficient access to perform this action.

* * @throws {@link InternalServerException} (server fault) *

Unexpected error during processing of request.

* * @throws {@link ResourceNotFoundException} (client fault) *

Request references a resource which does not exist.

* * @throws {@link ThrottlingException} (client fault) *

Request was denied due to request throttling.

* * @throws {@link ValidationException} (client fault) *

The input fails to satisfy the specified constraints.

* * @throws {@link CleanRoomsServiceException} *

Base exception class for all service exceptions from CleanRooms service.

* * * @public */ export declare class GetAnalysisTemplateCommand extends GetAnalysisTemplateCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetAnalysisTemplateInput; output: GetAnalysisTemplateOutput; }; sdk: { input: GetAnalysisTemplateCommandInput; output: GetAnalysisTemplateCommandOutput; }; }; }