Class: Aws::IoTEvents::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String)

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

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

  • :client_side_monitoring (Boolean) — default: false

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

  • :client_side_monitoring_client_id (String) — default: ""

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000

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

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

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

  • :convert_params (Boolean) — default: true

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

  • :correct_clock_skew (Boolean) — default: true

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

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

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

  • :endpoint_cache_max_threads (Integer) — default: 10

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

  • :endpoint_cache_poll_interval (Integer) — default: 60

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

  • :endpoint_discovery (Boolean) — default: false

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

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

    The log formatter.

  • :log_level (Symbol) — default: :info

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

  • :logger (Logger)

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

  • :max_attempts (Integer) — default: 3

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

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

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

  • :retry_backoff (Proc)

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

  • :retry_base_delay (Float) — default: 0.3

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

  • :retry_jitter (Symbol) — default: :none

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

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

  • :retry_limit (Integer) — default: 3

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

  • :retry_max_delay (Integer) — default: 0

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

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

    Specifies which retry algorithm to use. Values are:

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

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

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

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

  • :http_idle_timeout (Float) — default: 5

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

  • :http_continue_timeout (Float) — default: 1

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

  • :http_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

  • :ssl_ca_bundle (String)

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

  • :ssl_ca_directory (String)

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



324
325
326
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

#create_alarm_model(params = {}) ⇒ Types::CreateAlarmModelResponse

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_alarm_model({
  alarm_model_name: "AlarmModelName", # required
  alarm_model_description: "AlarmModelDescription",
  role_arn: "AmazonResourceName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  key: "AttributeJsonPath",
  severity: 1,
  alarm_rule: { # required
    simple_rule: {
      input_property: "InputProperty", # required
      comparison_operator: "GREATER", # required, accepts GREATER, GREATER_OR_EQUAL, LESS, LESS_OR_EQUAL, EQUAL, NOT_EQUAL
      threshold: "Threshold", # required
    },
  },
  alarm_notification: {
    notification_actions: [
      {
        action: { # required
          lambda_action: {
            function_arn: "AmazonResourceName", # required
            payload: {
              content_expression: "ContentExpression", # required
              type: "STRING", # required, accepts STRING, JSON
            },
          },
        },
        sms_configurations: [
          {
            sender_id: "SMSSenderId",
            additional_message: "NotificationAdditionalMessage",
            recipients: [ # required
              {
                sso_identity: {
                  identity_store_id: "IdentityStoreId", # required
                  user_id: "SSOReferenceId",
                },
              },
            ],
          },
        ],
        email_configurations: [
          {
            from: "FromEmail", # required
            content: {
              subject: "EmailSubject",
              additional_message: "NotificationAdditionalMessage",
            },
            recipients: { # required
              to: [
                {
                  sso_identity: {
                    identity_store_id: "IdentityStoreId", # required
                    user_id: "SSOReferenceId",
                  },
                },
              ],
            },
          },
        ],
      },
    ],
  },
  alarm_event_actions: {
    alarm_actions: [
      {
        sns: {
          target_arn: "AmazonResourceName", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        iot_topic_publish: {
          mqtt_topic: "MQTTTopic", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        lambda: {
          function_arn: "AmazonResourceName", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        iot_events: {
          input_name: "InputName", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        sqs: {
          queue_url: "QueueUrl", # required
          use_base_64: false,
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        firehose: {
          delivery_stream_name: "DeliveryStreamName", # required
          separator: "FirehoseSeparator",
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        dynamo_db: {
          hash_key_type: "DynamoKeyType",
          hash_key_field: "DynamoKeyField", # required
          hash_key_value: "DynamoKeyValue", # required
          range_key_type: "DynamoKeyType",
          range_key_field: "DynamoKeyField",
          range_key_value: "DynamoKeyValue",
          operation: "DynamoOperation",
          payload_field: "DynamoKeyField",
          table_name: "DynamoTableName", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        dynamo_d_bv_2: {
          table_name: "DynamoTableName", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        iot_site_wise: {
          entry_id: "AssetPropertyEntryId",
          asset_id: "AssetId",
          property_id: "AssetPropertyId",
          property_alias: "AssetPropertyAlias",
          property_value: {
            value: {
              string_value: "AssetPropertyStringValue",
              integer_value: "AssetPropertyIntegerValue",
              double_value: "AssetPropertyDoubleValue",
              boolean_value: "AssetPropertyBooleanValue",
            },
            timestamp: {
              time_in_seconds: "AssetPropertyTimeInSeconds", # required
              offset_in_nanos: "AssetPropertyOffsetInNanos",
            },
            quality: "AssetPropertyQuality",
          },
        },
      },
    ],
  },
  alarm_capabilities: {
    initialization_configuration: {
      disabled_on_initialization: false, # required
    },
    acknowledge_flow: {
      enabled: false, # required
    },
  },
})

Response structure


resp.creation_time #=> Time
resp.alarm_model_arn #=> String
resp.alarm_model_version #=> String
resp.last_update_time #=> Time
resp.status #=> String, one of "ACTIVE", "ACTIVATING", "INACTIVE", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :alarm_model_name (required, String)

    A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.

  • :alarm_model_description (String)

    A description that tells you what the alarm model detects.

  • :role_arn (required, String)

    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

  • :tags (Array<Types::Tag>)

    A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

    You can create up to 50 tags for one alarm model.

  • :key (String)

    An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

  • :severity (Integer)

    A non-negative integer that reflects the severity level of the alarm.

  • :alarm_rule (required, Types::AlarmRule)

    Defines when your alarm is invoked.

  • :alarm_notification (Types::AlarmNotification)

    Contains information about one or more notification actions.

  • :alarm_event_actions (Types::AlarmEventActions)

    Contains information about one or more alarm actions.

  • :alarm_capabilities (Types::AlarmCapabilities)

    Contains the configuration information of alarm state changes.

Returns:



578
579
580
581
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 578

def create_alarm_model(params = {}, options = {})
  req = build_request(:create_alarm_model, params)
  req.send_request(options)
end

#create_detector_model(params = {}) ⇒ 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
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
            },
          ],
          transition_events: [
            {
              event_name: "EventName", # required
              condition: "Condition", # required
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
              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
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
            },
          ],
        },
        on_exit: {
          events: [
            {
              event_name: "EventName", # required
              condition: "Condition",
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
            },
          ],
        },
      },
    ],
    initial_state_name: "StateName", # required
  },
  detector_model_description: "DetectorModelDescription",
  key: "AttributeJsonPath",
  role_arn: "AmazonResourceName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  evaluation_method: "BATCH", # accepts BATCH, SERIAL
})

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
resp.detector_model_configuration.evaluation_method #=> String, one of "BATCH", "SERIAL"

