novaact/aws.sdk.kotlin.services.novaact/NovaActClient

NovaActClient

The Nova Act service provides a REST API for managing AI-powered workflow automation. It enables users to create workflow definitions, execute workflow runs, manage sessions, and orchestrate acts (individual AI tasks) with tool integrations.

Types

Builder

class Builder : AbstractSdkClientBuilder<NovaActClient.Config, NovaActClient.Config.Builder, NovaActClient>

Companion

object Companion : AbstractAwsSdkClientFactory<NovaActClient.Config, NovaActClient.Config.Builder, NovaActClient, NovaActClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig, TimeoutConfig

Properties

config

abstract override val config: NovaActClient.Config

NovaActClient's configuration

Functions

createAct

abstract suspend fun createAct(input: CreateActRequest): CreateActResponse

Creates a new AI task (act) within a session that can interact with tools and perform specific actions.

createSession

abstract suspend fun createSession(input: CreateSessionRequest): CreateSessionResponse

Creates a new session context within a workflow run to manage conversation state and acts.

createWorkflowDefinition

abstract suspend fun createWorkflowDefinition(input: CreateWorkflowDefinitionRequest): CreateWorkflowDefinitionResponse

Creates a new workflow definition template that can be used to execute multiple workflow runs.

createWorkflowRun

abstract suspend fun createWorkflowRun(input: CreateWorkflowRunRequest): CreateWorkflowRunResponse

Creates a new execution instance of a workflow definition with specified parameters.

deleteWorkflowDefinition

abstract suspend fun deleteWorkflowDefinition(input: DeleteWorkflowDefinitionRequest): DeleteWorkflowDefinitionResponse

Deletes a workflow definition and all associated resources. This operation cannot be undone.

deleteWorkflowRun

abstract suspend fun deleteWorkflowRun(input: DeleteWorkflowRunRequest): DeleteWorkflowRunResponse

Terminates and cleans up a workflow run, stopping all associated acts and sessions.

getWorkflowDefinition

abstract suspend fun getWorkflowDefinition(input: GetWorkflowDefinitionRequest): GetWorkflowDefinitionResponse

Retrieves the details and configuration of a specific workflow definition.

getWorkflowRun

abstract suspend fun getWorkflowRun(input: GetWorkflowRunRequest): GetWorkflowRunResponse

Retrieves the current state, configuration, and execution details of a workflow run.

invokeActStep

abstract suspend fun invokeActStep(input: InvokeActStepRequest): InvokeActStepResponse

Executes the next step of an act, processing tool call results and returning new tool calls if needed.

listActs

abstract suspend fun listActs(input: ListActsRequest): ListActsResponse

Lists all acts within a specific session with their current status and execution details.

listModels

abstract suspend fun listModels(input: ListModelsRequest): ListModelsResponse

Lists all available AI models that can be used for workflow execution, including their status and compatibility information.

listSessions

abstract suspend fun listSessions(input: ListSessionsRequest): ListSessionsResponse

Lists all sessions within a specific workflow run.

listWorkflowDefinitions

abstract suspend fun listWorkflowDefinitions(input: ListWorkflowDefinitionsRequest = ListWorkflowDefinitionsRequest { }): ListWorkflowDefinitionsResponse

Lists all workflow definitions in your account with optional filtering and pagination.

listWorkflowRuns

abstract suspend fun listWorkflowRuns(input: ListWorkflowRunsRequest): ListWorkflowRunsResponse

Lists all workflow runs for a specific workflow definition with optional filtering and pagination.

updateAct

abstract suspend fun updateAct(input: UpdateActRequest): UpdateActResponse

Updates an existing act's configuration, status, or error information.

updateWorkflowRun

abstract suspend fun updateWorkflowRun(input: UpdateWorkflowRunRequest): UpdateWorkflowRunResponse

Updates the configuration or state of an active workflow run.

Inherited functions

expect abstract fun close()

createAct

inline suspend fun NovaActClient.createAct(crossinline block: CreateActRequest.Builder.() -> Unit): CreateActResponse

Creates a new AI task (act) within a session that can interact with tools and perform specific actions.

createSession

inline suspend fun NovaActClient.createSession(crossinline block: CreateSessionRequest.Builder.() -> Unit): CreateSessionResponse

Creates a new session context within a workflow run to manage conversation state and acts.

createWorkflowDefinition

inline suspend fun NovaActClient.createWorkflowDefinition(crossinline block: CreateWorkflowDefinitionRequest.Builder.() -> Unit): CreateWorkflowDefinitionResponse

Creates a new workflow definition template that can be used to execute multiple workflow runs.

createWorkflowRun

inline suspend fun NovaActClient.createWorkflowRun(crossinline block: CreateWorkflowRunRequest.Builder.() -> Unit): CreateWorkflowRunResponse

