Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/IoTAnalytics/Client.html below:

Client — AWS SDK for Ruby V2

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

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

iotanalytics = Aws::IoTAnalytics::Client.new(
  region: region_name,
  credentials: credentials,
  )

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

You can configure a default region in the following locations:

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

Go here for a list of supported regions.

Default credentials are loaded automatically from the following locations:

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

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

• Credentials
• SharedCredentials
• Aws::InstanceProfileCredentials
• AssumeRoleCredentials

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

creds = YAML.load(File.read('/path/to/secrets'))

Aws::IoTAnalytics::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.

#config, #handlers

• #initialize(options = {}) ⇒ Aws::IoTAnalytics::Client constructor

  Constructs an API client.

• #batch_put_message(options = {}) ⇒ Types::BatchPutMessageResponse

  Sends messages to a channel.

  .

• #cancel_pipeline_reprocessing(options = {}) ⇒ Struct

  Cancels the reprocessing of data through the pipeline.

  .

• #create_channel(options = {}) ⇒ Types::CreateChannelResponse
• #create_dataset(options = {}) ⇒ Types::CreateDatasetResponse
• #create_dataset_content(options = {}) ⇒ Types::CreateDatasetContentResponse

  Creates the content of a data set by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).

  .

• #create_datastore(options = {}) ⇒ Types::CreateDatastoreResponse

  Creates a data store, which is a repository for messages.

  .

• #create_pipeline(options = {}) ⇒ Types::CreatePipelineResponse
• #delete_channel(options = {}) ⇒ Struct

  Deletes the specified channel.

  .

• #delete_dataset(options = {}) ⇒ Struct

  Deletes the specified dataset.

  You do not have to delete the content of the dataset before you perform this operation.

  .

• #delete_dataset_content(options = {}) ⇒ Struct

  Deletes the content of the specified dataset.

  .

• #delete_datastore(options = {}) ⇒ Struct

  Deletes the specified data store.

  .

• #delete_pipeline(options = {}) ⇒ Struct

  Deletes the specified pipeline.

  .

• #describe_channel(options = {}) ⇒ Types::DescribeChannelResponse

  Retrieves information about a channel.

  .

• #describe_dataset(options = {}) ⇒ Types::DescribeDatasetResponse

  Retrieves information about a dataset.

  .

• #describe_datastore(options = {}) ⇒ Types::DescribeDatastoreResponse

  Retrieves information about a data store.

  .

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

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

  .

• #describe_pipeline(options = {}) ⇒ Types::DescribePipelineResponse

  Retrieves information about a pipeline.

  .

• #get_dataset_content(options = {}) ⇒ Types::GetDatasetContentResponse

  Retrieves the contents of a data set as presigned URIs.

  .

• #list_channels(options = {}) ⇒ Types::ListChannelsResponse

  Retrieves a list of channels.

  .

• #list_dataset_contents(options = {}) ⇒ Types::ListDatasetContentsResponse

  Lists information about data set contents that have been created.

  .

• #list_datasets(options = {}) ⇒ Types::ListDatasetsResponse

  Retrieves information about data sets.

  .

• #list_datastores(options = {}) ⇒ Types::ListDatastoresResponse

  Retrieves a list of data stores.

  .

• #list_pipelines(options = {}) ⇒ Types::ListPipelinesResponse

  Retrieves a list of pipelines.

  .

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

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

  .

• #put_logging_options(options = {}) ⇒ Struct

  Sets or updates the AWS IoT Analytics logging options.

  If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect.

• #run_pipeline_activity(options = {}) ⇒ Types::RunPipelineActivityResponse

  Simulates the results of running a pipeline activity on a message payload.

  .

• #sample_channel_data(options = {}) ⇒ Types::SampleChannelDataResponse

  Retrieves a sample of messages from the specified channel ingested during the specified timeframe.

• #start_pipeline_reprocessing(options = {}) ⇒ Types::StartPipelineReprocessingResponse

  Starts the reprocessing of raw message data through the pipeline.

  .

• #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_channel(options = {}) ⇒ Struct

  Updates the settings of a channel.

  .

• #update_dataset(options = {}) ⇒ Struct

  Updates the settings of a data set.

  .

• #update_datastore(options = {}) ⇒ Struct

  Updates the settings of a data store.

  .

• #update_pipeline(options = {}) ⇒ Struct

  Updates the settings of a pipeline.

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

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

#handle, #handle_request, #handle_response

Cancels the reprocessing of data through the pipeline.

Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.

Creates a dataset. A dataset stores data retrieved from a data store by applying a queryAction (a SQL query) or a containerAction (executing a containerized application). This operation creates the skeleton of a dataset. The dataset can be populated manually by calling CreateDatasetContent or automatically according to a trigger you specify.

Creates the content of a data set by applying a queryAction (a SQL query) or a containerAction (executing a containerized application).

Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

Deletes the specified channel.

Deletes the specified dataset.

You do not have to delete the content of the dataset before you perform this operation.

Deletes the content of the specified dataset.

Deletes the specified data store.

Deletes the specified pipeline.

Sets or updates the AWS IoT Analytics 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.

Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.

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

Removes the given tags (metadata) from the resource.

Updates the settings of a channel.

Updates the settings of a data set.

Updates the settings of a data store.

Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

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

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)

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

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

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

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

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4