Parameters:

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

    ({})

Options Hash (params):

  • :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 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 in the message payload of each input to specify the attribute-value pair 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.

  • :evaluation_method (String)

    Information about the order in which events are evaluated and how actions are executed.

Returns:



1103
1104
1105
1106
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1103

def create_detector_model(params = {}, options = {})
  req = build_request(:create_detector_model, params)
  req.send_request(options)
end

#create_input(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

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



1157
1158
1159
1160
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1157

def create_input(params = {}, options = {})
  req = build_request(:create_input, params)
  req.send_request(options)
end

#delete_alarm_model(params = {}) ⇒ Struct

Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.

Examples:

Request syntax with placeholder values


resp = client.delete_alarm_model({
  alarm_model_name: "AlarmModelName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :alarm_model_name (required, String)

    The name of the alarm model.

Returns:

  • (Struct)

    Returns an empty response.



1178
1179
1180
1181
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1178

def delete_alarm_model(params = {}, options = {})
  req = build_request(:delete_alarm_model, params)
  req.send_request(options)
end

#delete_detector_model(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :detector_model_name (required, String)

    The name of the detector model to be deleted.

Returns:

  • (Struct)

    Returns an empty response.



1199
1200
1201
1202
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1199

def delete_detector_model(params = {}, options = {})
  req = build_request(:delete_detector_model, params)
  req.send_request(options)
end

#delete_input(params = {}) ⇒ Struct

Deletes an input.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :input_name (required, String)

    The name of the input to delete.

Returns:

  • (Struct)

    Returns an empty response.



1219
1220
1221
1222
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1219

def delete_input(params = {}, options = {})
  req = build_request(:delete_input, params)
  req.send_request(options)
end

#describe_alarm_model(params = {}) ⇒ Types::DescribeAlarmModelResponse

Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.

Examples:

Request syntax with placeholder values


resp = client.describe_alarm_model({
  alarm_model_name: "AlarmModelName", # required
  alarm_model_version: "AlarmModelVersion",
})

Response structure


resp.creation_time #=> Time
resp.alarm_model_arn #=> String
resp.alarm_model_version #=> String
resp.last_update_time #=> Time
resp.status #=> String, one of "ACTIVE", "ACTIVATING", "INACTIVE", "FAILED"
resp.status_message #=> String
resp.alarm_model_name #=> String
resp.alarm_model_description #=> String
resp.role_arn #=> String
resp.key #=> String
resp.severity #=> Integer
resp.alarm_rule.simple_rule.input_property #=> String
resp.alarm_rule.simple_rule.comparison_operator #=> String, one of "GREATER", "GREATER_OR_EQUAL", "LESS", "LESS_OR_EQUAL", "EQUAL", "NOT_EQUAL"
resp.alarm_rule.simple_rule.threshold #=> String
resp.alarm_notification.notification_actions #=> Array
resp.alarm_notification.notification_actions[0].action.lambda_action.function_arn #=> String
resp.alarm_notification.notification_actions[0].action.lambda_action.payload.content_expression #=> String
resp.alarm_notification.notification_actions[0].action.lambda_action.payload.type #=> String, one of "STRING", "JSON"
resp.alarm_notification.notification_actions[0].sms_configurations #=> Array
resp.alarm_notification.notification_actions[0].sms_configurations[0].sender_id #=> String
resp.alarm_notification.notification_actions[0].sms_configurations[0].additional_message #=> String
resp.alarm_notification.notification_actions[0].sms_configurations[0].recipients #=> Array
resp.alarm_notification.notification_actions[0].sms_configurations[0].recipients[0].sso_identity.identity_store_id #=> String
resp.alarm_notification.notification_actions[0].sms_configurations[0].recipients[0].sso_identity.user_id #=> String
resp.alarm_notification.notification_actions[0].email_configurations #=> Array
resp.alarm_notification.notification_actions[0].email_configurations[0].from #=> String
resp.alarm_notification.notification_actions[0].email_configurations[0].content.subject #=> String
resp.alarm_notification.notification_actions[0].email_configurations[0].content.additional_message #=> String
resp.alarm_notification.notification_actions[0].email_configurations[0].recipients.to #=> Array
resp.alarm_notification.notification_actions[0].email_configurations[0].recipients.to[0].sso_identity.identity_store_id #=> String
resp.alarm_notification.notification_actions[0].email_configurations[0].recipients.to[0].sso_identity.user_id #=> String
resp.alarm_event_actions.alarm_actions #=> Array
resp.alarm_event_actions.alarm_actions[0].sns.target_arn #=> String
resp.alarm_event_actions.alarm_actions[0].sns.payload.content_expression #=> String
resp.alarm_event_actions.alarm_actions[0].sns.payload.type #=> String, one of "STRING", "JSON"
resp.alarm_event_actions.alarm_actions[0].iot_topic_publish.mqtt_topic #=> String
resp.alarm_event_actions.alarm_actions[0].iot_topic_publish.payload.content_expression #=> String
resp.alarm_event_actions.alarm_actions[0].iot_topic_publish.payload.type #=> String, one of "STRING", "JSON"
resp.alarm_event_actions.alarm_actions[0].lambda.function_arn #=> String
resp.alarm_event_actions.alarm_actions[0].lambda.payload.content_expression #=> String
resp.alarm_event_actions.alarm_actions[0].lambda.payload.type #=> String, one of "STRING", "JSON"
resp.alarm_event_actions.alarm_actions[0].iot_events.input_name #=> String
resp.alarm_event_actions.alarm_actions[0].iot_events.payload.content_expression #=> String
resp.alarm_event_actions.alarm_actions[0].iot_events.payload.type #=> String, one of "STRING", "JSON"
resp.alarm_event_actions.alarm_actions[0].sqs.queue_url #=> String
resp.alarm_event_actions.alarm_actions[0].sqs.use_base_64 #=> Boolean
resp.alarm_event_actions.alarm_actions[0].sqs.payload.content_expression #=> String
resp.alarm_event_actions.alarm_actions[0].sqs.payload.type #=> String, one of "STRING", "JSON"
resp.alarm_event_actions.alarm_actions[0].firehose.delivery_stream_name #=> String
resp.alarm_event_actions.alarm_actions[0].firehose.separator #=> String
resp.alarm_event_actions.alarm_actions[0].firehose.payload.content_expression #=> String
resp.alarm_event_actions.alarm_actions[0].firehose.payload.type #=> String, one of "STRING", "JSON"
resp.alarm_event_actions.alarm_actions[0].dynamo_db.hash_key_type #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_db.hash_key_field #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_db.hash_key_value #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_db.range_key_type #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_db.range_key_field #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_db.range_key_value #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_db.operation #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_db.payload_field #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_db.table_name #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_db.payload.content_expression #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_db.payload.type #=> String, one of "STRING", "JSON"
resp.alarm_event_actions.alarm_actions[0].dynamo_d_bv_2.table_name #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_d_bv_2.payload.content_expression #=> String
resp.alarm_event_actions.alarm_actions[0].dynamo_d_bv_2.payload.type #=> String, one of "STRING", "JSON"
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.entry_id #=> String
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.asset_id #=> String
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.property_id #=> String
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.property_alias #=> String
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.property_value.value.string_value #=> String
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.property_value.value.integer_value #=> String
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.property_value.value.double_value #=> String
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.property_value.value.boolean_value #=> String
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.property_value.timestamp.time_in_seconds #=> String
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.property_value.timestamp.offset_in_nanos #=> String
resp.alarm_event_actions.alarm_actions[0].iot_site_wise.property_value.quality #=> String
resp.alarm_capabilities.initialization_configuration.disabled_on_initialization #=> Boolean
resp.alarm_capabilities.acknowledge_flow.enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :alarm_model_name (required, String)

    The name of the alarm model.

  • :alarm_model_version (String)

    The version of the alarm model.

Returns:



1343
1344
1345
1346
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1343

def describe_alarm_model(params = {}, options = {})
  req = build_request(:describe_alarm_model, params)
  req.send_request(options)
end

#describe_detector_model(params = {}) ⇒ 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].sns.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].sns.payload.type #=> String, one of "STRING", "JSON"
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].iot_topic_publish.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_topic_publish.payload.type #=> String, one of "STRING", "JSON"
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].set_timer.duration_expression #=> String
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].lambda.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].lambda.payload.type #=> String, one of "STRING", "JSON"
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].iot_events.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_events.payload.type #=> String, one of "STRING", "JSON"
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 #=> Boolean
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].sqs.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].sqs.payload.type #=> String, one of "STRING", "JSON"
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.events[0].actions[0].firehose.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].firehose.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.hash_key_type #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.hash_key_field #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.hash_key_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.range_key_type #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.range_key_field #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.range_key_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.operation #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.payload_field #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.table_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_db.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_d_bv_2.table_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_d_bv_2.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].dynamo_d_bv_2.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.entry_id #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.asset_id #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.property_id #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.property_alias #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.property_value.value.string_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.property_value.value.integer_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.property_value.value.double_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.property_value.value.boolean_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.property_value.timestamp.time_in_seconds #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.property_value.timestamp.offset_in_nanos #=> String
resp.detector_model.detector_model_definition.states[0].on_input.events[0].actions[0].iot_site_wise.property_value.quality #=> 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].sns.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].sns.payload.type #=> String, one of "STRING", "JSON"
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].iot_topic_publish.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_topic_publish.payload.type #=> String, one of "STRING", "JSON"
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].set_timer.duration_expression #=> String
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].lambda.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].lambda.payload.type #=> String, one of "STRING", "JSON"
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].iot_events.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_events.payload.type #=> String, one of "STRING", "JSON"
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 #=> Boolean
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].sqs.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].sqs.payload.type #=> String, one of "STRING", "JSON"
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].actions[0].firehose.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].firehose.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.hash_key_type #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.hash_key_field #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.hash_key_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.range_key_type #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.range_key_field #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.range_key_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.operation #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.payload_field #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.table_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_db.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_d_bv_2.table_name #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_d_bv_2.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].dynamo_d_bv_2.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.entry_id #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.asset_id #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.property_id #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.property_alias #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.property_value.value.string_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.property_value.value.integer_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.property_value.value.double_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.property_value.value.boolean_value #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.property_value.timestamp.time_in_seconds #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.property_value.timestamp.offset_in_nanos #=> String
resp.detector_model.detector_model_definition.states[0].on_input.transition_events[0].actions[0].iot_site_wise.property_value.quality #=> 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].sns.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].sns.payload.type #=> String, one of "STRING", "JSON"
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].iot_topic_publish.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_topic_publish.payload.type #=> String, one of "STRING", "JSON"
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].set_timer.duration_expression #=> String
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].lambda.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].lambda.payload.type #=> String, one of "STRING", "JSON"
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].iot_events.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_events.payload.type #=> String, one of "STRING", "JSON"
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 #=> Boolean
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].sqs.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].sqs.payload.type #=> String, one of "STRING", "JSON"
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_enter.events[0].actions[0].firehose.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].firehose.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.hash_key_type #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.hash_key_field #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.hash_key_value #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.range_key_type #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.range_key_field #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.range_key_value #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.operation #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.payload_field #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.table_name #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_db.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_d_bv_2.table_name #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_d_bv_2.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].dynamo_d_bv_2.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.entry_id #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.asset_id #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.property_id #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.property_alias #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.property_value.value.string_value #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.property_value.value.integer_value #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.property_value.value.double_value #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.property_value.value.boolean_value #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.property_value.timestamp.time_in_seconds #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.property_value.timestamp.offset_in_nanos #=> String
resp.detector_model.detector_model_definition.states[0].on_enter.events[0].actions[0].iot_site_wise.property_value.quality #=> 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].sns.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].sns.payload.type #=> String, one of "STRING", "JSON"
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].iot_topic_publish.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_topic_publish.payload.type #=> String, one of "STRING", "JSON"
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].set_timer.duration_expression #=> String
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].lambda.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].lambda.payload.type #=> String, one of "STRING", "JSON"
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].iot_events.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_events.payload.type #=> String, one of "STRING", "JSON"
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 #=> Boolean
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].sqs.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].sqs.payload.type #=> String, one of "STRING", "JSON"
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.states[0].on_exit.events[0].actions[0].firehose.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].firehose.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.hash_key_type #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.hash_key_field #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.hash_key_value #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.range_key_type #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.range_key_field #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.range_key_value #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.operation #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.payload_field #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.table_name #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_db.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_d_bv_2.table_name #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_d_bv_2.payload.content_expression #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].dynamo_d_bv_2.payload.type #=> String, one of "STRING", "JSON"
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.entry_id #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.asset_id #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.property_id #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.property_alias #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.property_value.value.string_value #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.property_value.value.integer_value #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.property_value.value.double_value #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.property_value.value.boolean_value #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.property_value.timestamp.time_in_seconds #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.property_value.timestamp.offset_in_nanos #=> String
resp.detector_model.detector_model_definition.states[0].on_exit.events[0].actions[0].iot_site_wise.property_value.quality #=> 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
resp.detector_model.detector_model_configuration.evaluation_method #=> String, one of "BATCH", "SERIAL"

