class Aws::IoTAnalytics::Client

See {#initialize} for a full list of supported configuration options.
the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
For details on configuring region and credentials see
)
# …
credentials: credentials,
region: region_name,
client = Aws::IoTAnalytics::Client.new(
An API client for IoTAnalytics. To construct a client, you need to configure a ‘:region` and `:credentials`.

def batch_put_message(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • batch_put_message(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::BatchPutMessageResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :messages (required, Array) --
  • :channel_name (required, String) --
def batch_put_message(params = {}, options = {})
  req = build_request(:batch_put_message, params)
  req.send_request(options)
end

def build_request(operation_name, params = {})

Other tags:
    Api: - private

Parameters:
  • params ({}) --
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::IoTAnalytics')
  )
  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-iotanalytics'
  context[:gem_version] = '1.80.0'
  Seahorse::Client::Request.new(handlers, context)
end

def cancel_pipeline_reprocessing(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • cancel_pipeline_reprocessing(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :reprocessing_id (required, String) --
  • :pipeline_name (required, String) --
def cancel_pipeline_reprocessing(params = {}, options = {})
  req = build_request(:cancel_pipeline_reprocessing, params)
  req.send_request(options)
end

def create_channel(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_channel(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreateChannelResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :tags (Array) --
  • :retention_period (Types::RetentionPeriod) --
  • :channel_storage (Types::ChannelStorage) --
  • :channel_name (required, String) --
def create_channel(params = {}, options = {})
  req = build_request(:create_channel, params)
  req.send_request(options)
end

def create_dataset(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_dataset(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreateDatasetResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :late_data_rules (Array) --
  • :tags (Array) --
  • :versioning_configuration (Types::VersioningConfiguration) --
  • :retention_period (Types::RetentionPeriod) --
  • :content_delivery_rules (Array) --
  • :triggers (Array) --
  • :actions (required, Array) --
  • :dataset_name (required, String) --
def create_dataset(params = {}, options = {})
  req = build_request(:create_dataset, params)
  req.send_request(options)
end

def create_dataset_content(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_dataset_content(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreateDatasetContentResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :version_id (String) --
  • :dataset_name (required, String) --
def create_dataset_content(params = {}, options = {})
  req = build_request(:create_dataset_content, params)
  req.send_request(options)
end

def create_datastore(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_datastore(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreateDatastoreResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :datastore_partitions (Types::DatastorePartitions) --
  • :file_format_configuration (Types::FileFormatConfiguration) --
  • :tags (Array) --
  • :retention_period (Types::RetentionPeriod) --
  • :datastore_storage (Types::DatastoreStorage) --
  • :datastore_name (required, String) --
def create_datastore(params = {}, options = {})
  req = build_request(:create_datastore, params)
  req.send_request(options)
end

def create_pipeline(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_pipeline(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreatePipelineResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :tags (Array) --
  • :pipeline_activities (required, Array) --
  • :pipeline_name (required, String) --
def create_pipeline(params = {}, options = {})
  req = build_request(:create_pipeline, params)
  req.send_request(options)
end

def delete_channel(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_channel(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :channel_name (required, String) --
def delete_channel(params = {}, options = {})
  req = build_request(:delete_channel, params)
  req.send_request(options)
end

def delete_dataset(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_dataset(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :dataset_name (required, String) --
def delete_dataset(params = {}, options = {})
  req = build_request(:delete_dataset, params)
  req.send_request(options)
end

def delete_dataset_content(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_dataset_content(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :version_id (String) --
  • :dataset_name (required, String) --
def delete_dataset_content(params = {}, options = {})
  req = build_request(:delete_dataset_content, params)
  req.send_request(options)
end

def delete_datastore(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_datastore(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :datastore_name (required, String) --
def delete_datastore(params = {}, options = {})
  req = build_request(:delete_datastore, params)
  req.send_request(options)
end

def delete_pipeline(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_pipeline(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :pipeline_name (required, String) --
def delete_pipeline(params = {}, options = {})
  req = build_request(:delete_pipeline, params)
  req.send_request(options)
end

def describe_channel(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_channel(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeChannelResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :include_statistics (Boolean) --
  • :channel_name (required, String) --
def describe_channel(params = {}, options = {})
  req = build_request(:describe_channel, params)
  req.send_request(options)
end

def describe_dataset(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_dataset(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeDatasetResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :dataset_name (required, String) --
def describe_dataset(params = {}, options = {})
  req = build_request(:describe_dataset, params)
  req.send_request(options)
end

def describe_datastore(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_datastore(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeDatastoreResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :include_statistics (Boolean) --
  • :datastore_name (required, String) --
def describe_datastore(params = {}, options = {})
  req = build_request(:describe_datastore, params)
  req.send_request(options)
end

def describe_logging_options(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_logging_options(params = {})

Other tags:
    Example: Response structure -

Returns:
  • (Types::DescribeLoggingOptionsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:
def describe_logging_options(params = {}, options = {})
  req = build_request(:describe_logging_options, params)
  req.send_request(options)
end

def describe_pipeline(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_pipeline(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribePipelineResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :pipeline_name (required, String) --
def describe_pipeline(params = {}, options = {})
  req = build_request(:describe_pipeline, params)
  req.send_request(options)
end

def errors_module

Other tags:
    Api: - private
def errors_module
  Errors
end

def get_dataset_content(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_dataset_content(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::GetDatasetContentResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :version_id (String) --
  • :dataset_name (required, String) --
def get_dataset_content(params = {}, options = {})
  req = build_request(:get_dataset_content, params)
  req.send_request(options)
end

def initialize(*args)

Options Hash: (**options)
  • :ssl_verify_peer (Boolean) --
  • :ssl_timeout (Float) --
  • :ssl_key (OpenSSL::PKey) --
  • :ssl_cert (OpenSSL::X509::Certificate) --
  • :ssl_ca_store (String) --
  • :ssl_ca_directory (String) --
  • :ssl_ca_bundle (String) --
  • :raise_response_errors (Boolean) --
  • :on_chunk_sent (Proc) --
  • :on_chunk_received (Proc) --
  • :http_wire_trace (Boolean) --
  • :http_read_timeout (Float) --
  • :http_proxy (URI::HTTP, String) --
  • :http_open_timeout (Float) --
  • :http_idle_timeout (Float) --
  • :http_continue_timeout (Float) --
  • :endpoint_provider (Aws::IoTAnalytics::EndpointProvider) --
  • :validate_params (Boolean) --
  • :use_fips_endpoint (Boolean) --
  • :use_dualstack_endpoint (Boolean) --
  • :token_provider (Aws::TokenProvider) --
  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) --
  • :stub_responses (Boolean) --
  • :sigv4a_signing_region_set (Array) --
  • :session_token (String) --
  • :secret_access_key (String) --
  • :sdk_ua_app_id (String) --
  • :retry_mode (String) --
  • :retry_max_delay (Integer) --
  • :retry_limit (Integer) --
  • :retry_jitter (Symbol) --
  • :retry_base_delay (Float) --
  • :retry_backoff (Proc) --
  • :response_checksum_validation (String) --
  • :request_min_compression_size_bytes (Integer) --
  • :request_checksum_calculation (String) --
  • :profile (String) --
  • :max_attempts (Integer) --
  • :logger (Logger) --
  • :log_level (Symbol) --
  • :log_formatter (Aws::Log::Formatter) --
  • :ignore_configured_endpoint_urls (Boolean) --
  • :endpoint_discovery (Boolean) --
  • :endpoint_cache_poll_interval (Integer) --
  • :endpoint_cache_max_threads (Integer) --
  • :endpoint_cache_max_entries (Integer) --
  • :endpoint (String, URI::HTTPS, URI::HTTP) --
  • :disable_request_compression (Boolean) --
  • :disable_host_prefix_injection (Boolean) --
  • :defaults_mode (String) --
  • :correct_clock_skew (Boolean) --
  • :convert_params (Boolean) --
  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) --
  • :client_side_monitoring_port (Integer) --
  • :client_side_monitoring_host (String) --
  • :client_side_monitoring_client_id (String) --
  • :client_side_monitoring (Boolean) --
  • :adaptive_retry_wait_to_fill (Boolean) --
  • :active_endpoint_cache (Boolean) --
  • :account_id (String) --
  • :access_key_id (String) --
  • :region (required, String) --
  • :credentials (required, Aws::CredentialProvider) --
  • :plugins (Array) --

Other tags:
    See: https://www.awsarchitectureblog.com/2015/03/backoff.html -

Parameters:
  • options (Hash) --

Overloads:
  • initialize(options)
def initialize(*args)
  super
end

def list_channels(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_channels(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListChannelsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :max_results (Integer) --
  • :next_token (String) --
def list_channels(params = {}, options = {})
  req = build_request(:list_channels, params)
  req.send_request(options)
end

def list_dataset_contents(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_dataset_contents(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListDatasetContentsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :scheduled_before (Time, DateTime, Date, Integer, String) --
  • :scheduled_on_or_after (Time, DateTime, Date, Integer, String) --
  • :max_results (Integer) --
  • :next_token (String) --
  • :dataset_name (required, String) --
def list_dataset_contents(params = {}, options = {})
  req = build_request(:list_dataset_contents, params)
  req.send_request(options)
end

def list_datasets(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_datasets(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListDatasetsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :max_results (Integer) --
  • :next_token (String) --
def list_datasets(params = {}, options = {})
  req = build_request(:list_datasets, params)
  req.send_request(options)
end

def list_datastores(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_datastores(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListDatastoresResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :max_results (Integer) --
  • :next_token (String) --
def list_datastores(params = {}, options = {})
  req = build_request(:list_datastores, params)
  req.send_request(options)
end

def list_pipelines(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_pipelines(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListPipelinesResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :max_results (Integer) --
  • :next_token (String) --
def list_pipelines(params = {}, options = {})
  req = build_request(:list_pipelines, params)
  req.send_request(options)
end

def list_tags_for_resource(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_tags_for_resource(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListTagsForResourceResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :resource_arn (required, String) --
def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

def put_logging_options(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • put_logging_options(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :logging_options (required, Types::LoggingOptions) --
def put_logging_options(params = {}, options = {})
  req = build_request(:put_logging_options, params)
  req.send_request(options)
end

def run_pipeline_activity(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • run_pipeline_activity(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::RunPipelineActivityResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :payloads (required, Array) --
  • :pipeline_activity (required, Types::PipelineActivity) --
def run_pipeline_activity(params = {}, options = {})
  req = build_request(:run_pipeline_activity, params)
  req.send_request(options)
end

def sample_channel_data(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • sample_channel_data(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::SampleChannelDataResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :end_time (Time, DateTime, Date, Integer, String) --
  • :start_time (Time, DateTime, Date, Integer, String) --
  • :max_messages (Integer) --
  • :channel_name (required, String) --
def sample_channel_data(params = {}, options = {})
  req = build_request(:sample_channel_data, params)
  req.send_request(options)
end

def start_pipeline_reprocessing(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • start_pipeline_reprocessing(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::StartPipelineReprocessingResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :channel_messages (Types::ChannelMessages) --
  • :end_time (Time, DateTime, Date, Integer, String) --
  • :start_time (Time, DateTime, Date, Integer, String) --
  • :pipeline_name (required, String) --
def start_pipeline_reprocessing(params = {}, options = {})
  req = build_request(:start_pipeline_reprocessing, params)
  req.send_request(options)
end

def tag_resource(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • tag_resource(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :tags (required, Array) --
  • :resource_arn (required, String) --
def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

def untag_resource(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • untag_resource(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :tag_keys (required, Array) --
  • :resource_arn (required, String) --
def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

def update_channel(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_channel(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :retention_period (Types::RetentionPeriod) --
  • :channel_storage (Types::ChannelStorage) --
  • :channel_name (required, String) --
def update_channel(params = {}, options = {})
  req = build_request(:update_channel, params)
  req.send_request(options)
end

def update_dataset(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_dataset(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :late_data_rules (Array) --
  • :versioning_configuration (Types::VersioningConfiguration) --
  • :retention_period (Types::RetentionPeriod) --
  • :content_delivery_rules (Array) --
  • :triggers (Array) --
  • :actions (required, Array) --
  • :dataset_name (required, String) --
def update_dataset(params = {}, options = {})
  req = build_request(:update_dataset, params)
  req.send_request(options)
end

def update_datastore(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_datastore(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :file_format_configuration (Types::FileFormatConfiguration) --
  • :datastore_storage (Types::DatastoreStorage) --
  • :retention_period (Types::RetentionPeriod) --
  • :datastore_name (required, String) --
def update_datastore(params = {}, options = {})
  req = build_request(:update_datastore, params)
  req.send_request(options)
end

def update_pipeline(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_pipeline(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :pipeline_activities (required, Array) --
  • :pipeline_name (required, String) --
def update_pipeline(params = {}, options = {})
  req = build_request(:update_pipeline, params)
  req.send_request(options)
end

def waiter_names

Deprecated:

Other tags:
    Api: - private
def waiter_names
  []
end