Class Apiv2

Index

Constructors

constructor

Properties

config initConfig? middlewareStack

Methods

completeImportAutoTestConfiguration copyAutoTestConfiguration createAssistant createAssistantConversation createAssistantMessage createAutoTestSnapshot createEditorSession createSafeProgram deleteAutoTestConfiguration destroy executeEditorDocumentJupyterCell getAssistant getAssistantConversation getAssistantMessage getAutoTestConfiguration getAutoTestPublishedSnapshot getAutoTestSnapshot getEditorDocument getEditorSession getPearsonContextTemplate getPearsonContextTemplateQuestion handInEditorSession instantiatePearsonTemplate listAssignmentAssistants listAssistantMessages listAutoTestSnapshots listEditorDocumentJupyterCellOutputs listEditorSessions listUserAssistantConversations putAutoTestConfiguration putEditorFile putPearsonBook putPearsonContextTemplate putPearsonQuestion putPearsonTemplate send updateAssistant updateAutoTestConfiguration updatePearsonContextTemplate updatePearsonContextTemplateQuestion

Constructors

constructor

new Apiv2(...__namedParameters: [] | [Apiv2ClientConfig]): Apiv2
Parameters
- ...__namedParameters: [] | [Apiv2ClientConfig]
Returns Apiv2

Properties

`Readonly`config

config: Apiv2ClientResolvedConfig

The resolved configuration of Apiv2Client class. This is resolved and normalized from the constructor configuration interface.

`Optional` `Internal`initConfig

initConfig?: object

Holds an object reference to the initial configuration object. Used to check that the config resolver stack does not create dangling instances of an intermediate form of the configuration object.

middlewareStack

middlewareStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>

Methods

completeImportAutoTestConfiguration

completeImportAutoTestConfiguration(
args: CompleteImportAutoTestConfigurationCommandInput,
options?: HttpHandlerOptions,
): Promise<CompleteImportAutoTestConfigurationCommandOutput>
Parameters
- args: CompleteImportAutoTestConfigurationCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<CompleteImportAutoTestConfigurationCommandOutput>
See
CompleteImportAutoTestConfigurationCommand
completeImportAutoTestConfiguration(
    args: CompleteImportAutoTestConfigurationCommandInput,
    cb: (
        err: any,
        data?: CompleteImportAutoTestConfigurationCommandOutput,
    ) => void,
): void
Parameters
- args: CompleteImportAutoTestConfigurationCommandInput
- cb: (err: any, data?: CompleteImportAutoTestConfigurationCommandOutput) => void
Returns void
completeImportAutoTestConfiguration(
    args: CompleteImportAutoTestConfigurationCommandInput,
    options: HttpHandlerOptions,
    cb: (
        err: any,
        data?: CompleteImportAutoTestConfigurationCommandOutput,
    ) => void,
): void
Parameters
- args: CompleteImportAutoTestConfigurationCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: CompleteImportAutoTestConfigurationCommandOutput) => void
Returns void

copyAutoTestConfiguration

copyAutoTestConfiguration(
args: CopyAutoTestConfigurationCommandInput,
options?: HttpHandlerOptions,
): Promise<CopyAutoTestConfigurationCommandOutput>
Parameters
- args: CopyAutoTestConfigurationCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<CopyAutoTestConfigurationCommandOutput>
See
CopyAutoTestConfigurationCommand
copyAutoTestConfiguration(
args: CopyAutoTestConfigurationCommandInput,
cb: (err: any, data?: CopyAutoTestConfigurationCommandOutput) => void,
): void
Parameters
- args: CopyAutoTestConfigurationCommandInput
- cb: (err: any, data?: CopyAutoTestConfigurationCommandOutput) => void
Returns void
copyAutoTestConfiguration(
    args: CopyAutoTestConfigurationCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: CopyAutoTestConfigurationCommandOutput) => void,
): void
Parameters
- args: CopyAutoTestConfigurationCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: CopyAutoTestConfigurationCommandOutput) => void
Returns void

createAssistant

createAssistant(
args: CreateAssistantCommandInput,
options?: HttpHandlerOptions,
): Promise<CreateAssistantCommandOutput>
Parameters
- args: CreateAssistantCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<CreateAssistantCommandOutput>
See
CreateAssistantCommand
createAssistant(
args: CreateAssistantCommandInput,
cb: (err: any, data?: CreateAssistantCommandOutput) => void,
): void
Parameters
- args: CreateAssistantCommandInput
- cb: (err: any, data?: CreateAssistantCommandOutput) => void
Returns void
createAssistant(
    args: CreateAssistantCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: CreateAssistantCommandOutput) => void,
): void
Parameters
- args: CreateAssistantCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: CreateAssistantCommandOutput) => void
Returns void

createAssistantConversation

createAssistantConversation(
args: CreateAssistantConversationCommandInput,
options?: HttpHandlerOptions,
): Promise<CreateAssistantConversationCommandOutput>
Parameters
- args: CreateAssistantConversationCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<CreateAssistantConversationCommandOutput>
See
CreateAssistantConversationCommand
createAssistantConversation(
args: CreateAssistantConversationCommandInput,
cb: (err: any, data?: CreateAssistantConversationCommandOutput) => void,
): void
Parameters
- args: CreateAssistantConversationCommandInput
- cb: (err: any, data?: CreateAssistantConversationCommandOutput) => void
Returns void
createAssistantConversation(
    args: CreateAssistantConversationCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: CreateAssistantConversationCommandOutput) => void,
): void
Parameters
- args: CreateAssistantConversationCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: CreateAssistantConversationCommandOutput) => void
Returns void

