NovaAct class
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.
Constructors
- NovaAct({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createAct(
{required String sessionId, required String task, required String workflowDefinitionName, required String workflowRunId, String? clientToken, List< ToolSpec> ? toolSpecs}) → Future<CreateActResponse> - Creates a new AI task (act) within a session that can interact with tools and perform specific actions.
-
createSession(
{required String workflowDefinitionName, required String workflowRunId, String? clientToken}) → Future< CreateSessionResponse> - Creates a new session context within a workflow run to manage conversation state and acts.
-
createWorkflowDefinition(
{required String name, String? clientToken, String? description, WorkflowExportConfig? exportConfig}) → Future< CreateWorkflowDefinitionResponse> - Creates a new workflow definition template that can be used to execute multiple workflow runs.
-
createWorkflowRun(
{required ClientInfo clientInfo, required String modelId, required String workflowDefinitionName, String? clientToken, String? logGroupName}) → Future< CreateWorkflowRunResponse> - Creates a new execution instance of a workflow definition with specified parameters.
-
deleteWorkflowDefinition(
{required String workflowDefinitionName}) → Future< DeleteWorkflowDefinitionResponse> - Deletes a workflow definition and all associated resources. This operation cannot be undone.
-
deleteWorkflowRun(
{required String workflowDefinitionName, required String workflowRunId}) → Future< DeleteWorkflowRunResponse> - Terminates and cleans up a workflow run, stopping all associated acts and sessions.
-
getWorkflowDefinition(
{required String workflowDefinitionName}) → Future< GetWorkflowDefinitionResponse> - Retrieves the details and configuration of a specific workflow definition.
-
getWorkflowRun(
{required String workflowDefinitionName, required String workflowRunId}) → Future< GetWorkflowRunResponse> - Retrieves the current state, configuration, and execution details of a workflow run.
-
invokeActStep(
{required String actId, required List< CallResult> callResults, required String sessionId, required String workflowDefinitionName, required String workflowRunId, String? previousStepId}) → Future<InvokeActStepResponse> - Executes the next step of an act, processing tool call results and returning new tool calls if needed.
-
listActs(
{required String workflowDefinitionName, int? maxResults, String? nextToken, String? sessionId, SortOrder? sortOrder, String? workflowRunId}) → Future< ListActsResponse> - Lists all acts within a specific session with their current status and execution details.
-
listModels(
{required int clientCompatibilityVersion}) → Future< ListModelsResponse> - Lists all available AI models that can be used for workflow execution, including their status and compatibility information.
-
listSessions(
{required String workflowDefinitionName, required String workflowRunId, int? maxResults, String? nextToken, SortOrder? sortOrder}) → Future< ListSessionsResponse> - Lists all sessions within a specific workflow run.
-
listWorkflowDefinitions(
{int? maxResults, String? nextToken, SortOrder? sortOrder}) → Future< ListWorkflowDefinitionsResponse> - Lists all workflow definitions in your account with optional filtering and pagination.
-
listWorkflowRuns(
{required String workflowDefinitionName, int? maxResults, String? nextToken, SortOrder? sortOrder}) → Future< ListWorkflowRunsResponse> - Lists all workflow runs for a specific workflow definition with optional filtering and pagination.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateAct(
{required String actId, required String sessionId, required ActStatus status, required String workflowDefinitionName, required String workflowRunId, ActError? error}) → Future< void> - Updates an existing act's configuration, status, or error information.
-
updateWorkflowRun(
{required WorkflowRunStatus status, required String workflowDefinitionName, required String workflowRunId}) → Future< void> - Updates the configuration or state of an active workflow run.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited