You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AugmentedAIRuntime::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::AugmentedAIRuntime::Client

show all

Defined in:: (unknown)

Overview

An API client for Amazon Augmented AI Runtime. To construct a client, you need to configure a :region and :credentials.

augmentedairuntime = Aws::AugmentedAIRuntime::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::AugmentedAIRuntime::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::AugmentedAIRuntime::Client constructor
Constructs an API client.

API Operations collapse

#delete_human_loop(options = {}) ⇒ Struct
Deletes the specified human loop for a flow definition.

.
#describe_human_loop(options = {}) ⇒ Types::DescribeHumanLoopResponse
Returns information about the specified human loop.

.
#list_human_loops(options = {}) ⇒ Types::ListHumanLoopsResponse
Returns information about human loops, given the specified parameters.
#start_human_loop(options = {}) ⇒ Types::StartHumanLoopResponse
Starts a human loop, provided that at least one activation condition is met.

.
#stop_human_loop(options = {}) ⇒ Struct
Stops the specified human loop.

.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ `Aws::AugmentedAIRuntime::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
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. See Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.
: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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
: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. See Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#delete_human_loop(options = {}) ⇒ `Struct`

Deletes the specified human loop for a flow definition.

Examples:

Request syntax with placeholder values


resp = client.delete_human_loop({
  human_loop_name: "HumanLoopName", # required
})

Options Hash (options):

:human_loop_name (required, String) —
The name of the human loop that you want to delete.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#describe_human_loop(options = {}) ⇒ `Types::DescribeHumanLoopResponse`

Returns information about the specified human loop.

Examples:

Request syntax with placeholder values


resp = client.describe_human_loop({
  human_loop_name: "HumanLoopName", # required
})

Response structure


resp.creation_time #=> Time
resp.failure_reason #=> String
resp.failure_code #=> String
resp.human_loop_status #=> String, one of "InProgress", "Failed", "Completed", "Stopped", "Stopping"
resp.human_loop_name #=> String
resp.human_loop_arn #=> String
resp.flow_definition_arn #=> String
resp.human_loop_output.output_s3_uri #=> String

Options Hash (options):

:human_loop_name (required, String) —
The name of the human loop that you want information about.

Returns:

(Types::DescribeHumanLoopResponse) —
Returns a response object which responds to the following methods:
- #creation_time => Time
- #failure_reason => String
- #failure_code => String
- #human_loop_status => String
- #human_loop_name => String
- #human_loop_arn => String
- #flow_definition_arn => String
- #human_loop_output => Types::HumanLoopOutput

See Also:

AWS API Documentation

#list_human_loops(options = {}) ⇒ `Types::ListHumanLoopsResponse`

Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.

Examples:

Request syntax with placeholder values


resp = client.list_human_loops({
  creation_time_after: Time.now,
  creation_time_before: Time.now,
  flow_definition_arn: "FlowDefinitionArn", # required
  sort_order: "Ascending", # accepts Ascending, Descending
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.human_loop_summaries #=> Array
resp.human_loop_summaries[0].human_loop_name #=> String
resp.human_loop_summaries[0].human_loop_status #=> String, one of "InProgress", "Failed", "Completed", "Stopped", "Stopping"
resp.human_loop_summaries[0].creation_time #=> Time
resp.human_loop_summaries[0].failure_reason #=> String
resp.human_loop_summaries[0].flow_definition_arn #=> String
resp.next_token #=> String

Options Hash (options):

:creation_time_after (Time) — default: Optional —
The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, 2020-02-24.
:creation_time_before (Time) — default: Optional —
The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, 2020-02-24.
:flow_definition_arn (required, String) —
The Amazon Resource Name (ARN) of a flow definition.
:sort_order (String) —
Optional. The order for displaying results. Valid values: Ascending and Descending.
:next_token (String) —
A token to display the next page of results.
:max_results (Integer) —
The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken is returned in the output. You can use this token to display the next page of results.

Returns:

(Types::ListHumanLoopsResponse) —
Returns a response object which responds to the following methods:
- #human_loop_summaries => Array<Types::HumanLoopSummary>
- #next_token => String

See Also:

AWS API Documentation

#start_human_loop(options = {}) ⇒ `Types::StartHumanLoopResponse`

Starts a human loop, provided that at least one activation condition is met.

Examples:

Request syntax with placeholder values


resp = client.start_human_loop({
  human_loop_name: "HumanLoopName", # required
  flow_definition_arn: "FlowDefinitionArn", # required
  human_loop_input: { # required
    input_content: "InputContent", # required
  },
  data_attributes: {
    content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # required, accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
  },
})

Response structure


resp.human_loop_arn #=> String

Options Hash (options):

:human_loop_name (required, String) —
The name of the human loop.
:flow_definition_arn (required, String) —
The Amazon Resource Name (ARN) of the flow definition associated with this human loop.
:human_loop_input (required, Types::HumanLoopInput) —
An object that contains information about the human loop.
:data_attributes (Types::HumanLoopDataAttributes) —
Attributes of the specified data. Use DataAttributes to specify if your data is free of personally identifiable information and/or free of adult content.

Returns:

(Types::StartHumanLoopResponse) —
Returns a response object which responds to the following methods:
- #human_loop_arn => String

See Also:

AWS API Documentation

#stop_human_loop(options = {}) ⇒ `Struct`

Stops the specified human loop.

Examples:

Request syntax with placeholder values


resp = client.stop_human_loop({
  human_loop_name: "HumanLoopName", # required
})

Options Hash (options):

:human_loop_name (required, String) —
The name of the human loop that you want to stop.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

waiter_name (Symbol) —
The name of the waiter. See #waiter_names for a full list of supported waiters.
params (Hash) (defaults to: {}) —
Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

waiter (Waiters::Waiter) —
Yields a Waiter object that can be configured prior to waiting.

Returns:

(Boolean) —
Returns true if the waiter was successful.

Raises:

(Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —
Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —
Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —
Raised when you request to wait for an unknown state.

#waiter_names ⇒ `Array<Symbol>`

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name	Client Method	Default Delay:	Default Max Attempts:

Returns:

(Array<Symbol>) —
the list of supported waiters.

Class: Aws::AugmentedAIRuntime::Client

Overview

Region

Credentials

Attribute Summary collapse

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::AugmentedAIRuntime::Client

Instance Method Details

#delete_human_loop(options = {}) ⇒ Struct

#describe_human_loop(options = {}) ⇒ Types::DescribeHumanLoopResponse

#list_human_loops(options = {}) ⇒ Types::ListHumanLoopsResponse

#start_human_loop(options = {}) ⇒ Types::StartHumanLoopResponse

#stop_human_loop(options = {}) ⇒ Struct

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::AugmentedAIRuntime::Client`

#delete_human_loop(options = {}) ⇒ `Struct`

#describe_human_loop(options = {}) ⇒ `Types::DescribeHumanLoopResponse`

#list_human_loops(options = {}) ⇒ `Types::ListHumanLoopsResponse`

#start_human_loop(options = {}) ⇒ `Types::StartHumanLoopResponse`

#stop_human_loop(options = {}) ⇒ `Struct`

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

#waiter_names ⇒ `Array<Symbol>`