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

Class: Aws::IoTEvents::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::IoTEvents::Client

show all

Defined in:: (unknown)

Overview

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

iotevents = Aws::IoTEvents::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::IoTEvents::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.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

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

API Operations collapse

#create_detector_model(options = {}) ⇒ Types::CreateDetectorModelResponse
Creates a detector model.

.
#create_input(options = {}) ⇒ Types::CreateInputResponse
Creates an input.

.
#delete_detector_model(options = {}) ⇒ Struct
Deletes a detector model.
#delete_input(options = {}) ⇒ Struct
Deletes an input.

.
#describe_detector_model(options = {}) ⇒ Types::DescribeDetectorModelResponse
Describes a detector model.
#describe_input(options = {}) ⇒ Types::DescribeInputResponse
Describes an input.

.
#describe_logging_options(options = {}) ⇒ Types::DescribeLoggingOptionsResponse
Retrieves the current settings of the AWS IoT Events logging options.

.
#list_detector_model_versions(options = {}) ⇒ Types::ListDetectorModelVersionsResponse
Lists all the versions of a detector model.
#list_detector_models(options = {}) ⇒ Types::ListDetectorModelsResponse
Lists the detector models you have created.
#list_inputs(options = {}) ⇒ Types::ListInputsResponse
Lists the inputs you have created.

.
#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) you have assigned to the resource.

.
#put_logging_options(options = {}) ⇒ Struct
Sets or updates the AWS IoT Events logging options.

If you update the value of any "loggingOptions" field, it takes up to one minute for the change to take effect.
#tag_resource(options = {}) ⇒ Struct
Adds to or modifies the tags of the given resource.
#untag_resource(options = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.

.
#update_detector_model(options = {}) ⇒ Types::UpdateDetectorModelResponse
Updates a detector model.
#update_input(options = {}) ⇒ Types::UpdateInputResponse
Updates an input.

.

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::IoTEvents::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

#create_detector_model(options = {}) ⇒ `Types::CreateDetectorModelResponse`

Creates a detector model.

Examples:

Request syntax with placeholder values


resp = client.create_detector_model({
  detector_model_name: "DetectorModelName", # required
  detector_model_definition: { # required
    states: [ # required
      {
        state_name: "StateName", # required
        on_input: {
          events: [
            {
              event_name: "EventName", # required
              condition: "Condition",
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1, # required
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                  },
                  iot_events: {
                    input_name: "InputName", # required
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                  },
                },
              ],
            },
          ],
          transition_events: [
            {
              event_name: "EventName", # required
              condition: "Condition", # required
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1, # required
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                  },
                  iot_events: {
                    input_name: "InputName", # required
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                  },
                },
              ],
              next_state: "StateName", # required
            },
          ],
        },
        on_enter: {
          events: [
            {
              event_name: "EventName", # required
              condition: "Condition",
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1, # required
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                  },
                  iot_events: {
                    input_name: "InputName", # required
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                  },
                },
              ],
            },
          ],
        },
        on_exit: {
          events: [
            {
              event_name: "EventName", # required
              condition: "Condition",
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1, # required
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                  },
                  iot_events: {
                    input_name: "InputName", # required
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                  },
                },
              ],
            },
          ],
        },
      },
    ],
    initial_state_name: "StateName", # required
  },
  detector_model_description: "DetectorModelDescription",
  key: "AttributeJsonPath",
  role_arn: "AmazonResourceName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.detector_model_configuration.detector_model_name #=> String
resp.detector_model_configuration.detector_model_version #=> String
resp.detector_model_configuration.detector_model_description #=> String
resp.detector_model_configuration.detector_model_arn #=> String
resp.detector_model_configuration.role_arn #=> String
resp.detector_model_configuration.creation_time #=> Time
resp.detector_model_configuration.last_update_time #=> Time
resp.detector_model_configuration.status #=> String, one of "ACTIVE", "ACTIVATING", "INACTIVE", "DEPRECATED", "DRAFT", "PAUSED", "FAILED"
resp.detector_model_configuration.key #=> String

Options Hash (options):

:detector_model_name (required, String) —
The name of the detector model.
:detector_model_definition (required, Types::DetectorModelDefinition) —
Information that defines how the detectors operate.
:detector_model_description (String) —
A brief description of the detector model.
:key (String) —
The input attribute key used to identify a device or system in order to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to identify the device associated with the input.
:role_arn (required, String) —
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
:tags (Array<Types::Tag>) —
Metadata that can be used to manage the detector model.