createAssistantMessage

createAssistantMessage(
args: CreateAssistantMessageCommandInput,
options?: HttpHandlerOptions,
): Promise<CreateAssistantMessageCommandOutput>
Parameters
- args: CreateAssistantMessageCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<CreateAssistantMessageCommandOutput>
See
CreateAssistantMessageCommand
createAssistantMessage(
args: CreateAssistantMessageCommandInput,
cb: (err: any, data?: CreateAssistantMessageCommandOutput) => void,
): void
Parameters
- args: CreateAssistantMessageCommandInput
- cb: (err: any, data?: CreateAssistantMessageCommandOutput) => void
Returns void
createAssistantMessage(
    args: CreateAssistantMessageCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: CreateAssistantMessageCommandOutput) => void,
): void
Parameters
- args: CreateAssistantMessageCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: CreateAssistantMessageCommandOutput) => void
Returns void

createAutoTestSnapshot

createAutoTestSnapshot(
args: CreateAutoTestSnapshotCommandInput,
options?: HttpHandlerOptions,
): Promise<CreateAutoTestSnapshotCommandOutput>
Parameters
- args: CreateAutoTestSnapshotCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<CreateAutoTestSnapshotCommandOutput>
See
CreateAutoTestSnapshotCommand
createAutoTestSnapshot(
args: CreateAutoTestSnapshotCommandInput,
cb: (err: any, data?: CreateAutoTestSnapshotCommandOutput) => void,
): void
Parameters
- args: CreateAutoTestSnapshotCommandInput
- cb: (err: any, data?: CreateAutoTestSnapshotCommandOutput) => void
Returns void
createAutoTestSnapshot(
    args: CreateAutoTestSnapshotCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: CreateAutoTestSnapshotCommandOutput) => void,
): void
Parameters
- args: CreateAutoTestSnapshotCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: CreateAutoTestSnapshotCommandOutput) => void
Returns void

createEditorSession

createEditorSession(
args: CreateEditorSessionCommandInput,
options?: HttpHandlerOptions,
): Promise<CreateEditorSessionCommandOutput>
Parameters
- args: CreateEditorSessionCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<CreateEditorSessionCommandOutput>
See
CreateEditorSessionCommand
createEditorSession(
args: CreateEditorSessionCommandInput,
cb: (err: any, data?: CreateEditorSessionCommandOutput) => void,
): void
Parameters
- args: CreateEditorSessionCommandInput
- cb: (err: any, data?: CreateEditorSessionCommandOutput) => void
Returns void
createEditorSession(
    args: CreateEditorSessionCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: CreateEditorSessionCommandOutput) => void,
): void
Parameters
- args: CreateEditorSessionCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: CreateEditorSessionCommandOutput) => void
Returns void

createSafeProgram

createSafeProgram(
args: CreateSafeProgramCommandInput,
options?: HttpHandlerOptions,
): Promise<CreateSafeProgramCommandOutput>
Parameters
- args: CreateSafeProgramCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<CreateSafeProgramCommandOutput>
See
CreateSafeProgramCommand
createSafeProgram(
args: CreateSafeProgramCommandInput,
cb: (err: any, data?: CreateSafeProgramCommandOutput) => void,
): void
Parameters
- args: CreateSafeProgramCommandInput
- cb: (err: any, data?: CreateSafeProgramCommandOutput) => void
Returns void
createSafeProgram(
    args: CreateSafeProgramCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: CreateSafeProgramCommandOutput) => void,
): void
Parameters
- args: CreateSafeProgramCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: CreateSafeProgramCommandOutput) => void
Returns void

deleteAutoTestConfiguration

deleteAutoTestConfiguration(
args: DeleteAutoTestConfigurationCommandInput,
options?: HttpHandlerOptions,
): Promise<DeleteAutoTestConfigurationCommandOutput>
Parameters
- args: DeleteAutoTestConfigurationCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<DeleteAutoTestConfigurationCommandOutput>
See
DeleteAutoTestConfigurationCommand
deleteAutoTestConfiguration(
args: DeleteAutoTestConfigurationCommandInput,
cb: (err: any, data?: DeleteAutoTestConfigurationCommandOutput) => void,
): void
Parameters
- args: DeleteAutoTestConfigurationCommandInput
- cb: (err: any, data?: DeleteAutoTestConfigurationCommandOutput) => void
Returns void
deleteAutoTestConfiguration(
    args: DeleteAutoTestConfigurationCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: DeleteAutoTestConfigurationCommandOutput) => void,
): void
Parameters
- args: DeleteAutoTestConfigurationCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: DeleteAutoTestConfigurationCommandOutput) => void
Returns void

destroy

destroy(): void
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void

executeEditorDocumentJupyterCell

