# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/invocation_id.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/http_checksum.rb' require 'aws-sdk-core/plugins/checksum_algorithm.rb' require 'aws-sdk-core/plugins/request_compression.rb' require 'aws-sdk-core/plugins/defaults_mode.rb' require 'aws-sdk-core/plugins/recursion_detection.rb' require 'aws-sdk-core/plugins/telemetry.rb' require 'aws-sdk-core/plugins/sign.rb' require 'aws-sdk-core/plugins/protocols/rest_json.rb' module Aws::IoTEvents # 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](/sdk-for-ruby/v3/developer-guide/setup-config.html). # # See {#initialize} for a full list of supported configuration options. class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :iotevents set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::InvocationId) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::HttpChecksum) add_plugin(Aws::Plugins::ChecksumAlgorithm) add_plugin(Aws::Plugins::RequestCompression) add_plugin(Aws::Plugins::DefaultsMode) add_plugin(Aws::Plugins::RecursionDetection) add_plugin(Aws::Plugins::Telemetry) add_plugin(Aws::Plugins::Sign) add_plugin(Aws::Plugins::Protocols::RestJson) add_plugin(Aws::IoTEvents::Plugins::Endpoints) # @overload initialize(options) # @param [Hash] options # # @option options [Array] :plugins ([]]) # A list of plugins to apply to the client. Each plugin is either a # class name or an instance of a plugin class. # # @option options [required, Aws::CredentialProvider] :credentials # 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`, `:session_token`, and # `:account_id` options. # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'] # * `~/.aws/credentials` # * `~/.aws/config` # * EC2/ECS IMDS instance profile - When used by default, the timeouts # are very aggressive. Construct and pass an instance of # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to # enable retries and extended timeouts. Instance profile credential # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] # to true. # # @option options [required, String] :region # 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` # # @option options [String] :access_key_id # # @option options [String] :account_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :adaptive_retry_wait_to_fill (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. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("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. # # @option options [Integer] :client_side_monitoring_port (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. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :correct_clock_skew (true) # Used only in `standard` and adaptive retry modes. Specifies whether to apply # a clock skew correction and retry requests with skewed client clocks. # # @option options [String] :defaults_mode ("legacy") # See {Aws::DefaultsModeConfiguration} for a list of the # accepted modes and the configuration defaults that are included. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [Boolean] :disable_request_compression (false) # When set to 'true' the request body will not be compressed # for supported operations. # # @option options [String, URI::HTTPS, URI::HTTP] :endpoint # Normally you should not configure the `:endpoint` option # directly. This is normally constructed from the `:region` # option. Configuring `:endpoint` is normally reserved for # connecting to test or custom endpoints. The endpoint should # be a URI formatted like: # # 'http://example.com' # 'https://example.com' # 'http://example.com:123' # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (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. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. # # @option options [Boolean] :ignore_configured_endpoint_urls # Setting to true disables use of endpoint URLs provided via environment # variables and the shared configuration file. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [Integer] :max_attempts (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. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Integer] :request_min_compression_size_bytes (10240) # The minimum size in bytes that triggers compression for request # bodies. The value must be non-negative integer value between 0 # and 10485780 bytes inclusive. # # @option options [Proc] :retry_backoff # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. # This option is only used in the `legacy` retry mode. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. This option # is only used in the `legacy` retry mode. # # @option options [Symbol] :retry_jitter (: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 # # @option options [Integer] :retry_limit (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. # # @option options [Integer] :retry_max_delay (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. # # @option options [String] :retry_mode ("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. # # @option options [String] :sdk_ua_app_id # A unique and opaque application ID that is appended to the # User-Agent header as app/sdk_ua_app_id. It should have a # maximum length of 50. This variable is sourced from environment # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Array] :sigv4a_signing_region_set # A list of regions that should be signed with SigV4a signing. When # not passed, a default `:sigv4a_signing_region_set` is searched for # in the following locations: # # * `Aws.config[:sigv4a_signing_region_set]` # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']` # * `~/.aws/config` # # @option options [Boolean] :stub_responses (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. # # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider) # Allows you to provide a telemetry provider, which is used to # emit telemetry data. By default, uses `NoOpTelemetryProvider` which # will not record or emit any telemetry data. The SDK supports the # following telemetry providers: # # * OpenTelemetry (OTel) - To use the OTel provider, install and require the # `opentelemetry-sdk` gem and then, pass in an instance of a # `Aws::Telemetry::OTelProvider` for telemetry provider. # # @option options [Aws::TokenProvider] :token_provider # A Bearer Token Provider. This can be an instance of any one of the # following classes: # # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing # tokens. # # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an # access token generated from `aws login`. # # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain` # will be used to search for tokens configured for your profile in shared configuration files. # # @option options [Boolean] :use_dualstack_endpoint # When set to `true`, dualstack enabled endpoints (with `.aws` TLD) # will be used if available. # # @option options [Boolean] :use_fips_endpoint # When set to `true`, fips compatible endpoints will be used if available. # When a `fips` region is used, the region is normalized and this config # is set to `true`. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [Aws::IoTEvents::EndpointProvider] :endpoint_provider # The endpoint provider used to resolve endpoints. Any object that responds to # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to # `Aws::IoTEvents::EndpointParameters`. # # @option options [Float] :http_continue_timeout (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. # # @option options [Float] :http_idle_timeout (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. # # @option options [Float] :http_open_timeout (15) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [URI::HTTP,String] :http_proxy # A proxy to send requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_read_timeout (60) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [Boolean] :http_wire_trace (false) # When `true`, HTTP debug output will be sent to the `:logger`. # # @option options [Proc] :on_chunk_received # When a Proc object is provided, it will be used as callback when each chunk # of the response body is received. It provides three arguments: the chunk, # the number of bytes received, and the total number of # bytes in the response (or nil if the server did not send a `content-length`). # # @option options [Proc] :on_chunk_sent # When a Proc object is provided, it will be used as callback when each chunk # of the request body is sent. It provides three arguments: the chunk, # the number of bytes read from the body, and the total number of # bytes in the body. # # @option options [Boolean] :raise_response_errors (true) # When `true`, response errors are raised. # # @option options [String] :ssl_ca_bundle # 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. # # @option options [String] :ssl_ca_directory # 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. # # @option options [String] :ssl_ca_store # Sets the X509::Store to verify peer certificate. # # @option options [OpenSSL::X509::Certificate] :ssl_cert # Sets a client certificate when creating http connections. # # @option options [OpenSSL::PKey] :ssl_key # Sets a client key when creating http connections. # # @option options [Float] :ssl_timeout # Sets the SSL timeout in seconds # # @option options [Boolean] :ssl_verify_peer (true) # When `true`, SSL peer certificates are verified when establishing a connection. # def initialize(*args) super end # @!group API Operations # 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][1] # in the *AWS IoT Events Developer Guide*. # # # # [1]: https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html # # @option params [required, String] :alarm_model_name # A unique name that helps you identify the alarm model. You can't # change this name after you create the alarm model. # # @option params [String] :alarm_model_description # A description that tells you what the alarm model detects. # # @option params [required, String] :role_arn # 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)][1] in the *AWS General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # # @option params [Array] :tags # 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][1] in the *AWS IoT Events # Developer Guide*. # # You can create up to 50 tags for one alarm model. # # # # [1]: https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html # # @option params [String] :key # An input attribute used as a key to create an alarm. AWS IoT Events # routes [inputs][1] associated with this key to the alarm. # # # # [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html # # @option params [Integer] :severity # A non-negative integer that reflects the severity level of the alarm. # # @option params [required, Types::AlarmRule] :alarm_rule # Defines when your alarm is invoked. # # @option params [Types::AlarmNotification] :alarm_notification # Contains information about one or more notification actions. # # @option params [Types::AlarmEventActions] :alarm_event_actions # Contains information about one or more alarm actions. # # @option params [Types::AlarmCapabilities] :alarm_capabilities # Contains the configuration information of alarm state changes. # # @return [Types::CreateAlarmModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateAlarmModelResponse#creation_time #creation_time} => Time # * {Types::CreateAlarmModelResponse#alarm_model_arn #alarm_model_arn} => String # * {Types::CreateAlarmModelResponse#alarm_model_version #alarm_model_version} => String # * {Types::CreateAlarmModelResponse#last_update_time #last_update_time} => Time # * {Types::CreateAlarmModelResponse#status #status} => String # # @example 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 # }, # }, # }) # # @example 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" # # @overload create_alarm_model(params = {}) # @param [Hash] params ({}) def create_alarm_model(params = {}, options = {}) req = build_request(:create_alarm_model, params) req.send_request(options) end # Creates a detector model. # # @option params [required, String] :detector_model_name # The name of the detector model. # # @option params [required, Types::DetectorModelDefinition] :detector_model_definition # Information that defines how the detectors operate. # # @option params [String] :detector_model_description # A brief description of the detector model. # # @option params [String] :key # 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. # # @option params [required, String] :role_arn # The ARN of the role that grants permission to AWS IoT Events to # perform its operations. # # @option params [Array] :tags # Metadata that can be used to manage the detector model. # # @option params [String] :evaluation_method # Information about the order in which events are evaluated and how # actions are executed. # # @return [Types::CreateDetectorModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDetectorModelResponse#detector_model_configuration #detector_model_configuration} => Types::DetectorModelConfiguration # # @example 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 # }) # # @example 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" # # @overload create_detector_model(params = {}) # @param [Hash] params ({}) def create_detector_model(params = {}, options = {}) req = build_request(:create_detector_model, params) req.send_request(options) end # Creates an input. # # @option params [required, String] :input_name # The name you want to give to the input. # # @option params [String] :input_description # A brief description of the input. # # @option params [required, Types::InputDefinition] :input_definition # The definition of the input. # # @option params [Array] :tags # Metadata that can be used to manage the input. # # @return [Types::CreateInputResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateInputResponse#input_configuration #input_configuration} => Types::InputConfiguration # # @example 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 # }, # ], # }) # # @example 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" # # @overload create_input(params = {}) # @param [Hash] params ({}) def create_input(params = {}, options = {}) req = build_request(:create_input, params) req.send_request(options) end # Deletes an alarm model. Any alarm instances that were created based on # this alarm model are also deleted. This action can't be undone. # # @option params [required, String] :alarm_model_name # The name of the alarm model. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_alarm_model({ # alarm_model_name: "AlarmModelName", # required # }) # # @overload delete_alarm_model(params = {}) # @param [Hash] params ({}) def delete_alarm_model(params = {}, options = {}) req = build_request(:delete_alarm_model, params) req.send_request(options) end # Deletes a detector model. Any active instances of the detector model # are also deleted. # # @option params [required, String] :detector_model_name # The name of the detector model to be deleted. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_detector_model({ # detector_model_name: "DetectorModelName", # required # }) # # @overload delete_detector_model(params = {}) # @param [Hash] params ({}) def delete_detector_model(params = {}, options = {}) req = build_request(:delete_detector_model, params) req.send_request(options) end # Deletes an input. # # @option params [required, String] :input_name # The name of the input to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_input({ # input_name: "InputName", # required # }) # # @overload delete_input(params = {}) # @param [Hash] params ({}) def delete_input(params = {}, options = {}) req = build_request(:delete_input, params) req.send_request(options) end # Retrieves information about an alarm model. If you don't specify a # value for the `alarmModelVersion` parameter, the latest version is # returned. # # @option params [required, String] :alarm_model_name # The name of the alarm model. # # @option params [String] :alarm_model_version # The version of the alarm model. # # @return [Types::DescribeAlarmModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeAlarmModelResponse#creation_time #creation_time} => Time # * {Types::DescribeAlarmModelResponse#alarm_model_arn #alarm_model_arn} => String # * {Types::DescribeAlarmModelResponse#alarm_model_version #alarm_model_version} => String # * {Types::DescribeAlarmModelResponse#last_update_time #last_update_time} => Time # * {Types::DescribeAlarmModelResponse#status #status} => String # * {Types::DescribeAlarmModelResponse#status_message #status_message} => String # * {Types::DescribeAlarmModelResponse#alarm_model_name #alarm_model_name} => String # * {Types::DescribeAlarmModelResponse#alarm_model_description #alarm_model_description} => String # * {Types::DescribeAlarmModelResponse#role_arn #role_arn} => String # * {Types::DescribeAlarmModelResponse#key #key} => String # * {Types::DescribeAlarmModelResponse#severity #severity} => Integer # * {Types::DescribeAlarmModelResponse#alarm_rule #alarm_rule} => Types::AlarmRule # * {Types::DescribeAlarmModelResponse#alarm_notification #alarm_notification} => Types::AlarmNotification # * {Types::DescribeAlarmModelResponse#alarm_event_actions #alarm_event_actions} => Types::AlarmEventActions # * {Types::DescribeAlarmModelResponse#alarm_capabilities #alarm_capabilities} => Types::AlarmCapabilities # # @example Request syntax with placeholder values # # resp = client.describe_alarm_model({ # alarm_model_name: "AlarmModelName", # required # alarm_model_version: "AlarmModelVersion", # }) # # @example 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 # # @overload describe_alarm_model(params = {}) # @param [Hash] params ({}) def describe_alarm_model(params = {}, options = {}) req = build_request(:describe_alarm_model, params) req.send_request(options) end # Describes a detector model. If the `version` parameter is not # specified, information about the latest version is returned. # # @option params [required, String] :detector_model_name # The name of the detector model. # # @option params [String] :detector_model_version # The version of the detector model. # # @return [Types::DescribeDetectorModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDetectorModelResponse#detector_model #detector_model} => Types::DetectorModel # # @example Request syntax with placeholder values # # resp = client.describe_detector_model({ # detector_model_name: "DetectorModelName", # required # detector_model_version: "DetectorModelVersion", # }) # # @example 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" # # @overload describe_detector_model(params = {}) # @param [Hash] params ({}) def describe_detector_model(params = {}, options = {}) req = build_request(:describe_detector_model, params) req.send_request(options) end # 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. # # # # @option params [required, String] :analysis_id # The ID of the analysis result that you want to retrieve. # # @return [Types::DescribeDetectorModelAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDetectorModelAnalysisResponse#status #status} => String # # @example Request syntax with placeholder values # # resp = client.describe_detector_model_analysis({ # analysis_id: "AnalysisId", # required # }) # # @example Response structure # # resp.status #=> String, one of "RUNNING", "COMPLETE", "FAILED" # # @overload describe_detector_model_analysis(params = {}) # @param [Hash] params ({}) def describe_detector_model_analysis(params = {}, options = {}) req = build_request(:describe_detector_model_analysis, params) req.send_request(options) end # Describes an input. # # @option params [required, String] :input_name # The name of the input. # # @return [Types::DescribeInputResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeInputResponse#input #input} => Types::Input # # @example Request syntax with placeholder values # # resp = client.describe_input({ # input_name: "InputName", # required # }) # # @example 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 # # @overload describe_input(params = {}) # @param [Hash] params ({}) def describe_input(params = {}, options = {}) req = build_request(:describe_input, params) req.send_request(options) end # Retrieves the current settings of the AWS IoT Events logging options. # # @return [Types::DescribeLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeLoggingOptionsResponse#logging_options #logging_options} => Types::LoggingOptions # # @example 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 # # @overload describe_logging_options(params = {}) # @param [Hash] params ({}) def describe_logging_options(params = {}, options = {}) req = build_request(:describe_logging_options, params) req.send_request(options) end # 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. # # # # @option params [required, String] :analysis_id # The ID of the analysis result that you want to retrieve. # # @option params [String] :next_token # The token that you can use to return the next set of results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::GetDetectorModelAnalysisResultsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDetectorModelAnalysisResultsResponse#analysis_results #analysis_results} => Array<Types::AnalysisResult> # * {Types::GetDetectorModelAnalysisResultsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.get_detector_model_analysis_results({ # analysis_id: "AnalysisId", # required # next_token: "NextToken", # max_results: 1, # }) # # @example 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 # # @overload get_detector_model_analysis_results(params = {}) # @param [Hash] params ({}) def get_detector_model_analysis_results(params = {}, options = {}) req = build_request(:get_detector_model_analysis_results, params) req.send_request(options) end # Lists all the versions of an alarm model. The operation returns only # the metadata associated with each alarm model version. # # @option params [required, String] :alarm_model_name # The name of the alarm model. # # @option params [String] :next_token # The token that you can use to return the next set of results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListAlarmModelVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListAlarmModelVersionsResponse#alarm_model_version_summaries #alarm_model_version_summaries} => Array<Types::AlarmModelVersionSummary> # * {Types::ListAlarmModelVersionsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_alarm_model_versions({ # alarm_model_name: "AlarmModelName", # required # next_token: "NextToken", # max_results: 1, # }) # # @example 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 # # @overload list_alarm_model_versions(params = {}) # @param [Hash] params ({}) def list_alarm_model_versions(params = {}, options = {}) req = build_request(:list_alarm_model_versions, params) req.send_request(options) end # Lists the alarm models that you created. The operation returns only # the metadata associated with each alarm model. # # @option params [String] :next_token # The token that you can use to return the next set of results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListAlarmModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListAlarmModelsResponse#alarm_model_summaries #alarm_model_summaries} => Array<Types::AlarmModelSummary> # * {Types::ListAlarmModelsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_alarm_models({ # next_token: "NextToken", # max_results: 1, # }) # # @example 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 # # @overload list_alarm_models(params = {}) # @param [Hash] params ({}) def list_alarm_models(params = {}, options = {}) req = build_request(:list_alarm_models, params) req.send_request(options) end # Lists all the versions of a detector model. Only the metadata # associated with each detector model version is returned. # # @option params [required, String] :detector_model_name # The name of the detector model whose versions are returned. # # @option params [String] :next_token # The token that you can use to return the next set of results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListDetectorModelVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDetectorModelVersionsResponse#detector_model_version_summaries #detector_model_version_summaries} => Array<Types::DetectorModelVersionSummary> # * {Types::ListDetectorModelVersionsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_detector_model_versions({ # detector_model_name: "DetectorModelName", # required # next_token: "NextToken", # max_results: 1, # }) # # @example 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 # # @overload list_detector_model_versions(params = {}) # @param [Hash] params ({}) def list_detector_model_versions(params = {}, options = {}) req = build_request(:list_detector_model_versions, params) req.send_request(options) end # Lists the detector models you have created. Only the metadata # associated with each detector model is returned. # # @option params [String] :next_token # The token that you can use to return the next set of results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListDetectorModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDetectorModelsResponse#detector_model_summaries #detector_model_summaries} => Array<Types::DetectorModelSummary> # * {Types::ListDetectorModelsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_detector_models({ # next_token: "NextToken", # max_results: 1, # }) # # @example 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 # # @overload list_detector_models(params = {}) # @param [Hash] params ({}) def list_detector_models(params = {}, options = {}) req = build_request(:list_detector_models, params) req.send_request(options) end # Lists one or more input routings. # # @option params [required, Types::InputIdentifier] :input_identifier # The identifer of the routed input. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @option params [String] :next_token # The token that you can use to return the next set of results. # # @return [Types::ListInputRoutingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListInputRoutingsResponse#routed_resources #routed_resources} => Array<Types::RoutedResource> # * {Types::ListInputRoutingsResponse#next_token #next_token} => String # # @example 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", # }) # # @example Response structure # # resp.routed_resources #=> Array # resp.routed_resources[0].name #=> String # resp.routed_resources[0].arn #=> String # resp.next_token #=> String # # @overload list_input_routings(params = {}) # @param [Hash] params ({}) def list_input_routings(params = {}, options = {}) req = build_request(:list_input_routings, params) req.send_request(options) end # Lists the inputs you have created. # # @option params [String] :next_token # The token that you can use to return the next set of results. # # @option params [Integer] :max_results # The maximum number of results to be returned per request. # # @return [Types::ListInputsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListInputsResponse#input_summaries #input_summaries} => Array<Types::InputSummary> # * {Types::ListInputsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_inputs({ # next_token: "NextToken", # max_results: 1, # }) # # @example 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 # # @overload list_inputs(params = {}) # @param [Hash] params ({}) def list_inputs(params = {}, options = {}) req = build_request(:list_inputs, params) req.send_request(options) end # Lists the tags (metadata) you have assigned to the resource. # # @option params [required, String] :resource_arn # The ARN of the resource. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag> # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ # resource_arn: "AmazonResourceName", # required # }) # # @example Response structure # # resp.tags #=> Array # resp.tags[0].key #=> String # resp.tags[0].value #=> String # # @overload list_tags_for_resource(params = {}) # @param [Hash] params ({}) def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end # 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. # # @option params [required, Types::LoggingOptions] :logging_options # The new values of the AWS IoT Events logging options. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example 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", # }, # ], # }, # }) # # @overload put_logging_options(params = {}) # @param [Hash] params ({}) def put_logging_options(params = {}, options = {}) req = build_request(:put_logging_options, params) req.send_request(options) end # Performs an analysis of your detector model. For more information, see # [Troubleshooting a detector model][1] in the *AWS IoT Events Developer # Guide*. # # # # [1]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html # # @option params [required, Types::DetectorModelDefinition] :detector_model_definition # Information that defines how a detector operates. # # @return [Types::StartDetectorModelAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::StartDetectorModelAnalysisResponse#analysis_id #analysis_id} => String # # @example 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 # }, # }) # # @example Response structure # # resp.analysis_id #=> String # # @overload start_detector_model_analysis(params = {}) # @param [Hash] params ({}) def start_detector_model_analysis(params = {}, options = {}) req = build_request(:start_detector_model_analysis, params) req.send_request(options) end # Adds to or modifies the tags of the given resource. Tags are metadata # that can be used to manage a resource. # # @option params [required, String] :resource_arn # The ARN of the resource. # # @option params [required, Array] :tags # The new or modified tags for the resource. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.tag_resource({ # resource_arn: "AmazonResourceName", # required # tags: [ # required # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @overload tag_resource(params = {}) # @param [Hash] params ({}) def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end # Removes the given tags (metadata) from the resource. # # @option params [required, String] :resource_arn # The ARN of the resource. # # @option params [required, Array] :tag_keys # A list of the keys of the tags to be removed from the resource. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.untag_resource({ # resource_arn: "AmazonResourceName", # required # tag_keys: ["TagKey"], # required # }) # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end # Updates an alarm model. Any alarms that were created based on the # previous version are deleted and then created again as new data # arrives. # # @option params [required, String] :alarm_model_name # The name of the alarm model. # # @option params [String] :alarm_model_description # The description of the alarm model. # # @option params [required, String] :role_arn # 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)][1] in the *AWS General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # # @option params [Integer] :severity # A non-negative integer that reflects the severity level of the alarm. # # @option params [required, Types::AlarmRule] :alarm_rule # Defines when your alarm is invoked. # # @option params [Types::AlarmNotification] :alarm_notification # Contains information about one or more notification actions. # # @option params [Types::AlarmEventActions] :alarm_event_actions # Contains information about one or more alarm actions. # # @option params [Types::AlarmCapabilities] :alarm_capabilities # Contains the configuration information of alarm state changes. # # @return [Types::UpdateAlarmModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateAlarmModelResponse#creation_time #creation_time} => Time # * {Types::UpdateAlarmModelResponse#alarm_model_arn #alarm_model_arn} => String # * {Types::UpdateAlarmModelResponse#alarm_model_version #alarm_model_version} => String # * {Types::UpdateAlarmModelResponse#last_update_time #last_update_time} => Time # * {Types::UpdateAlarmModelResponse#status #status} => String # # @example 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 # }, # }, # }) # # @example 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" # # @overload update_alarm_model(params = {}) # @param [Hash] params ({}) def update_alarm_model(params = {}, options = {}) req = build_request(:update_alarm_model, params) req.send_request(options) end # Updates a detector model. Detectors (instances) spawned by the # previous version are deleted and then re-created as new inputs arrive. # # @option params [required, String] :detector_model_name # The name of the detector model that is updated. # # @option params [required, Types::DetectorModelDefinition] :detector_model_definition # Information that defines how a detector operates. # # @option params [String] :detector_model_description # A brief description of the detector model. # # @option params [required, String] :role_arn # The ARN of the role that grants permission to AWS IoT Events to # perform its operations. # # @option params [String] :evaluation_method # Information about the order in which events are evaluated and how # actions are executed. # # @return [Types::UpdateDetectorModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDetectorModelResponse#detector_model_configuration #detector_model_configuration} => Types::DetectorModelConfiguration # # @example 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 # }) # # @example 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" # # @overload update_detector_model(params = {}) # @param [Hash] params ({}) def update_detector_model(params = {}, options = {}) req = build_request(:update_detector_model, params) req.send_request(options) end # Updates an input. # # @option params [required, String] :input_name # The name of the input you want to update. # # @option params [String] :input_description # A brief description of the input. # # @option params [required, Types::InputDefinition] :input_definition # The definition of the input. # # @return [Types::UpdateInputResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateInputResponse#input_configuration #input_configuration} => Types::InputConfiguration # # @example 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 # }, # ], # }, # }) # # @example 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" # # @overload update_input(params = {}) # @param [Hash] params ({}) def update_input(params = {}, options = {}) req = build_request(:update_input, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::IoTEvents') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-iotevents' context[:gem_version] = '1.60.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end