Returns:

(Types::CreateDetectorModelResponse) —
Returns a response object which responds to the following methods:
- #detector_model_configuration => Types::DetectorModelConfiguration

#create_input(options = {}) ⇒ `Types::CreateInputResponse`

Creates an input.

Examples:

Request syntax with placeholder values


resp = client.create_input({
  input_name: "InputName", # required
  input_description: "InputDescription",
  input_definition: { # required
    attributes: [ # required
      {
        json_path: "AttributeJsonPath", # required
      },
    ],
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.input_configuration.input_name #=> String
resp.input_configuration.input_description #=> String
resp.input_configuration.input_arn #=> String
resp.input_configuration.creation_time #=> Time
resp.input_configuration.last_update_time #=> Time
resp.input_configuration.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING"

Options Hash (options):

:input_name (required, String) —
The name you want to give to the input.
:input_description (String) —
A brief description of the input.
:input_definition (required, Types::InputDefinition) —
The definition of the input.
:tags (Array<Types::Tag>) —
Metadata that can be used to manage the input.

Returns:

(Types::CreateInputResponse) —
Returns a response object which responds to the following methods:
- #input_configuration => Types::InputConfiguration

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

Deletes a detector model. Any active instances of the detector model are also deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_detector_model({
  detector_model_name: "DetectorModelName", # required
})

Options Hash (options):

:detector_model_name (required, String) —
The name of the detector model to be deleted.

Returns:

(Struct) —
Returns an empty response.

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

Deletes an input.

Examples:

Request syntax with placeholder values


resp = client.delete_input({
  input_name: "InputName", # required
})

Options Hash (options):

:input_name (required, String) —
The name of the input to delete.

Returns:

(Struct) —
Returns an empty response.

#describe_detector_model(options = {}) ⇒ `Types::DescribeDetectorModelResponse`

Describes a detector model. If the "version" parameter is not specified, information about the latest version is returned.

Examples:

Request syntax with placeholder values


resp = client.describe_detector_model({
  detector_model_name: "DetectorModelName", # required
  detector_model_version: "DetectorModelVersion",
})

Response structure


resp.detector_model.detector_model_definition.states #=> Array
resp.detector_model.detector_model_definition.states[0].state_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events #=> Array
resp.detector_model.detector_model_definition.states[0].on_input.events[0].event_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].condition #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions #=> Array
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].set_variable.variable_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].set_variable.value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].sns.target_arn #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_topic_publish.mqtt_topic #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].set_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].set_timer.seconds #=> Integer
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].clear_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].reset_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].lambda.function_arn #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_events.input_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].sqs.queue_url #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].sqs.use_base_64 #=> true/false
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].firehose.delivery_stream_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].firehose.separator #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events #=> Array
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].event_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].condition #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions #=> Array
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].set_variable.variable_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].set_variable.value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].sns.target_arn #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_topic_publish.mqtt_topic #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].set_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].set_timer.seconds #=> Integer
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].clear_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].reset_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].lambda.function_arn #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_events.input_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].sqs.queue_url #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].sqs.use_base_64 #=> true/false
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].firehose.delivery_stream_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].firehose.separator #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].next_state #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events #=> Array
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].event_name #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].condition #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions #=> Array
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].set_variable.variable_name #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].set_variable.value #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].sns.target_arn #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_topic_publish.mqtt_topic #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].set_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].set_timer.seconds #=> Integer
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].clear_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].reset_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].lambda.function_arn #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_events.input_name #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].sqs.queue_url #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].sqs.use_base_64 #=> true/false
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].firehose.delivery_stream_name #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].firehose.separator #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events #=> Array
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].event_name #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].condition #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions #=> Array
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].set_variable.variable_name #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].set_variable.value #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].sns.target_arn #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_topic_publish.mqtt_topic #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].set_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].set_timer.seconds #=> Integer
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].clear_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].reset_timer.timer_name #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].lambda.function_arn #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_events.input_name #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].sqs.queue_url #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].sqs.use_base_64 #=> true/false
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].firehose.delivery_stream_name #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].firehose.separator #=> String
resp.detector_model.detector_model_definition.initial_state_name #=> String
resp.detector_model.detector_model_configuration.detector_model_name #=> String
resp.detector_model.detector_model_configuration.detector_model_version #=> String
resp.detector_model.detector_model_configuration.detector_model_description #=> String
resp.detector_model.detector_model_configuration.detector_model_arn #=> String
resp.detector_model.detector_model_configuration.role_arn #=> String
resp.detector_model.detector_model_configuration.creation_time #=> Time
resp.detector_model.detector_model_configuration.last_update_time #=> Time
resp.detector_model.detector_model_configuration.status #=> String, one of "ACTIVE", "ACTIVATING", "INACTIVE", "DEPRECATED", "DRAFT", "PAUSED", "FAILED"
resp.detector_model.detector_model_configuration.key #=> String