executeEditorDocumentJupyterCell(
args: ExecuteEditorDocumentJupyterCellCommandInput,
options?: HttpHandlerOptions,
): Promise<ExecuteEditorDocumentJupyterCellCommandOutput>
Parameters
- args: ExecuteEditorDocumentJupyterCellCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<ExecuteEditorDocumentJupyterCellCommandOutput>
See
ExecuteEditorDocumentJupyterCellCommand
executeEditorDocumentJupyterCell(
    args: ExecuteEditorDocumentJupyterCellCommandInput,
    cb: (
        err: any,
        data?: ExecuteEditorDocumentJupyterCellCommandOutput,
    ) => void,
): void
Parameters
- args: ExecuteEditorDocumentJupyterCellCommandInput
- cb: (err: any, data?: ExecuteEditorDocumentJupyterCellCommandOutput) => void
Returns void
executeEditorDocumentJupyterCell(
    args: ExecuteEditorDocumentJupyterCellCommandInput,
    options: HttpHandlerOptions,
    cb: (
        err: any,
        data?: ExecuteEditorDocumentJupyterCellCommandOutput,
    ) => void,
): void
Parameters
- args: ExecuteEditorDocumentJupyterCellCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: ExecuteEditorDocumentJupyterCellCommandOutput) => void
Returns void

getAssistant

getAssistant(
args: GetAssistantCommandInput,
options?: HttpHandlerOptions,
): Promise<GetAssistantCommandOutput>
Parameters
- args: GetAssistantCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<GetAssistantCommandOutput>
See
GetAssistantCommand
getAssistant(
args: GetAssistantCommandInput,
cb: (err: any, data?: GetAssistantCommandOutput) => void,
): void
Parameters
- args: GetAssistantCommandInput
- cb: (err: any, data?: GetAssistantCommandOutput) => void
Returns void
getAssistant(
    args: GetAssistantCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: GetAssistantCommandOutput) => void,
): void
Parameters
- args: GetAssistantCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: GetAssistantCommandOutput) => void
Returns void

getAssistantConversation

getAssistantConversation(
args: GetAssistantConversationCommandInput,
options?: HttpHandlerOptions,
): Promise<GetAssistantConversationCommandOutput>
Parameters
- args: GetAssistantConversationCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<GetAssistantConversationCommandOutput>
See
GetAssistantConversationCommand
getAssistantConversation(
args: GetAssistantConversationCommandInput,
cb: (err: any, data?: GetAssistantConversationCommandOutput) => void,
): void
Parameters
- args: GetAssistantConversationCommandInput
- cb: (err: any, data?: GetAssistantConversationCommandOutput) => void
Returns void
getAssistantConversation(
    args: GetAssistantConversationCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: GetAssistantConversationCommandOutput) => void,
): void
Parameters
- args: GetAssistantConversationCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: GetAssistantConversationCommandOutput) => void
Returns void

getAssistantMessage

getAssistantMessage(
args: GetAssistantMessageCommandInput,
options?: HttpHandlerOptions,
): Promise<GetAssistantMessageCommandOutput>
Parameters
- args: GetAssistantMessageCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<GetAssistantMessageCommandOutput>
See
GetAssistantMessageCommand
getAssistantMessage(
args: GetAssistantMessageCommandInput,
cb: (err: any, data?: GetAssistantMessageCommandOutput) => void,
): void
Parameters
- args: GetAssistantMessageCommandInput
- cb: (err: any, data?: GetAssistantMessageCommandOutput) => void
Returns void
getAssistantMessage(
    args: GetAssistantMessageCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: GetAssistantMessageCommandOutput) => void,
): void
Parameters
- args: GetAssistantMessageCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: GetAssistantMessageCommandOutput) => void
Returns void

getAutoTestConfiguration

getAutoTestConfiguration(
args: GetAutoTestConfigurationCommandInput,
options?: HttpHandlerOptions,
): Promise<GetAutoTestConfigurationCommandOutput>
Parameters
- args: GetAutoTestConfigurationCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<GetAutoTestConfigurationCommandOutput>
See
GetAutoTestConfigurationCommand
getAutoTestConfiguration(
args: GetAutoTestConfigurationCommandInput,
cb: (err: any, data?: GetAutoTestConfigurationCommandOutput) => void,
): void
Parameters
- args: GetAutoTestConfigurationCommandInput
- cb: (err: any, data?: GetAutoTestConfigurationCommandOutput) => void
Returns void
getAutoTestConfiguration(
    args: GetAutoTestConfigurationCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: GetAutoTestConfigurationCommandOutput) => void,
): void
Parameters
- args: GetAutoTestConfigurationCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: GetAutoTestConfigurationCommandOutput) => void
Returns void

getAutoTestPublishedSnapshot

getAutoTestPublishedSnapshot(
args: GetAutoTestPublishedSnapshotCommandInput,
options?: HttpHandlerOptions,
): Promise<GetAutoTestPublishedSnapshotCommandOutput>
Parameters
- args: GetAutoTestPublishedSnapshotCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<GetAutoTestPublishedSnapshotCommandOutput>
See
GetAutoTestPublishedSnapshotCommand
getAutoTestPublishedSnapshot(
args: GetAutoTestPublishedSnapshotCommandInput,
cb: (err: any, data?: GetAutoTestPublishedSnapshotCommandOutput) => void,
): void
Parameters
- args: GetAutoTestPublishedSnapshotCommandInput
- cb: (err: any, data?: GetAutoTestPublishedSnapshotCommandOutput) => void
Returns void
getAutoTestPublishedSnapshot(
    args: GetAutoTestPublishedSnapshotCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: GetAutoTestPublishedSnapshotCommandOutput) => void,
): void
Parameters
- args: GetAutoTestPublishedSnapshotCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: GetAutoTestPublishedSnapshotCommandOutput) => void
Returns void

