Struct Client 

pub struct Client { /* private fields */ }

Client for Nova Act Service

Client for invoking operations on Nova Act Service. Each operation on Nova Act Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_novaact::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_novaact::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateAct operation has a Client::create_act, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_act()
    .workflow_definition_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_act(&self) -> CreateActFluentBuilder

Constructs a fluent builder for the CreateAct operation.

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition containing the session.

    
    
  • workflow_run_id(impl Into<String>) / set_workflow_run_id(Option<String>):
    required: true
    

    The unique identifier of the workflow run containing the session.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The unique identifier of the session to create the act in.

    
    
  • task(impl Into<String>) / set_task(Option<String>):
    required: true
    

    The task description that defines what the act should accomplish.

    
    
  • tool_specs(ToolSpec) / set_tool_specs(Option<Vec::<ToolSpec>>):
    required: false
    

    A list of tool specifications that the act can invoke to complete its task.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with CreateActOutput with field(s):
  • act_id(String):

    The unique identifier for the created act.

  • status(ActStatus):

    The initial status of the act after creation.

• On failure, responds with SdkError<CreateActError>

impl Client

pub fn create_session(&self) -> CreateSessionFluentBuilder

Constructs a fluent builder for the CreateSession operation.

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition containing the workflow run.

    
    
  • workflow_run_id(impl Into<String>) / set_workflow_run_id(Option<String>):
    required: true
    

    The unique identifier of the workflow run to create the session in.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with CreateSessionOutput with field(s):
  • session_id(String):

    The unique identifier for the created session.

• On failure, responds with SdkError<CreateSessionError>

impl Client

pub fn create_workflow_definition( &self, ) -> CreateWorkflowDefinitionFluentBuilder

Constructs a fluent builder for the CreateWorkflowDefinition operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the workflow definition. Must be unique within your account and region.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description of the workflow definition’s purpose and functionality.

    
    
  • export_config(WorkflowExportConfig) / set_export_config(Option<WorkflowExportConfig>):
    required: false
    

    Configuration for exporting workflow execution data to Amazon Simple Storage Service.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with CreateWorkflowDefinitionOutput with field(s):
  • status(WorkflowDefinitionStatus):

    The current status of the workflow definition after creation.

• On failure, responds with SdkError<CreateWorkflowDefinitionError>

impl Client

pub fn create_workflow_run(&self) -> CreateWorkflowRunFluentBuilder

Constructs a fluent builder for the CreateWorkflowRun operation.

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition to execute.

    
    
  • model_id(impl Into<String>) / set_model_id(Option<String>):
    required: true
    

    The ID of the AI model to use for workflow execution.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • log_group_name(impl Into<String>) / set_log_group_name(Option<String>):
    required: false
    

    The CloudWatch log group name for storing workflow execution logs.

    
    
  • client_info(ClientInfo) / set_client_info(Option<ClientInfo>):
    required: true
    

    Information about the client making the request, including compatibility version and SDK version.

    
    
• On success, responds with CreateWorkflowRunOutput with field(s):
  • workflow_run_id(String):

    The unique identifier for the created workflow run.

  • status(WorkflowRunStatus):

    The initial status of the workflow run after creation.

• On failure, responds with SdkError<CreateWorkflowRunError>

impl Client

pub fn delete_workflow_definition( &self, ) -> DeleteWorkflowDefinitionFluentBuilder

Constructs a fluent builder for the DeleteWorkflowDefinition operation.

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition to delete.

    
    
• On success, responds with DeleteWorkflowDefinitionOutput with field(s):
  • status(WorkflowDefinitionStatus):

    The status of the workflow definition after deletion request.

• On failure, responds with SdkError<DeleteWorkflowDefinitionError>

impl Client

pub fn delete_workflow_run(&self) -> DeleteWorkflowRunFluentBuilder

Constructs a fluent builder for the DeleteWorkflowRun operation.

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition containing the workflow run.

    
    
  • workflow_run_id(impl Into<String>) / set_workflow_run_id(Option<String>):
    required: true
    

    The unique identifier of the workflow run to delete.

    
    