Options Hash (options):

:detector_model_name (required, String) —
The name of the detector model.
:detector_model_version (String) —
The version of the detector model.

Returns:

(Types::DescribeDetectorModelResponse) —
Returns a response object which responds to the following methods:
- #detector_model => Types::DetectorModel

#describe_input(options = {}) ⇒ `Types::DescribeInputResponse`

Describes an input.

Examples:

Request syntax with placeholder values


resp = client.describe_input({
  input_name: "InputName", # required
})

Response structure


resp.input.input_configuration.input_name #=> String
resp.input.input_configuration.input_description #=> String
resp.input.input_configuration.input_arn #=> String
resp.input.input_configuration.creation_time #=> Time
resp.input.input_configuration.last_update_time #=> Time
resp.input.input_configuration.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING"
resp.input.input_definition.attributes #=> Array
resp.input.input_definition.attributes[0].json_path #=> String

Options Hash (options):

:input_name (required, String) —
The name of the input.

Returns:

(Types::DescribeInputResponse) —
Returns a response object which responds to the following methods:
- #input => Types::Input

#describe_logging_options(options = {}) ⇒ `Types::DescribeLoggingOptionsResponse`

Retrieves the current settings of the AWS IoT Events logging options.

Examples:

Request syntax with placeholder values


resp = client.describe_logging_options()

Response structure


resp.logging_options.role_arn #=> String
resp.logging_options.level #=> String, one of "ERROR", "INFO", "DEBUG"
resp.logging_options.enabled #=> true/false
resp.logging_options.detector_debug_options #=> Array
resp.logging_options.detector_debug_options[0].detector_model_name #=> String
resp.logging_options.detector_debug_options[0].key_value #=> String

Returns:

(Types::DescribeLoggingOptionsResponse) —
Returns a response object which responds to the following methods:
- #logging_options => Types::LoggingOptions

#list_detector_model_versions(options = {}) ⇒ `Types::ListDetectorModelVersionsResponse`

Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.

Examples:

Request syntax with placeholder values


