GetCollaborationAnalysisTemplateCommand

Suggest an Edit

Retrieves an analysis template within a collaboration.

Example Syntax

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

import { CleanRoomsClient, GetCollaborationAnalysisTemplateCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
// const { CleanRoomsClient, GetCollaborationAnalysisTemplateCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
const client = new CleanRoomsClient(config);
const input = { // GetCollaborationAnalysisTemplateInput
  collaborationIdentifier: "STRING_VALUE", // required
  analysisTemplateArn: "STRING_VALUE", // required
};
const command = new GetCollaborationAnalysisTemplateCommand(input);
const response = await client.send(command);
// { // GetCollaborationAnalysisTemplateOutput
//   collaborationAnalysisTemplate: { // CollaborationAnalysisTemplate
//     id: "STRING_VALUE", // required
//     arn: "STRING_VALUE", // required
//     collaborationId: "STRING_VALUE", // required
//     collaborationArn: "STRING_VALUE", // required
//     description: "STRING_VALUE",
//     creatorAccountId: "STRING_VALUE", // required
//     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
//           },
//         ],
//       },
//     ],
//   },
// };

GetCollaborationAnalysisTemplateCommand Input

See GetCollaborationAnalysisTemplateCommandInput for more details

Parameter
Type
Description
analysisTemplateArn
Required
string | undefined

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

collaborationIdentifier
Required
string | undefined

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

GetCollaborationAnalysisTemplateCommand Output

See GetCollaborationAnalysisTemplateCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
collaborationAnalysisTemplate
Required
CollaborationAnalysisTemplate | undefined

The analysis template within a collaboration.

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.