lib/aws-sdk-iotdataplane/client.rb in aws-sdk-iotdataplane-1.0.0.rc1 vs lib/aws-sdk-iotdataplane/client.rb in aws-sdk-iotdataplane-1.0.0.rc2

- old
+ new

@@ -1,8 +1,8 @@ # WARNING ABOUT GENERATED CODE # -# This file is generated. See the contributing for info on making contributions: +# This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' @@ -16,270 +16,306 @@ require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.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/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/signature_v4.rb' require 'aws-sdk-core/plugins/protocols/rest_json.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:iotdataplane) -module Aws - module IoTDataPlane - class Client < Seahorse::Client::Base +module Aws::IoTDataPlane + class Client < Seahorse::Client::Base - include Aws::ClientStubs + include Aws::ClientStubs - @identifier = :iotdataplane + @identifier = :iotdataplane - set_api(ClientApi::API) + 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::ResponsePaging) - add_plugin(Aws::Plugins::StubResponses) - add_plugin(Aws::Plugins::IdempotencyToken) - add_plugin(Aws::Plugins::SignatureV4) - add_plugin(Aws::Plugins::Protocols::RestJson) + 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::ResponsePaging) + add_plugin(Aws::Plugins::StubResponses) + add_plugin(Aws::Plugins::IdempotencyToken) + add_plugin(Aws::Plugins::JsonvalueConverter) + add_plugin(Aws::Plugins::SignatureV4) + add_plugin(Aws::Plugins::Protocols::RestJson) - # @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::InstanceProfileCredentials` - Used for loading credentials - # from an EC2 IMDS on an EC2 instance. - # - # * `Aws::SharedCredentials` - Used for loading credentials from a - # shared file, such as `~/.aws/config`. - # - # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. - # - # When `:credentials` are not configured directly, the following - # locations will be searched for credentials: - # - # * `Aws.config[:credentials]` - # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. - # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] - # * `~/.aws/credentials` - # * `~/.aws/config` - # * EC2 IMDS instance profile - When used by default, the timeouts are - # very aggressive. Construct and pass an instance of - # `Aws::InstanceProfileCredentails` to enable retries and extended - # timeouts. - # @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 search 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 [Boolean] :convert_params (true) - # When `true`, an attempt is made to coerce request parameters into - # the required types. - # @option options [String] :endpoint - # The client endpoint is normally constructed from the `:region` - # option. You should only configure an `:endpoint` when connecting - # to test endpoints. This should be avalid HTTP(S) URI. - # @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 [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] :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 and auth - # errors from expired credentials. - # @option options [String] :secret_access_key - # @option options [String] :session_token - # @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 [Boolean] :validate_params (true) - # When `true`, request parameters are validated before - # sending the request. - def initialize(*args) - super - end + # @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::InstanceProfileCredentials` - Used for loading credentials + # from an EC2 IMDS on an EC2 instance. + # + # * `Aws::SharedCredentials` - Used for loading credentials from a + # shared file, such as `~/.aws/config`. + # + # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. + # + # When `:credentials` are not configured directly, the following + # locations will be searched for credentials: + # + # * `Aws.config[:credentials]` + # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. + # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] + # * `~/.aws/credentials` + # * `~/.aws/config` + # * EC2 IMDS instance profile - When used by default, the timeouts are + # very aggressive. Construct and pass an instance of + # `Aws::InstanceProfileCredentails` to enable retries and extended + # timeouts. + # + # @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 search 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 [Boolean] :convert_params (true) + # When `true`, an attempt is made to coerce request parameters into + # the required types. + # + # @option options [String] :endpoint + # The client endpoint is normally constructed from the `:region` + # option. You should only configure an `:endpoint` when connecting + # to test endpoints. This should be avalid HTTP(S) URI. + # + # @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 [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] :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 and auth + # errors from expired credentials. + # + # @option options [String] :secret_access_key + # + # @option options [String] :session_token + # + # @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 [Boolean] :validate_params (true) + # When `true`, request parameters are validated before + # sending the request. + # + def initialize(*args) + super + end - # @!group API Operations + # @!group API Operations - # Deletes the thing shadow for the specified thing. - # - # For more information, see [DeleteThingShadow][1] in the *AWS IoT - # Developer Guide*. - # - # - # - # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html - # @option params [required, String] :thing_name - # The name of the thing. - # @return [Types::DeleteThingShadowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: - # - # * {Types::DeleteThingShadowResponse#payload #payload} => String - # - # @example Request syntax with placeholder values - # resp = client.delete_thing_shadow({ - # thing_name: "ThingName", # required - # }) - # - # @example Response structure - # resp.payload #=> String - # @overload delete_thing_shadow(params = {}) - # @param [Hash] params ({}) - def delete_thing_shadow(params = {}, options = {}) - req = build_request(:delete_thing_shadow, params) - req.send_request(options) - end + # Deletes the thing shadow for the specified thing. + # + # For more information, see [DeleteThingShadow][1] in the *AWS IoT + # Developer Guide*. + # + # + # + # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html + # + # @option params [required, String] :thing_name + # The name of the thing. + # + # @return [Types::DeleteThingShadowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::DeleteThingShadowResponse#payload #payload} => String + # + # @example Request syntax with placeholder values + # + # resp = client.delete_thing_shadow({ + # thing_name: "ThingName", # required + # }) + # + # @example Response structure + # + # resp.payload #=> String + # + # @overload delete_thing_shadow(params = {}) + # @param [Hash] params ({}) + def delete_thing_shadow(params = {}, options = {}) + req = build_request(:delete_thing_shadow, params) + req.send_request(options) + end - # Gets the thing shadow for the specified thing. - # - # For more information, see [GetThingShadow][1] in the *AWS IoT - # Developer Guide*. - # - # - # - # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html - # @option params [required, String] :thing_name - # The name of the thing. - # @return [Types::GetThingShadowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: - # - # * {Types::GetThingShadowResponse#payload #payload} => String - # - # @example Request syntax with placeholder values - # resp = client.get_thing_shadow({ - # thing_name: "ThingName", # required - # }) - # - # @example Response structure - # resp.payload #=> String - # @overload get_thing_shadow(params = {}) - # @param [Hash] params ({}) - def get_thing_shadow(params = {}, options = {}) - req = build_request(:get_thing_shadow, params) - req.send_request(options) - end + # Gets the thing shadow for the specified thing. + # + # For more information, see [GetThingShadow][1] in the *AWS IoT + # Developer Guide*. + # + # + # + # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html + # + # @option params [required, String] :thing_name + # The name of the thing. + # + # @return [Types::GetThingShadowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetThingShadowResponse#payload #payload} => String + # + # @example Request syntax with placeholder values + # + # resp = client.get_thing_shadow({ + # thing_name: "ThingName", # required + # }) + # + # @example Response structure + # + # resp.payload #=> String + # + # @overload get_thing_shadow(params = {}) + # @param [Hash] params ({}) + def get_thing_shadow(params = {}, options = {}) + req = build_request(:get_thing_shadow, params) + req.send_request(options) + end - # Publishes state information. - # - # For more information, see [HTTP Protocol][1] in the *AWS IoT Developer - # Guide*. - # - # - # - # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#http - # @option params [required, String] :topic - # The name of the MQTT topic. - # @option params [Integer] :qos - # The Quality of Service (QoS) level. - # @option params [String, IO] :payload - # The state information, in JSON format. - # @return [Struct] Returns an empty {Seahorse::Client::Response response}. - # - # @example Request syntax with placeholder values - # resp = client.publish({ - # topic: "Topic", # required - # qos: 1, - # payload: "data", - # }) - # @overload publish(params = {}) - # @param [Hash] params ({}) - def publish(params = {}, options = {}) - req = build_request(:publish, params) - req.send_request(options) - end + # Publishes state information. + # + # For more information, see [HTTP Protocol][1] in the *AWS IoT Developer + # Guide*. + # + # + # + # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#http + # + # @option params [required, String] :topic + # The name of the MQTT topic. + # + # @option params [Integer] :qos + # The Quality of Service (QoS) level. + # + # @option params [String, IO] :payload + # The state information, in JSON format. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.publish({ + # topic: "Topic", # required + # qos: 1, + # payload: "data", + # }) + # + # @overload publish(params = {}) + # @param [Hash] params ({}) + def publish(params = {}, options = {}) + req = build_request(:publish, params) + req.send_request(options) + end - # Updates the thing shadow for the specified thing. - # - # For more information, see [UpdateThingShadow][1] in the *AWS IoT - # Developer Guide*. - # - # - # - # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html - # @option params [required, String] :thing_name - # The name of the thing. - # @option params [required, String, IO] :payload - # The state information, in JSON format. - # @return [Types::UpdateThingShadowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: - # - # * {Types::UpdateThingShadowResponse#payload #payload} => String - # - # @example Request syntax with placeholder values - # resp = client.update_thing_shadow({ - # thing_name: "ThingName", # required - # payload: "data", # required - # }) - # - # @example Response structure - # resp.payload #=> String - # @overload update_thing_shadow(params = {}) - # @param [Hash] params ({}) - def update_thing_shadow(params = {}, options = {}) - req = build_request(:update_thing_shadow, params) - req.send_request(options) - end + # Updates the thing shadow for the specified thing. + # + # For more information, see [UpdateThingShadow][1] in the *AWS IoT + # Developer Guide*. + # + # + # + # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html + # + # @option params [required, String] :thing_name + # The name of the thing. + # + # @option params [required, String, IO] :payload + # The state information, in JSON format. + # + # @return [Types::UpdateThingShadowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::UpdateThingShadowResponse#payload #payload} => String + # + # @example Request syntax with placeholder values + # + # resp = client.update_thing_shadow({ + # thing_name: "ThingName", # required + # payload: "data", # required + # }) + # + # @example Response structure + # + # resp.payload #=> String + # + # @overload update_thing_shadow(params = {}) + # @param [Hash] params ({}) + def update_thing_shadow(params = {}, options = {}) + req = build_request(:update_thing_shadow, params) + req.send_request(options) + end - # @!endgroup + # @!endgroup - # @param params ({}) - # @api private - def build_request(operation_name, params = {}) - handlers = @handlers.for(operation_name) - context = Seahorse::Client::RequestContext.new( - operation_name: operation_name, - operation: config.api.operation(operation_name), - client: self, - params: params, - config: config) - context[:gem_name] = 'aws-sdk-iotdataplane' - context[:gem_version] = '1.0.0.rc1' - Seahorse::Client::Request.new(handlers, context) - end + # @param params ({}) + # @api private + def build_request(operation_name, params = {}) + handlers = @handlers.for(operation_name) + context = Seahorse::Client::RequestContext.new( + operation_name: operation_name, + operation: config.api.operation(operation_name), + client: self, + params: params, + config: config) + context[:gem_name] = 'aws-sdk-iotdataplane' + context[:gem_version] = '1.0.0.rc2' + Seahorse::Client::Request.new(handlers, context) + end - # @api private - # @deprecated - def waiter_names - [] - end + # @api private + # @deprecated + def waiter_names + [] + end - class << self + class << self - # @api private - attr_reader :identifier + # @api private + attr_reader :identifier - # @api private - def errors_module - Errors - end - + # @api private + def errors_module + Errors end + end end end