Class GetAutoTestPublishedSnapshotCommand

Get the published snapshot of an AutoTest configuration.

Example

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

import { Apiv2Client, GetAutoTestPublishedSnapshotCommand } from "@codegrade/apiv2-client"; // ES Modules import
// const { Apiv2Client, GetAutoTestPublishedSnapshotCommand } = require("@codegrade/apiv2-client"); // CommonJS import
const client = new Apiv2Client(config);
const input = { // GetAutoTestPublishedSnapshotRequest
  assignmentId: "STRING_VALUE", // required
};
const command = new GetAutoTestPublishedSnapshotCommand(input);
const response = await client.send(command);
// { // GetAutoTestPublishedSnapshotResponse
//   snapshot: { // AutoTestPublishedSnapshot
//     assignmentId: "STRING_VALUE", // required
//     snapshotId: "STRING_VALUE", // required
//     createdAt: new Date("TIMESTAMP"), // required
//     test: { // AutoTestRedactedTestConfigurationOutput
//       steps: [ // AutoTestRedactedTestStepsOutput // required
//         { // AutoTestRedactedTestStepOutput Union: only one key present
//           testHide: { // AutoTestRedactedTestHideStepOutput
//             id: "STRING_VALUE", // required
//             children: [ // required
//               {//  Union: only one key present
//                 testHide: {
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   hideType: "result" || "config" || "output", // required
//                   preposition: "always" || "before" || "after", // required
//                   when: "deadline" || "lockdate", // required
//                 },
//                 runIn: { // AutoTestRedactedRunInStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   environment: "everywhere" || "code-editor" || "auto-test", // required
//                 },
//                 runIf: { // AutoTestRedactedRunIfStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   condition: { // AutoTestRedactedRunIfCondition Union: only one key present
//                     redacted: {},
//                     unredacted: { // AutoTestRunIfCondition
//                       type: "rubric-percentage-met" || "rubric-percentage-not-met", // required
//                       rubricRowId: Number("int"),
//                       minimumPercentage: Number("int"), // required
//                     },
//                   },
//                 },
//                 allowInternet: { // AutoTestRedactedAllowInternetStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                 },
//                 connectRubric: { // AutoTestRedactedConnectRubricStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   rubricRowId: { // AutoTestRedactedInteger Union: only one key present
//                     redacted: {},
//                     unredacted: Number("int"),
//                   },
//                 },
//                 weight: { // AutoTestRedactedWeightStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   weight: { // AutoTestRedactedFraction Union: only one key present
//                     redacted: {},
//                     unredacted: { // Fraction
//                       numerator: Number("int"), // required
//                       denominator: Number("int"), // required
//                     },
//                   },
//                 },
//                 checkstyle: { // AutoTestRedactedCheckstyleStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: { // AutoTestDescription
//                     value: "STRING_VALUE", // required
//                     behavior: "collapse" || "uncollapse" || "uncollapse-on-fail", // required
//                   },
//                   config: { // AutoTestRedactedString Union: only one key present
//                     redacted: {},
//                     unredacted: "STRING_VALUE",
//                   },
//                   files: {//  Union: only one key present
//                     redacted: {},
//                     unredacted: "STRING_VALUE",
//                   },
//                   version: { // AutoTestRedactedCheckstyleVersion Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "9.3" || "10.12.3",
//                   },
//                   deductions: { // AutoTestRedactedDeductions Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: { // AutoTestDeductions
//                       error: Number("int"), // required
//                       warning: Number("int"), // required
//                       info: Number("int"), // required
//                     },
//                   },
//                 },
//                 javaCompile: { // AutoTestRedactedJavaCompileStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: {
//                     value: "STRING_VALUE", // required
//                     behavior: "collapse" || "uncollapse" || "uncollapse-on-fail", // required
//                   },
//                   path: {//  Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "STRING_VALUE",
//                   },
//                 },
//                 junit5: { // AutoTestRedactedJunit5StepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: {
//                     value: "STRING_VALUE", // required
//                     behavior: "collapse" || "uncollapse" || "uncollapse-on-fail", // required
//                   },
//                   version: "1.10.0" || "1.8.2", // required
//                   testFile: { // AutoTestRedactedJunit5TestFile Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: { // AutoTestJunit5TestFile
//                       name: "STRING_VALUE", // required
//                       content: "STRING_VALUE", // required
//                     },
//                   },
//                 },
//                 customTest: { // AutoTestRedactedCustomTestStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: {
//                     value: "STRING_VALUE", // required
//                     behavior: "collapse" || "uncollapse" || "uncollapse-on-fail", // required
//                   },
//                   script: {//  Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "STRING_VALUE",
//                   },
//                 },
//                 testTimeoutEach: { // AutoTestRedactedTestTimeoutEachStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   timeout: { // AutoTestRedactedPositiveDuration Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: Number("int"),
//                   },
//                 },
//                 flake8: { // AutoTestRedactedFlake8StepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: {
//                     value: "STRING_VALUE", // required
//                     behavior: "collapse" || "uncollapse" || "uncollapse-on-fail", // required
//                   },
//                   config: {//  Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "STRING_VALUE",
//                   },
//                   file: "<AutoTestRedactedString>", // required
//                   version: { // AutoTestRedactedFlake8Version Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "6.0.0",
//                   },
//                   deductions: {//  Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: {
//                       error: Number("int"), // required
//                       warning: Number("int"), // required
//                       info: Number("int"), // required
//                     },
//                   },
//                 },
//                 pytest: { // AutoTestRedactedPytestStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   script: "<AutoTestRedactedString>", // required
//                   version: "8.3.3" || "7.4.4" || "7.3.1", // required
//                 },
//                 simplePythonTest: { // AutoTestRedactedSimplePythonTestStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   script: "<AutoTestRedactedString>", // required
//                 },
//                 jupyterNotebook: { // AutoTestRedactedJupyterNotebookStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   kernel: "Python 3", // required
//                   python3KernelVersion: "6.29.5", // required
//                   templateFile: { // AutoTestPartialUploadedFileOutput
//                     id: "STRING_VALUE", // required
//                     path: "STRING_VALUE", // required
//                     size: Number("int"), // required
//                   },
//                   runPermission: "enabled" || "disabled", // required
//                 },
//                 runInNotebook: { // AutoTestRedactedRunInNotebookStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   insertMethod: { // AutoTestRedactedRunInNotebookInsertMethod Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "append-to-notebook" || "prepend-to-notebook" || "after-cell" || "before-cell",
//                   },
//                   targetCellId: "<AutoTestRedactedString>",
//                   cellContent: "<AutoTestRedactedString>", // required
//                 },
//                 output: { // AutoTestRedactedOutputStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   toUpload: "<AutoTestRedactedString>", // required
//                 },
//                 testUploadFiles: { // AutoTestRedactedTestUploadFilesStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   files: { // AutoTestRedactedUploadedFilesOutput Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: [ // AutoTestPartialUploadedFilesOutput
//                       {
//                         id: "STRING_VALUE", // required
//                         path: "STRING_VALUE", // required
//                         size: Number("int"), // required
//                       },
//                     ],
//                   },
//                 },
//                 snapshot: { // AutoTestRedactedSnapshotStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                 },
//                 ioTest: { // AutoTestRedactedIoTestStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   script: "<AutoTestRedactedString>", // required
//                 },
//                 simpleMatch: { // AutoTestRedactedSimpleMatchStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   inputText: "<AutoTestRedactedString>", // required
//                   outputText: "<AutoTestRedactedString>", // required
//                   caseSensitivity: { // AutoTestRedactedCaseSensitivity Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "sensitive" || "insensitive",
//                   },
//                   whitespacesPolicy: { // AutoTestRedactedWhitespacesPolicy Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "include" || "ignore",
//                   },
//                 },
//                 regexMatch: { // AutoTestRedactedRegexMatchStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   inputText: "<AutoTestRedactedString>", // required
//                   outputText: "<AutoTestRedactedString>", // required
//                   caseSensitivity: {//  Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "sensitive" || "insensitive",
//                   },
//                   whitespacesPolicy: {//  Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "include" || "ignore",
//                   },
//                 },
//                 substringMatch: { // AutoTestRedactedSubstringMatchStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   inputText: "<AutoTestRedactedString>", // required
//                   outputText: "<AutoTestRedactedString>", // required
//                   caseSensitivity: {//  Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "sensitive" || "insensitive",
//                   },
//                   whitespacesPolicy: {//  Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "include" || "ignore",
//                   },
//                 },
//                 codeStructureTest: { // AutoTestRedactedCodeStructureTestStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   file: "<AutoTestRedactedString>", // required
//                   version: { // AutoTestRedactedCodeStructureTestVersion Union: only one key present
//                     redacted: "<Unit>",
//                     unredacted: "1.43.0",
//                   },
//                 },
//                 negativeMatch: { // AutoTestRedactedNegativeMatchStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   rules: "<AutoTestRedactedString>", // required
//                 },
//                 positiveMatch: { // AutoTestRedactedPositiveMatchStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   rules: "<AutoTestRedactedString>", // required
//                 },
//                 quiz: { // AutoTestRedactedQuizStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   fileName: "STRING_VALUE", // required
//                   runSingleQuestions: true || false,
//                 },
//                 codingQuestion: { // AutoTestRedactedCodingQuestionStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   studentFileName: "STRING_VALUE", // required
//                   question: "STRING_VALUE", // required
//                   starterCode: "STRING_VALUE", // required
//                 },
//                 promptEngineeringQuestion: { // AutoTestRedactedPromptEngineeringQuestionStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   children: "<AutoTestRedactedTestStepsOutput>", // required
//                   answerFilename: "STRING_VALUE", // required
//                   answerLanguage: "STRING_VALUE", // required
//                   question: "STRING_VALUE", // required
//                   systemPrompt: "STRING_VALUE", // required
//                 },
//                 mcq: { // AutoTestRedactedMcqStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   question: "STRING_VALUE", // required
//                   answerOrder: "index-order" || "random-order",
//                   answers: [ // AutoTestRedactedMcqAnswers // required
//                     { // AutoTestRedactedMcqAnswersValue
//                       id: "STRING_VALUE", // required
//                       answer: "STRING_VALUE", // required
//                       hint: "<AutoTestRedactedString>",
//                     },
//                   ],
//                   correctAnswer: "<AutoTestRedactedString>",
//                 },
//                 selectAllQuestion: { // AutoTestRedactedSelectAllQuestionStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   question: "STRING_VALUE", // required
//                   answerOrder: "index-order" || "random-order",
//                   answers: [ // AutoTestRedactedSelectAllQuestionAnswers // required
//                     { // AutoTestRedactedSelectAllQuestionAnswersValue
//                       id: "STRING_VALUE", // required
//                       answer: "STRING_VALUE", // required
//                       isCorrect: { // AutoTestRedactedBoolean Union: only one key present
//                         redacted: "<Unit>",
//                         unredacted: true || false,
//                       },
//                       hints: { // AutoTestRedactedSelectAllQuestionAnswersValueHints Union: only one key present
//                         redacted: "<Unit>",
//                         unredacted: { // AutoTestSelectAllQuestionAnswersValueHints
//                           correct: "STRING_VALUE", // required
//                           incorrect: "STRING_VALUE", // required
//                         },
//                       },
//                     },
//                   ],
//                 },
//                 program: { // AutoTestRedactedProgramStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   script: "<AutoTestRedactedString>", // required
//                 },
//               },
//             ],
//             hideType: "result" || "config" || "output", // required
//             preposition: "always" || "before" || "after", // required
//             when: "deadline" || "lockdate", // required
//           },
//           runIn: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             environment: "everywhere" || "code-editor" || "auto-test", // required
//           },
//           runIf: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             condition: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: {
//                 type: "rubric-percentage-met" || "rubric-percentage-not-met", // required
//                 rubricRowId: Number("int"),
//                 minimumPercentage: Number("int"), // required
//               },
//             },
//           },
//           allowInternet: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//           },
//           connectRubric: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             rubricRowId: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: Number("int"),
//             },
//           },
//           weight: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             weight: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: {
//                 numerator: Number("int"), // required
//                 denominator: Number("int"), // required
//               },
//             },
//           },
//           checkstyle: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             config: "<AutoTestRedactedString>", // required
//             files: "<AutoTestRedactedString>", // required
//             version: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: "9.3" || "10.12.3",
//             },
//             deductions: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: {
//                 error: Number("int"), // required
//                 warning: Number("int"), // required
//                 info: Number("int"), // required
//               },
//             },
//           },
//           javaCompile: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             path: "<AutoTestRedactedString>", // required
//           },
//           junit5: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             version: "1.10.0" || "1.8.2", // required
//             testFile: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: {
//                 name: "STRING_VALUE", // required
//                 content: "STRING_VALUE", // required
//               },
//             },
//           },
//           customTest: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             script: "<AutoTestRedactedString>", // required
//           },
//           testTimeoutEach: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             timeout: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: Number("int"),
//             },
//           },
//           flake8: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             config: "<AutoTestRedactedString>", // required
//             file: "<AutoTestRedactedString>", // required
//             version: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: "6.0.0",
//             },
//             deductions: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: {
//                 error: Number("int"), // required
//                 warning: Number("int"), // required
//                 info: Number("int"), // required
//               },
//             },
//           },
//           pytest: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             script: "<AutoTestRedactedString>", // required
//             version: "8.3.3" || "7.4.4" || "7.3.1", // required
//           },
//           simplePythonTest: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             script: "<AutoTestRedactedString>", // required
//           },
//           jupyterNotebook: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             kernel: "Python 3", // required
//             python3KernelVersion: "6.29.5", // required
//             templateFile: "<AutoTestPartialUploadedFileOutput>",
//             runPermission: "enabled" || "disabled", // required
//           },
//           runInNotebook: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             insertMethod: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: "append-to-notebook" || "prepend-to-notebook" || "after-cell" || "before-cell",
//             },
//             targetCellId: "<AutoTestRedactedString>",
//             cellContent: "<AutoTestRedactedString>", // required
//           },
//           output: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             toUpload: "<AutoTestRedactedString>", // required
//           },
//           testUploadFiles: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             files: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: [
//                 "<AutoTestPartialUploadedFileOutput>",
//               ],
//             },
//           },
//           snapshot: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//           },
//           ioTest: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             script: "<AutoTestRedactedString>", // required
//           },
//           simpleMatch: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             inputText: "<AutoTestRedactedString>", // required
//             outputText: "<AutoTestRedactedString>", // required
//             caseSensitivity: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: "sensitive" || "insensitive",
//             },
//             whitespacesPolicy: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: "include" || "ignore",
//             },
//           },
//           regexMatch: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             inputText: "<AutoTestRedactedString>", // required
//             outputText: "<AutoTestRedactedString>", // required
//             caseSensitivity: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: "sensitive" || "insensitive",
//             },
//             whitespacesPolicy: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: "include" || "ignore",
//             },
//           },
//           substringMatch: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             inputText: "<AutoTestRedactedString>", // required
//             outputText: "<AutoTestRedactedString>", // required
//             caseSensitivity: "<AutoTestRedactedCaseSensitivity>", // required
//             whitespacesPolicy: "<AutoTestRedactedWhitespacesPolicy>", // required
//           },
//           codeStructureTest: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             file: "<AutoTestRedactedString>", // required
//             version: {//  Union: only one key present
//               redacted: "<Unit>",
//               unredacted: "1.43.0",
//             },
//           },
//           negativeMatch: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             rules: "<AutoTestRedactedString>", // required
//           },
//           positiveMatch: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             rules: "<AutoTestRedactedString>", // required
//           },
//           quiz: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             fileName: "STRING_VALUE", // required
//             runSingleQuestions: true || false,
//           },
//           codingQuestion: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             studentFileName: "STRING_VALUE", // required
//             question: "STRING_VALUE", // required
//             starterCode: "STRING_VALUE", // required
//           },
//           promptEngineeringQuestion: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             children: "<AutoTestRedactedTestStepsOutput>", // required
//             answerFilename: "STRING_VALUE", // required
//             answerLanguage: "STRING_VALUE", // required
//             question: "STRING_VALUE", // required
//             systemPrompt: "STRING_VALUE", // required
//           },
//           mcq: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             question: "STRING_VALUE", // required
//             answerOrder: "index-order" || "random-order",
//             answers: [ // required
//               {
//                 id: "STRING_VALUE", // required
//                 answer: "STRING_VALUE", // required
//                 hint: "<AutoTestRedactedString>",
//               },
//             ],
//             correctAnswer: "<AutoTestRedactedString>",
//           },
//           selectAllQuestion: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             question: "STRING_VALUE", // required
//             answerOrder: "index-order" || "random-order",
//             answers: [ // required
//               {
//                 id: "STRING_VALUE", // required
//                 answer: "STRING_VALUE", // required
//                 isCorrect: {//  Union: only one key present
//                   redacted: "<Unit>",
//                   unredacted: true || false,
//                 },
//                 hints: {//  Union: only one key present
//                   redacted: "<Unit>",
//                   unredacted: {
//                     correct: "STRING_VALUE", // required
//                     incorrect: "STRING_VALUE", // required
//                   },
//                 },
//               },
//             ],
//           },
//           program: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             script: "<AutoTestRedactedString>", // required
//           },
//         },
//       ],
//     },
//   },
// };

