Class: Aws::NovaAct::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-novaact/client.rb,
sig/client.rbs

Overview

An API client for NovaAct. To construct a client, you need to configure a :region and :credentials.

client = Aws::NovaAct::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Defined Under Namespace

Modules: _CreateActResponseSuccess, _CreateSessionResponseSuccess, _CreateWorkflowDefinitionResponseSuccess, _CreateWorkflowRunResponseSuccess, _DeleteWorkflowDefinitionResponseSuccess, _DeleteWorkflowRunResponseSuccess, _GetWorkflowDefinitionResponseSuccess, _GetWorkflowRunResponseSuccess, _InvokeActStepResponseSuccess, _ListActsResponseSuccess, _ListModelsResponseSuccess, _ListSessionsResponseSuccess, _ListWorkflowDefinitionsResponseSuccess, _ListWorkflowRunsResponseSuccess, _UpdateActResponseSuccess, _UpdateWorkflowRunResponseSuccess

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::NovaAct::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::NovaAct::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'lib/aws-sdk-novaact/client.rb', line 471

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1257
1258
1259
 
# File 'lib/aws-sdk-novaact/client.rb', line 1257

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1260
1261
1262
 
# File 'lib/aws-sdk-novaact/client.rb', line 1260

def errors_module
  Errors
end

.new ⇒ Object

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/NovaAct/Client.html#initialize-instance_method



14
 
# File 'sig/client.rbs', line 14

