Class PutEditorFileCommand

Create a new item in the editor session file tree. No operation is done if the file or directory already exists

Example

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

import { Apiv2Client, PutEditorFileCommand } from "@codegrade/apiv2-client"; // ES Modules import
// const { Apiv2Client, PutEditorFileCommand } = require("@codegrade/apiv2-client"); // CommonJS import
const client = new Apiv2Client(config);
const input = { // PutEditorFileRequest
  editorSessionId: "STRING_VALUE", // required
  path: "STRING_VALUE", // required
  fileType: { // InputFileType Union: only one key present
    directory: {},
    regular: { // InputRegularFileType
      content: "STRING_VALUE",
    },
  },
};
const command = new PutEditorFileCommand(input);
const response = await client.send(command);
// { // PutEditorFileResponse
//   file: { // OutputEditorFile
//     editorSessionId: "STRING_VALUE", // required
//     path: "STRING_VALUE", // required
//     assignmentId: "STRING_VALUE", // required
//     fileType: { // EditorFileType Union: only one key present
//       directory: { // OutputEditorDirectoryType
//         children: [ // EditorFileList // required
//           {//  Union: only one key present
//             directory: {
//               children: [ // required
//                 "<EditorFileType>",
//               ],
//             },
//             regular: { // OuptutRegularFileType Union: only one key present
//               text: { // OutputRegularTextFileType
//                 documentId: "STRING_VALUE", // required
//               },
//               binary: {},
//               quiz: { // OutputRegularQuizFileType
//                 documentId: "STRING_VALUE", // required
//               },
//               notebook: { // OutputJupyterNotebookFileType
//                 documentId: "STRING_VALUE", // required
//               },
//             },
//           },
//         ],
//       },
//       regular: {//  Union: only one key present
//         text: {
//           documentId: "STRING_VALUE", // required
//         },
//         binary: {},
//         quiz: {
//           documentId: "STRING_VALUE", // required
//         },
//         notebook: {
//           documentId: "STRING_VALUE", // required
//         },
//       },
//     },
//   },
// };

Param: PutEditorFileCommandInput

PutEditorFileCommandInput

Returns

PutEditorFileCommandOutput

See

PutEditorFileCommandInput for command's input shape.
PutEditorFileCommandOutput 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<
    PutEditorFileCommandInput,
    PutEditorFileCommandOutput,
    Apiv2ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- PutEditorFileCommand

Index

Constructors

constructor

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

Properties

`Readonly`input

input: PutEditorFileCommandInput

`Readonly`middlewareStack

middlewareStack: MiddlewareStack<
PutEditorFileCommandInput,
PutEditorFileCommandOutput,
>

`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: PutEditorFileRequest; output: PutEditorFileResponse };
    sdk: {
        input: PutEditorFileCommandInput;
        output: PutEditorFileCommandOutput;
    };
}

type navigation helper, not in runtime.

Methods

resolveMiddleware

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

resolveMiddlewareWithContext

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

`Static`getEndpointParameterInstructions

getEndpointParameterInstructions(): EndpointParameterInstructions
Returns EndpointParameterInstructions
Inherited from $Command.classBuilder<PutEditorFileCommandInput, PutEditorFileCommandOutput, Apiv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>() .m(function (this: any, Command: any, cs: any, config: Apiv2ClientResolvedConfig, o: any) { return [ getSerdePlugin(config, this.serialize, this.deserialize), ]; }) .s("Apiv2", "PutEditorFile", { }) .n("Apiv2Client", "PutEditorFileCommand") .f(void 0, void 0) .ser(se_PutEditorFileCommand) .de(de_PutEditorFileCommand) .build().getEndpointParameterInstructions

Class PutEditorFileCommand

Example

Param: PutEditorFileCommandInput

Returns

See

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PutEditorFileCommand

Parameters

Returns PutEditorFileCommand

Properties

`Readonly`input

`Readonly`middlewareStack

`Optional` `Readonly`schema

`Protected` `Static` `Internal`__types

Methods

resolveMiddleware

Parameters

Returns Handler<PutEditorFileCommandInput, PutEditorFileCommandOutput>

resolveMiddlewareWithContext

Parameters

Returns InitializeHandler<any, PutEditorFileCommandOutput>

`Static`getEndpointParameterInstructions

Returns EndpointParameterInstructions

Settings

On This Page

Class PutEditorFileCommand

Example

Param: PutEditorFileCommandInput

Returns

See

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PutEditorFileCommand

Parameters

Returns PutEditorFileCommand

Properties

Readonlyinput

ReadonlymiddlewareStack

Optional Readonlyschema

Protected Static Internal__types

Methods

resolveMiddleware

Parameters

Returns Handler<PutEditorFileCommandInput, PutEditorFileCommandOutput>

resolveMiddlewareWithContext

Parameters

Returns InitializeHandler<any, PutEditorFileCommandOutput>

StaticgetEndpointParameterInstructions

Returns EndpointParameterInstructions

Settings

On This Page

`Readonly`input

`Readonly`middlewareStack

`Optional` `Readonly`schema

`Protected` `Static` `Internal`__types

`Static`getEndpointParameterInstructions