Param: GetAutoTestPublishedSnapshotCommandInput

GetAutoTestPublishedSnapshotCommandInput

Returns

GetAutoTestPublishedSnapshotCommandOutput

See

GetAutoTestPublishedSnapshotCommandInput for command's input shape.
GetAutoTestPublishedSnapshotCommandOutput for command's response shape.
config for Apiv2Client's config shape.

Throws

InternalServerError (server fault) An internal failure at the fault of the server.

Throws

BadRequestError (client fault) An error at the fault of the client sending invalid input.

Throws

NotFoundError (client fault) An error due to the client attempting to access a missing resource.

Throws

NotAuthorizedError (client fault) An error due to the client not being authorized to access the resource.

Throws

NotAuthenticatedError (client fault) An error due to the client not being authenticated.

Throws

ValidationError (client fault) A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

Throws

Apiv2ServiceException

Base exception class for all service exceptions from Apiv2 service.

Hierarchy

CommandImpl<
    GetAutoTestPublishedSnapshotCommandInput,
    GetAutoTestPublishedSnapshotCommandOutput,
    Apiv2ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetAutoTestPublishedSnapshotCommand

Index

Constructors

constructor

new GetAutoTestPublishedSnapshotCommand(
input: GetAutoTestPublishedSnapshotCommandInput,
): GetAutoTestPublishedSnapshotCommand
Parameters
- input: GetAutoTestPublishedSnapshotCommandInput
Returns GetAutoTestPublishedSnapshotCommand
Inherited from $Command.classBuilder<GetAutoTestPublishedSnapshotCommandInput, GetAutoTestPublishedSnapshotCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "GetAutoTestPublishedSnapshot", { }) .n("Apiv2Client", "GetAutoTestPublishedSnapshotCommand") .f(void 0, void 0) .ser(se_GetAutoTestPublishedSnapshotCommand) .de(de_GetAutoTestPublishedSnapshotCommand) .build().constructor
new GetAutoTestPublishedSnapshotCommand(
...__namedParameters: [GetAutoTestPublishedSnapshotCommandInput],
): GetAutoTestPublishedSnapshotCommand
Parameters
- ...__namedParameters: [GetAutoTestPublishedSnapshotCommandInput]
Returns GetAutoTestPublishedSnapshotCommand
Inherited from $Command.classBuilder<GetAutoTestPublishedSnapshotCommandInput, GetAutoTestPublishedSnapshotCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "GetAutoTestPublishedSnapshot", { }) .n("Apiv2Client", "GetAutoTestPublishedSnapshotCommand") .f(void 0, void 0) .ser(se_GetAutoTestPublishedSnapshotCommand) .de(de_GetAutoTestPublishedSnapshotCommand) .build().constructor