getAutoTestSnapshot

getAutoTestSnapshot(
args: GetAutoTestSnapshotCommandInput,
options?: HttpHandlerOptions,
): Promise<GetAutoTestSnapshotCommandOutput>
Parameters
- args: GetAutoTestSnapshotCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<GetAutoTestSnapshotCommandOutput>
See
GetAutoTestSnapshotCommand
getAutoTestSnapshot(
args: GetAutoTestSnapshotCommandInput,
cb: (err: any, data?: GetAutoTestSnapshotCommandOutput) => void,
): void
Parameters
- args: GetAutoTestSnapshotCommandInput
- cb: (err: any, data?: GetAutoTestSnapshotCommandOutput) => void
Returns void
getAutoTestSnapshot(
    args: GetAutoTestSnapshotCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: GetAutoTestSnapshotCommandOutput) => void,
): void
Parameters
- args: GetAutoTestSnapshotCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: GetAutoTestSnapshotCommandOutput) => void
Returns void

getEditorDocument

getEditorDocument(
args: GetEditorDocumentCommandInput,
options?: HttpHandlerOptions,
): Promise<GetEditorDocumentCommandOutput>
Parameters
- args: GetEditorDocumentCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<GetEditorDocumentCommandOutput>
See
GetEditorDocumentCommand
getEditorDocument(
args: GetEditorDocumentCommandInput,
cb: (err: any, data?: GetEditorDocumentCommandOutput) => void,
): void
Parameters
- args: GetEditorDocumentCommandInput
- cb: (err: any, data?: GetEditorDocumentCommandOutput) => void
Returns void
getEditorDocument(
    args: GetEditorDocumentCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: GetEditorDocumentCommandOutput) => void,
): void
Parameters
- args: GetEditorDocumentCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: GetEditorDocumentCommandOutput) => void
Returns void

getEditorSession

getEditorSession(
args: GetEditorSessionCommandInput,
options?: HttpHandlerOptions,
): Promise<GetEditorSessionCommandOutput>
Parameters
- args: GetEditorSessionCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<GetEditorSessionCommandOutput>
See
GetEditorSessionCommand
getEditorSession(
args: GetEditorSessionCommandInput,
cb: (err: any, data?: GetEditorSessionCommandOutput) => void,
): void
Parameters
- args: GetEditorSessionCommandInput
- cb: (err: any, data?: GetEditorSessionCommandOutput) => void
Returns void
getEditorSession(
    args: GetEditorSessionCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: GetEditorSessionCommandOutput) => void,
): void
Parameters
- args: GetEditorSessionCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: GetEditorSessionCommandOutput) => void
Returns void

getPearsonContextTemplate

getPearsonContextTemplate(
args: GetPearsonContextTemplateCommandInput,
options?: HttpHandlerOptions,
): Promise<GetPearsonContextTemplateCommandOutput>
Parameters
- args: GetPearsonContextTemplateCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<GetPearsonContextTemplateCommandOutput>
See
GetPearsonContextTemplateCommand
getPearsonContextTemplate(
args: GetPearsonContextTemplateCommandInput,
cb: (err: any, data?: GetPearsonContextTemplateCommandOutput) => void,
): void
Parameters
- args: GetPearsonContextTemplateCommandInput
- cb: (err: any, data?: GetPearsonContextTemplateCommandOutput) => void
Returns void
getPearsonContextTemplate(
    args: GetPearsonContextTemplateCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: GetPearsonContextTemplateCommandOutput) => void,
): void
Parameters
- args: GetPearsonContextTemplateCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: GetPearsonContextTemplateCommandOutput) => void
Returns void

getPearsonContextTemplateQuestion

getPearsonContextTemplateQuestion(
args: GetPearsonContextTemplateQuestionCommandInput,
options?: HttpHandlerOptions,
): Promise<GetPearsonContextTemplateQuestionCommandOutput>
Parameters
- args: GetPearsonContextTemplateQuestionCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<GetPearsonContextTemplateQuestionCommandOutput>
See
GetPearsonContextTemplateQuestionCommand
getPearsonContextTemplateQuestion(
    args: GetPearsonContextTemplateQuestionCommandInput,
    cb: (
        err: any,
        data?: GetPearsonContextTemplateQuestionCommandOutput,
    ) => void,
): void
Parameters
- args: GetPearsonContextTemplateQuestionCommandInput
- cb: (err: any, data?: GetPearsonContextTemplateQuestionCommandOutput) => void
Returns void
getPearsonContextTemplateQuestion(
    args: GetPearsonContextTemplateQuestionCommandInput,
    options: HttpHandlerOptions,
    cb: (
        err: any,
        data?: GetPearsonContextTemplateQuestionCommandOutput,
    ) => void,
): void
Parameters
- args: GetPearsonContextTemplateQuestionCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: GetPearsonContextTemplateQuestionCommandOutput) => void
Returns void

handInEditorSession