Parameters:

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

    ({})

Options Hash (params):

  • :detector_model_name (required, String)

    The name of the detector model.

  • :detector_model_version (String)

    The version of the detector model.

Returns:



1611
1612
1613
1614
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1611

def describe_detector_model(params = {}, options = {})
  req = build_request(:describe_detector_model, params)
  req.send_request(options)
end

#describe_detector_model_analysis(params = {}) ⇒ Types::DescribeDetectorModelAnalysisResponse

Retrieves runtime information about a detector model analysis.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

Examples:

Request syntax with placeholder values


resp = client.describe_detector_model_analysis({
  analysis_id: "AnalysisId", # required
})

Response structure


resp.status #=> String, one of "RUNNING", "COMPLETE", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :analysis_id (required, String)

    The ID of the analysis result that you want to retrieve.

Returns:



1642
1643
1644
1645
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1642

def describe_detector_model_analysis(params = {}, options = {})
  req = build_request(:describe_detector_model_analysis, params)
  req.send_request(options)
end

#describe_input(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :input_name (required, String)

    The name of the input.

Returns:



1675
1676
1677
1678
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1675

def describe_input(params = {}, options = {})
  req = build_request(:describe_input, params)
  req.send_request(options)
end

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

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

Examples:

Response structure


resp.logging_options.role_arn #=> String
resp.logging_options.level #=> String, one of "ERROR", "INFO", "DEBUG"
resp.logging_options.enabled #=> Boolean
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