Properties

`Readonly`input

input: GetAutoTestPublishedSnapshotCommandInput

`Readonly`middlewareStack

middlewareStack: MiddlewareStack<
GetAutoTestPublishedSnapshotCommandInput,
GetAutoTestPublishedSnapshotCommandOutput,
>

`Optional` `Readonly`schema

schema?: OperationSchema

This should be OperationSchema from @smithy/types, but would create problems with the client transform type adaptors.

`Protected` `Static` `Internal`__types

__types: {
    api: {
        input: GetAutoTestPublishedSnapshotRequest;
        output: GetAutoTestPublishedSnapshotResponse;
    };
    sdk: {
        input: GetAutoTestPublishedSnapshotCommandInput;
        output: GetAutoTestPublishedSnapshotCommandOutput;
    };
}

type navigation helper, not in runtime.

Methods

resolveMiddleware

resolveMiddleware(
    stack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
    configuration: Apiv2ClientResolvedConfig,
    options: any,
): Handler<
    GetAutoTestPublishedSnapshotCommandInput,
    GetAutoTestPublishedSnapshotCommandOutput,
>
Parameters
- stack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>
- configuration: Apiv2ClientResolvedConfig
- options: any
Returns Handler<
GetAutoTestPublishedSnapshotCommandInput,
GetAutoTestPublishedSnapshotCommandOutput,
>
Inherited from $Command.classBuilder<GetAutoTestPublishedSnapshotCommandInput, GetAutoTestPublishedSnapshotCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "GetAutoTestPublishedSnapshot", { }) .n("Apiv2Client", "GetAutoTestPublishedSnapshotCommand") .f(void 0, void 0) .ser(se_GetAutoTestPublishedSnapshotCommand) .de(de_GetAutoTestPublishedSnapshotCommand) .build().resolveMiddleware

