Class: Aws::IoT1ClickDevicesService::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-iot1clickdevicesservice/client.rb

Overview

An API client for IoT1ClickDevicesService. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::IoT1ClickDevicesService::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 Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    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`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.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::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    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:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: 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.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "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.

  • :client_side_monitoring_port (Integer) — default: 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.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String) —

    The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 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.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 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.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :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 www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 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.

  • :retry_max_delay (Integer) — default: 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.

  • :retry_mode (String) — default: "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.

  • :sdk_ua_app_id (String) —

    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.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: 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.

  • :token_provider (Aws::TokenProvider) —

    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.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    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`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::IoT1ClickDevicesService::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::IoT1ClickDevicesService::EndpointParameters`

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a ‘Timeout::Error`.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 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.

  • :http_continue_timeout (Float) — default: 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.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    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.

  • :ssl_ca_directory (String) —

    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.



385
386
387
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 385

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



853
854
855
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 853

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



856
857
858
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 856

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 831

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-iot1clickdevicesservice'
  context[:gem_version] = '1.48.0'
  Seahorse::Client::Request.new(handlers, context)
end

#claim_devices_by_claim_code(params = {}) ⇒ Types::ClaimDevicesByClaimCodeResponse

Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).

Examples:

Request syntax with placeholder values


resp = client.claim_devices_by_claim_code({
  claim_code: "__string", # required
})

Response structure


resp.claim_code #=> String
resp.total #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :claim_code (required, String)

Returns:

See Also:



416
417
418
419
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 416

def claim_devices_by_claim_code(params = {}, options = {})
  req = build_request(:claim_devices_by_claim_code, params)
  req.send_request(options)
end

#describe_device(params = {}) ⇒ Types::DescribeDeviceResponse

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

Examples:

Request syntax with placeholder values


resp = client.describe_device({
  device_id: "__string", # required
})

Response structure


resp.device_description.arn #=> String
resp.device_description.attributes #=> Hash
resp.device_description.attributes["__string"] #=> String
resp.device_description.device_id #=> String
resp.device_description.enabled #=> Boolean
resp.device_description.remaining_life #=> Float
resp.device_description.type #=> String
resp.device_description.tags #=> Hash
resp.device_description.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (required, String)

Returns:

See Also:



452
453
454
455
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 452

def describe_device(params = {}, options = {})
  req = build_request(:describe_device, params)
  req.send_request(options)
end

#finalize_device_claim(params = {}) ⇒ Types::FinalizeDeviceClaimResponse

Given a device ID, finalizes the claim request for the associated device.

<note markdown=“1”> Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.

</note>

Examples:

Request syntax with placeholder values