resp = client.list_detector_model_versions({
  detector_model_name: "DetectorModelName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.detector_model_version_summaries #=> Array
resp.detector_model_version_summaries[0].detector_model_name #=> String
resp.detector_model_version_summaries[0].detector_model_version #=> String
resp.detector_model_version_summaries[0].detector_model_arn #=> String
resp.detector_model_version_summaries[0].role_arn #=> String
resp.detector_model_version_summaries[0].creation_time #=> Time
resp.detector_model_version_summaries[0].last_update_time #=> Time
resp.detector_model_version_summaries[0].status #=> String, one of "ACTIVE", "ACTIVATING", "INACTIVE", "DEPRECATED", "DRAFT", "PAUSED", "FAILED"
resp.next_token #=> String

Options Hash (options):

:detector_model_name (required, String) —
The name of the detector model whose versions are returned.
:next_token (String) —
The token for the next set of results.
:max_results (Integer) —
The maximum number of results to return at one time.

Returns:

(Types::ListDetectorModelVersionsResponse) —
Returns a response object which responds to the following methods:
- #detector_model_version_summaries => Array<Types::DetectorModelVersionSummary>
- #next_token => String

#list_detector_models(options = {}) ⇒ `Types::ListDetectorModelsResponse`

Lists the detector models you have created. Only the metadata associated with each detector model is returned.

Examples:

Request syntax with placeholder values


resp = client.list_detector_models({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.detector_model_summaries #=> Array
resp.detector_model_summaries[0].detector_model_name #=> String
resp.detector_model_summaries[0].detector_model_description #=> String
resp.detector_model_summaries[0].creation_time #=> Time
resp.next_token #=> String

Options Hash (options):

:next_token (String) —
The token for the next set of results.
:max_results (Integer) —
The maximum number of results to return at one time.

Returns:

(Types::ListDetectorModelsResponse) —
Returns a response object which responds to the following methods:
- #detector_model_summaries => Array<Types::DetectorModelSummary>
- #next_token => String

#list_inputs(options = {}) ⇒ `Types::ListInputsResponse`

Lists the inputs you have created.

Examples:

Request syntax with placeholder values


resp = client.list_inputs({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.input_summaries #=> Array
resp.input_summaries[0].input_name #=> String
resp.input_summaries[0].input_description #=> String
resp.input_summaries[0].input_arn #=> String
resp.input_summaries[0].creation_time #=> Time
resp.input_summaries[0].last_update_time #=> Time
resp.input_summaries[0].status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING"
resp.next_token #=> String

Options Hash (options):

:next_token (String) —
The token for the next set of results.
:max_results (Integer) —
The maximum number of results to return at one time.

Returns:

(Types::ListInputsResponse) —
Returns a response object which responds to the following methods:
- #input_summaries => Array<Types::InputSummary>
- #next_token => String

#list_tags_for_resource(options = {}) ⇒ `Types::ListTagsForResourceResponse`

Lists the tags (metadata) you have assigned to the resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

:resource_arn (required, String) —
The ARN of the resource.

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #tags => Array<Types::Tag>

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

Sets or updates the AWS IoT Events logging options.

If you update the value of any "loggingOptions" field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the "roleArn" field (for example, to correct an invalid policy) it takes up to five minutes for that change to take effect.

Examples:

Request syntax with placeholder values


resp = client.put_logging_options({
  logging_options: { # required
    role_arn: "AmazonResourceName", # required
    level: "ERROR", # required, accepts ERROR, INFO, DEBUG
    enabled: false, # required
    detector_debug_options: [
      {
        detector_model_name: "DetectorModelName", # required
        key_value: "KeyValue",
      },
    ],
  },
})

Options Hash (options):

:logging_options (required, Types::LoggingOptions) —
The new values of the AWS IoT Events logging options.

Returns:

(Struct) —
Returns an empty response.

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

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Options Hash (options):

:resource_arn (required, String) —
The ARN of the resource.
:tags (required, Array<Types::Tag>) —
The new or modified tags for the resource.

Returns:

(Struct) —
Returns an empty response.

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

Removes the given tags (metadata) from the resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Options Hash (options):

:resource_arn (required, String) —
The ARN of the resource.
:tag_keys (required, Array<String>) —
A list of the keys of the tags to be removed from the resource.

Returns:

(Struct) —
Returns an empty response.

#update_detector_model(options = {}) ⇒ `Types::UpdateDetectorModelResponse`

Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.

Examples:

Request syntax with placeholder values


resp = client.update_detector_model({
  detector_model_name: "DetectorModelName", # required
  detector_model_definition: { # required
    states: [ # required
      {
        state_name: "StateName", # required
        on_input: {
          events: [
            {
              event_name: "EventName", # required
              condition: "Condition",
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1, # required
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                  },
                  iot_events: {
                    input_name: "InputName", # required
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                  },
                },
              ],
            },
          ],
          transition_events: [
            {
              event_name: "EventName", # required
              condition: "Condition", # required
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1, # required
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                  },
                  iot_events: {
                    input_name: "InputName", # required
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                  },
                },
              ],
              next_state: "StateName", # required
            },
          ],
        },
        on_enter: {
          events: [
            {
              event_name: "EventName", # required
              condition: "Condition",
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1, # required
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                  },
                  iot_events: {
                    input_name: "InputName", # required
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                  },
                },
              ],
            },
          ],
        },
        on_exit: {
          events: [
            {
              event_name: "EventName", # required
              condition: "Condition",
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1, # required
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                  },
                  iot_events: {
                    input_name: "InputName", # required
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                  },
                },
              ],
            },
          ],
        },
      },
    ],
    initial_state_name: "StateName", # required
  },
  detector_model_description: "DetectorModelDescription",
  role_arn: "AmazonResourceName", # required
})

Response structure