handInEditorSession(
args: HandInEditorSessionCommandInput,
options?: HttpHandlerOptions,
): Promise<HandInEditorSessionCommandOutput>
Parameters
- args: HandInEditorSessionCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<HandInEditorSessionCommandOutput>
See
HandInEditorSessionCommand
handInEditorSession(
args: HandInEditorSessionCommandInput,
cb: (err: any, data?: HandInEditorSessionCommandOutput) => void,
): void
Parameters
- args: HandInEditorSessionCommandInput
- cb: (err: any, data?: HandInEditorSessionCommandOutput) => void
Returns void
handInEditorSession(
    args: HandInEditorSessionCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: HandInEditorSessionCommandOutput) => void,
): void
Parameters
- args: HandInEditorSessionCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: HandInEditorSessionCommandOutput) => void
Returns void

instantiatePearsonTemplate

instantiatePearsonTemplate(
args: InstantiatePearsonTemplateCommandInput,
options?: HttpHandlerOptions,
): Promise<InstantiatePearsonTemplateCommandOutput>
Parameters
- args: InstantiatePearsonTemplateCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<InstantiatePearsonTemplateCommandOutput>
See
InstantiatePearsonTemplateCommand
instantiatePearsonTemplate(
args: InstantiatePearsonTemplateCommandInput,
cb: (err: any, data?: InstantiatePearsonTemplateCommandOutput) => void,
): void
Parameters
- args: InstantiatePearsonTemplateCommandInput
- cb: (err: any, data?: InstantiatePearsonTemplateCommandOutput) => void
Returns void
instantiatePearsonTemplate(
    args: InstantiatePearsonTemplateCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: InstantiatePearsonTemplateCommandOutput) => void,
): void
Parameters
- args: InstantiatePearsonTemplateCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: InstantiatePearsonTemplateCommandOutput) => void
Returns void

listAssignmentAssistants

listAssignmentAssistants(
args: ListAssignmentAssistantsCommandInput,
options?: HttpHandlerOptions,
): Promise<ListAssignmentAssistantsCommandOutput>
Parameters
- args: ListAssignmentAssistantsCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<ListAssignmentAssistantsCommandOutput>
See
ListAssignmentAssistantsCommand
listAssignmentAssistants(
args: ListAssignmentAssistantsCommandInput,
cb: (err: any, data?: ListAssignmentAssistantsCommandOutput) => void,
): void
Parameters
- args: ListAssignmentAssistantsCommandInput
- cb: (err: any, data?: ListAssignmentAssistantsCommandOutput) => void
Returns void
listAssignmentAssistants(
    args: ListAssignmentAssistantsCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: ListAssignmentAssistantsCommandOutput) => void,
): void
Parameters
- args: ListAssignmentAssistantsCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: ListAssignmentAssistantsCommandOutput) => void
Returns void

listAssistantMessages

listAssistantMessages(
args: ListAssistantMessagesCommandInput,
options?: HttpHandlerOptions,
): Promise<ListAssistantMessagesCommandOutput>
Parameters
- args: ListAssistantMessagesCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<ListAssistantMessagesCommandOutput>
See
ListAssistantMessagesCommand
listAssistantMessages(
args: ListAssistantMessagesCommandInput,
cb: (err: any, data?: ListAssistantMessagesCommandOutput) => void,
): void
Parameters
- args: ListAssistantMessagesCommandInput
- cb: (err: any, data?: ListAssistantMessagesCommandOutput) => void
Returns void
listAssistantMessages(
    args: ListAssistantMessagesCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: ListAssistantMessagesCommandOutput) => void,
): void
Parameters
- args: ListAssistantMessagesCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: ListAssistantMessagesCommandOutput) => void
Returns void

listAutoTestSnapshots

listAutoTestSnapshots(
args: ListAutoTestSnapshotsCommandInput,
options?: HttpHandlerOptions,
): Promise<ListAutoTestSnapshotsCommandOutput>
Parameters
- args: ListAutoTestSnapshotsCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<ListAutoTestSnapshotsCommandOutput>
See
ListAutoTestSnapshotsCommand
listAutoTestSnapshots(
args: ListAutoTestSnapshotsCommandInput,
cb: (err: any, data?: ListAutoTestSnapshotsCommandOutput) => void,
): void
Parameters
- args: ListAutoTestSnapshotsCommandInput
- cb: (err: any, data?: ListAutoTestSnapshotsCommandOutput) => void
Returns void
listAutoTestSnapshots(
    args: ListAutoTestSnapshotsCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: ListAutoTestSnapshotsCommandOutput) => void,
): void
Parameters
- args: ListAutoTestSnapshotsCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: ListAutoTestSnapshotsCommandOutput) => void
Returns void

listEditorDocumentJupyterCellOutputs

listEditorDocumentJupyterCellOutputs(
args: ListEditorDocumentJupyterCellOutputsCommandInput,
options?: HttpHandlerOptions,
): Promise<ListEditorDocumentJupyterCellOutputsCommandOutput>
Parameters
- args: ListEditorDocumentJupyterCellOutputsCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<ListEditorDocumentJupyterCellOutputsCommandOutput>
See
ListEditorDocumentJupyterCellOutputsCommand
listEditorDocumentJupyterCellOutputs(
    args: ListEditorDocumentJupyterCellOutputsCommandInput,
    cb: (
        err: any,
        data?: ListEditorDocumentJupyterCellOutputsCommandOutput,
    ) => void,
): void
Parameters
- args: ListEditorDocumentJupyterCellOutputsCommandInput
- cb: (err: any, data?: ListEditorDocumentJupyterCellOutputsCommandOutput) => void
Returns void
listEditorDocumentJupyterCellOutputs(
    args: ListEditorDocumentJupyterCellOutputsCommandInput,
    options: HttpHandlerOptions,
    cb: (
        err: any,
        data?: ListEditorDocumentJupyterCellOutputsCommandOutput,
    ) => void,
): void
Parameters
- args: ListEditorDocumentJupyterCellOutputsCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: ListEditorDocumentJupyterCellOutputsCommandOutput) => void
Returns void