• On success, responds with DeleteWorkflowRunOutput with field(s):
  • status(WorkflowRunStatus):

    The status of the workflow run after deletion request.

• On failure, responds with SdkError<DeleteWorkflowRunError>

impl Client

pub fn get_workflow_definition(&self) -> GetWorkflowDefinitionFluentBuilder

Constructs a fluent builder for the GetWorkflowDefinition operation.

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition to retrieve.

    
    
• On success, responds with GetWorkflowDefinitionOutput with field(s):
  • name(String):

    The name of the workflow definition.

  • arn(String):

    The Amazon Resource Name (ARN) of the workflow definition.

  • created_at(DateTime):

    The timestamp when the workflow definition was created.

  • description(Option<String>):

    The description of the workflow definition.

  • export_config(Option<WorkflowExportConfig>):

    The export configuration for the workflow definition.

  • status(WorkflowDefinitionStatus):

    The current status of the workflow definition.

• On failure, responds with SdkError<GetWorkflowDefinitionError>

impl Client

pub fn get_workflow_run(&self) -> GetWorkflowRunFluentBuilder

Constructs a fluent builder for the GetWorkflowRun operation.

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition containing the workflow run.

    
    
  • workflow_run_id(impl Into<String>) / set_workflow_run_id(Option<String>):
    required: true
    

    The unique identifier of the workflow run to retrieve.

    
    
• On success, responds with GetWorkflowRunOutput with field(s):
  • workflow_run_arn(String):

    The Amazon Resource Name (ARN) of the workflow run.

  • workflow_run_id(String):

    The unique identifier of the workflow run.

  • status(WorkflowRunStatus):

    The current execution status of the workflow run.

  • started_at(DateTime):

    The timestamp when the workflow run started execution.

  • ended_at(Option<DateTime>):

    The timestamp when the workflow run completed execution, if applicable.

  • model_id(String):

    The ID of the AI model being used for this workflow run.

  • log_group_name(Option<String>):

    The CloudWatch log group name for this workflow run’s logs.

• On failure, responds with SdkError<GetWorkflowRunError>

impl Client

pub fn invoke_act_step(&self) -> InvokeActStepFluentBuilder

Constructs a fluent builder for the InvokeActStep operation.

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition containing the act.

    
    
  • workflow_run_id(impl Into<String>) / set_workflow_run_id(Option<String>):
    required: true
    

    The unique identifier of the workflow run containing the act.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The unique identifier of the session containing the act.

    
    
  • act_id(impl Into<String>) / set_act_id(Option<String>):
    required: true
    

    The unique identifier of the act to invoke the next step for.

    
    
  • call_results(CallResult) / set_call_results(Option<Vec::<CallResult>>):
    required: true
    

    The results from previous tool calls that the act requested.

    
    
  • previous_step_id(impl Into<String>) / set_previous_step_id(Option<String>):
    required: false
    

    The identifier of the previous step, used for tracking execution flow.

    
    
• On success, responds with InvokeActStepOutput with field(s):
  • calls(Vec::<Call>):

    A list of tool calls that the act wants to execute in this step.

  • step_id(String):

    The unique identifier for this execution step.

• On failure, responds with SdkError<InvokeActStepError>

impl Client

pub fn list_acts(&self) -> ListActsFluentBuilder

Constructs a fluent builder for the ListActs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition containing the session.

    
    
  • workflow_run_id(impl Into<String>) / set_workflow_run_id(Option<String>):
    required: false
    

    The unique identifier of the workflow run containing the session.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: false
    

    The unique identifier of the session to list acts for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of acts to return in a single response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    The sort order for the returned acts (ascending or descending).

    
    
• On success, responds with ListActsOutput with field(s):
  • act_summaries(Vec::<ActSummary>):

    A list of summary information for acts in the session.

  • next_token(Option<String>):

    The token for retrieving the next page of results, if available.

• On failure, responds with SdkError<ListActsError>

impl Client

pub fn list_models(&self) -> ListModelsFluentBuilder

Constructs a fluent builder for the ListModels operation.

• The fluent builder is configurable:
  • client_compatibility_version(i32) / set_client_compatibility_version(Option<i32>):
    required: true
    

    The client compatibility version to filter models by compatibility.

    
    