resp.detector_model_configuration.detector_model_name #=> String
resp.detector_model_configuration.detector_model_version #=> String
resp.detector_model_configuration.detector_model_description #=> String
resp.detector_model_configuration.detector_model_arn #=> String
resp.detector_model_configuration.role_arn #=> String
resp.detector_model_configuration.creation_time #=> Time
resp.detector_model_configuration.last_update_time #=> Time
resp.detector_model_configuration.status #=> String, one of "ACTIVE", "ACTIVATING", "INACTIVE", "DEPRECATED", "DRAFT", "PAUSED", "FAILED"
resp.detector_model_configuration.key #=> String

Options Hash (options):

:detector_model_name (required, String) —
The name of the detector model that is updated.
:detector_model_definition (required, Types::DetectorModelDefinition) —
Information that defines how a detector operates.
:detector_model_description (String) —
A brief description of the detector model.
:role_arn (required, String) —
The ARN of the role that grants permission to AWS IoT Events to perform its operations.

Returns:

(Types::UpdateDetectorModelResponse) —
Returns a response object which responds to the following methods:
- #detector_model_configuration => Types::DetectorModelConfiguration

#update_input(options = {}) ⇒ `Types::UpdateInputResponse`

Updates an input.

Examples:

Request syntax with placeholder values


resp = client.update_input({
  input_name: "InputName", # required
  input_description: "InputDescription",
  input_definition: { # required
    attributes: [ # required
      {
        json_path: "AttributeJsonPath", # required
      },
    ],
  },
})

Response structure


resp.input_configuration.input_name #=> String
resp.input_configuration.input_description #=> String
resp.input_configuration.input_arn #=> String
resp.input_configuration.creation_time #=> Time
resp.input_configuration.last_update_time #=> Time
resp.input_configuration.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING"

Options Hash (options):

:input_name (required, String) —
The name of the input you want to update.
:input_description (String) —
A brief description of the input.
:input_definition (required, Types::InputDefinition) —
The definition of the input.

Returns:

(Types::UpdateInputResponse) —
Returns a response object which responds to the following methods:
- #input_configuration => Types::InputConfiguration

#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::IoTEvents::Client

Overview

Region

Credentials

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::IoTEvents::Client

Instance Method Details

#create_detector_model(options = {}) ⇒ Types::CreateDetectorModelResponse

#create_input(options = {}) ⇒ Types::CreateInputResponse

#delete_detector_model(options = {}) ⇒ Struct

#delete_input(options = {}) ⇒ Struct

#describe_detector_model(options = {}) ⇒ Types::DescribeDetectorModelResponse

#describe_input(options = {}) ⇒ Types::DescribeInputResponse

#describe_logging_options(options = {}) ⇒ Types::DescribeLoggingOptionsResponse

#list_detector_model_versions(options = {}) ⇒ Types::ListDetectorModelVersionsResponse

#list_detector_models(options = {}) ⇒ Types::ListDetectorModelsResponse

#list_inputs(options = {}) ⇒ Types::ListInputsResponse

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

#put_logging_options(options = {}) ⇒ Struct

#tag_resource(options = {}) ⇒ Struct

#untag_resource(options = {}) ⇒ Struct

#update_detector_model(options = {}) ⇒ Types::UpdateDetectorModelResponse

#update_input(options = {}) ⇒ Types::UpdateInputResponse

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

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

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

#create_detector_model(options = {}) ⇒ `Types::CreateDetectorModelResponse`

#create_input(options = {}) ⇒ `Types::CreateInputResponse`

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

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

#describe_detector_model(options = {}) ⇒ `Types::DescribeDetectorModelResponse`

#describe_input(options = {}) ⇒ `Types::DescribeInputResponse`

#describe_logging_options(options = {}) ⇒ `Types::DescribeLoggingOptionsResponse`

#list_detector_model_versions(options = {}) ⇒ `Types::ListDetectorModelVersionsResponse`

#list_detector_models(options = {}) ⇒ `Types::ListDetectorModelsResponse`

#list_inputs(options = {}) ⇒ `Types::ListInputsResponse`

#list_tags_for_resource(options = {}) ⇒ `Types::ListTagsForResourceResponse`

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

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

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

#update_detector_model(options = {}) ⇒ `Types::UpdateDetectorModelResponse`

#update_input(options = {}) ⇒ `Types::UpdateInputResponse`

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

#waiter_names ⇒ `Array<Symbol>`