resolveMiddlewareWithContext

resolveMiddlewareWithContext(
    clientStack: MiddlewareStack<any, any>,
    configuration: {
        logger: Logger;
        requestHandler: RequestHandler<any, any, any>;
    },
    options: any,
    __namedParameters: ResolveMiddlewareContextArgs,
): InitializeHandler<any, GetAutoTestPublishedSnapshotCommandOutput>
Internal
Parameters
- clientStack: MiddlewareStack<any, any>
- configuration: { logger: Logger; requestHandler: RequestHandler<any, any, any> }
- options: any
- __namedParameters: ResolveMiddlewareContextArgs
Returns InitializeHandler<any, GetAutoTestPublishedSnapshotCommandOutput>
Inherited from $Command.classBuilder<GetAutoTestPublishedSnapshotCommandInput, GetAutoTestPublishedSnapshotCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "GetAutoTestPublishedSnapshot", { }) .n("Apiv2Client", "GetAutoTestPublishedSnapshotCommand") .f(void 0, void 0) .ser(se_GetAutoTestPublishedSnapshotCommand) .de(de_GetAutoTestPublishedSnapshotCommand) .build().resolveMiddlewareWithContext

`Static`getEndpointParameterInstructions

getEndpointParameterInstructions(): EndpointParameterInstructions
Returns EndpointParameterInstructions
Inherited from $Command.classBuilder<GetAutoTestPublishedSnapshotCommandInput, GetAutoTestPublishedSnapshotCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "GetAutoTestPublishedSnapshot", { }) .n("Apiv2Client", "GetAutoTestPublishedSnapshotCommand") .f(void 0, void 0) .ser(se_GetAutoTestPublishedSnapshotCommand) .de(de_GetAutoTestPublishedSnapshotCommand) .build().getEndpointParameterInstructions