Parameters:

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

    ({})

Returns:



1697
1698
1699
1700
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1697

def describe_logging_options(params = {}, options = {})
  req = build_request(:describe_logging_options, params)
  req.send_request(options)
end

#get_detector_model_analysis_results(params = {}) ⇒ Types::GetDetectorModelAnalysisResultsResponse

Retrieves one or more analysis results of the detector model.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

Examples:

Request syntax with placeholder values


resp = client.get_detector_model_analysis_results({
  analysis_id: "AnalysisId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.analysis_results #=> Array
resp.analysis_results[0].type #=> String
resp.analysis_results[0].level #=> String, one of "INFO", "WARNING", "ERROR"
resp.analysis_results[0].message #=> String
resp.analysis_results[0].locations #=> Array
resp.analysis_results[0].locations[0].path #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :analysis_id (required, String)

    The ID of the analysis result that you want to retrieve.

  • :next_token (String)

    The token that you can use to return the next set of results.

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:



1743
1744
1745
1746
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1743

def get_detector_model_analysis_results(params = {}, options = {})
  req = build_request(:get_detector_model_analysis_results, params)
  req.send_request(options)
end

#list_alarm_model_versions(params = {}) ⇒ Types::ListAlarmModelVersionsResponse

Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.

Examples:

Request syntax with placeholder values


resp = client.list_alarm_model_versions({
  alarm_model_name: "AlarmModelName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.alarm_model_version_summaries #=> Array
resp.alarm_model_version_summaries[0].alarm_model_name #=> String
resp.alarm_model_version_summaries[0].alarm_model_arn #=> String
resp.alarm_model_version_summaries[0].alarm_model_version #=> String
resp.alarm_model_version_summaries[0].role_arn #=> String
resp.alarm_model_version_summaries[0].creation_time #=> Time
resp.alarm_model_version_summaries[0].last_update_time #=> Time
resp.alarm_model_version_summaries[0].status #=> String, one of "ACTIVE", "ACTIVATING", "INACTIVE", "FAILED"
resp.alarm_model_version_summaries[0].status_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :alarm_model_name (required, String)

    The name of the alarm model.

  • :next_token (String)

    The token that you can use to return the next set of results.

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:



1788
1789
1790
1791
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1788

def list_alarm_model_versions(params = {}, options = {})
  req = build_request(:list_alarm_model_versions, params)
  req.send_request(options)
end

#list_alarm_models(params = {}) ⇒ Types::ListAlarmModelsResponse

Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.

Examples:

Request syntax with placeholder values


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

Response structure


resp.alarm_model_summaries #=> Array
resp.alarm_model_summaries[0].creation_time #=> Time
resp.alarm_model_summaries[0].alarm_model_description #=> String
resp.alarm_model_summaries[0].alarm_model_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token that you can use to return the next set of results.

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:



1824
1825
1826
1827
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1824

def list_alarm_models(params = {}, options = {})
  req = build_request(:list_alarm_models, params)
  req.send_request(options)
end

#list_detector_model_versions(params = {}) ⇒ 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.detector_model_version_summaries[0].evaluation_method #=> String, one of "BATCH", "SERIAL"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :detector_model_name (required, String)

    The name of the detector model whose versions are returned.

  • :next_token (String)

    The token that you can use to return the next set of results.

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:



1869
1870
1871
1872
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1869

def list_detector_model_versions(params = {}, options = {})
  req = build_request(:list_detector_model_versions, params)
  req.send_request(options)
end

#list_detector_models(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token that you can use to return the next set of results.

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:



1905
1906
1907
1908
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1905

def list_detector_models(params = {}, options = {})
  req = build_request(:list_detector_models, params)
  req.send_request(options)
end

#list_input_routings(params = {}) ⇒ Types::ListInputRoutingsResponse

Lists one or more input routings.

Examples:

Request syntax with placeholder values


resp = client.list_input_routings({
  input_identifier: { # required
    iot_events_input_identifier: {
      input_name: "InputName", # required
    },
    iot_site_wise_input_identifier: {
      iot_site_wise_asset_model_property_identifier: {
        asset_model_id: "AssetModelId", # required
        property_id: "AssetPropertyId", # required
      },
    },
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.routed_resources #=> Array
resp.routed_resources[0].name #=> String
resp.routed_resources[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :input_identifier (required, Types::InputIdentifier)

    The identifer of the routed input.

  • :max_results (Integer)

    The maximum number of results to be returned per request.

  • :next_token (String)

    The token that you can use to return the next set of results.

Returns:



1953
1954
1955
1956
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1953

def list_input_routings(params = {}, options = {})
  req = build_request(:list_input_routings, params)
  req.send_request(options)
end

#list_inputs(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token that you can use to return the next set of results.

  • :max_results (Integer)

    The maximum number of results to be returned per request.

Returns:



1991
1992
1993
1994
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 1991

def list_inputs(params = {}, options = {})
  req = build_request(:list_inputs, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The ARN of the resource.

Returns:



2019
2020
2021
2022
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 2019

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_logging_options(params = {}) ⇒ 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. 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",
      },
    ],
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :logging_options (required, Types::LoggingOptions)

    The new values of the AWS IoT Events logging options.

Returns:

  • (Struct)

    Returns an empty response.



2055
2056
2057
2058
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 2055

def put_logging_options(params = {}, options = {})
  req = build_request(:put_logging_options, params)
  req.send_request(options)
end

#start_detector_model_analysis(params = {}) ⇒ Types::StartDetectorModelAnalysisResponse

Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.start_detector_model_analysis({
  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
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
            },
          ],
          transition_events: [
            {
              event_name: "EventName", # required
              condition: "Condition", # required
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
              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
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
            },
          ],
        },
        on_exit: {
          events: [
            {
              event_name: "EventName", # required
              condition: "Condition",
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
            },
          ],
        },
      },
    ],
    initial_state_name: "StateName", # required
  },
})

Response structure


resp.analysis_id #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:



2541
2542
2543
2544
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 2541

def start_detector_model_analysis(params = {}, options = {})
  req = build_request(:start_detector_model_analysis, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ 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
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :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.



2571
2572
2573
2574
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 2571

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :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.



2595
2596
2597
2598
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 2595

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_alarm_model(params = {}) ⇒ Types::UpdateAlarmModelResponse

Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.

Examples:

Request syntax with placeholder values


resp = client.update_alarm_model({
  alarm_model_name: "AlarmModelName", # required
  alarm_model_description: "AlarmModelDescription",
  role_arn: "AmazonResourceName", # required
  severity: 1,
  alarm_rule: { # required
    simple_rule: {
      input_property: "InputProperty", # required
      comparison_operator: "GREATER", # required, accepts GREATER, GREATER_OR_EQUAL, LESS, LESS_OR_EQUAL, EQUAL, NOT_EQUAL
      threshold: "Threshold", # required
    },
  },
  alarm_notification: {
    notification_actions: [
      {
        action: { # required
          lambda_action: {
            function_arn: "AmazonResourceName", # required
            payload: {
              content_expression: "ContentExpression", # required
              type: "STRING", # required, accepts STRING, JSON
            },
          },
        },
        sms_configurations: [
          {
            sender_id: "SMSSenderId",
            additional_message: "NotificationAdditionalMessage",
            recipients: [ # required
              {
                sso_identity: {
                  identity_store_id: "IdentityStoreId", # required
                  user_id: "SSOReferenceId",
                },
              },
            ],
          },
        ],
        email_configurations: [
          {
            from: "FromEmail", # required
            content: {
              subject: "EmailSubject",
              additional_message: "NotificationAdditionalMessage",
            },
            recipients: { # required
              to: [
                {
                  sso_identity: {
                    identity_store_id: "IdentityStoreId", # required
                    user_id: "SSOReferenceId",
                  },
                },
              ],
            },
          },
        ],
      },
    ],
  },
  alarm_event_actions: {
    alarm_actions: [
      {
        sns: {
          target_arn: "AmazonResourceName", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        iot_topic_publish: {
          mqtt_topic: "MQTTTopic", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        lambda: {
          function_arn: "AmazonResourceName", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        iot_events: {
          input_name: "InputName", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        sqs: {
          queue_url: "QueueUrl", # required
          use_base_64: false,
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        firehose: {
          delivery_stream_name: "DeliveryStreamName", # required
          separator: "FirehoseSeparator",
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        dynamo_db: {
          hash_key_type: "DynamoKeyType",
          hash_key_field: "DynamoKeyField", # required
          hash_key_value: "DynamoKeyValue", # required
          range_key_type: "DynamoKeyType",
          range_key_field: "DynamoKeyField",
          range_key_value: "DynamoKeyValue",
          operation: "DynamoOperation",
          payload_field: "DynamoKeyField",
          table_name: "DynamoTableName", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        dynamo_d_bv_2: {
          table_name: "DynamoTableName", # required
          payload: {
            content_expression: "ContentExpression", # required
            type: "STRING", # required, accepts STRING, JSON
          },
        },
        iot_site_wise: {
          entry_id: "AssetPropertyEntryId",
          asset_id: "AssetId",
          property_id: "AssetPropertyId",
          property_alias: "AssetPropertyAlias",
          property_value: {
            value: {
              string_value: "AssetPropertyStringValue",
              integer_value: "AssetPropertyIntegerValue",
              double_value: "AssetPropertyDoubleValue",
              boolean_value: "AssetPropertyBooleanValue",
            },
            timestamp: {
              time_in_seconds: "AssetPropertyTimeInSeconds", # required
              offset_in_nanos: "AssetPropertyOffsetInNanos",
            },
            quality: "AssetPropertyQuality",
          },
        },
      },
    ],
  },
  alarm_capabilities: {
    initialization_configuration: {
      disabled_on_initialization: false, # required
    },
    acknowledge_flow: {
      enabled: false, # required
    },
  },
})

Response structure


resp.creation_time #=> Time
resp.alarm_model_arn #=> String
resp.alarm_model_version #=> String
resp.last_update_time #=> Time
resp.status #=> String, one of "ACTIVE", "ACTIVATING", "INACTIVE", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :alarm_model_name (required, String)

    The name of the alarm model.

  • :alarm_model_description (String)

    The description of the alarm model.

  • :role_arn (required, String)

    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

  • :severity (Integer)

    A non-negative integer that reflects the severity level of the alarm.

  • :alarm_rule (required, Types::AlarmRule)

    Defines when your alarm is invoked.

  • :alarm_notification (Types::AlarmNotification)

    Contains information about one or more notification actions.

  • :alarm_event_actions (Types::AlarmEventActions)

    Contains information about one or more alarm actions.

  • :alarm_capabilities (Types::AlarmCapabilities)

    Contains the configuration information of alarm state changes.

Returns:



2815
2816
2817
2818
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 2815

def update_alarm_model(params = {}, options = {})
  req = build_request(:update_alarm_model, params)
  req.send_request(options)
end

#update_detector_model(params = {}) ⇒ 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
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
            },
          ],
          transition_events: [
            {
              event_name: "EventName", # required
              condition: "Condition", # required
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
              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
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
            },
          ],
        },
        on_exit: {
          events: [
            {
              event_name: "EventName", # required
              condition: "Condition",
              actions: [
                {
                  set_variable: {
                    variable_name: "VariableName", # required
                    value: "VariableValue", # required
                  },
                  sns: {
                    target_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_topic_publish: {
                    mqtt_topic: "MQTTTopic", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  set_timer: {
                    timer_name: "TimerName", # required
                    seconds: 1,
                    duration_expression: "VariableValue",
                  },
                  clear_timer: {
                    timer_name: "TimerName", # required
                  },
                  reset_timer: {
                    timer_name: "TimerName", # required
                  },
                  lambda: {
                    function_arn: "AmazonResourceName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_events: {
                    input_name: "InputName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  sqs: {
                    queue_url: "QueueUrl", # required
                    use_base_64: false,
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  firehose: {
                    delivery_stream_name: "DeliveryStreamName", # required
                    separator: "FirehoseSeparator",
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_db: {
                    hash_key_type: "DynamoKeyType",
                    hash_key_field: "DynamoKeyField", # required
                    hash_key_value: "DynamoKeyValue", # required
                    range_key_type: "DynamoKeyType",
                    range_key_field: "DynamoKeyField",
                    range_key_value: "DynamoKeyValue",
                    operation: "DynamoOperation",
                    payload_field: "DynamoKeyField",
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  dynamo_d_bv_2: {
                    table_name: "DynamoTableName", # required
                    payload: {
                      content_expression: "ContentExpression", # required
                      type: "STRING", # required, accepts STRING, JSON
                    },
                  },
                  iot_site_wise: {
                    entry_id: "AssetPropertyEntryId",
                    asset_id: "AssetId",
                    property_id: "AssetPropertyId",
                    property_alias: "AssetPropertyAlias",
                    property_value: {
                      value: {
                        string_value: "AssetPropertyStringValue",
                        integer_value: "AssetPropertyIntegerValue",
                        double_value: "AssetPropertyDoubleValue",
                        boolean_value: "AssetPropertyBooleanValue",
                      },
                      timestamp: {
                        time_in_seconds: "AssetPropertyTimeInSeconds", # required
                        offset_in_nanos: "AssetPropertyOffsetInNanos",
                      },
                      quality: "AssetPropertyQuality",
                    },
                  },
                },
              ],
            },
          ],
        },
      },
    ],
    initial_state_name: "StateName", # required
  },
  detector_model_description: "DetectorModelDescription",
  role_arn: "AmazonResourceName", # required
  evaluation_method: "BATCH", # accepts BATCH, SERIAL
})

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
resp.detector_model_configuration.evaluation_method #=> String, one of "BATCH", "SERIAL"

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :evaluation_method (String)

    Information about the order in which events are evaluated and how actions are executed.

Returns:



3323
3324
3325
3326
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 3323

def update_detector_model(params = {}, options = {})
  req = build_request(:update_detector_model, params)
  req.send_request(options)
end

#update_input(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

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



3368
3369
3370
3371
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/client.rb', line 3368

def update_input(params = {}, options = {})
  req = build_request(:update_input, params)
  req.send_request(options)
end