Class: Aws::IoTDataPlane::Client

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

Overview

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

client = Aws::IoTDataPlane::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):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or 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`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `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::InstanceProfileCredentials` 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)
  • :account_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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :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 —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

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

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

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

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :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 the 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` - A retry mode that includes all the functionality of `standard` mode along with automatic client side throttling.

  • :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. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or 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::IoTDataPlane::EndpointProvider) —

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

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

  • :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_open_timeout (Float) — default: 15 —

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

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

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

  • :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_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



471
472
473
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 471

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. 



1231
1232
1233
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 1231

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. 



1234
1235
1236
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 1234

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: {}) 


1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 1204

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

#delete_connection(params = {}) ⇒ Struct

Disconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client’s network connection and optionally cleans the session state.

Requires permission to access the [DeleteConnection] action.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions

Examples:

Request syntax with placeholder values


resp = client.delete_connection({
  client_id: "ClientId", # required
  clean_session: false,
  prevent_will_message: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_id (required, String) —

    The unique identifier of the MQTT client to disconnect. The client ID can’t start with a dollar sign ($).

    MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

  • :clean_session (Boolean) —

    Specifies whether to remove the client’s persistent session state when disconnecting. Set to ‘TRUE` to delete all session information, including subscriptions and queued messages. Set to `FALSE` to preserve the session state for [persistent sessions]. For clean sessions this parameter will be ignored. By default, this is set to `FALSE` (preserves the session state).

    [1]: docs.aws.amazon.com/iot/latest/developerguide/mqtt.html#mqtt-persistent-sessions

  • :prevent_will_message (Boolean) —

    Controls if Amazon Web Services IoT Core publishes the client’s Last Will and Testament (LWT) message upon disconnection. Set to ‘TRUE` to prevent publishing the LWT message. Set to `FALSE` to ensure that LWT is published. By default, this is set to `FALSE` (LWT message is published).

Returns:

  • (Struct) —

    Returns an empty response.



526
527
528
529
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 526

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

#delete_thing_shadow(params = {}) ⇒ Types::DeleteThingShadowResponse

Deletes the shadow for the specified thing.

Requires permission to access the [DeleteThingShadow] action.

For more information, see [DeleteThingShadow] in the IoT Developer Guide.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions [2]: docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html

Examples:

Request syntax with placeholder values


resp = client.delete_thing_shadow({
  thing_name: "ThingName", # required
  shadow_name: "ShadowName",
})

Response structure


resp.payload #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :thing_name (required, String) —

    The name of the thing.

  • :shadow_name (String) —

    The name of the shadow.

Returns:



566
567
568
569
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 566

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

#get_connection(params = {}) ⇒ Types::GetConnectionResponse

Retrieves connection information for the specified MQTT client.

Requires permission to access the [GetConnection] action.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions

Examples:

Request syntax with placeholder values


resp = client.get_connection({
  client_id: "ClientId", # required
  include_socket_information: false,
})

Response structure


resp.connected #=> Boolean
resp.thing_name #=> String
resp.clean_session #=> Boolean
resp.source_ip #=> String
resp.source_port #=> Integer
resp.target_ip #=> String
resp.target_port #=> Integer
resp.keep_alive_duration #=> Integer
resp.connected_since #=> Integer
resp.disconnected_since #=> Integer
resp.disconnect_reason #=> String
resp.session_expiry #=> Integer
resp.client_id #=> String
resp.vpc_endpoint_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_id (required, String) —

    The unique identifier of the MQTT client to retrieve connection information. The client ID can’t start with a dollar sign ($).

    MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

  • :include_socket_information (Boolean) —

    Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp) should be included in the GetConnection response. Set to ‘TRUE` to include socket information. Set to `FALSE` to omit socket information. By default, this is set to `FALSE`. See the [developer guide] for how to authorize this parameter.

    [1]: docs.aws.amazon.com/iot/latest/developerguide/mqtt.html#mqtt-client-disconnect

Returns:



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

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

#get_retained_message(params = {}) ⇒ Types::GetRetainedMessageResponse

Gets the details of a single retained message for the specified topic.

This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call [ListRetainedMessages].

Requires permission to access the [GetRetainedMessage] action.

For more information about messaging costs, see [Amazon Web Services IoT Core pricing - Messaging].

[1]: docs.aws.amazon.com/iot/latest/apireference/API_iotdata_ListRetainedMessages.html [2]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html [3]: aws.amazon.com/iot-core/pricing/#Messaging

Examples:

Request syntax with placeholder values


resp = client.get_retained_message({
  topic: "Topic", # required
})

Response structure


resp.topic #=> String
resp.payload #=> String
resp.qos #=> Integer
resp.last_modified_time #=> Integer
resp.user_properties #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :topic (required, String) —

    The topic name of the retained message to retrieve.

Returns:



690
691
692
693
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 690

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

#get_thing_shadow(params = {}) ⇒ Types::GetThingShadowResponse

Gets the shadow for the specified thing.

Requires permission to access the [GetThingShadow] action.

For more information, see [GetThingShadow] in the IoT Developer Guide.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions [2]: docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html

Examples:

Request syntax with placeholder values


resp = client.get_thing_shadow({
  thing_name: "ThingName", # required
  shadow_name: "ShadowName",
})

Response structure


resp.payload #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :thing_name (required, String) —

    The name of the thing.

  • :shadow_name (String) —

    The name of the shadow.

Returns:



730
731
732
733
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 730

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

#list_named_shadows_for_thing(params = {}) ⇒ Types::ListNamedShadowsForThingResponse

Lists the shadows for the specified thing.

Requires permission to access the [ListNamedShadowsForThing] action.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions

Examples:

Request syntax with placeholder values


resp = client.list_named_shadows_for_thing({
  thing_name: "ThingName", # required
  next_token: "NextToken",
  page_size: 1,
})

Response structure


resp.results #=> Array
resp.results[0] #=> String
resp.next_token #=> String
resp.timestamp #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :thing_name (required, String) —

    The name of the thing.

  • :next_token (String) —

    The token to retrieve the next set of results.

  • :page_size (Integer) —

    The result page size.

Returns:



776
777
778
779
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 776

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

#list_retained_messages(params = {}) ⇒ Types::ListRetainedMessagesResponse

Lists summary information about the retained messages stored for the account.

This action returns only the topic names of the retained messages. It doesn’t return any message payloads. Although this action doesn’t return a message payload, it can still incur messaging costs.

To get the message payload of a retained message, call

GetRetainedMessage][1

with the topic name of the retained message.

Requires permission to access the [ListRetainedMessages] action.

For more information about messaging costs, see [Amazon Web Services IoT Core pricing - Messaging].

[1]: docs.aws.amazon.com/iot/latest/apireference/API_iotdata_GetRetainedMessage.html [2]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html [3]: aws.amazon.com/iot-core/pricing/#Messaging

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_retained_messages({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.retained_topics #=> Array
resp.retained_topics[0].topic #=> String
resp.retained_topics[0].payload_size #=> Integer
resp.retained_topics[0].qos #=> Integer
resp.retained_topics[0].last_modified_time #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    To retrieve the next set of results, the ‘nextToken` value from a previous response; otherwise null to receive the first set of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



835
836
837
838
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 835

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

#list_subscriptions(params = {}) ⇒ Types::ListSubscriptionsResponse

Returns a list of all subscriptions for MQTT clients with active sessions, including offline clients with persistent sessions.

Requires permission to access the [ListSubscriptions] action.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_subscriptions({
  client_id: "ClientId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.subscriptions #=> Array
resp.subscriptions[0].topic_filter #=> String
resp.subscriptions[0].qos #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_id (required, String) —

    The unique identifier of the MQTT client to list subscriptions for. The client ID can’t start with a dollar sign ($).

    MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

  • :next_token (String) —

    To retrieve the next set of results, the ‘nextToken` value from a previous response; otherwise null to receive the first set of results.

  • :max_results (Integer) —

    The maximum number of subscriptions to return in a single request. By default, this is set to 20.

Returns:



890
891
892
893
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 890

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

#publish(params = {}) ⇒ Struct

Publishes an MQTT message.

Requires permission to access the [Publish] action.

For more information about MQTT messages, see [MQTT Protocol] in the IoT Developer Guide.

For more information about messaging costs, see [Amazon Web Services IoT Core pricing - Messaging].

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions [2]: docs.aws.amazon.com/iot/latest/developerguide/mqtt.html [3]: aws.amazon.com/iot-core/pricing/#Messaging

Examples:

Request syntax with placeholder values


resp = client.publish({
  topic: "Topic", # required
  qos: 1,
  retain: false,
  payload: "data",
  user_properties: "UserProperties",
  payload_format_indicator: "UNSPECIFIED_BYTES", # accepts UNSPECIFIED_BYTES, UTF8_DATA
  content_type: "ContentType",
  response_topic: "ResponseTopic",
  correlation_data: "CorrelationData",
  message_expiry: 1,
})

Parameters:

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

    ({})

Options Hash (params):

  • :topic (required, String) —

    The name of the MQTT topic.

  • :qos (Integer) —

    The Quality of Service (QoS) level. The default QoS level is 0.

  • :retain (Boolean) —

    A Boolean value that determines whether to set the RETAIN flag when the message is published.

    Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

    Valid values: ‘true` | `false`

    Default value: ‘false`

  • :payload (String, StringIO, File) —

    The message body. MQTT accepts text, binary, and empty (null) message payloads.

    Publishing an empty (null) payload with retain = ‘true` deletes the retained message identified by topic from Amazon Web Services IoT Core.

  • :user_properties (String) —

    A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. ‘userProperties` is an HTTP header value in the API.

    The following example ‘userProperties` parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:

    ‘[“alpha”, “45”]`

    **SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.**

  • :payload_format_indicator (String) —

    An ‘Enum` string value that indicates whether the payload is formatted as UTF-8. `payloadFormatIndicator` is an HTTP header value in the API.

  • :content_type (String) —

    A UTF-8 encoded string that describes the content of the publishing message.

  • :response_topic (String) —

    A UTF-8 encoded string that’s used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

  • :correlation_data (String) —

    The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it’s received. ‘correlationData` is an HTTP header value in the API.

  • :message_expiry (Integer) —

    A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn’t expire. For more information about the limits of ‘messageExpiry`, see [Amazon Web Services IoT Core message broker and protocol limits and quotas ][1] from the Amazon Web Services Reference Guide.

    [1]: docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits

Returns:

  • (Struct) —

    Returns an empty response.



1001
1002
1003
1004
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 1001

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

#send_direct_message(params = {}) ⇒ Types::SendDirectMessageResponse

Sends an MQTT message directly to a specific client identified by its client ID.

‘SendDirectMessage` targets a single client ID. The receiving client does not need to subscribe to the topic, but the receiver’s policy must allow ‘iot:Receive` on the specified topic.

Requires permission to access the [SendDirectMessage] action.

For more information about messaging costs, see [Amazon Web Services IoT Core pricing].

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions [2]: aws.amazon.com/iot-core/pricing/

Examples:

Request syntax with placeholder values


resp = client.send_direct_message({
  client_id: "ClientId", # required
  topic: "Topic", # required
  content_type: "ContentType",
  response_topic: "ResponseTopic",
  confirmation: false,
  timeout: 1,
  payload: "data",
  user_properties: "UserProperties",
  payload_format_indicator: "UNSPECIFIED_BYTES", # accepts UNSPECIFIED_BYTES, UTF8_DATA
  correlation_data: "CorrelationData",
})

Response structure


resp.message #=> String
resp.trace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_id (required, String) —

    The unique identifier of the MQTT client to send the message to.

    Client IDs must not exceed 128 characters and can’t start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. For more information, see [Amazon Web Services IoT Core message broker and protocol limits and quotas].

    [1]: docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits

  • :topic (required, String) —

    The topic of the outbound MQTT Publish message to the receiving client. For more information, see [Amazon Web Services IoT Core message broker and protocol limits and quotas].

    [1]: docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits

  • :content_type (String) —

    The MQTT5 content type property forwarded to the receiving client (for example, ‘application/json`).

  • :response_topic (String) —

    A UTF-8 encoded string that’s used as the topic name for a response message. The response topic describes the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters. For more information, see [Amazon Web Services IoT Core message broker and protocol limits and quotas].

    [1]: docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits

  • :confirmation (Boolean) —

    A Boolean value that specifies whether to wait for delivery confirmation from the receiving client.

    When set to ‘true`, the API delivers the message at QoS 1 and waits for the client to send a delivery confirmation (PUBACK) before returning a successful response. If delivery confirmation is not received within the specified `timeout` period, the API returns HTTP 504.

    When set to ‘false`, the API delivers the message at QoS 0 and returns after Amazon Web Services IoT Core attempts to deliver the message.

    Valid values: ‘true` | `false`

    Default value: ‘false`

  • :timeout (Integer) —

    An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when ‘confirmation` is set to `true`. If `confirmation` is `false`, this parameter is ignored.

    The total API response time may be higher than this value due to internal processing. Set your HTTP client timeout to a value greater than this parameter.

    Valid range: 1 to 15 seconds.

    Default value: ‘5` seconds.

  • :payload (String, StringIO, File) —

    The message body. MQTT accepts text, binary, and empty (null) message payloads.

  • :user_properties (String) —

    A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. ‘userProperties` is an HTTP header value in the API.

    For MQTT 3.1.1 clients, user properties are silently dropped.

    The following example ‘userProperties` parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:

    ‘[“alpha”, “45”]`

    **SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.**

  • :payload_format_indicator (String) —

    An ‘Enum` string value that indicates whether the payload is formatted as UTF-8. `payloadFormatIndicator` is an HTTP header value in the API.

  • :correlation_data (String) —

    The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it’s received. ‘correlationData` is an HTTP header value in the API.

Returns:



1151
1152
1153
1154
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 1151

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

#update_thing_shadow(params = {}) ⇒ Types::UpdateThingShadowResponse

Updates the shadow for the specified thing.

Requires permission to access the [UpdateThingShadow] action.

For more information, see [UpdateThingShadow] in the IoT Developer Guide.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions [2]: docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html

Examples:

Request syntax with placeholder values


resp = client.update_thing_shadow({
  thing_name: "ThingName", # required
  shadow_name: "ShadowName",
  payload: "data", # required
})

Response structure


resp.payload #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :thing_name (required, String) —

    The name of the thing.

  • :shadow_name (String) —

    The name of the shadow.

  • :payload (required, String, StringIO, File) —

    The state information, in JSON format.

Returns:



1195
1196
1197
1198
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 1195

def update_thing_shadow(params = {}, options = {})
  req = build_request(:update_thing_shadow, 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. 


1224
1225
1226
 
# File 'lib/aws-sdk-iotdataplane/client.rb', line 1224

def waiter_names
  []
end