aws-sdk-novaact 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1268 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length'
11
+ require 'aws-sdk-core/plugins/credentials_configuration'
12
+ require 'aws-sdk-core/plugins/logging'
13
+ require 'aws-sdk-core/plugins/param_converter'
14
+ require 'aws-sdk-core/plugins/param_validator'
15
+ require 'aws-sdk-core/plugins/user_agent'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors'
17
+ require 'aws-sdk-core/plugins/retry_errors'
18
+ require 'aws-sdk-core/plugins/global_configuration'
19
+ require 'aws-sdk-core/plugins/regional_endpoint'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern'
22
+ require 'aws-sdk-core/plugins/response_paging'
23
+ require 'aws-sdk-core/plugins/stub_responses'
24
+ require 'aws-sdk-core/plugins/idempotency_token'
25
+ require 'aws-sdk-core/plugins/invocation_id'
26
+ require 'aws-sdk-core/plugins/jsonvalue_converter'
27
+ require 'aws-sdk-core/plugins/client_metrics_plugin'
28
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin'
29
+ require 'aws-sdk-core/plugins/transfer_encoding'
30
+ require 'aws-sdk-core/plugins/http_checksum'
31
+ require 'aws-sdk-core/plugins/checksum_algorithm'
32
+ require 'aws-sdk-core/plugins/request_compression'
33
+ require 'aws-sdk-core/plugins/defaults_mode'
34
+ require 'aws-sdk-core/plugins/recursion_detection'
35
+ require 'aws-sdk-core/plugins/telemetry'
36
+ require 'aws-sdk-core/plugins/sign'
37
+ require 'aws-sdk-core/plugins/protocols/rest_json'
38
+
39
+ module Aws::NovaAct
40
+ # An API client for NovaAct. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::NovaAct::Client.new(
43
+ # region: region_name,
44
+ # credentials: credentials,
45
+ # # ...
46
+ # )
47
+ #
48
+ # For details on configuring region and credentials see
49
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
50
+ #
51
+ # See {#initialize} for a full list of supported configuration options.
52
+ class Client < Seahorse::Client::Base
53
+
54
+ include Aws::ClientStubs
55
+
56
+ @identifier = :novaact
57
+
58
+ set_api(ClientApi::API)
59
+
60
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
61
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
62
+ add_plugin(Aws::Plugins::Logging)
63
+ add_plugin(Aws::Plugins::ParamConverter)
64
+ add_plugin(Aws::Plugins::ParamValidator)
65
+ add_plugin(Aws::Plugins::UserAgent)
66
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
67
+ add_plugin(Aws::Plugins::RetryErrors)
68
+ add_plugin(Aws::Plugins::GlobalConfiguration)
69
+ add_plugin(Aws::Plugins::RegionalEndpoint)
70
+ add_plugin(Aws::Plugins::EndpointDiscovery)
71
+ add_plugin(Aws::Plugins::EndpointPattern)
72
+ add_plugin(Aws::Plugins::ResponsePaging)
73
+ add_plugin(Aws::Plugins::StubResponses)
74
+ add_plugin(Aws::Plugins::IdempotencyToken)
75
+ add_plugin(Aws::Plugins::InvocationId)
76
+ add_plugin(Aws::Plugins::JsonvalueConverter)
77
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
78
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
79
+ add_plugin(Aws::Plugins::TransferEncoding)
80
+ add_plugin(Aws::Plugins::HttpChecksum)
81
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
82
+ add_plugin(Aws::Plugins::RequestCompression)
83
+ add_plugin(Aws::Plugins::DefaultsMode)
84
+ add_plugin(Aws::Plugins::RecursionDetection)
85
+ add_plugin(Aws::Plugins::Telemetry)
86
+ add_plugin(Aws::Plugins::Sign)
87
+ add_plugin(Aws::Plugins::Protocols::RestJson)
88
+ add_plugin(Aws::NovaAct::Plugins::Endpoints)
89
+
90
+ # @overload initialize(options)
91
+ # @param [Hash] options
92
+ #
93
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
94
+ # A list of plugins to apply to the client. Each plugin is either a
95
+ # class name or an instance of a plugin class.
96
+ #
97
+ # @option options [required, Aws::CredentialProvider] :credentials
98
+ # Your AWS credentials used for authentication. This can be any class that includes and implements
99
+ # `Aws::CredentialProvider`, or instance of any one of the following classes:
100
+ #
101
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
102
+ # credentials.
103
+ #
104
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
105
+ # shared file, such as `~/.aws/config`.
106
+ #
107
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ #
109
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
110
+ # assume a role after providing credentials via the web.
111
+ #
112
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
113
+ # access token generated from `aws login`.
114
+ #
115
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
116
+ # process that outputs to stdout.
117
+ #
118
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
119
+ # from an EC2 IMDS on an EC2 instance.
120
+ #
121
+ # * `Aws::ECSCredentials` - Used for loading credentials from
122
+ # instances running in ECS.
123
+ #
124
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
125
+ # from the Cognito Identity service.
126
+ #
127
+ # When `:credentials` are not configured directly, the following locations will be searched for credentials:
128
+ #
129
+ # * `Aws.config[:credentials]`
130
+ #
131
+ # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
+ # `:account_id` options.
133
+ #
134
+ # * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
135
+ # `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
136
+ #
137
+ # * `~/.aws/credentials`
138
+ #
139
+ # * `~/.aws/config`
140
+ #
141
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
142
+ # Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
143
+ # enable retries and extended timeouts. Instance profile credential fetching can be disabled by
144
+ # setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
145
+ #
146
+ # @option options [required, String] :region
147
+ # The AWS region to connect to. The configured `:region` is
148
+ # used to determine the service `:endpoint`. When not passed,
149
+ # a default `:region` is searched for in the following locations:
150
+ #
151
+ # * `Aws.config[:region]`
152
+ # * `ENV['AWS_REGION']`
153
+ # * `ENV['AMAZON_REGION']`
154
+ # * `ENV['AWS_DEFAULT_REGION']`
155
+ # * `~/.aws/credentials`
156
+ # * `~/.aws/config`
157
+ #
158
+ # @option options [String] :access_key_id
159
+ #
160
+ # @option options [String] :account_id
161
+ #
162
+ # @option options [Boolean] :active_endpoint_cache (false)
163
+ # When set to `true`, a thread polling for endpoints will be running in
164
+ # the background every 60 secs (default). Defaults to `false`.
165
+ #
166
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
167
+ # Used only in `adaptive` retry mode. When true, the request will sleep
168
+ # until there is sufficent client side capacity to retry the request.
169
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
170
+ # not retry instead of sleeping.
171
+ #
172
+ # @option options [Array<String>] :auth_scheme_preference
173
+ # A list of preferred authentication schemes to use when making a request. Supported values are:
174
+ # `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
175
+ # shared config as `auth_scheme_preference`, the value should be a comma-separated list.
176
+ #
177
+ # @option options [Boolean] :client_side_monitoring (false)
178
+ # When `true`, client-side metrics will be collected for all API requests from
179
+ # this client.
180
+ #
181
+ # @option options [String] :client_side_monitoring_client_id ("")
182
+ # Allows you to provide an identifier for this client which will be attached to
183
+ # all generated client side metrics. Defaults to an empty string.
184
+ #
185
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
186
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
187
+ # side monitoring agent is running on, where client metrics will be published via UDP.
188
+ #
189
+ # @option options [Integer] :client_side_monitoring_port (31000)
190
+ # Required for publishing client metrics. The port that the client side monitoring
191
+ # agent is running on, where client metrics will be published via UDP.
192
+ #
193
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
194
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
195
+ # will use the Client Side Monitoring Agent Publisher.
196
+ #
197
+ # @option options [Boolean] :convert_params (true)
198
+ # When `true`, an attempt is made to coerce request parameters into
199
+ # the required types.
200
+ #
201
+ # @option options [Boolean] :correct_clock_skew (true)
202
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
203
+ # a clock skew correction and retry requests with skewed client clocks.
204
+ #
205
+ # @option options [String] :defaults_mode ("legacy")
206
+ # See {Aws::DefaultsModeConfiguration} for a list of the
207
+ # accepted modes and the configuration defaults that are included.
208
+ #
209
+ # @option options [Boolean] :disable_host_prefix_injection (false)
210
+ # When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
211
+ #
212
+ # @option options [Boolean] :disable_request_compression (false)
213
+ # When set to 'true' the request body will not be compressed
214
+ # for supported operations.
215
+ #
216
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
217
+ # Normally you should not configure the `:endpoint` option
218
+ # directly. This is normally constructed from the `:region`
219
+ # option. Configuring `:endpoint` is normally reserved for
220
+ # connecting to test or custom endpoints. The endpoint should
221
+ # be a URI formatted like:
222
+ #
223
+ # 'http://example.com'
224
+ # 'https://example.com'
225
+ # 'http://example.com:123'
226
+ #
227
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
228
+ # Used for the maximum size limit of the LRU cache storing endpoints data
229
+ # for endpoint discovery enabled operations. Defaults to 1000.
230
+ #
231
+ # @option options [Integer] :endpoint_cache_max_threads (10)
232
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
233
+ #
234
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
235
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
236
+ # Use this option to config the time interval in seconds for making
237
+ # requests fetching endpoints information. Defaults to 60 sec.
238
+ #
239
+ # @option options [Boolean] :endpoint_discovery (false)
240
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
241
+ #
242
+ # @option options [Boolean] :ignore_configured_endpoint_urls
243
+ # Setting to true disables use of endpoint URLs provided via environment
244
+ # variables and the shared configuration file.
245
+ #
246
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
247
+ # The log formatter.
248
+ #
249
+ # @option options [Symbol] :log_level (:info)
250
+ # The log level to send messages to the `:logger` at.
251
+ #
252
+ # @option options [Logger] :logger
253
+ # The Logger instance to send log messages to. If this option
254
+ # is not set, logging will be disabled.
255
+ #
256
+ # @option options [Integer] :max_attempts (3)
257
+ # An integer representing the maximum number attempts that will be made for
258
+ # a single request, including the initial attempt. For example,
259
+ # setting this value to 5 will result in a request being retried up to
260
+ # 4 times. Used in `standard` and `adaptive` retry modes.
261
+ #
262
+ # @option options [String] :profile ("default")
263
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
264
+ # When not specified, 'default' is used.
265
+ #
266
+ # @option options [String] :request_checksum_calculation ("when_supported")
267
+ # Determines when a checksum will be calculated for request payloads. Values are:
268
+ #
269
+ # * `when_supported` - (default) When set, a checksum will be
270
+ # calculated for all request payloads of operations modeled with the
271
+ # `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
272
+ # `requestAlgorithmMember` is modeled.
273
+ # * `when_required` - When set, a checksum will only be calculated for
274
+ # request payloads of operations modeled with the `httpChecksum` trait where
275
+ # `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
276
+ # is modeled and supplied.
277
+ #
278
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
279
+ # The minimum size in bytes that triggers compression for request
280
+ # bodies. The value must be non-negative integer value between 0
281
+ # and 10485780 bytes inclusive.
282
+ #
283
+ # @option options [String] :response_checksum_validation ("when_supported")
284
+ # Determines when checksum validation will be performed on response payloads. Values are:
285
+ #
286
+ # * `when_supported` - (default) When set, checksum validation is performed on all
287
+ # response payloads of operations modeled with the `httpChecksum` trait where
288
+ # `responseAlgorithms` is modeled, except when no modeled checksum algorithms
289
+ # are supported.
290
+ # * `when_required` - When set, checksum validation is not performed on
291
+ # response payloads of operations unless the checksum algorithm is supported and
292
+ # the `requestValidationModeMember` member is set to `ENABLED`.
293
+ #
294
+ # @option options [Proc] :retry_backoff
295
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
296
+ # This option is only used in the `legacy` retry mode.
297
+ #
298
+ # @option options [Float] :retry_base_delay (0.3)
299
+ # The base delay in seconds used by the default backoff function. This option
300
+ # is only used in the `legacy` retry mode.
301
+ #
302
+ # @option options [Symbol] :retry_jitter (:none)
303
+ # A delay randomiser function used by the default backoff function.
304
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
305
+ # otherwise a Proc that takes and returns a number. This option is only used
306
+ # in the `legacy` retry mode.
307
+ #
308
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
309
+ #
310
+ # @option options [Integer] :retry_limit (3)
311
+ # The maximum number of times to retry failed requests. Only
312
+ # ~ 500 level server errors and certain ~ 400 level client errors
313
+ # are retried. Generally, these are throttling errors, data
314
+ # checksum errors, networking errors, timeout errors, auth errors,
315
+ # endpoint discovery, and errors from expired credentials.
316
+ # This option is only used in the `legacy` retry mode.
317
+ #
318
+ # @option options [Integer] :retry_max_delay (0)
319
+ # The maximum number of seconds to delay between retries (0 for no limit)
320
+ # used by the default backoff function. This option is only used in the
321
+ # `legacy` retry mode.
322
+ #
323
+ # @option options [String] :retry_mode ("legacy")
324
+ # Specifies which retry algorithm to use. Values are:
325
+ #
326
+ # * `legacy` - The pre-existing retry behavior. This is default value if
327
+ # no retry mode is provided.
328
+ #
329
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
330
+ # This includes support for retry quotas, which limit the number of
331
+ # unsuccessful retries a client can make.
332
+ #
333
+ # * `adaptive` - An experimental retry mode that includes all the
334
+ # functionality of `standard` mode along with automatic client side
335
+ # throttling. This is a provisional mode that may change behavior
336
+ # in the future.
337
+ #
338
+ # @option options [String] :sdk_ua_app_id
339
+ # A unique and opaque application ID that is appended to the
340
+ # User-Agent header as app/sdk_ua_app_id. It should have a
341
+ # maximum length of 50. This variable is sourced from environment
342
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
343
+ #
344
+ # @option options [String] :secret_access_key
345
+ #
346
+ # @option options [String] :session_token
347
+ #
348
+ # @option options [Array] :sigv4a_signing_region_set
349
+ # A list of regions that should be signed with SigV4a signing. When
350
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
351
+ # in the following locations:
352
+ #
353
+ # * `Aws.config[:sigv4a_signing_region_set]`
354
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
355
+ # * `~/.aws/config`
356
+ #
357
+ # @option options [Boolean] :stub_responses (false)
358
+ # Causes the client to return stubbed responses. By default
359
+ # fake responses are generated and returned. You can specify
360
+ # the response data to return or errors to raise by calling
361
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
362
+ #
363
+ # ** Please note ** When response stubbing is enabled, no HTTP
364
+ # requests are made, and retries are disabled.
365
+ #
366
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
367
+ # Allows you to provide a telemetry provider, which is used to
368
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
369
+ # will not record or emit any telemetry data. The SDK supports the
370
+ # following telemetry providers:
371
+ #
372
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
373
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
374
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
375
+ #
376
+ # @option options [Aws::TokenProvider] :token_provider
377
+ # Your Bearer token used for authentication. This can be any class that includes and implements
378
+ # `Aws::TokenProvider`, or instance of any one of the following classes:
379
+ #
380
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
381
+ # tokens.
382
+ #
383
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
384
+ # access token generated from `aws login`.
385
+ #
386
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
387
+ # will be used to search for tokens configured for your profile in shared configuration files.
388
+ #
389
+ # @option options [Boolean] :use_dualstack_endpoint
390
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
391
+ # will be used if available.
392
+ #
393
+ # @option options [Boolean] :use_fips_endpoint
394
+ # When set to `true`, fips compatible endpoints will be used if available.
395
+ # When a `fips` region is used, the region is normalized and this config
396
+ # is set to `true`.
397
+ #
398
+ # @option options [Boolean] :validate_params (true)
399
+ # When `true`, request parameters are validated before
400
+ # sending the request.
401
+ #
402
+ # @option options [Aws::NovaAct::EndpointProvider] :endpoint_provider
403
+ # The endpoint provider used to resolve endpoints. Any object that responds to
404
+ # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
405
+ # `Aws::NovaAct::EndpointParameters`.
406
+ #
407
+ # @option options [Float] :http_continue_timeout (1)
408
+ # The number of seconds to wait for a 100-continue response before sending the
409
+ # request body. This option has no effect unless the request has "Expect"
410
+ # header set to "100-continue". Defaults to `nil` which disables this
411
+ # behaviour. This value can safely be set per request on the session.
412
+ #
413
+ # @option options [Float] :http_idle_timeout (5)
414
+ # The number of seconds a connection is allowed to sit idle before it
415
+ # is considered stale. Stale connections are closed and removed from the
416
+ # pool before making a request.
417
+ #
418
+ # @option options [Float] :http_open_timeout (15)
419
+ # The default number of seconds to wait for response data.
420
+ # This value can safely be set per-request on the session.
421
+ #
422
+ # @option options [URI::HTTP,String] :http_proxy
423
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
424
+ #
425
+ # @option options [Float] :http_read_timeout (60)
426
+ # The default number of seconds to wait for response data.
427
+ # This value can safely be set per-request on the session.
428
+ #
429
+ # @option options [Boolean] :http_wire_trace (false)
430
+ # When `true`, HTTP debug output will be sent to the `:logger`.
431
+ #
432
+ # @option options [Proc] :on_chunk_received
433
+ # When a Proc object is provided, it will be used as callback when each chunk
434
+ # of the response body is received. It provides three arguments: the chunk,
435
+ # the number of bytes received, and the total number of
436
+ # bytes in the response (or nil if the server did not send a `content-length`).
437
+ #
438
+ # @option options [Proc] :on_chunk_sent
439
+ # When a Proc object is provided, it will be used as callback when each chunk
440
+ # of the request body is sent. It provides three arguments: the chunk,
441
+ # the number of bytes read from the body, and the total number of
442
+ # bytes in the body.
443
+ #
444
+ # @option options [Boolean] :raise_response_errors (true)
445
+ # When `true`, response errors are raised.
446
+ #
447
+ # @option options [String] :ssl_ca_bundle
448
+ # Full path to the SSL certificate authority bundle file that should be used when
449
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
450
+ # `:ssl_ca_directory` the the system default will be used if available.
451
+ #
452
+ # @option options [String] :ssl_ca_directory
453
+ # Full path of the directory that contains the unbundled SSL certificate
454
+ # authority files for verifying peer certificates. If you do
455
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
456
+ # default will be used if available.
457
+ #
458
+ # @option options [String] :ssl_ca_store
459
+ # Sets the X509::Store to verify peer certificate.
460
+ #
461
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
462
+ # Sets a client certificate when creating http connections.
463
+ #
464
+ # @option options [OpenSSL::PKey] :ssl_key
465
+ # Sets a client key when creating http connections.
466
+ #
467
+ # @option options [Float] :ssl_timeout
468
+ # Sets the SSL timeout in seconds
469
+ #
470
+ # @option options [Boolean] :ssl_verify_peer (true)
471
+ # When `true`, SSL peer certificates are verified when establishing a connection.
472
+ #
473
+ def initialize(*args)
474
+ super
475
+ end
476
+
477
+ # @!group API Operations
478
+
479
+ # Creates a new AI task (act) within a session that can interact with
480
+ # tools and perform specific actions.
481
+ #
482
+ # @option params [required, String] :workflow_definition_name
483
+ # The name of the workflow definition containing the session.
484
+ #
485
+ # @option params [required, String] :workflow_run_id
486
+ # The unique identifier of the workflow run containing the session.
487
+ #
488
+ # @option params [required, String] :session_id
489
+ # The unique identifier of the session to create the act in.
490
+ #
491
+ # @option params [required, String] :task
492
+ # The task description that defines what the act should accomplish.
493
+ #
494
+ # @option params [Array<Types::ToolSpec>] :tool_specs
495
+ # A list of tool specifications that the act can invoke to complete its
496
+ # task.
497
+ #
498
+ # @option params [String] :client_token
499
+ # A unique, case-sensitive identifier that you provide to ensure the
500
+ # idempotency of the request.
501
+ #
502
+ # **A suitable default value is auto-generated.** You should normally
503
+ # not need to pass this option.**
504
+ #
505
+ # @return [Types::CreateActResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
506
+ #
507
+ # * {Types::CreateActResponse#act_id #act_id} => String
508
+ # * {Types::CreateActResponse#status #status} => String
509
+ #
510
+ # @example Request syntax with placeholder values
511
+ #
512
+ # resp = client.create_act({
513
+ # workflow_definition_name: "WorkflowDefinitionName", # required
514
+ # workflow_run_id: "UuidString", # required
515
+ # session_id: "UuidString", # required
516
+ # task: "Task", # required
517
+ # tool_specs: [
518
+ # {
519
+ # name: "ToolName", # required
520
+ # description: "ToolDescription", # required
521
+ # input_schema: { # required
522
+ # json: {
523
+ # },
524
+ # },
525
+ # },
526
+ # ],
527
+ # client_token: "ClientToken",
528
+ # })
529
+ #
530
+ # @example Response structure
531
+ #
532
+ # resp.act_id #=> String
533
+ # resp.status #=> String, one of "RUNNING", "PENDING_CLIENT_ACTION", "PENDING_HUMAN_ACTION", "SUCCEEDED", "FAILED", "TIMED_OUT"
534
+ #
535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/CreateAct AWS API Documentation
536
+ #
537
+ # @overload create_act(params = {})
538
+ # @param [Hash] params ({})
539
+ def create_act(params = {}, options = {})
540
+ req = build_request(:create_act, params)
541
+ req.send_request(options)
542
+ end
543
+
544
+ # Creates a new session context within a workflow run to manage
545
+ # conversation state and acts.
546
+ #
547
+ # @option params [required, String] :workflow_definition_name
548
+ # The name of the workflow definition containing the workflow run.
549
+ #
550
+ # @option params [required, String] :workflow_run_id
551
+ # The unique identifier of the workflow run to create the session in.
552
+ #
553
+ # @option params [String] :client_token
554
+ # A unique, case-sensitive identifier that you provide to ensure the
555
+ # idempotency of the request.
556
+ #
557
+ # **A suitable default value is auto-generated.** You should normally
558
+ # not need to pass this option.**
559
+ #
560
+ # @return [Types::CreateSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
561
+ #
562
+ # * {Types::CreateSessionResponse#session_id #session_id} => String
563
+ #
564
+ # @example Request syntax with placeholder values
565
+ #
566
+ # resp = client.create_session({
567
+ # workflow_definition_name: "WorkflowDefinitionName", # required
568
+ # workflow_run_id: "UuidString", # required
569
+ # client_token: "ClientToken",
570
+ # })
571
+ #
572
+ # @example Response structure
573
+ #
574
+ # resp.session_id #=> String
575
+ #
576
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/CreateSession AWS API Documentation
577
+ #
578
+ # @overload create_session(params = {})
579
+ # @param [Hash] params ({})
580
+ def create_session(params = {}, options = {})
581
+ req = build_request(:create_session, params)
582
+ req.send_request(options)
583
+ end
584
+
585
+ # Creates a new workflow definition template that can be used to execute
586
+ # multiple workflow runs.
587
+ #
588
+ # @option params [required, String] :name
589
+ # The name of the workflow definition. Must be unique within your
590
+ # account and region.
591
+ #
592
+ # @option params [String] :description
593
+ # An optional description of the workflow definition's purpose and
594
+ # functionality.
595
+ #
596
+ # @option params [Types::WorkflowExportConfig] :export_config
597
+ # Configuration for exporting workflow execution data to Amazon Simple
598
+ # Storage Service.
599
+ #
600
+ # @option params [String] :client_token
601
+ # A unique, case-sensitive identifier that you provide to ensure the
602
+ # idempotency of the request.
603
+ #
604
+ # **A suitable default value is auto-generated.** You should normally
605
+ # not need to pass this option.**
606
+ #
607
+ # @return [Types::CreateWorkflowDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
608
+ #
609
+ # * {Types::CreateWorkflowDefinitionResponse#status #status} => String
610
+ #
611
+ # @example Request syntax with placeholder values
612
+ #
613
+ # resp = client.create_workflow_definition({
614
+ # name: "WorkflowDefinitionName", # required
615
+ # description: "WorkflowDescription",
616
+ # export_config: {
617
+ # s3_bucket_name: "S3BucketName", # required
618
+ # s3_key_prefix: "S3KeyPrefix",
619
+ # },
620
+ # client_token: "ClientToken",
621
+ # })
622
+ #
623
+ # @example Response structure
624
+ #
625
+ # resp.status #=> String, one of "ACTIVE", "DELETING"
626
+ #
627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/CreateWorkflowDefinition AWS API Documentation
628
+ #
629
+ # @overload create_workflow_definition(params = {})
630
+ # @param [Hash] params ({})
631
+ def create_workflow_definition(params = {}, options = {})
632
+ req = build_request(:create_workflow_definition, params)
633
+ req.send_request(options)
634
+ end
635
+
636
+ # Creates a new execution instance of a workflow definition with
637
+ # specified parameters.
638
+ #
639
+ # @option params [required, String] :workflow_definition_name
640
+ # The name of the workflow definition to execute.
641
+ #
642
+ # @option params [required, String] :model_id
643
+ # The ID of the AI model to use for workflow execution.
644
+ #
645
+ # @option params [String] :client_token
646
+ # A unique, case-sensitive identifier that you provide to ensure the
647
+ # idempotency of the request.
648
+ #
649
+ # **A suitable default value is auto-generated.** You should normally
650
+ # not need to pass this option.**
651
+ #
652
+ # @option params [String] :log_group_name
653
+ # The CloudWatch log group name for storing workflow execution logs.
654
+ #
655
+ # @option params [required, Types::ClientInfo] :client_info
656
+ # Information about the client making the request, including
657
+ # compatibility version and SDK version.
658
+ #
659
+ # @return [Types::CreateWorkflowRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
660
+ #
661
+ # * {Types::CreateWorkflowRunResponse#workflow_run_id #workflow_run_id} => String
662
+ # * {Types::CreateWorkflowRunResponse#status #status} => String
663
+ #
664
+ # @example Request syntax with placeholder values
665
+ #
666
+ # resp = client.create_workflow_run({
667
+ # workflow_definition_name: "WorkflowDefinitionName", # required
668
+ # model_id: "ModelId", # required
669
+ # client_token: "ClientToken",
670
+ # log_group_name: "CloudWatchLogGroupName",
671
+ # client_info: { # required
672
+ # compatibility_version: 1, # required
673
+ # sdk_version: "NonBlankString",
674
+ # },
675
+ # })
676
+ #
677
+ # @example Response structure
678
+ #
679
+ # resp.workflow_run_id #=> String
680
+ # resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "DELETING"
681
+ #
682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/CreateWorkflowRun AWS API Documentation
683
+ #
684
+ # @overload create_workflow_run(params = {})
685
+ # @param [Hash] params ({})
686
+ def create_workflow_run(params = {}, options = {})
687
+ req = build_request(:create_workflow_run, params)
688
+ req.send_request(options)
689
+ end
690
+
691
+ # Deletes a workflow definition and all associated resources. This
692
+ # operation cannot be undone.
693
+ #
694
+ # @option params [required, String] :workflow_definition_name
695
+ # The name of the workflow definition to delete.
696
+ #
697
+ # @return [Types::DeleteWorkflowDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
698
+ #
699
+ # * {Types::DeleteWorkflowDefinitionResponse#status #status} => String
700
+ #
701
+ # @example Request syntax with placeholder values
702
+ #
703
+ # resp = client.delete_workflow_definition({
704
+ # workflow_definition_name: "WorkflowDefinitionName", # required
705
+ # })
706
+ #
707
+ # @example Response structure
708
+ #
709
+ # resp.status #=> String, one of "ACTIVE", "DELETING"
710
+ #
711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/DeleteWorkflowDefinition AWS API Documentation
712
+ #
713
+ # @overload delete_workflow_definition(params = {})
714
+ # @param [Hash] params ({})
715
+ def delete_workflow_definition(params = {}, options = {})
716
+ req = build_request(:delete_workflow_definition, params)
717
+ req.send_request(options)
718
+ end
719
+
720
+ # Terminates and cleans up a workflow run, stopping all associated acts
721
+ # and sessions.
722
+ #
723
+ # @option params [required, String] :workflow_definition_name
724
+ # The name of the workflow definition containing the workflow run.
725
+ #
726
+ # @option params [required, String] :workflow_run_id
727
+ # The unique identifier of the workflow run to delete.
728
+ #
729
+ # @return [Types::DeleteWorkflowRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
730
+ #
731
+ # * {Types::DeleteWorkflowRunResponse#status #status} => String
732
+ #
733
+ # @example Request syntax with placeholder values
734
+ #
735
+ # resp = client.delete_workflow_run({
736
+ # workflow_definition_name: "WorkflowDefinitionName", # required
737
+ # workflow_run_id: "UuidString", # required
738
+ # })
739
+ #
740
+ # @example Response structure
741
+ #
742
+ # resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "DELETING"
743
+ #
744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/DeleteWorkflowRun AWS API Documentation
745
+ #
746
+ # @overload delete_workflow_run(params = {})
747
+ # @param [Hash] params ({})
748
+ def delete_workflow_run(params = {}, options = {})
749
+ req = build_request(:delete_workflow_run, params)
750
+ req.send_request(options)
751
+ end
752
+
753
+ # Retrieves the details and configuration of a specific workflow
754
+ # definition.
755
+ #
756
+ # @option params [required, String] :workflow_definition_name
757
+ # The name of the workflow definition to retrieve.
758
+ #
759
+ # @return [Types::GetWorkflowDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
760
+ #
761
+ # * {Types::GetWorkflowDefinitionResponse#name #name} => String
762
+ # * {Types::GetWorkflowDefinitionResponse#arn #arn} => String
763
+ # * {Types::GetWorkflowDefinitionResponse#created_at #created_at} => Time
764
+ # * {Types::GetWorkflowDefinitionResponse#description #description} => String
765
+ # * {Types::GetWorkflowDefinitionResponse#export_config #export_config} => Types::WorkflowExportConfig
766
+ # * {Types::GetWorkflowDefinitionResponse#status #status} => String
767
+ #
768
+ # @example Request syntax with placeholder values
769
+ #
770
+ # resp = client.get_workflow_definition({
771
+ # workflow_definition_name: "WorkflowDefinitionName", # required
772
+ # })
773
+ #
774
+ # @example Response structure
775
+ #
776
+ # resp.name #=> String
777
+ # resp.arn #=> String
778
+ # resp.created_at #=> Time
779
+ # resp.description #=> String
780
+ # resp.export_config.s3_bucket_name #=> String
781
+ # resp.export_config.s3_key_prefix #=> String
782
+ # resp.status #=> String, one of "ACTIVE", "DELETING"
783
+ #
784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/GetWorkflowDefinition AWS API Documentation
785
+ #
786
+ # @overload get_workflow_definition(params = {})
787
+ # @param [Hash] params ({})
788
+ def get_workflow_definition(params = {}, options = {})
789
+ req = build_request(:get_workflow_definition, params)
790
+ req.send_request(options)
791
+ end
792
+
793
+ # Retrieves the current state, configuration, and execution details of a
794
+ # workflow run.
795
+ #
796
+ # @option params [required, String] :workflow_definition_name
797
+ # The name of the workflow definition containing the workflow run.
798
+ #
799
+ # @option params [required, String] :workflow_run_id
800
+ # The unique identifier of the workflow run to retrieve.
801
+ #
802
+ # @return [Types::GetWorkflowRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
803
+ #
804
+ # * {Types::GetWorkflowRunResponse#workflow_run_arn #workflow_run_arn} => String
805
+ # * {Types::GetWorkflowRunResponse#workflow_run_id #workflow_run_id} => String
806
+ # * {Types::GetWorkflowRunResponse#status #status} => String
807
+ # * {Types::GetWorkflowRunResponse#started_at #started_at} => Time
808
+ # * {Types::GetWorkflowRunResponse#ended_at #ended_at} => Time
809
+ # * {Types::GetWorkflowRunResponse#model_id #model_id} => String
810
+ # * {Types::GetWorkflowRunResponse#log_group_name #log_group_name} => String
811
+ #
812
+ # @example Request syntax with placeholder values
813
+ #
814
+ # resp = client.get_workflow_run({
815
+ # workflow_definition_name: "WorkflowDefinitionName", # required
816
+ # workflow_run_id: "UuidString", # required
817
+ # })
818
+ #
819
+ # @example Response structure
820
+ #
821
+ # resp.workflow_run_arn #=> String
822
+ # resp.workflow_run_id #=> String
823
+ # resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "DELETING"
824
+ # resp.started_at #=> Time
825
+ # resp.ended_at #=> Time
826
+ # resp.model_id #=> String
827
+ # resp.log_group_name #=> String
828
+ #
829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/GetWorkflowRun AWS API Documentation
830
+ #
831
+ # @overload get_workflow_run(params = {})
832
+ # @param [Hash] params ({})
833
+ def get_workflow_run(params = {}, options = {})
834
+ req = build_request(:get_workflow_run, params)
835
+ req.send_request(options)
836
+ end
837
+
838
+ # Executes the next step of an act, processing tool call results and
839
+ # returning new tool calls if needed.
840
+ #
841
+ # @option params [required, String] :workflow_definition_name
842
+ # The name of the workflow definition containing the act.
843
+ #
844
+ # @option params [required, String] :workflow_run_id
845
+ # The unique identifier of the workflow run containing the act.
846
+ #
847
+ # @option params [required, String] :session_id
848
+ # The unique identifier of the session containing the act.
849
+ #
850
+ # @option params [required, String] :act_id
851
+ # The unique identifier of the act to invoke the next step for.
852
+ #
853
+ # @option params [required, Array<Types::CallResult>] :call_results
854
+ # The results from previous tool calls that the act requested.
855
+ #
856
+ # @option params [String] :previous_step_id
857
+ # The identifier of the previous step, used for tracking execution flow.
858
+ #
859
+ # @return [Types::InvokeActStepResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
860
+ #
861
+ # * {Types::InvokeActStepResponse#calls #calls} => Array&lt;Types::Call&gt;
862
+ # * {Types::InvokeActStepResponse#step_id #step_id} => String
863
+ #
864
+ # @example Request syntax with placeholder values
865
+ #
866
+ # resp = client.invoke_act_step({
867
+ # workflow_definition_name: "WorkflowDefinitionName", # required
868
+ # workflow_run_id: "UuidString", # required
869
+ # session_id: "UuidString", # required
870
+ # act_id: "UuidString", # required
871
+ # call_results: [ # required
872
+ # {
873
+ # call_id: "CallId",
874
+ # content: [ # required
875
+ # {
876
+ # text: "String",
877
+ # },
878
+ # ],
879
+ # },
880
+ # ],
881
+ # previous_step_id: "UuidString",
882
+ # })
883
+ #
884
+ # @example Response structure
885
+ #
886
+ # resp.calls #=> Array
887
+ # resp.calls[0].call_id #=> String
888
+ # resp.calls[0].name #=> String
889
+ # resp.step_id #=> String
890
+ #
891
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/InvokeActStep AWS API Documentation
892
+ #
893
+ # @overload invoke_act_step(params = {})
894
+ # @param [Hash] params ({})
895
+ def invoke_act_step(params = {}, options = {})
896
+ req = build_request(:invoke_act_step, params)
897
+ req.send_request(options)
898
+ end
899
+
900
+ # Lists all acts within a specific session with their current status and
901
+ # execution details.
902
+ #
903
+ # @option params [required, String] :workflow_definition_name
904
+ # The name of the workflow definition containing the session.
905
+ #
906
+ # @option params [String] :workflow_run_id
907
+ # The unique identifier of the workflow run containing the session.
908
+ #
909
+ # @option params [String] :session_id
910
+ # The unique identifier of the session to list acts for.
911
+ #
912
+ # @option params [Integer] :max_results
913
+ # The maximum number of acts to return in a single response.
914
+ #
915
+ # @option params [String] :next_token
916
+ # The token for retrieving the next page of results.
917
+ #
918
+ # @option params [String] :sort_order
919
+ # The sort order for the returned acts (ascending or descending).
920
+ #
921
+ # @return [Types::ListActsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
922
+ #
923
+ # * {Types::ListActsResponse#act_summaries #act_summaries} => Array&lt;Types::ActSummary&gt;
924
+ # * {Types::ListActsResponse#next_token #next_token} => String
925
+ #
926
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
927
+ #
928
+ # @example Request syntax with placeholder values
929
+ #
930
+ # resp = client.list_acts({
931
+ # workflow_definition_name: "WorkflowDefinitionName", # required
932
+ # workflow_run_id: "UuidString",
933
+ # session_id: "UuidString",
934
+ # max_results: 1,
935
+ # next_token: "NextToken",
936
+ # sort_order: "Ascending", # accepts Ascending, Descending
937
+ # })
938
+ #
939
+ # @example Response structure
940
+ #
941
+ # resp.act_summaries #=> Array
942
+ # resp.act_summaries[0].workflow_run_id #=> String
943
+ # resp.act_summaries[0].session_id #=> String
944
+ # resp.act_summaries[0].act_id #=> String
945
+ # resp.act_summaries[0].status #=> String, one of "RUNNING", "PENDING_CLIENT_ACTION", "PENDING_HUMAN_ACTION", "SUCCEEDED", "FAILED", "TIMED_OUT"
946
+ # resp.act_summaries[0].started_at #=> Time
947
+ # resp.act_summaries[0].ended_at #=> Time
948
+ # resp.act_summaries[0].trace_location.location_type #=> String, one of "S3"
949
+ # resp.act_summaries[0].trace_location.location #=> String
950
+ # resp.next_token #=> String
951
+ #
952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/ListActs AWS API Documentation
953
+ #
954
+ # @overload list_acts(params = {})
955
+ # @param [Hash] params ({})
956
+ def list_acts(params = {}, options = {})
957
+ req = build_request(:list_acts, params)
958
+ req.send_request(options)
959
+ end
960
+
961
+ # Lists all available AI models that can be used for workflow execution,
962
+ # including their status and compatibility information.
963
+ #
964
+ # @option params [required, Integer] :client_compatibility_version
965
+ # The client compatibility version to filter models by compatibility.
966
+ #
967
+ # @return [Types::ListModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
968
+ #
969
+ # * {Types::ListModelsResponse#model_summaries #model_summaries} => Array&lt;Types::ModelSummary&gt;
970
+ # * {Types::ListModelsResponse#model_aliases #model_aliases} => Array&lt;Types::ModelAlias&gt;
971
+ # * {Types::ListModelsResponse#compatibility_information #compatibility_information} => Types::CompatibilityInformation
972
+ #
973
+ # @example Request syntax with placeholder values
974
+ #
975
+ # resp = client.list_models({
976
+ # client_compatibility_version: 1, # required
977
+ # })
978
+ #
979
+ # @example Response structure
980
+ #
981
+ # resp.model_summaries #=> Array
982
+ # resp.model_summaries[0].model_id #=> String
983
+ # resp.model_summaries[0].model_lifecycle.status #=> String, one of "ACTIVE", "LEGACY", "DEPRECATED", "PREVIEW"
984
+ # resp.model_summaries[0].minimum_compatibility_version #=> Integer
985
+ # resp.model_aliases #=> Array
986
+ # resp.model_aliases[0].alias_name #=> String
987
+ # resp.model_aliases[0].latest_model_id #=> String
988
+ # resp.model_aliases[0].resolved_model_id #=> String
989
+ # resp.compatibility_information.client_compatibility_version #=> Integer
990
+ # resp.compatibility_information.supported_model_ids #=> Array
991
+ # resp.compatibility_information.supported_model_ids[0] #=> String
992
+ # resp.compatibility_information.message #=> String
993
+ #
994
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/ListModels AWS API Documentation
995
+ #
996
+ # @overload list_models(params = {})
997
+ # @param [Hash] params ({})
998
+ def list_models(params = {}, options = {})
999
+ req = build_request(:list_models, params)
1000
+ req.send_request(options)
1001
+ end
1002
+
1003
+ # Lists all sessions within a specific workflow run.
1004
+ #
1005
+ # @option params [required, String] :workflow_definition_name
1006
+ # The name of the workflow definition containing the workflow run.
1007
+ #
1008
+ # @option params [required, String] :workflow_run_id
1009
+ # The unique identifier of the workflow run to list sessions for.
1010
+ #
1011
+ # @option params [Integer] :max_results
1012
+ # The maximum number of sessions to return in a single response.
1013
+ #
1014
+ # @option params [String] :next_token
1015
+ # The token for retrieving the next page of results.
1016
+ #
1017
+ # @option params [String] :sort_order
1018
+ # The sort order for the returned sessions (ascending or descending).
1019
+ #
1020
+ # @return [Types::ListSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1021
+ #
1022
+ # * {Types::ListSessionsResponse#session_summaries #session_summaries} => Array&lt;Types::SessionSummary&gt;
1023
+ # * {Types::ListSessionsResponse#next_token #next_token} => String
1024
+ #
1025
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1026
+ #
1027
+ # @example Request syntax with placeholder values
1028
+ #
1029
+ # resp = client.list_sessions({
1030
+ # workflow_definition_name: "WorkflowDefinitionName", # required
1031
+ # workflow_run_id: "UuidString", # required
1032
+ # max_results: 1,
1033
+ # next_token: "NextToken",
1034
+ # sort_order: "Ascending", # accepts Ascending, Descending
1035
+ # })
1036
+ #
1037
+ # @example Response structure
1038
+ #
1039
+ # resp.session_summaries #=> Array
1040
+ # resp.session_summaries[0].session_id #=> String
1041
+ # resp.next_token #=> String
1042
+ #
1043
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/ListSessions AWS API Documentation
1044
+ #
1045
+ # @overload list_sessions(params = {})
1046
+ # @param [Hash] params ({})
1047
+ def list_sessions(params = {}, options = {})
1048
+ req = build_request(:list_sessions, params)
1049
+ req.send_request(options)
1050
+ end
1051
+
1052
+ # Lists all workflow definitions in your account with optional filtering
1053
+ # and pagination.
1054
+ #
1055
+ # @option params [Integer] :max_results
1056
+ # The maximum number of workflow definitions to return in a single
1057
+ # response.
1058
+ #
1059
+ # @option params [String] :next_token
1060
+ # The token for retrieving the next page of results.
1061
+ #
1062
+ # @option params [String] :sort_order
1063
+ # The sort order for the returned workflow definitions (ascending or
1064
+ # descending).
1065
+ #
1066
+ # @return [Types::ListWorkflowDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1067
+ #
1068
+ # * {Types::ListWorkflowDefinitionsResponse#workflow_definition_summaries #workflow_definition_summaries} => Array&lt;Types::WorkflowDefinitionSummary&gt;
1069
+ # * {Types::ListWorkflowDefinitionsResponse#next_token #next_token} => String
1070
+ #
1071
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1072
+ #
1073
+ # @example Request syntax with placeholder values
1074
+ #
1075
+ # resp = client.list_workflow_definitions({
1076
+ # max_results: 1,
1077
+ # next_token: "NextToken",
1078
+ # sort_order: "Ascending", # accepts Ascending, Descending
1079
+ # })
1080
+ #
1081
+ # @example Response structure
1082
+ #
1083
+ # resp.workflow_definition_summaries #=> Array
1084
+ # resp.workflow_definition_summaries[0].workflow_definition_arn #=> String
1085
+ # resp.workflow_definition_summaries[0].workflow_definition_name #=> String
1086
+ # resp.workflow_definition_summaries[0].created_at #=> Time
1087
+ # resp.workflow_definition_summaries[0].status #=> String, one of "ACTIVE", "DELETING"
1088
+ # resp.next_token #=> String
1089
+ #
1090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/ListWorkflowDefinitions AWS API Documentation
1091
+ #
1092
+ # @overload list_workflow_definitions(params = {})
1093
+ # @param [Hash] params ({})
1094
+ def list_workflow_definitions(params = {}, options = {})
1095
+ req = build_request(:list_workflow_definitions, params)
1096
+ req.send_request(options)
1097
+ end
1098
+
1099
+ # Lists all workflow runs for a specific workflow definition with
1100
+ # optional filtering and pagination.
1101
+ #
1102
+ # @option params [required, String] :workflow_definition_name
1103
+ # The name of the workflow definition to list workflow runs for.
1104
+ #
1105
+ # @option params [Integer] :max_results
1106
+ # The maximum number of workflow runs to return in a single response.
1107
+ #
1108
+ # @option params [String] :next_token
1109
+ # The token for retrieving the next page of results.
1110
+ #
1111
+ # @option params [String] :sort_order
1112
+ # The sort order for the returned workflow runs (ascending or
1113
+ # descending).
1114
+ #
1115
+ # @return [Types::ListWorkflowRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1116
+ #
1117
+ # * {Types::ListWorkflowRunsResponse#workflow_run_summaries #workflow_run_summaries} => Array&lt;Types::WorkflowRunSummary&gt;
1118
+ # * {Types::ListWorkflowRunsResponse#next_token #next_token} => String
1119
+ #
1120
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1121
+ #
1122
+ # @example Request syntax with placeholder values
1123
+ #
1124
+ # resp = client.list_workflow_runs({
1125
+ # workflow_definition_name: "WorkflowDefinitionName", # required
1126
+ # max_results: 1,
1127
+ # next_token: "NextToken",
1128
+ # sort_order: "Ascending", # accepts Ascending, Descending
1129
+ # })
1130
+ #
1131
+ # @example Response structure
1132
+ #
1133
+ # resp.workflow_run_summaries #=> Array
1134
+ # resp.workflow_run_summaries[0].workflow_run_arn #=> String
1135
+ # resp.workflow_run_summaries[0].workflow_run_id #=> String
1136
+ # resp.workflow_run_summaries[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "DELETING"
1137
+ # resp.workflow_run_summaries[0].started_at #=> Time
1138
+ # resp.workflow_run_summaries[0].ended_at #=> Time
1139
+ # resp.workflow_run_summaries[0].trace_location.location_type #=> String, one of "S3"
1140
+ # resp.workflow_run_summaries[0].trace_location.location #=> String
1141
+ # resp.next_token #=> String
1142
+ #
1143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/ListWorkflowRuns AWS API Documentation
1144
+ #
1145
+ # @overload list_workflow_runs(params = {})
1146
+ # @param [Hash] params ({})
1147
+ def list_workflow_runs(params = {}, options = {})
1148
+ req = build_request(:list_workflow_runs, params)
1149
+ req.send_request(options)
1150
+ end
1151
+
1152
+ # Updates an existing act's configuration, status, or error
1153
+ # information.
1154
+ #
1155
+ # @option params [required, String] :workflow_definition_name
1156
+ # The name of the workflow definition containing the act.
1157
+ #
1158
+ # @option params [required, String] :workflow_run_id
1159
+ # The unique identifier of the workflow run containing the act.
1160
+ #
1161
+ # @option params [required, String] :session_id
1162
+ # The unique identifier of the session containing the act.
1163
+ #
1164
+ # @option params [required, String] :act_id
1165
+ # The unique identifier of the act to update.
1166
+ #
1167
+ # @option params [required, String] :status
1168
+ # The new status to set for the act.
1169
+ #
1170
+ # @option params [Types::ActError] :error
1171
+ # Error information to associate with the act, if applicable.
1172
+ #
1173
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1174
+ #
1175
+ # @example Request syntax with placeholder values
1176
+ #
1177
+ # resp = client.update_act({
1178
+ # workflow_definition_name: "WorkflowDefinitionName", # required
1179
+ # workflow_run_id: "UuidString", # required
1180
+ # session_id: "UuidString", # required
1181
+ # act_id: "UuidString", # required
1182
+ # status: "RUNNING", # required, accepts RUNNING, PENDING_CLIENT_ACTION, PENDING_HUMAN_ACTION, SUCCEEDED, FAILED, TIMED_OUT
1183
+ # error: {
1184
+ # message: "ActErrorMessageString", # required
1185
+ # type: "ActErrorTypeString",
1186
+ # },
1187
+ # })
1188
+ #
1189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/UpdateAct AWS API Documentation
1190
+ #
1191
+ # @overload update_act(params = {})
1192
+ # @param [Hash] params ({})
1193
+ def update_act(params = {}, options = {})
1194
+ req = build_request(:update_act, params)
1195
+ req.send_request(options)
1196
+ end
1197
+
1198
+ # Updates the configuration or state of an active workflow run.
1199
+ #
1200
+ # @option params [required, String] :workflow_definition_name
1201
+ # The name of the workflow definition containing the workflow run.
1202
+ #
1203
+ # @option params [required, String] :workflow_run_id
1204
+ # The unique identifier of the workflow run to update.
1205
+ #
1206
+ # @option params [required, String] :status
1207
+ # The new status to set for the workflow run.
1208
+ #
1209
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1210
+ #
1211
+ # @example Request syntax with placeholder values
1212
+ #
1213
+ # resp = client.update_workflow_run({
1214
+ # workflow_definition_name: "WorkflowDefinitionName", # required
1215
+ # workflow_run_id: "UuidString", # required
1216
+ # status: "RUNNING", # required, accepts RUNNING, SUCCEEDED, FAILED, TIMED_OUT, DELETING
1217
+ # })
1218
+ #
1219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/UpdateWorkflowRun AWS API Documentation
1220
+ #
1221
+ # @overload update_workflow_run(params = {})
1222
+ # @param [Hash] params ({})
1223
+ def update_workflow_run(params = {}, options = {})
1224
+ req = build_request(:update_workflow_run, params)
1225
+ req.send_request(options)
1226
+ end
1227
+
1228
+ # @!endgroup
1229
+
1230
+ # @param params ({})
1231
+ # @api private
1232
+ def build_request(operation_name, params = {})
1233
+ handlers = @handlers.for(operation_name)
1234
+ tracer = config.telemetry_provider.tracer_provider.tracer(
1235
+ Aws::Telemetry.module_to_tracer_name('Aws::NovaAct')
1236
+ )
1237
+ context = Seahorse::Client::RequestContext.new(
1238
+ operation_name: operation_name,
1239
+ operation: config.api.operation(operation_name),
1240
+ client: self,
1241
+ params: params,
1242
+ config: config,
1243
+ tracer: tracer
1244
+ )
1245
+ context[:gem_name] = 'aws-sdk-novaact'
1246
+ context[:gem_version] = '1.0.0'
1247
+ Seahorse::Client::Request.new(handlers, context)
1248
+ end
1249
+
1250
+ # @api private
1251
+ # @deprecated
1252
+ def waiter_names
1253
+ []
1254
+ end
1255
+
1256
+ class << self
1257
+
1258
+ # @api private
1259
+ attr_reader :identifier
1260
+
1261
+ # @api private
1262
+ def errors_module
1263
+ Errors
1264
+ end
1265
+
1266
+ end
1267
+ end
1268
+ end