Class GetEditorSessionCommand

Returns a single editor session.

Example

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

import { Apiv2Client, GetEditorSessionCommand } from "@codegrade/apiv2-client"; // ES Modules import
// const { Apiv2Client, GetEditorSessionCommand } = require("@codegrade/apiv2-client"); // CommonJS import
const client = new Apiv2Client(config);
const input = { // GetEditorSessionRequest
  editorSessionId: "STRING_VALUE", // required
};
const command = new GetEditorSessionCommand(input);
const response = await client.send(command);
// { // GetEditorSessionResponse
//   editorSession: { // EditorSession
//     editorSessionId: "STRING_VALUE", // required
//     owner: "STRING_VALUE", // required
//     assignmentId: "STRING_VALUE", // required
//     name: "STRING_VALUE", // required
//     createdAt: new Date("TIMESTAMP"), // required
//     updatedAt: new Date("TIMESTAMP"), // required
//     fileTreeId: "STRING_VALUE", // required
//   },
// };

Param: GetEditorSessionCommandInput

GetEditorSessionCommandInput

Returns

GetEditorSessionCommandOutput

See

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

Constructors

constructor

Properties

input middlewareStack schema? __types

Methods

resolveMiddleware resolveMiddlewareWithContext getEndpointParameterInstructions

Constructors

constructor

  • new GetEditorSessionCommand(
        input: GetEditorSessionCommandInput,
    ): GetEditorSessionCommand

    Parameters

    Returns GetEditorSessionCommand

  • new GetEditorSessionCommand(
        ...__namedParameters: [GetEditorSessionCommandInput],
    ): GetEditorSessionCommand

    Parameters

    Returns GetEditorSessionCommand

Properties

Readonlyinput

input: GetEditorSessionCommandInput

ReadonlymiddlewareStack

middlewareStack: MiddlewareStack<
    GetEditorSessionCommandInput,
    GetEditorSessionCommandOutput,
>

Optional Readonlyschema

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: GetEditorSessionRequest;
        output: GetEditorSessionResponse;
    };
    sdk: {
        input: GetEditorSessionCommandInput;
        output: GetEditorSessionCommandOutput;
    };
}

type navigation helper, not in runtime.

Methods

resolveMiddleware

resolveMiddlewareWithContext

  • resolveMiddlewareWithContext(
        clientStack: MiddlewareStack<any, any>,
        configuration: {
            logger: Logger;
            requestHandler: RequestHandler<any, any, any>;
        },
        options: any,
        __namedParameters: ResolveMiddlewareContextArgs,
    ): InitializeHandler<any, GetEditorSessionCommandOutput>
    Internal

    Parameters

    • clientStack: MiddlewareStack<any, any>
    • configuration: { logger: Logger; requestHandler: RequestHandler<any, any, any> }
    • options: any
    • __namedParameters: ResolveMiddlewareContextArgs

    Returns InitializeHandler<any, GetEditorSessionCommandOutput>

StaticgetEndpointParameterInstructions

  • getEndpointParameterInstructions(): EndpointParameterInstructions

    Returns EndpointParameterInstructions

Settings

Member Visibility

On This Page

Constructors
Properties
Methods