Class GetAutoTestConfigurationCommand

Retrieve an AutoTest configuration

Example

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

import { Apiv2Client, GetAutoTestConfigurationCommand } from "@codegrade/apiv2-client"; // ES Modules import
// const { Apiv2Client, GetAutoTestConfigurationCommand } = require("@codegrade/apiv2-client"); // CommonJS import
const client = new Apiv2Client(config);
const input = { // GetAutoTestConfigurationRequest
  assignmentId: "STRING_VALUE", // required
};
const command = new GetAutoTestConfigurationCommand(input);
const response = await client.send(command);
// { // GetAutoTestConfigurationResponse
//   configuration: { // AutoTestConfiguration
//     assignmentId: "STRING_VALUE", // required
//     setup: { // AutoTestSetupConfigurationOutput
//       metadata: { // AutoTestSetupMetadata
//         baseImageId: "STRING_VALUE",
//       },
//       steps: [ // AutoTestSetupStepsOutput // required
//         { // AutoTestSetupStepOutput Union: only one key present
//           installDotnet: { // AutoTestInstallDotnetStepOutput
//             id: "STRING_VALUE", // required
//             version: "8.0" || "9.0" || "6.0" || "7.0", // required
//           },
//           installJava: { // AutoTestInstallJavaStepOutput
//             id: "STRING_VALUE", // required
//             version: "8" || "11" || "17" || "21", // required
//           },
//           installPython: { // AutoTestInstallPythonStepOutput
//             id: "STRING_VALUE", // required
//             version: "3.12" || "3.11" || "3.10" || "pypy3.10 - 7.3.12", // required
//           },
//           installNode: { // AutoTestInstallNodeStepOutput
//             id: "STRING_VALUE", // required
//             version: "14" || "16" || "18", // required
//           },
//           uploadFiles: { // AutoTestUploadFilesStepOutput
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: { // AutoTestDescription
//               value: "STRING_VALUE", // required
//               behavior: "collapse" || "uncollapse" || "uncollapse-on-fail", // required
//             },
//             files: [ // AutoTestUploadedFilesOutput // required
//               { // AutoTestUploadedFileOutput
//                 id: "STRING_VALUE", // required
//                 path: "STRING_VALUE", // required
//                 size: Number("int"), // required
//                 url: "STRING_VALUE", // required
//               },
//             ],
//           },
//           installClang: { // AutoTestInstallClangStepOutput
//             id: "STRING_VALUE", // required
//             version: "12" || "16", // required
//           },
//           installGcc: { // AutoTestInstallGccStepOutput
//             id: "STRING_VALUE", // required
//             version: "9" || "10" || "13", // required
//           },
//           script: { // AutoTestScriptStepOutput
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: {
//               value: "STRING_VALUE", // required
//               behavior: "collapse" || "uncollapse" || "uncollapse-on-fail", // required
//             },
//             script: "STRING_VALUE", // required
//           },
//         },
//       ],
//     },
//     test: { // AutoTestTestConfigurationOutput
//       steps: [ // AutoTestTestStepsOutput // required
//         { // AutoTestTestStepOutput Union: only one key present
//           testHide: { // AutoTestTestHideStepOutput
//             id: "STRING_VALUE", // required
//             children: [ // required
//               {//  Union: only one key present
//                 testHide: {
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   hideType: "result" || "config" || "output", // required
//                   preposition: "always" || "before" || "after", // required
//                   when: "deadline" || "lockdate", // required
//                 },
//                 runIn: { // AutoTestRunInStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   environment: "everywhere" || "code-editor" || "auto-test", // required
//                 },
//                 runIf: { // AutoTestRunIfStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   condition: { // AutoTestRunIfCondition
//                     type: "rubric-percentage-met" || "rubric-percentage-not-met", // required
//                     rubricRowId: Number("int"),
//                     minimumPercentage: Number("int"), // required
//                   },
//                 },
//                 allowInternet: { // AutoTestAllowInternetStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                 },
//                 connectRubric: { // AutoTestConnectRubricStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   rubricRowId: Number("int"),
//                 },
//                 weight: { // AutoTestWeightStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   weight: { // Fraction
//                     numerator: Number("int"), // required
//                     denominator: Number("int"), // required
//                   },
//                 },
//                 checkstyle: { // AutoTestCheckstyleStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: {
//                     value: "STRING_VALUE", // required
//                     behavior: "collapse" || "uncollapse" || "uncollapse-on-fail", // required
//                   },
//                   config: "STRING_VALUE", // required
//                   files: "STRING_VALUE", // required
//                   version: "9.3" || "10.12.3", // required
//                   deductions: { // AutoTestDeductions
//                     error: Number("int"), // required
//                     warning: Number("int"), // required
//                     info: Number("int"), // required
//                   },
//                 },
//                 javaCompile: { // AutoTestJavaCompileStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: {
//                     value: "STRING_VALUE", // required
//                     behavior: "collapse" || "uncollapse" || "uncollapse-on-fail", // required
//                   },
//                   path: "STRING_VALUE", // required
//                 },
//                 junit5: { // AutoTestJunit5StepOutput
//                   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: { // AutoTestJunit5TestFile
//                     name: "STRING_VALUE", // required
//                     content: "STRING_VALUE", // required
//                   },
//                 },
//                 customTest: { // AutoTestCustomTestStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   script: "STRING_VALUE", // required
//                 },
//                 testTimeoutEach: { // AutoTestTestTimeoutEachStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   timeout: Number("int"),
//                 },
//                 flake8: { // AutoTestFlake8StepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   config: "STRING_VALUE", // required
//                   file: "STRING_VALUE", // required
//                   version: "6.0.0", // required
//                   deductions: {
//                     error: Number("int"), // required
//                     warning: Number("int"), // required
//                     info: Number("int"), // required
//                   },
//                 },
//                 pytest: { // AutoTestPytestStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   script: "STRING_VALUE", // required
//                   version: "8.3.3" || "7.4.4" || "7.3.1", // required
//                 },
//                 simplePythonTest: { // AutoTestSimplePythonTestStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   script: "STRING_VALUE", // required
//                 },
//                 jupyterNotebook: { // AutoTestJupyterNotebookStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   kernel: "Python 3", // required
//                   python3KernelVersion: "6.29.5", // required
//                   templateFile: {
//                     id: "STRING_VALUE", // required
//                     path: "STRING_VALUE", // required
//                     size: Number("int"), // required
//                     url: "STRING_VALUE", // required
//                   },
//                   runPermission: "enabled" || "disabled", // required
//                 },
//                 runInNotebook: { // AutoTestRunInNotebookStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   insertMethod: "append-to-notebook" || "prepend-to-notebook" || "after-cell" || "before-cell",
//                   targetCellId: "STRING_VALUE",
//                   cellContent: "STRING_VALUE", // required
//                 },
//                 output: { // AutoTestOutputStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   toUpload: "STRING_VALUE", // required
//                 },
//                 testUploadFiles: { // AutoTestTestUploadFilesStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   files: [ // required
//                     "<AutoTestUploadedFileOutput>",
//                   ],
//                 },
//                 snapshot: { // AutoTestSnapshotStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                 },
//                 ioTest: { // AutoTestIoTestStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   script: "STRING_VALUE", // required
//                 },
//                 simpleMatch: { // AutoTestSimpleMatchStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   inputText: "STRING_VALUE", // required
//                   outputText: "STRING_VALUE", // required
//                   caseSensitivity: "sensitive" || "insensitive", // required
//                   whitespacesPolicy: "include" || "ignore", // required
//                 },
//                 regexMatch: { // AutoTestRegexMatchStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   inputText: "STRING_VALUE", // required
//                   outputText: "STRING_VALUE", // required
//                   caseSensitivity: "sensitive" || "insensitive", // required
//                   whitespacesPolicy: "include" || "ignore", // required
//                 },
//                 substringMatch: { // AutoTestSubstringMatchStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   inputText: "STRING_VALUE", // required
//                   outputText: "STRING_VALUE", // required
//                   caseSensitivity: "sensitive" || "insensitive", // required
//                   whitespacesPolicy: "include" || "ignore", // required
//                 },
//                 codeStructureTest: { // AutoTestCodeStructureTestStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   file: "STRING_VALUE", // required
//                   version: "1.43.0", // required
//                 },
//                 negativeMatch: { // AutoTestNegativeMatchStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   rules: "STRING_VALUE", // required
//                 },
//                 positiveMatch: { // AutoTestPositiveMatchStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   rules: "STRING_VALUE", // required
//                 },
//                 quiz: { // AutoTestQuizStepOutput
//                   id: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   fileName: "STRING_VALUE", // required
//                   runSingleQuestions: true || false,
//                 },
//                 codingQuestion: { // AutoTestCodingQuestionStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   studentFileName: "STRING_VALUE", // required
//                   question: "STRING_VALUE", // required
//                   starterCode: "STRING_VALUE", // required
//                 },
//                 promptEngineeringQuestion: { // AutoTestPromptEngineeringQuestionStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   children: "<AutoTestTestStepsOutput>", // required
//                   answerFilename: "STRING_VALUE", // required
//                   answerLanguage: "STRING_VALUE", // required
//                   question: "STRING_VALUE", // required
//                   systemPrompt: "STRING_VALUE", // required
//                 },
//                 mcq: { // AutoTestMcqStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   question: "STRING_VALUE", // required
//                   answerOrder: "index-order" || "random-order",
//                   answers: [ // AutoTestMcqAnswers // required
//                     { // AutoTestMcqAnswersValue
//                       id: "STRING_VALUE", // required
//                       answer: "STRING_VALUE", // required
//                       hint: "STRING_VALUE",
//                     },
//                   ],
//                   correctAnswer: "STRING_VALUE",
//                 },
//                 selectAllQuestion: { // AutoTestSelectAllQuestionStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   question: "STRING_VALUE", // required
//                   answerOrder: "index-order" || "random-order",
//                   answers: [ // AutoTestSelectAllQuestionAnswers // required
//                     { // AutoTestSelectAllQuestionAnswersValue
//                       id: "STRING_VALUE", // required
//                       answer: "STRING_VALUE", // required
//                       isCorrect: true || false, // required
//                       hints: { // AutoTestSelectAllQuestionAnswersValueHints
//                         correct: "STRING_VALUE", // required
//                         incorrect: "STRING_VALUE", // required
//                       },
//                     },
//                   ],
//                 },
//                 program: { // AutoTestProgramStepOutput
//                   id: "STRING_VALUE", // required
//                   name: "STRING_VALUE", // required
//                   description: "<AutoTestDescription>", // required
//                   script: "STRING_VALUE", // required
//                 },
//               },
//             ],
//             hideType: "result" || "config" || "output", // required
//             preposition: "always" || "before" || "after", // required
//             when: "deadline" || "lockdate", // required
//           },
//           runIn: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//             environment: "everywhere" || "code-editor" || "auto-test", // required
//           },
//           runIf: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//             condition: {
//               type: "rubric-percentage-met" || "rubric-percentage-not-met", // required
//               rubricRowId: Number("int"),
//               minimumPercentage: Number("int"), // required
//             },
//           },
//           allowInternet: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//           },
//           connectRubric: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//             rubricRowId: Number("int"),
//           },
//           weight: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//             weight: {
//               numerator: Number("int"), // required
//               denominator: Number("int"), // required
//             },
//           },
//           checkstyle: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             config: "STRING_VALUE", // required
//             files: "STRING_VALUE", // required
//             version: "9.3" || "10.12.3", // required
//             deductions: {
//               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: "STRING_VALUE", // required
//           },
//           junit5: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             version: "1.10.0" || "1.8.2", // required
//             testFile: {
//               name: "STRING_VALUE", // required
//               content: "STRING_VALUE", // required
//             },
//           },
//           customTest: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             script: "STRING_VALUE", // required
//           },
//           testTimeoutEach: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//             timeout: Number("int"),
//           },
//           flake8: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             config: "STRING_VALUE", // required
//             file: "STRING_VALUE", // required
//             version: "6.0.0", // required
//             deductions: {
//               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: "STRING_VALUE", // 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: "STRING_VALUE", // required
//           },
//           jupyterNotebook: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//             kernel: "Python 3", // required
//             python3KernelVersion: "6.29.5", // required
//             templateFile: "<AutoTestUploadedFileOutput>",
//             runPermission: "enabled" || "disabled", // required
//           },
//           runInNotebook: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             insertMethod: "append-to-notebook" || "prepend-to-notebook" || "after-cell" || "before-cell",
//             targetCellId: "STRING_VALUE",
//             cellContent: "STRING_VALUE", // required
//           },
//           output: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             toUpload: "STRING_VALUE", // required
//           },
//           testUploadFiles: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             files: [ // required
//               "<AutoTestUploadedFileOutput>",
//             ],
//           },
//           snapshot: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//           },
//           ioTest: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//             script: "STRING_VALUE", // required
//           },
//           simpleMatch: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             inputText: "STRING_VALUE", // required
//             outputText: "STRING_VALUE", // required
//             caseSensitivity: "sensitive" || "insensitive", // required
//             whitespacesPolicy: "include" || "ignore", // required
//           },
//           regexMatch: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             inputText: "STRING_VALUE", // required
//             outputText: "STRING_VALUE", // required
//             caseSensitivity: "sensitive" || "insensitive", // required
//             whitespacesPolicy: "include" || "ignore", // required
//           },
//           substringMatch: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             inputText: "STRING_VALUE", // required
//             outputText: "STRING_VALUE", // required
//             caseSensitivity: "sensitive" || "insensitive", // required
//             whitespacesPolicy: "include" || "ignore", // required
//           },
//           codeStructureTest: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//             file: "STRING_VALUE", // required
//             version: "1.43.0", // required
//           },
//           negativeMatch: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             rules: "STRING_VALUE", // required
//           },
//           positiveMatch: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             rules: "STRING_VALUE", // required
//           },
//           quiz: {
//             id: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//             fileName: "STRING_VALUE", // required
//             runSingleQuestions: true || false,
//           },
//           codingQuestion: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // required
//             studentFileName: "STRING_VALUE", // required
//             question: "STRING_VALUE", // required
//             starterCode: "STRING_VALUE", // required
//           },
//           promptEngineeringQuestion: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             children: "<AutoTestTestStepsOutput>", // 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: "STRING_VALUE",
//               },
//             ],
//             correctAnswer: "STRING_VALUE",
//           },
//           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: true || false, // required
//                 hints: {
//                   correct: "STRING_VALUE", // required
//                   incorrect: "STRING_VALUE", // required
//                 },
//               },
//             ],
//           },
//           program: {
//             id: "STRING_VALUE", // required
//             name: "STRING_VALUE", // required
//             description: "<AutoTestDescription>", // required
//             script: "STRING_VALUE", // required
//           },
//         },
//       ],
//     },
//     publishedSnapshot: { // AutoTestPublishedSnapshotId Union: only one key present
//       unpublished: {},
//       published: "STRING_VALUE",
//     },
//   },
// };

Param: GetAutoTestConfigurationCommandInput

GetAutoTestConfigurationCommandInput

Returns

GetAutoTestConfigurationCommandOutput

See

GetAutoTestConfigurationCommandInput for command's input shape.
GetAutoTestConfigurationCommandOutput 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<
    GetAutoTestConfigurationCommandInput,
    GetAutoTestConfigurationCommandOutput,
    Apiv2ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetAutoTestConfigurationCommand

Index

Constructors

constructor

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

Properties

`Readonly`input

input: GetAutoTestConfigurationCommandInput

`Readonly`middlewareStack

middlewareStack: MiddlewareStack<
GetAutoTestConfigurationCommandInput,
GetAutoTestConfigurationCommandOutput,
>

`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: GetAutoTestConfigurationRequest;
        output: GetAutoTestConfigurationResponse;
    };
    sdk: {
        input: GetAutoTestConfigurationCommandInput;
        output: GetAutoTestConfigurationCommandOutput;
    };
}

type navigation helper, not in runtime.

Methods

resolveMiddleware

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

resolveMiddlewareWithContext

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

`Static`getEndpointParameterInstructions

getEndpointParameterInstructions(): EndpointParameterInstructions
Returns EndpointParameterInstructions
Inherited from $Command.classBuilder<GetAutoTestConfigurationCommandInput, GetAutoTestConfigurationCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "GetAutoTestConfiguration", { }) .n("Apiv2Client", "GetAutoTestConfigurationCommand") .f(void 0, void 0) .ser(se_GetAutoTestConfigurationCommand) .de(de_GetAutoTestConfigurationCommand) .build().getEndpointParameterInstructions

Class GetAutoTestConfigurationCommand

Example

Param: GetAutoTestConfigurationCommandInput

Returns

See

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GetAutoTestConfigurationCommand

Parameters

Returns GetAutoTestConfigurationCommand

Properties

`Readonly`input

`Readonly`middlewareStack

`Optional` `Readonly`schema

`Protected` `Static` `Internal`__types

Methods

resolveMiddleware

Parameters

Returns Handler<
GetAutoTestConfigurationCommandInput,
GetAutoTestConfigurationCommandOutput,
>

resolveMiddlewareWithContext

Parameters

Returns InitializeHandler<any, GetAutoTestConfigurationCommandOutput>

`Static`getEndpointParameterInstructions

Returns EndpointParameterInstructions

Settings

On This Page

Class GetAutoTestConfigurationCommand

Example

Param: GetAutoTestConfigurationCommandInput

Returns

See

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GetAutoTestConfigurationCommand

Parameters

Returns GetAutoTestConfigurationCommand

Properties

Readonlyinput

ReadonlymiddlewareStack

Optional Readonlyschema

Protected Static Internal__types

Methods

resolveMiddleware

Parameters

Returns Handler< GetAutoTestConfigurationCommandInput, GetAutoTestConfigurationCommandOutput,>

resolveMiddlewareWithContext

Parameters

Returns InitializeHandler<any, GetAutoTestConfigurationCommandOutput>

StaticgetEndpointParameterInstructions

Returns EndpointParameterInstructions

Settings

On This Page

`Readonly`input

`Readonly`middlewareStack

`Optional` `Readonly`schema

`Protected` `Static` `Internal`__types

Returns Handler<
GetAutoTestConfigurationCommandInput,
GetAutoTestConfigurationCommandOutput,
>

`Static`getEndpointParameterInstructions