listEditorSessions

listEditorSessions(
args: ListEditorSessionsCommandInput,
options?: HttpHandlerOptions,
): Promise<ListEditorSessionsCommandOutput>
Parameters
- args: ListEditorSessionsCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<ListEditorSessionsCommandOutput>
See
ListEditorSessionsCommand
listEditorSessions(
args: ListEditorSessionsCommandInput,
cb: (err: any, data?: ListEditorSessionsCommandOutput) => void,
): void
Parameters
- args: ListEditorSessionsCommandInput
- cb: (err: any, data?: ListEditorSessionsCommandOutput) => void
Returns void
listEditorSessions(
    args: ListEditorSessionsCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: ListEditorSessionsCommandOutput) => void,
): void
Parameters
- args: ListEditorSessionsCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: ListEditorSessionsCommandOutput) => void
Returns void

listUserAssistantConversations

listUserAssistantConversations(
args: ListUserAssistantConversationsCommandInput,
options?: HttpHandlerOptions,
): Promise<ListUserAssistantConversationsCommandOutput>
Parameters
- args: ListUserAssistantConversationsCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<ListUserAssistantConversationsCommandOutput>
See
ListUserAssistantConversationsCommand
listUserAssistantConversations(
args: ListUserAssistantConversationsCommandInput,
cb: (err: any, data?: ListUserAssistantConversationsCommandOutput) => void,
): void
Parameters
- args: ListUserAssistantConversationsCommandInput
- cb: (err: any, data?: ListUserAssistantConversationsCommandOutput) => void
Returns void
listUserAssistantConversations(
    args: ListUserAssistantConversationsCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: ListUserAssistantConversationsCommandOutput) => void,
): void
Parameters
- args: ListUserAssistantConversationsCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: ListUserAssistantConversationsCommandOutput) => void
Returns void

putAutoTestConfiguration

putAutoTestConfiguration(
args: PutAutoTestConfigurationCommandInput,
options?: HttpHandlerOptions,
): Promise<PutAutoTestConfigurationCommandOutput>
Parameters
- args: PutAutoTestConfigurationCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<PutAutoTestConfigurationCommandOutput>
See
PutAutoTestConfigurationCommand
putAutoTestConfiguration(
args: PutAutoTestConfigurationCommandInput,
cb: (err: any, data?: PutAutoTestConfigurationCommandOutput) => void,
): void
Parameters
- args: PutAutoTestConfigurationCommandInput
- cb: (err: any, data?: PutAutoTestConfigurationCommandOutput) => void
Returns void
putAutoTestConfiguration(
    args: PutAutoTestConfigurationCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: PutAutoTestConfigurationCommandOutput) => void,
): void
Parameters
- args: PutAutoTestConfigurationCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: PutAutoTestConfigurationCommandOutput) => void
Returns void

putEditorFile

putEditorFile(
args: PutEditorFileCommandInput,
options?: HttpHandlerOptions,
): Promise<PutEditorFileCommandOutput>
Parameters
- args: PutEditorFileCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<PutEditorFileCommandOutput>
See
PutEditorFileCommand
putEditorFile(
args: PutEditorFileCommandInput,
cb: (err: any, data?: PutEditorFileCommandOutput) => void,
): void
Parameters
- args: PutEditorFileCommandInput
- cb: (err: any, data?: PutEditorFileCommandOutput) => void
Returns void
putEditorFile(
    args: PutEditorFileCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: PutEditorFileCommandOutput) => void,
): void
Parameters
- args: PutEditorFileCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: PutEditorFileCommandOutput) => void
Returns void

putPearsonBook

putPearsonBook(
args: PutPearsonBookCommandInput,
options?: HttpHandlerOptions,
): Promise<PutPearsonBookCommandOutput>
Parameters
- args: PutPearsonBookCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<PutPearsonBookCommandOutput>
See
PutPearsonBookCommand
putPearsonBook(
args: PutPearsonBookCommandInput,
cb: (err: any, data?: PutPearsonBookCommandOutput) => void,
): void
Parameters
- args: PutPearsonBookCommandInput
- cb: (err: any, data?: PutPearsonBookCommandOutput) => void
Returns void
putPearsonBook(
    args: PutPearsonBookCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: PutPearsonBookCommandOutput) => void,
): void
Parameters
- args: PutPearsonBookCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: PutPearsonBookCommandOutput) => void
Returns void

putPearsonContextTemplate

