Skip to content

NovaActServiceClient#

Index > NovaActService > NovaActServiceClient

Auto-generated documentation for NovaActService type annotations stubs module mypy-boto3-nova-act.

NovaActServiceClient#

Type annotations and code completion for boto3.client("nova-act"). boto3 documentation

# NovaActServiceClient usage example

from boto3.session import Session
from mypy_boto3_nova_act.client import NovaActServiceClient

def get_nova-act_client() -> NovaActServiceClient:
    return Session().client("nova-act")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("nova-act").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("nova-act")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_nova_act.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("nova-act").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("nova-act").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_act#

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

Type annotations and code completion for boto3.client("nova-act").create_act method. boto3 documentation

# create_act method definition

def create_act(
    self,
    *,
    workflowDefinitionName: str,
    workflowRunId: str,
    sessionId: str,
    task: str,
    toolSpecs: Sequence[ToolSpecTypeDef] = ...,  # (1)
    clientToken: str = ...,
) -> CreateActResponseTypeDef:  # (2)
    ...
  1. See Sequence[ToolSpecTypeDef]
  2. See CreateActResponseTypeDef
# create_act method usage example with argument unpacking

kwargs: CreateActRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
    "workflowRunId": ...,
    "sessionId": ...,
    "task": ...,
}

parent.create_act(**kwargs)
  1. See CreateActRequestTypeDef

create_session#

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

Type annotations and code completion for boto3.client("nova-act").create_session method. boto3 documentation

# create_session method definition

def create_session(
    self,
    *,
    workflowDefinitionName: str,
    workflowRunId: str,
    clientToken: str = ...,
) -> CreateSessionResponseTypeDef:  # (1)
    ...
  1. See CreateSessionResponseTypeDef
# create_session method usage example with argument unpacking

kwargs: CreateSessionRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
    "workflowRunId": ...,
}

parent.create_session(**kwargs)
  1. See CreateSessionRequestTypeDef

create_workflow_definition#

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

Type annotations and code completion for boto3.client("nova-act").create_workflow_definition method. boto3 documentation

# create_workflow_definition method definition

def create_workflow_definition(
    self,
    *,
    name: str,
    description: str = ...,
    exportConfig: WorkflowExportConfigTypeDef = ...,  # (1)
    clientToken: str = ...,
) -> CreateWorkflowDefinitionResponseTypeDef:  # (2)
    ...
  1. See WorkflowExportConfigTypeDef
  2. See CreateWorkflowDefinitionResponseTypeDef
# create_workflow_definition method usage example with argument unpacking

kwargs: CreateWorkflowDefinitionRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_workflow_definition(**kwargs)
  1. See CreateWorkflowDefinitionRequestTypeDef

create_workflow_run#

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

Type annotations and code completion for boto3.client("nova-act").create_workflow_run method. boto3 documentation

# create_workflow_run method definition

def create_workflow_run(
    self,
    *,
    workflowDefinitionName: str,
    modelId: str,
    clientInfo: ClientInfoTypeDef,  # (1)
    clientToken: str = ...,
    logGroupName: str = ...,
) -> CreateWorkflowRunResponseTypeDef:  # (2)
    ...
  1. See ClientInfoTypeDef
  2. See CreateWorkflowRunResponseTypeDef
# create_workflow_run method usage example with argument unpacking

kwargs: CreateWorkflowRunRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
    "modelId": ...,
    "clientInfo": ...,
}

parent.create_workflow_run(**kwargs)
  1. See CreateWorkflowRunRequestTypeDef

delete_workflow_definition#

Deletes a workflow definition and all associated resources.

Type annotations and code completion for boto3.client("nova-act").delete_workflow_definition method. boto3 documentation

# delete_workflow_definition method definition

def delete_workflow_definition(
    self,
    *,
    workflowDefinitionName: str,
) -> DeleteWorkflowDefinitionResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkflowDefinitionResponseTypeDef
# delete_workflow_definition method usage example with argument unpacking

kwargs: DeleteWorkflowDefinitionRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
}

parent.delete_workflow_definition(**kwargs)
  1. See DeleteWorkflowDefinitionRequestTypeDef

delete_workflow_run#

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

Type annotations and code completion for boto3.client("nova-act").delete_workflow_run method. boto3 documentation

# delete_workflow_run method definition

def delete_workflow_run(
    self,
    *,
    workflowDefinitionName: str,
    workflowRunId: str,
) -> DeleteWorkflowRunResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkflowRunResponseTypeDef
# delete_workflow_run method usage example with argument unpacking

kwargs: DeleteWorkflowRunRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
    "workflowRunId": ...,
}

parent.delete_workflow_run(**kwargs)
  1. See DeleteWorkflowRunRequestTypeDef

get_workflow_definition#

Retrieves the details and configuration of a specific workflow definition.

Type annotations and code completion for boto3.client("nova-act").get_workflow_definition method. boto3 documentation

# get_workflow_definition method definition

def get_workflow_definition(
    self,
    *,
    workflowDefinitionName: str,
) -> GetWorkflowDefinitionResponseTypeDef:  # (1)
    ...
  1. See GetWorkflowDefinitionResponseTypeDef
# get_workflow_definition method usage example with argument unpacking

kwargs: GetWorkflowDefinitionRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
}

parent.get_workflow_definition(**kwargs)
  1. See GetWorkflowDefinitionRequestTypeDef

get_workflow_run#

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

Type annotations and code completion for boto3.client("nova-act").get_workflow_run method. boto3 documentation

# get_workflow_run method definition

def get_workflow_run(
    self,
    *,
    workflowDefinitionName: str,
    workflowRunId: str,
) -> GetWorkflowRunResponseTypeDef:  # (1)
    ...
  1. See GetWorkflowRunResponseTypeDef
# get_workflow_run method usage example with argument unpacking

kwargs: GetWorkflowRunRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
    "workflowRunId": ...,
}

parent.get_workflow_run(**kwargs)
  1. See GetWorkflowRunRequestTypeDef

invoke_act_step#

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

Type annotations and code completion for boto3.client("nova-act").invoke_act_step method. boto3 documentation

# invoke_act_step method definition

def invoke_act_step(
    self,
    *,
    workflowDefinitionName: str,
    workflowRunId: str,
    sessionId: str,
    actId: str,
    callResults: Sequence[CallResultTypeDef],  # (1)
    previousStepId: str = ...,
) -> InvokeActStepResponseTypeDef:  # (2)
    ...
  1. See Sequence[CallResultTypeDef]
  2. See InvokeActStepResponseTypeDef
# invoke_act_step method usage example with argument unpacking

kwargs: InvokeActStepRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
    "workflowRunId": ...,
    "sessionId": ...,
    "actId": ...,
    "callResults": ...,
}

parent.invoke_act_step(**kwargs)
  1. See InvokeActStepRequestTypeDef

list_acts#

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

Type annotations and code completion for boto3.client("nova-act").list_acts method. boto3 documentation

# list_acts method definition

def list_acts(
    self,
    *,
    workflowDefinitionName: str,
    workflowRunId: str = ...,
    sessionId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    sortOrder: SortOrderType = ...,  # (1)
) -> ListActsResponseTypeDef:  # (2)
    ...
  1. See SortOrderType
  2. See ListActsResponseTypeDef
# list_acts method usage example with argument unpacking

kwargs: ListActsRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
}

parent.list_acts(**kwargs)
  1. See ListActsRequestTypeDef

list_models#

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

Type annotations and code completion for boto3.client("nova-act").list_models method. boto3 documentation

# list_models method definition

def list_models(
    self,
    *,
    clientCompatibilityVersion: int,
) -> ListModelsResponseTypeDef:  # (1)
    ...
  1. See ListModelsResponseTypeDef