• On success, responds with ListModelsOutput with field(s):
  • model_summaries(Vec::<ModelSummary>):

    A list of available AI models with their status and compatibility information.

  • model_aliases(Vec::<ModelAlias>):

    A list of model aliases that provide stable references to model versions.

  • compatibility_information(Option<CompatibilityInformation>):

    Information about client compatibility and supported models.

• On failure, responds with SdkError<ListModelsError>

impl Client

pub fn list_sessions(&self) -> ListSessionsFluentBuilder

Constructs a fluent builder for the ListSessions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition containing the workflow run.

    
    
  • workflow_run_id(impl Into<String>) / set_workflow_run_id(Option<String>):
    required: true
    

    The unique identifier of the workflow run to list sessions for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of sessions to return in a single response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    The sort order for the returned sessions (ascending or descending).

    
    
• On success, responds with ListSessionsOutput with field(s):
  • session_summaries(Vec::<SessionSummary>):

    A list of summary information for sessions in the workflow run.

  • next_token(Option<String>):

    The token for retrieving the next page of results, if available.

• On failure, responds with SdkError<ListSessionsError>

impl Client

pub fn list_workflow_definitions(&self) -> ListWorkflowDefinitionsFluentBuilder

Constructs a fluent builder for the ListWorkflowDefinitions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of workflow definitions to return in a single response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    The sort order for the returned workflow definitions (ascending or descending).

    
    
• On success, responds with ListWorkflowDefinitionsOutput with field(s):
  • workflow_definition_summaries(Vec::<WorkflowDefinitionSummary>):

    A list of summary information for workflow definitions.

  • next_token(Option<String>):

    The token for retrieving the next page of results, if available.

• On failure, responds with SdkError<ListWorkflowDefinitionsError>

impl Client

pub fn list_workflow_runs(&self) -> ListWorkflowRunsFluentBuilder

Constructs a fluent builder for the ListWorkflowRuns operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition to list workflow runs for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of workflow runs to return in a single response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for retrieving the next page of results.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    The sort order for the returned workflow runs (ascending or descending).

    
    
• On success, responds with ListWorkflowRunsOutput with field(s):
  • workflow_run_summaries(Vec::<WorkflowRunSummary>):

    A list of summary information for workflow runs.

  • next_token(Option<String>):

    The token for retrieving the next page of results, if available.

• On failure, responds with SdkError<ListWorkflowRunsError>

impl Client

pub fn update_act(&self) -> UpdateActFluentBuilder

Constructs a fluent builder for the UpdateAct operation.

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition containing the act.

    
    
  • workflow_run_id(impl Into<String>) / set_workflow_run_id(Option<String>):
    required: true
    

    The unique identifier of the workflow run containing the act.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The unique identifier of the session containing the act.

    
    
  • act_id(impl Into<String>) / set_act_id(Option<String>):
    required: true
    

    The unique identifier of the act to update.

    
    
  • status(ActStatus) / set_status(Option<ActStatus>):
    required: true
    

    The new status to set for the act.

    
    
  • error(ActError) / set_error(Option<ActError>):
    required: false
    

    Error information to associate with the act, if applicable.

    
    
• On success, responds with UpdateActOutput
• On failure, responds with SdkError<UpdateActError>

impl Client

pub fn update_workflow_run(&self) -> UpdateWorkflowRunFluentBuilder

Constructs a fluent builder for the UpdateWorkflowRun operation.

• The fluent builder is configurable:
  • workflow_definition_name(impl Into<String>) / set_workflow_definition_name(Option<String>):
    required: true
    

    The name of the workflow definition containing the workflow run.

    
    
  • workflow_run_id(impl Into<String>) / set_workflow_run_id(Option<String>):
    required: true
    

    The unique identifier of the workflow run to update.

    
    
  • status(WorkflowRunStatus) / set_status(Option<WorkflowRunStatus>):
    required: true
    

    The new status to set for the workflow run.

    
    
• On success, responds with UpdateWorkflowRunOutput
• On failure, responds with SdkError<UpdateWorkflowRunError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.