putPearsonContextTemplate(
args: PutPearsonContextTemplateCommandInput,
options?: HttpHandlerOptions,
): Promise<PutPearsonContextTemplateCommandOutput>
Parameters
- args: PutPearsonContextTemplateCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<PutPearsonContextTemplateCommandOutput>
See
PutPearsonContextTemplateCommand
putPearsonContextTemplate(
args: PutPearsonContextTemplateCommandInput,
cb: (err: any, data?: PutPearsonContextTemplateCommandOutput) => void,
): void
Parameters
- args: PutPearsonContextTemplateCommandInput
- cb: (err: any, data?: PutPearsonContextTemplateCommandOutput) => void
Returns void
putPearsonContextTemplate(
    args: PutPearsonContextTemplateCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: PutPearsonContextTemplateCommandOutput) => void,
): void
Parameters
- args: PutPearsonContextTemplateCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: PutPearsonContextTemplateCommandOutput) => void
Returns void

putPearsonQuestion

putPearsonQuestion(
args: PutPearsonQuestionCommandInput,
options?: HttpHandlerOptions,
): Promise<PutPearsonQuestionCommandOutput>
Parameters
- args: PutPearsonQuestionCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<PutPearsonQuestionCommandOutput>
See
PutPearsonQuestionCommand
putPearsonQuestion(
args: PutPearsonQuestionCommandInput,
cb: (err: any, data?: PutPearsonQuestionCommandOutput) => void,
): void
Parameters
- args: PutPearsonQuestionCommandInput
- cb: (err: any, data?: PutPearsonQuestionCommandOutput) => void
Returns void
putPearsonQuestion(
    args: PutPearsonQuestionCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: PutPearsonQuestionCommandOutput) => void,
): void
Parameters
- args: PutPearsonQuestionCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: PutPearsonQuestionCommandOutput) => void
Returns void

putPearsonTemplate

putPearsonTemplate(
args: PutPearsonTemplateCommandInput,
options?: HttpHandlerOptions,
): Promise<PutPearsonTemplateCommandOutput>
Parameters
- args: PutPearsonTemplateCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<PutPearsonTemplateCommandOutput>
See
PutPearsonTemplateCommand
putPearsonTemplate(
args: PutPearsonTemplateCommandInput,
cb: (err: any, data?: PutPearsonTemplateCommandOutput) => void,
): void
Parameters
- args: PutPearsonTemplateCommandInput
- cb: (err: any, data?: PutPearsonTemplateCommandOutput) => void
Returns void
putPearsonTemplate(
    args: PutPearsonTemplateCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: PutPearsonTemplateCommandOutput) => void,
): void
Parameters
- args: PutPearsonTemplateCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: PutPearsonTemplateCommandOutput) => void
Returns void

send

send<InputType extends ServiceInputTypes, OutputType extends ServiceOutputTypes>(
    command: Command<
        ServiceInputTypes,
        InputType,
        ServiceOutputTypes,
        OutputType,
        SmithyResolvedConfiguration<HttpHandlerOptions>,
    >,
    options?: HttpHandlerOptions,
): Promise<OutputType>
Type Parameters
- InputType extends ServiceInputTypes
- OutputType extends ServiceOutputTypes
Parameters
- command: Command<
      ServiceInputTypes,
      InputType,
      ServiceOutputTypes,
      OutputType,
      SmithyResolvedConfiguration<HttpHandlerOptions>,
  >
- Optionaloptions: HttpHandlerOptions
Returns Promise<OutputType>
send<InputType extends ServiceInputTypes, OutputType extends ServiceOutputTypes>(
    command: Command<
        ServiceInputTypes,
        InputType,
        ServiceOutputTypes,
        OutputType,
        SmithyResolvedConfiguration<HttpHandlerOptions>,
    >,
    cb: (err: any, data?: OutputType) => void,
): void
Type Parameters
- InputType extends ServiceInputTypes
- OutputType extends ServiceOutputTypes
Parameters
- command: Command<
      ServiceInputTypes,
      InputType,
      ServiceOutputTypes,
      OutputType,
      SmithyResolvedConfiguration<HttpHandlerOptions>,
  >
- cb: (err: any, data?: OutputType) => void
Returns void
send<InputType extends ServiceInputTypes, OutputType extends ServiceOutputTypes>(
    command: Command<
        ServiceInputTypes,
        InputType,
        ServiceOutputTypes,
        OutputType,
        SmithyResolvedConfiguration<HttpHandlerOptions>,
    >,
    options: HttpHandlerOptions,
    cb: (err: any, data?: OutputType) => void,
): void
Type Parameters
- InputType extends ServiceInputTypes
- OutputType extends ServiceOutputTypes
Parameters
- command: Command<
      ServiceInputTypes,
      InputType,
      ServiceOutputTypes,
      OutputType,
      SmithyResolvedConfiguration<HttpHandlerOptions>,
  >
- options: HttpHandlerOptions
- cb: (err: any, data?: OutputType) => void
Returns void

updateAssistant

updateAssistant(
args: UpdateAssistantCommandInput,
options?: HttpHandlerOptions,
): Promise<UpdateAssistantCommandOutput>
Parameters
- args: UpdateAssistantCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<UpdateAssistantCommandOutput>
See
UpdateAssistantCommand
updateAssistant(
args: UpdateAssistantCommandInput,
cb: (err: any, data?: UpdateAssistantCommandOutput) => void,
): void
Parameters
- args: UpdateAssistantCommandInput
- cb: (err: any, data?: UpdateAssistantCommandOutput) => void
Returns void
updateAssistant(
    args: UpdateAssistantCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: UpdateAssistantCommandOutput) => void,
): void
Parameters
- args: UpdateAssistantCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: UpdateAssistantCommandOutput) => void
Returns void

updateAutoTestConfiguration

updateAutoTestConfiguration(
args: UpdateAutoTestConfigurationCommandInput,
options?: HttpHandlerOptions,
): Promise<UpdateAutoTestConfigurationCommandOutput>
Parameters
- args: UpdateAutoTestConfigurationCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<UpdateAutoTestConfigurationCommandOutput>
See
UpdateAutoTestConfigurationCommand
updateAutoTestConfiguration(
args: UpdateAutoTestConfigurationCommandInput,
cb: (err: any, data?: UpdateAutoTestConfigurationCommandOutput) => void,
): void
Parameters
- args: UpdateAutoTestConfigurationCommandInput
- cb: (err: any, data?: UpdateAutoTestConfigurationCommandOutput) => void
Returns void
updateAutoTestConfiguration(
    args: UpdateAutoTestConfigurationCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: UpdateAutoTestConfigurationCommandOutput) => void,
): void
Parameters
- args: UpdateAutoTestConfigurationCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: UpdateAutoTestConfigurationCommandOutput) => void
Returns void

updatePearsonContextTemplate

updatePearsonContextTemplate(
args: UpdatePearsonContextTemplateCommandInput,
options?: HttpHandlerOptions,
): Promise<UpdatePearsonContextTemplateCommandOutput>
Parameters
- args: UpdatePearsonContextTemplateCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<UpdatePearsonContextTemplateCommandOutput>
See
UpdatePearsonContextTemplateCommand
updatePearsonContextTemplate(
args: UpdatePearsonContextTemplateCommandInput,
cb: (err: any, data?: UpdatePearsonContextTemplateCommandOutput) => void,
): void
Parameters
- args: UpdatePearsonContextTemplateCommandInput
- cb: (err: any, data?: UpdatePearsonContextTemplateCommandOutput) => void
Returns void
updatePearsonContextTemplate(
    args: UpdatePearsonContextTemplateCommandInput,
    options: HttpHandlerOptions,
    cb: (err: any, data?: UpdatePearsonContextTemplateCommandOutput) => void,
): void
Parameters
- args: UpdatePearsonContextTemplateCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: UpdatePearsonContextTemplateCommandOutput) => void
Returns void

updatePearsonContextTemplateQuestion

updatePearsonContextTemplateQuestion(
args: UpdatePearsonContextTemplateQuestionCommandInput,
options?: HttpHandlerOptions,
): Promise<UpdatePearsonContextTemplateQuestionCommandOutput>
Parameters
- args: UpdatePearsonContextTemplateQuestionCommandInput
- Optionaloptions: HttpHandlerOptions
Returns Promise<UpdatePearsonContextTemplateQuestionCommandOutput>
See
UpdatePearsonContextTemplateQuestionCommand
updatePearsonContextTemplateQuestion(
    args: UpdatePearsonContextTemplateQuestionCommandInput,
    cb: (
        err: any,
        data?: UpdatePearsonContextTemplateQuestionCommandOutput,
    ) => void,
): void
Parameters
- args: UpdatePearsonContextTemplateQuestionCommandInput
- cb: (err: any, data?: UpdatePearsonContextTemplateQuestionCommandOutput) => void
Returns void
updatePearsonContextTemplateQuestion(
    args: UpdatePearsonContextTemplateQuestionCommandInput,
    options: HttpHandlerOptions,
    cb: (
        err: any,
        data?: UpdatePearsonContextTemplateQuestionCommandOutput,
    ) => void,
): void
Parameters
- args: UpdatePearsonContextTemplateQuestionCommandInput
- options: HttpHandlerOptions
- cb: (err: any, data?: UpdatePearsonContextTemplateQuestionCommandOutput) => void
Returns void

Class Apiv2

Hierarchy (View Summary)

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Apiv2

Properties

Readonlyconfig

Optional InternalinitConfig

middlewareStack

Methods

completeImportAutoTestConfiguration

Parameters

Returns Promise<CompleteImportAutoTestConfigurationCommandOutput>

See

Parameters

Returns void

Parameters

Returns void

copyAutoTestConfiguration

Parameters

Returns Promise<CopyAutoTestConfigurationCommandOutput>

See

Parameters

Returns void

Parameters

Returns void

createAssistant

Parameters

Returns Promise<CreateAssistantCommandOutput>

See

Parameters

Returns void

Parameters

Returns void

createAssistantConversation

Parameters

Returns Promise<CreateAssistantConversationCommandOutput>

See

Parameters

Returns void

Parameters

Returns void

createAssistantMessage

Parameters

Returns Promise<CreateAssistantMessageCommandOutput>

See

Parameters

Returns void

Parameters

Returns void

createAutoTestSnapshot

Parameters

Returns Promise<CreateAutoTestSnapshotCommandOutput>

See

Parameters

Returns void

Parameters

Returns void

createEditorSession

Parameters

Returns Promise<CreateEditorSessionCommandOutput>

See

Parameters

Returns void

Parameters

Returns void

createSafeProgram

Parameters

Returns Promise<CreateSafeProgramCommandOutput>

See

Parameters

Returns void

Parameters

`Readonly`config

`Optional` `Internal`initConfig