# list_models method usage example with argument unpacking

kwargs: ListModelsRequestTypeDef = {  # (1)
    "clientCompatibilityVersion": ...,
}

parent.list_models(**kwargs)
  1. See ListModelsRequestTypeDef

list_sessions#

Lists all sessions within a specific workflow run.

Type annotations and code completion for boto3.client("nova-act").list_sessions method. boto3 documentation

# list_sessions method definition

def list_sessions(
    self,
    *,
    workflowDefinitionName: str,
    workflowRunId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    sortOrder: SortOrderType = ...,  # (1)
) -> ListSessionsResponseTypeDef:  # (2)
    ...
  1. See SortOrderType
  2. See ListSessionsResponseTypeDef
# list_sessions method usage example with argument unpacking

kwargs: ListSessionsRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
    "workflowRunId": ...,
}

parent.list_sessions(**kwargs)
  1. See ListSessionsRequestTypeDef

list_workflow_definitions#

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

Type annotations and code completion for boto3.client("nova-act").list_workflow_definitions method. boto3 documentation

# list_workflow_definitions method definition

def list_workflow_definitions(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    sortOrder: SortOrderType = ...,  # (1)
) -> ListWorkflowDefinitionsResponseTypeDef:  # (2)
    ...
  1. See SortOrderType
  2. See ListWorkflowDefinitionsResponseTypeDef
# list_workflow_definitions method usage example with argument unpacking

kwargs: ListWorkflowDefinitionsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_workflow_definitions(**kwargs)
  1. See ListWorkflowDefinitionsRequestTypeDef

list_workflow_runs#

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

Type annotations and code completion for boto3.client("nova-act").list_workflow_runs method. boto3 documentation

# list_workflow_runs method definition

def list_workflow_runs(
    self,
    *,
    workflowDefinitionName: str,
    maxResults: int = ...,
    nextToken: str = ...,
    sortOrder: SortOrderType = ...,  # (1)
) -> ListWorkflowRunsResponseTypeDef:  # (2)
    ...
  1. See SortOrderType
  2. See ListWorkflowRunsResponseTypeDef
# list_workflow_runs method usage example with argument unpacking

kwargs: ListWorkflowRunsRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
}

parent.list_workflow_runs(**kwargs)
  1. See ListWorkflowRunsRequestTypeDef

update_act#

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

Type annotations and code completion for boto3.client("nova-act").update_act method. boto3 documentation

# update_act method definition

def update_act(
    self,
    *,
    workflowDefinitionName: str,
    workflowRunId: str,
    sessionId: str,
    actId: str,
    status: ActStatusType,  # (1)
    error: ActErrorTypeDef = ...,  # (2)
) -> dict[str, Any]:
    ...
  1. See ActStatusType
  2. See ActErrorTypeDef
# update_act method usage example with argument unpacking

kwargs: UpdateActRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
    "workflowRunId": ...,
    "sessionId": ...,
    "actId": ...,
    "status": ...,
}

parent.update_act(**kwargs)
  1. See UpdateActRequestTypeDef

update_workflow_run#

Updates the configuration or state of an active workflow run.

Type annotations and code completion for boto3.client("nova-act").update_workflow_run method. boto3 documentation

# update_workflow_run method definition

def update_workflow_run(
    self,
    *,
    workflowDefinitionName: str,
    workflowRunId: str,
    status: WorkflowRunStatusType,  # (1)
) -> dict[str, Any]:
    ...
  1. See WorkflowRunStatusType
# update_workflow_run method usage example with argument unpacking

kwargs: UpdateWorkflowRunRequestTypeDef = {  # (1)
    "workflowDefinitionName": ...,
    "workflowRunId": ...,
    "status": ...,
}

parent.update_workflow_run(**kwargs)
  1. See UpdateWorkflowRunRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("nova-act").get_paginator method with overloads.