def self.new: (

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# File 'lib/aws-sdk-novaact/client.rb', line 1230

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::NovaAct')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-novaact'
  context[:gem_version] = '1.9.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_act(params = {}) ⇒ Types::CreateActResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_act({
  workflow_definition_name: "WorkflowDefinitionName", # required
  workflow_run_id: "UuidString", # required
  session_id: "UuidString", # required
  task: "Task", # required
  tool_specs: [
    {
      name: "ToolName", # required
      description: "ToolDescription", # required
      input_schema: { # required
        json: {
        },
      },
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.act_id #=> String
resp.status #=> String, one of "RUNNING", "PENDING_CLIENT_ACTION", "PENDING_HUMAN_ACTION", "SUCCEEDED", "FAILED", "TIMED_OUT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition containing the session.

  • :workflow_run_id (required, String) —

    The unique identifier of the workflow run containing the session.

  • :session_id (required, String) —

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

  • :task (required, String) —

    The task description that defines what the act should accomplish.

  • :tool_specs (Array<Types::ToolSpec>) —

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

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



87
 
# File 'sig/client.rbs', line 87

def create_act: (

#create_session(params = {}) ⇒ Types::CreateSessionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_session({
  workflow_definition_name: "WorkflowDefinitionName", # required
  workflow_run_id: "UuidString", # required
  client_token: "ClientToken",
})

Response structure


resp.session_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition containing the workflow run.

  • :workflow_run_id (required, String) —

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

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



111
 
# File 'sig/client.rbs', line 111

def create_session: (

#create_workflow_definition(params = {}) ⇒ Types::CreateWorkflowDefinitionResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_workflow_definition({
  name: "WorkflowDefinitionName", # required
  description: "WorkflowDescription",
  export_config: {
    s3_bucket_name: "S3BucketName", # required
    s3_key_prefix: "S3KeyPrefix",
  },
  client_token: "ClientToken",
})

Response structure


resp.status #=> String, one of "ACTIVE", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :description (String) —

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

  • :export_config (Types::WorkflowExportConfig) —

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

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



123
 
# File 'sig/client.rbs', line 123

def create_workflow_definition: (

#create_workflow_run(params = {}) ⇒ Types::CreateWorkflowRunResponse

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

Examples:

Request syntax with placeholder values


resp = client.create_workflow_run({
  workflow_definition_name: "WorkflowDefinitionName", # required
  model_id: "ModelId", # required
  client_token: "ClientToken",
  log_group_name: "CloudWatchLogGroupName",
  client_info: { # required
    compatibility_version: 1, # required
    sdk_version: "NonBlankString",
  },
})

Response structure


resp.workflow_run_id #=> String
resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition to execute.

  • :model_id (required, String) —

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

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :log_group_name (String) —

    The CloudWatch log group name for storing workflow execution logs.

  • :client_info (required, Types::ClientInfo) —

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

Returns:

See Also:



140
 
# File 'sig/client.rbs', line 140

def create_workflow_run: (

#delete_workflow_definition(params = {}) ⇒ Types::DeleteWorkflowDefinitionResponse

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

Examples:

Request syntax with placeholder values


resp = client.delete_workflow_definition({
  workflow_definition_name: "WorkflowDefinitionName", # required
})

Response structure


resp.status #=> String, one of "ACTIVE", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition to delete.

Returns:

See Also:



157
 
# File 'sig/client.rbs', line 157

def delete_workflow_definition: (

#delete_workflow_run(params = {}) ⇒ Types::DeleteWorkflowRunResponse

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

Examples:

Request syntax with placeholder values


resp = client.delete_workflow_run({
  workflow_definition_name: "WorkflowDefinitionName", # required
  workflow_run_id: "UuidString", # required
})

Response structure


resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition containing the workflow run.

  • :workflow_run_id (required, String) —

    The unique identifier of the workflow run to delete.

Returns:

See Also:



167
 
# File 'sig/client.rbs', line 167

def delete_workflow_run: (

#get_workflow_definition(params = {}) ⇒ Types::GetWorkflowDefinitionResponse

Retrieves the details and configuration of a specific workflow definition.

Examples:

Request syntax with placeholder values


resp = client.get_workflow_definition({
  workflow_definition_name: "WorkflowDefinitionName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.created_at #=> Time
resp.description #=> String
resp.export_config.s3_bucket_name #=> String
resp.export_config.s3_key_prefix #=> String
resp.status #=> String, one of "ACTIVE", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition to retrieve.

Returns:

See Also:



183
 
# File 'sig/client.rbs', line 183

def get_workflow_definition: (

#get_workflow_run(params = {}) ⇒ Types::GetWorkflowRunResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_workflow_run({
  workflow_definition_name: "WorkflowDefinitionName", # required
  workflow_run_id: "UuidString", # required
})

Response structure


resp.workflow_run_arn #=> String
resp.workflow_run_id #=> String
resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "DELETING"
resp.started_at #=> Time
resp.ended_at #=> Time
resp.model_id #=> String
resp.log_group_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition containing the workflow run.

  • :workflow_run_id (required, String) —

    The unique identifier of the workflow run to retrieve.

Returns:

See Also:



199
 
# File 'sig/client.rbs', line 199

def get_workflow_run: (

#invoke_act_step(params = {}) ⇒ Types::InvokeActStepResponse

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

Examples:

Request syntax with placeholder values


resp = client.invoke_act_step({
  workflow_definition_name: "WorkflowDefinitionName", # required
  workflow_run_id: "UuidString", # required
  session_id: "UuidString", # required
  act_id: "UuidString", # required
  call_results: [ # required
    {
      call_id: "CallId",
      content: [ # required
        {
          text: "String",
        },
      ],
    },
  ],
  previous_step_id: "UuidString",
})

Response structure


resp.calls #=> Array
resp.calls[0].call_id #=> String
resp.calls[0].name #=> String
resp.step_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition containing the act.

  • :workflow_run_id (required, String) —

    The unique identifier of the workflow run containing the act.

  • :session_id (required, String) —

    The unique identifier of the session containing the act.

  • :act_id (required, String) —

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

  • :call_results (required, Array<Types::CallResult>) —

    The results from previous tool calls that the act requested.

  • :previous_step_id (String) —

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

Returns:

See Also:



211
 
# File 'sig/client.rbs', line 211

def invoke_act_step: (

#list_acts(params = {}) ⇒ Types::ListActsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_acts({
  workflow_definition_name: "WorkflowDefinitionName", # required
  workflow_run_id: "UuidString",
  session_id: "UuidString",
  max_results: 1,
  next_token: "NextToken",
  sort_order: "Ascending", # accepts Ascending, Descending
})

Response structure


resp.act_summaries #=> Array
resp.act_summaries[0].workflow_run_id #=> String
resp.act_summaries[0].session_id #=> String
resp.act_summaries[0].act_id #=> String
resp.act_summaries[0].status #=> String, one of "RUNNING", "PENDING_CLIENT_ACTION", "PENDING_HUMAN_ACTION", "SUCCEEDED", "FAILED", "TIMED_OUT"
resp.act_summaries[0].started_at #=> Time
resp.act_summaries[0].ended_at #=> Time
resp.act_summaries[0].trace_location.location_type #=> String, one of "S3"
resp.act_summaries[0].trace_location.location #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition containing the session.

  • :workflow_run_id (String) —

    The unique identifier of the workflow run containing the session.

  • :session_id (String) —

    The unique identifier of the session to list acts for.

  • :max_results (Integer) —

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

  • :next_token (String) —

    The token for retrieving the next page of results.

  • :sort_order (String) —

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

Returns:

See Also:



236
 
# File 'sig/client.rbs', line 236

def list_acts: (

#list_models(params = {}) ⇒ Types::ListModelsResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_models({
  client_compatibility_version: 1, # required
})

Response structure


resp.model_summaries #=> Array
resp.model_summaries[0].model_id #=> String
resp.model_summaries[0].model_lifecycle.status #=> String, one of "ACTIVE", "LEGACY", "DEPRECATED", "PREVIEW"
resp.model_summaries[0].minimum_compatibility_version #=> Integer
resp.model_aliases #=> Array
resp.model_aliases[0].alias_name #=> String
resp.model_aliases[0].latest_model_id #=> String
resp.model_aliases[0].resolved_model_id #=> String
resp.compatibility_information.client_compatibility_version #=> Integer
resp.compatibility_information.supported_model_ids #=> Array
resp.compatibility_information.supported_model_ids[0] #=> String
resp.compatibility_information.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_compatibility_version (required, Integer) —

    The client compatibility version to filter models by compatibility.

Returns:

See Also:



253
 
# File 'sig/client.rbs', line 253

def list_models: (

#list_sessions(params = {}) ⇒ Types::ListSessionsResponse

Lists all sessions within a specific workflow run.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_sessions({
  workflow_definition_name: "WorkflowDefinitionName", # required
  workflow_run_id: "UuidString", # required
  max_results: 1,
  next_token: "NextToken",
  sort_order: "Ascending", # accepts Ascending, Descending
})

Response structure


resp.session_summaries #=> Array
resp.session_summaries[0].session_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition containing the workflow run.

  • :workflow_run_id (required, String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

    The token for retrieving the next page of results.

  • :sort_order (String) —

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

Returns:

See Also:



264
 
# File 'sig/client.rbs', line 264

def list_sessions: (

#list_workflow_definitions(params = {}) ⇒ Types::ListWorkflowDefinitionsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workflow_definitions({
  max_results: 1,
  next_token: "NextToken",
  sort_order: "Ascending", # accepts Ascending, Descending
})

Response structure


resp.workflow_definition_summaries #=> Array
resp.workflow_definition_summaries[0].workflow_definition_arn #=> String
resp.workflow_definition_summaries[0].workflow_definition_name #=> String
resp.workflow_definition_summaries[0].created_at #=> Time
resp.workflow_definition_summaries[0].status #=> String, one of "ACTIVE", "DELETING"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

    The token for retrieving the next page of results.

  • :sort_order (String) —

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

Returns:

See Also:



279
 
# File 'sig/client.rbs', line 279

def list_workflow_definitions: (

#list_workflow_runs(params = {}) ⇒ Types::ListWorkflowRunsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workflow_runs({
  workflow_definition_name: "WorkflowDefinitionName", # required
  max_results: 1,
  next_token: "NextToken",
  sort_order: "Ascending", # accepts Ascending, Descending
})

Response structure


resp.workflow_run_summaries #=> Array
resp.workflow_run_summaries[0].workflow_run_arn #=> String
resp.workflow_run_summaries[0].workflow_run_id #=> String
resp.workflow_run_summaries[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "DELETING"
resp.workflow_run_summaries[0].started_at #=> Time
resp.workflow_run_summaries[0].ended_at #=> Time
resp.workflow_run_summaries[0].trace_location.location_type #=> String, one of "S3"
resp.workflow_run_summaries[0].trace_location.location #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

    The token for retrieving the next page of results.

  • :sort_order (String) —

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

Returns:

See Also:



292
 
# File 'sig/client.rbs', line 292

def list_workflow_runs: (

#update_act(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.update_act({
  workflow_definition_name: "WorkflowDefinitionName", # required
  workflow_run_id: "UuidString", # required
  session_id: "UuidString", # required
  act_id: "UuidString", # required
  status: "RUNNING", # required, accepts RUNNING, PENDING_CLIENT_ACTION, PENDING_HUMAN_ACTION, SUCCEEDED, FAILED, TIMED_OUT
  error: {
    message: "ActErrorMessageString", # required
    type: "ActErrorTypeString",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition containing the act.

  • :workflow_run_id (required, String) —

    The unique identifier of the workflow run containing the act.

  • :session_id (required, String) —

    The unique identifier of the session containing the act.

  • :act_id (required, String) —

    The unique identifier of the act to update.

  • :status (required, String) —

    The new status to set for the act.

  • :error (Types::ActError) —

    Error information to associate with the act, if applicable.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



304
 
# File 'sig/client.rbs', line 304

def update_act: (

#update_workflow_run(params = {}) ⇒ Struct

Updates the configuration or state of an active workflow run.

Examples:

Request syntax with placeholder values


resp = client.update_workflow_run({
  workflow_definition_name: "WorkflowDefinitionName", # required
  workflow_run_id: "UuidString", # required
  status: "RUNNING", # required, accepts RUNNING, SUCCEEDED, FAILED, TIMED_OUT, DELETING
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_definition_name (required, String) —

    The name of the workflow definition containing the workflow run.

  • :workflow_run_id (required, String) —

    The unique identifier of the workflow run to update.

  • :status (required, String) —

    The new status to set for the workflow run.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



321
 
# File 'sig/client.rbs', line 321

def update_workflow_run: (

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1250
1251
1252
 
# File 'lib/aws-sdk-novaact/client.rb', line 1250

def waiter_names
  []
end