resp = client.finalize_device_claim({
  device_id: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Response structure


resp.state #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (required, String)
  • :tags (Hash<String,String>)

Returns:

See Also:



491
492
493
494
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 491

def finalize_device_claim(params = {}, options = {})
  req = build_request(:finalize_device_claim, params)
  req.send_request(options)
end

#get_device_methods(params = {}) ⇒ Types::GetDeviceMethodsResponse

Given a device ID, returns the invokable methods associated with the device.

Examples:

Request syntax with placeholder values


resp = client.get_device_methods({
  device_id: "__string", # required
})

Response structure


resp.device_methods #=> Array
resp.device_methods[0].device_type #=> String
resp.device_methods[0].method_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (required, String)

Returns:

See Also:



521
522
523
524
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 521

def get_device_methods(params = {}, options = {})
  req = build_request(:get_device_methods, params)
  req.send_request(options)
end

#initiate_device_claim(params = {}) ⇒ Types::InitiateDeviceClaimResponse

Given a device ID, initiates a claim request for the associated device.

<note markdown=“1”> Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.

</note>

Examples:

Request syntax with placeholder values


resp = client.initiate_device_claim({
  device_id: "__string", # required
})

Response structure


resp.state #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (required, String)

Returns:

See Also:



555
556
557
558
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 555

def initiate_device_claim(params = {}, options = {})
  req = build_request(:initiate_device_claim, params)
  req.send_request(options)
end

#invoke_device_method(params = {}) ⇒ Types::InvokeDeviceMethodResponse

Given a device ID, issues a request to invoke a named device method (with possible parameters). See the “Example POST” code snippet below.

Examples:

Request syntax with placeholder values


resp = client.invoke_device_method({
  device_id: "__string", # required
  device_method: {
    device_type: "__string",
    method_name: "__string",
  },
  device_method_parameters: "__string",
})

Response structure


resp.device_method_response #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (required, String)
  • :device_method (Types::DeviceMethod) —

    The device method to invoke.

  • :device_method_parameters (String) —

    A JSON encoded string containing the device method request parameters.

Returns:

See Also:



595
596
597
598
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 595

def invoke_device_method(params = {}, options = {})
  req = build_request(:invoke_device_method, params)
  req.send_request(options)
end

#list_device_events(params = {}) ⇒ Types::ListDeviceEventsResponse

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.

Examples:

Request syntax with placeholder values


resp = client.list_device_events({
  device_id: "__string", # required
  from_time_stamp: Time.now, # required
  max_results: 1,
  next_token: "__string",
  to_time_stamp: Time.now, # required
})

Response structure


resp.events #=> Array
resp.events[0].device.device_id #=> String
resp.events[0].device.type #=> String
resp.events[0].std_event #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (required, String)
  • :from_time_stamp (required, Time, DateTime, Date, Integer, String)
  • :max_results (Integer)
  • :next_token (String)
  • :to_time_stamp (required, Time, DateTime, Date, Integer, String)

Returns:

See Also:



640
641
642
643
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 640

def list_device_events(params = {}, options = {})
  req = build_request(:list_device_events, params)
  req.send_request(options)
end

#list_devices(params = {}) ⇒ Types::ListDevicesResponse

Lists the 1-Click compatible devices associated with your AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_devices({
  device_type: "__string",
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.devices #=> Array
resp.devices[0].arn #=> String
resp.devices[0].attributes #=> Hash
resp.devices[0].attributes["__string"] #=> String
resp.devices[0].device_id #=> String
resp.devices[0].enabled #=> Boolean
resp.devices[0].remaining_life #=> Float
resp.devices[0].type #=> String
resp.devices[0].tags #=> Hash
resp.devices[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_type (String)
  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



684
685
686
687
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 684

def list_devices(params = {}, options = {})
  req = build_request(:list_devices, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags associated with the specified resource ARN.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "__string", # required
})

Response structure


resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String)

Returns:

See Also:



712
713
714
715
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 712

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds or updates the tags associated with the resource ARN. See [AWS IoT 1-Click Service Limits] for the maximum number of tags allowed per resource.

[1]: docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "__string", # required
  tags: { # required
    "__string" => "__string",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tags (required, Hash<String,String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



744
745
746
747
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 744

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#unclaim_device(params = {}) ⇒ Types::UnclaimDeviceResponse

Disassociates a device from your AWS account using its device ID.

Examples:

Request syntax with placeholder values


resp = client.unclaim_device({
  device_id: "__string", # required
})

Response structure


resp.state #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (required, String)

Returns:

See Also:



771
772
773
774
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 771

def unclaim_device(params = {}, options = {})
  req = build_request(:unclaim_device, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "__string", # required
  tag_keys: ["__string"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tag_keys (required, Array<String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



796
797
798
799
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 796

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_device_state(params = {}) ⇒ Struct

Using a Boolean value (true or false), this operation enables or disables the device given a device ID.

Examples:

Request syntax with placeholder values


resp = client.update_device_state({
  device_id: "__string", # required
  enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_id (required, String)
  • :enabled (Boolean) —

    If true, the device is enabled. If false, the device is disabled.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



822
823
824
825
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 822

def update_device_state(params = {}, options = {})
  req = build_request(:update_device_state, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


846
847
848
 
# File 'lib/aws-sdk-iot1clickdevicesservice/client.rb', line 846

def waiter_names
  []
end