Creates a new execution instance of a workflow definition with specified parameters.

deleteWorkflowDefinition

inline suspend fun NovaActClient.deleteWorkflowDefinition(crossinline block: DeleteWorkflowDefinitionRequest.Builder.() -> Unit): DeleteWorkflowDefinitionResponse

Deletes a workflow definition and all associated resources. This operation cannot be undone.

deleteWorkflowRun

inline suspend fun NovaActClient.deleteWorkflowRun(crossinline block: DeleteWorkflowRunRequest.Builder.() -> Unit): DeleteWorkflowRunResponse

Terminates and cleans up a workflow run, stopping all associated acts and sessions.

getWorkflowDefinition

inline suspend fun NovaActClient.getWorkflowDefinition(crossinline block: GetWorkflowDefinitionRequest.Builder.() -> Unit): GetWorkflowDefinitionResponse

Retrieves the details and configuration of a specific workflow definition.

getWorkflowRun

inline suspend fun NovaActClient.getWorkflowRun(crossinline block: GetWorkflowRunRequest.Builder.() -> Unit): GetWorkflowRunResponse

Retrieves the current state, configuration, and execution details of a workflow run.

invokeActStep

inline suspend fun NovaActClient.invokeActStep(crossinline block: InvokeActStepRequest.Builder.() -> Unit): InvokeActStepResponse

Executes the next step of an act, processing tool call results and returning new tool calls if needed.

listActs

inline suspend fun NovaActClient.listActs(crossinline block: ListActsRequest.Builder.() -> Unit): ListActsResponse

Lists all acts within a specific session with their current status and execution details.

listActsPaginated

fun NovaActClient.listActsPaginated(initialRequest: ListActsRequest): Flow<ListActsResponse>

fun NovaActClient.listActsPaginated(block: ListActsRequest.Builder.() -> Unit): Flow<ListActsResponse>

Paginate over ListActsResponse results.

listModels

inline suspend fun NovaActClient.listModels(crossinline block: ListModelsRequest.Builder.() -> Unit): ListModelsResponse

Lists all available AI models that can be used for workflow execution, including their status and compatibility information.

listSessions

inline suspend fun NovaActClient.listSessions(crossinline block: ListSessionsRequest.Builder.() -> Unit): ListSessionsResponse

Lists all sessions within a specific workflow run.

listSessionsPaginated

fun NovaActClient.listSessionsPaginated(initialRequest: ListSessionsRequest): Flow<ListSessionsResponse>

fun NovaActClient.listSessionsPaginated(block: ListSessionsRequest.Builder.() -> Unit): Flow<ListSessionsResponse>

Paginate over ListSessionsResponse results.

listWorkflowDefinitions

inline suspend fun NovaActClient.listWorkflowDefinitions(crossinline block: ListWorkflowDefinitionsRequest.Builder.() -> Unit): ListWorkflowDefinitionsResponse

Lists all workflow definitions in your account with optional filtering and pagination.

listWorkflowDefinitionsPaginated

fun NovaActClient.listWorkflowDefinitionsPaginated(initialRequest: ListWorkflowDefinitionsRequest = ListWorkflowDefinitionsRequest { }): Flow<ListWorkflowDefinitionsResponse>

fun NovaActClient.listWorkflowDefinitionsPaginated(block: ListWorkflowDefinitionsRequest.Builder.() -> Unit): Flow<ListWorkflowDefinitionsResponse>

Paginate over ListWorkflowDefinitionsResponse results.

listWorkflowRuns

inline suspend fun NovaActClient.listWorkflowRuns(crossinline block: ListWorkflowRunsRequest.Builder.() -> Unit): ListWorkflowRunsResponse

Lists all workflow runs for a specific workflow definition with optional filtering and pagination.

listWorkflowRunsPaginated

fun NovaActClient.listWorkflowRunsPaginated(initialRequest: ListWorkflowRunsRequest): Flow<ListWorkflowRunsResponse>

fun NovaActClient.listWorkflowRunsPaginated(block: ListWorkflowRunsRequest.Builder.() -> Unit): Flow<ListWorkflowRunsResponse>

Paginate over ListWorkflowRunsResponse results.

updateAct

inline suspend fun NovaActClient.updateAct(crossinline block: UpdateActRequest.Builder.() -> Unit): UpdateActResponse

Updates an existing act's configuration, status, or error information.

updateWorkflowRun

inline suspend fun NovaActClient.updateWorkflowRun(crossinline block: UpdateWorkflowRunRequest.Builder.() -> Unit): UpdateWorkflowRunResponse

Updates the configuration or state of an active workflow run.

withConfig

fun NovaActClient.withConfig(block: NovaActClient.Config.Builder.() -> Unit): NovaActClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.