Class GetAutoTestPublishedSnapshotCommand

Example

Param: GetAutoTestPublishedSnapshotCommandInput

Returns

See

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GetAutoTestPublishedSnapshotCommand

Parameters

Returns GetAutoTestPublishedSnapshotCommand

Properties

`Readonly`input

`Readonly`middlewareStack

`Optional` `Readonly`schema

`Protected` `Static` `Internal`__types

Methods

resolveMiddleware

Parameters

Returns Handler<
GetAutoTestPublishedSnapshotCommandInput,
GetAutoTestPublishedSnapshotCommandOutput,
>

resolveMiddlewareWithContext

Parameters

Returns InitializeHandler<any, GetAutoTestPublishedSnapshotCommandOutput>

`Static`getEndpointParameterInstructions

Returns EndpointParameterInstructions

Settings

On This Page

Class GetAutoTestPublishedSnapshotCommand

Example

Param: GetAutoTestPublishedSnapshotCommandInput

Returns

See

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GetAutoTestPublishedSnapshotCommand

Parameters

Returns GetAutoTestPublishedSnapshotCommand

Properties

Readonlyinput

ReadonlymiddlewareStack

Optional Readonlyschema

Protected Static Internal__types

Methods

resolveMiddleware

Parameters

Returns Handler< GetAutoTestPublishedSnapshotCommandInput, GetAutoTestPublishedSnapshotCommandOutput,>

resolveMiddlewareWithContext

Parameters

Returns InitializeHandler<any, GetAutoTestPublishedSnapshotCommandOutput>

StaticgetEndpointParameterInstructions

Returns EndpointParameterInstructions

Settings

On This Page

`Readonly`input

`Readonly`middlewareStack

`Optional` `Readonly`schema

`Protected` `Static` `Internal`__types

Returns Handler<
GetAutoTestPublishedSnapshotCommandInput,
GetAutoTestPublishedSnapshotCommandOutput,
>

`Static`getEndpointParameterInstructions