You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoTEvents::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoTEvents::Client
- Defined in:
- (unknown)
Overview
An API client for AWS IoT Events. To construct a client, you need to configure a :region
and :credentials
.
iotevents = Aws::IoTEvents::Client.new(
region: region_name,
credentials: credentials,
# ...
)
See #initialize for a full list of supported configuration options.
Region
You can configure a default region in the following locations:
ENV['AWS_REGION']
Aws.config[:region]
Go here for a list of supported regions.
Credentials
Default credentials are loaded automatically from the following locations:
ENV['AWS_ACCESS_KEY_ID']
andENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
- The shared credentials ini file at
~/.aws/credentials
(more information) - From an instance profile when running on EC2
You can also construct a credentials object from one of the following classes:
Alternatively, you configure credentials with :access_key_id
and
:secret_access_key
:
# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))
Aws::IoTEvents::Client.new(
access_key_id: creds['access_key_id'],
secret_access_key: creds['secret_access_key']
)
Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
Constructor collapse
-
#initialize(options = {}) ⇒ Aws::IoTEvents::Client
constructor
Constructs an API client.
API Operations collapse
-
#create_detector_model(options = {}) ⇒ Types::CreateDetectorModelResponse
Creates a detector model.
.
-
#create_input(options = {}) ⇒ Types::CreateInputResponse
Creates an input.
.
-
#delete_detector_model(options = {}) ⇒ Struct
Deletes a detector model.
-
#delete_input(options = {}) ⇒ Struct
Deletes an input.
.
-
#describe_detector_model(options = {}) ⇒ Types::DescribeDetectorModelResponse
Describes a detector model.
-
#describe_input(options = {}) ⇒ Types::DescribeInputResponse
Describes an input.
.
-
#describe_logging_options(options = {}) ⇒ Types::DescribeLoggingOptionsResponse
Retrieves the current settings of the AWS IoT Events logging options.
.
-
#list_detector_model_versions(options = {}) ⇒ Types::ListDetectorModelVersionsResponse
Lists all the versions of a detector model.
-
#list_detector_models(options = {}) ⇒ Types::ListDetectorModelsResponse
Lists the detector models you have created.
-
#list_inputs(options = {}) ⇒ Types::ListInputsResponse
Lists the inputs you have created.
.
-
#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) you have assigned to the resource.
.
-
#put_logging_options(options = {}) ⇒ Struct
Sets or updates the AWS IoT Events logging options.
If you update the value of any
"loggingOptions"
field, it takes up to one minute for the change to take effect. -
#tag_resource(options = {}) ⇒ Struct
Adds to or modifies the tags of the given resource.
-
#untag_resource(options = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.
.
-
#update_detector_model(options = {}) ⇒ Types::UpdateDetectorModelResponse
Updates a detector model.
-
#update_input(options = {}) ⇒ Types::UpdateInputResponse
Updates an input.
.
Instance Method Summary collapse
-
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
-
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.
Methods inherited from Seahorse::Client::Base
add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options = {}) ⇒ Aws::IoTEvents::Client
Constructs an API client.
Instance Method Details
#create_detector_model(options = {}) ⇒ Types::CreateDetectorModelResponse
Creates a detector model.
#create_input(options = {}) ⇒ Types::CreateInputResponse
Creates an input.
#delete_detector_model(options = {}) ⇒ Struct
Deletes a detector model. Any active instances of the detector model are also deleted.
#delete_input(options = {}) ⇒ Struct
Deletes an input.
#describe_detector_model(options = {}) ⇒ Types::DescribeDetectorModelResponse
Describes a detector model. If the "version"
parameter is not specified, information about the latest version is returned.
#describe_input(options = {}) ⇒ Types::DescribeInputResponse
Describes an input.
#describe_logging_options(options = {}) ⇒ Types::DescribeLoggingOptionsResponse
Retrieves the current settings of the AWS IoT Events logging options.
#list_detector_model_versions(options = {}) ⇒ Types::ListDetectorModelVersionsResponse
Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
#list_detector_models(options = {}) ⇒ Types::ListDetectorModelsResponse
Lists the detector models you have created. Only the metadata associated with each detector model is returned.
#list_inputs(options = {}) ⇒ Types::ListInputsResponse
Lists the inputs you have created.
#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags (metadata) you have assigned to the resource.
#put_logging_options(options = {}) ⇒ Struct
Sets or updates the AWS IoT Events logging options.
If you update the value of any "loggingOptions"
field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the "roleArn"
field (for example, to correct an invalid policy) it takes up to five minutes for that change to take effect.
#tag_resource(options = {}) ⇒ Struct
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
#untag_resource(options = {}) ⇒ Struct
Removes the given tags (metadata) from the resource.
#update_detector_model(options = {}) ⇒ Types::UpdateDetectorModelResponse
Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
#update_input(options = {}) ⇒ Types::UpdateInputResponse
Updates an input.
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
Basic Usage
Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:
# poll for ~25 seconds
client.wait_until(...) do |w|
w.max_attempts = 5
w.delay = 5
end
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(...) do |w|
# disable max attempts
w.max_attempts = nil
# poll for 1 hour, instead of a number of attempts
w.before_wait do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
end
Handling Errors
When a waiter is successful, it returns true
. When a waiter
fails, it raises an error. All errors raised extend from
Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:
Waiter Name | Client Method | Default Delay: | Default Max Attempts: |
---|