Class: Aws::IoTWireless::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb

Overview

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

client = Aws::IoTWireless::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

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 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[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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['AWS_EC2_METADATA_DISABLED'] 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:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :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['AWS_AUTH_SCHEME_PREFERENCE'] 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 https://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. 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:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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 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::IoTWireless::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::IoTWireless::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 'http://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.



476
477
478
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 476

def initialize(*args)
  super
end

Instance Method Details

#associate_aws_account_with_partner_account(params = {}) ⇒ Types::AssociateAwsAccountWithPartnerAccountResponse

Associates a partner account with your AWS account.

Examples:

Request syntax with placeholder values


resp = client.({
  sidewalk: { # required
    amazon_id: "AmazonId",
    app_server_private_key: "AppServerPrivateKey",
  },
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.sidewalk.amazon_id #=> String
resp.sidewalk.app_server_private_key #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :sidewalk (required, Types::SidewalkAccountInfo) —

    The Sidewalk account credentials.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>) —

    The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Returns:



538
539
540
541
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 538

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

#associate_multicast_group_with_fuota_task(params = {}) ⇒ Struct

Associate a multicast group with a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.associate_multicast_group_with_fuota_task({
  id: "FuotaTaskId", # required
  multicast_group_id: "MulticastGroupId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a FUOTA task.

  • :multicast_group_id (required, String) —

    The ID of the multicast group.

Returns:

  • (Struct) —

    Returns an empty response.



562
563
564
565
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 562

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

#associate_wireless_device_with_fuota_task(params = {}) ⇒ Struct

Associate a wireless device with a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.associate_wireless_device_with_fuota_task({
  id: "FuotaTaskId", # required
  wireless_device_id: "WirelessDeviceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a FUOTA task.

  • :wireless_device_id (required, String) —

    The ID of the wireless device.

Returns:

  • (Struct) —

    Returns an empty response.



586
587
588
589
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 586

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

#associate_wireless_device_with_multicast_group(params = {}) ⇒ Struct

Associates a wireless device with a multicast group.

Examples:

Request syntax with placeholder values


resp = client.associate_wireless_device_with_multicast_group({
  id: "MulticastGroupId", # required
  wireless_device_id: "WirelessDeviceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

  • :wireless_device_id (required, String) —

    The ID of the wireless device.

Returns:

  • (Struct) —

    Returns an empty response.



610
611
612
613
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 610

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

#associate_wireless_device_with_thing(params = {}) ⇒ Struct

Associates a wireless device with a thing.

Examples:

Request syntax with placeholder values


resp = client.associate_wireless_device_with_thing({
  id: "WirelessDeviceId", # required
  thing_arn: "ThingArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to update.

  • :thing_arn (required, String) —

    The ARN of the thing to associate with the wireless device.

Returns:

  • (Struct) —

    Returns an empty response.



634
635
636
637
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 634

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

#associate_wireless_gateway_with_certificate(params = {}) ⇒ Types::AssociateWirelessGatewayWithCertificateResponse

Associates a wireless gateway with a certificate.

Examples:

Request syntax with placeholder values


resp = client.associate_wireless_gateway_with_certificate({
  id: "WirelessGatewayId", # required
  iot_certificate_id: "IotCertificateId", # required
})

Response structure


resp.iot_certificate_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to update.

  • :iot_certificate_id (required, String) —

    The ID of the certificate to associate with the wireless gateway.

Returns:



664
665
666
667
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 664

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

#associate_wireless_gateway_with_thing(params = {}) ⇒ Struct

Associates a wireless gateway with a thing.

Examples:

Request syntax with placeholder values


resp = client.associate_wireless_gateway_with_thing({
  id: "WirelessGatewayId", # required
  thing_arn: "ThingArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to update.

  • :thing_arn (required, String) —

    The ARN of the thing to associate with the wireless gateway.

Returns:

  • (Struct) —

    Returns an empty response.



688
689
690
691
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 688

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

#cancel_multicast_group_session(params = {}) ⇒ Struct

Cancels an existing multicast group session.

Examples:

Request syntax with placeholder values


resp = client.cancel_multicast_group_session({
  id: "MulticastGroupId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

Returns:

  • (Struct) —

    Returns an empty response.



708
709
710
711
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 708

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

#create_destination(params = {}) ⇒ Types::CreateDestinationResponse

Creates a new destination that maps a device message to an AWS IoT rule.

Examples:

Request syntax with placeholder values


resp = client.create_destination({
  name: "DestinationName", # required
  expression_type: "RuleName", # required, accepts RuleName, MqttTopic
  expression: "Expression", # required
  description: "Description",
  role_arn: "RoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
})

Response structure


resp.arn #=> String
resp.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the new resource.

  • :expression_type (required, String) —

    The type of value in Expression.

  • :expression (required, String) —

    The rule name or topic rule to send messages to.

  • :description (String) —

    The description of the new resource.

  • :role_arn (required, String) —

    The ARN of the IAM Role that authorizes the destination.

  • :tags (Array<Types::Tag>) —

    The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



782
783
784
785
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 782

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

#create_device_profile(params = {}) ⇒ Types::CreateDeviceProfileResponse

Creates a new device profile.

Examples:

Request syntax with placeholder values


resp = client.create_device_profile({
  name: "DeviceProfileName",
  lo_ra_wan: {
    supports_class_b: false,
    class_b_timeout: 1,
    ping_slot_period: 1,
    ping_slot_dr: 1,
    ping_slot_freq: 1,
    supports_class_c: false,
    class_c_timeout: 1,
    mac_version: "MacVersion",
    reg_params_revision: "RegParamsRevision",
    rx_delay_1: 1,
    rx_dr_offset_1: 1,
    rx_data_rate_2: 1,
    rx_freq_2: 1,
    factory_preset_freqs_list: [1],
    max_eirp: 1,
    max_duty_cycle: 1,
    rf_region: "RfRegion",
    supports_join: false,
    supports_32_bit_f_cnt: false,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
  sidewalk: {
  },
})

Response structure


resp.arn #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name of the new resource.

    The following special characters aren't accepted: <>^#~$

  • :lo_ra_wan (Types::LoRaWANDeviceProfile) —

    The device profile information to use to create the device profile.

  • :tags (Array<Types::Tag>) —

    The tags to attach to the new device profile. Tags are metadata that you can use to manage a resource.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :sidewalk (Types::SidewalkCreateDeviceProfile) —

    The Sidewalk-related information for creating the Sidewalk device profile.

Returns:



873
874
875
876
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 873

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

#create_fuota_task(params = {}) ⇒ Types::CreateFuotaTaskResponse

Creates a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.create_fuota_task({
  name: "FuotaTaskName",
  description: "Description",
  client_request_token: "ClientRequestToken",
  lo_ra_wan: {
    rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1, AS923-2, AS923-3, AS923-4, EU433, CN470, CN779, RU864, KR920, IN865
  },
  firmware_update_image: "FirmwareUpdateImage", # required
  firmware_update_role: "FirmwareUpdateRole", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  redundancy_percent: 1,
  fragment_size_bytes: 1,
  fragment_interval_ms: 1,
  descriptor: "FileDescriptor",
})

Response structure


resp.arn #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name of a FUOTA task.

  • :description (String) —

    The description of the new resource.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :lo_ra_wan (Types::LoRaWANFuotaTask) —

    The LoRaWAN information used with a FUOTA task.

  • :firmware_update_image (required, String) —

    The S3 URI points to a firmware update image that is to be used with a FUOTA task.

  • :firmware_update_role (required, String) —

    The firmware update role that is to be used with a FUOTA task.

  • :tags (Array<Types::Tag>) —

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

  • :redundancy_percent (Integer) —

    The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

  • :fragment_size_bytes (Integer) —

    The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

  • :fragment_interval_ms (Integer) —

    The interval for sending fragments in milliseconds, rounded to the nearest second.

    This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

  • :descriptor (String) —

    The descriptor is the metadata about the file that is transferred to the device using FUOTA, such as the software version. It is a binary field encoded in base64.

Returns:



979
980
981
982
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 979

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

#create_multicast_group(params = {}) ⇒ Types::CreateMulticastGroupResponse

Creates a multicast group.

Examples:

Request syntax with placeholder values


resp = client.create_multicast_group({
  name: "MulticastGroupName",
  description: "Description",
  client_request_token: "ClientRequestToken",
  lo_ra_wan: { # required
    rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1, AS923-2, AS923-3, AS923-4, EU433, CN470, CN779, RU864, KR920, IN865
    dl_class: "ClassB", # accepts ClassB, ClassC
    participating_gateways: {
      gateway_list: ["WirelessGatewayId"],
      transmission_interval: 1,
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name of the multicast group.

  • :description (String) —

    The description of the multicast group.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :lo_ra_wan (required, Types::LoRaWANMulticast) —

    The LoRaWAN information that is to be used with the multicast group.

  • :tags (Array<Types::Tag>) —

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Returns:



1051
1052
1053
1054
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1051

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

#create_network_analyzer_configuration(params = {}) ⇒ Types::CreateNetworkAnalyzerConfigurationResponse

Creates a new network analyzer configuration.

Examples:

Request syntax with placeholder values


resp = client.create_network_analyzer_configuration({
  name: "NetworkAnalyzerConfigurationName", # required
  trace_content: {
    wireless_device_frame_info: "ENABLED", # accepts ENABLED, DISABLED
    log_level: "INFO", # accepts INFO, ERROR, DISABLED
    multicast_frame_info: "ENABLED", # accepts ENABLED, DISABLED
  },
  wireless_devices: ["WirelessDeviceId"],
  wireless_gateways: ["WirelessGatewayId"],
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
  multicast_groups: ["MulticastGroupId"],
})

Response structure


resp.arn #=> String
resp.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    Name of the network analyzer configuration.

  • :trace_content (Types::TraceContent) —

    Trace content for your wireless devices, gateways, and multicast groups.

  • :wireless_devices (Array<String>) —

    Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

  • :wireless_gateways (Array<String>) —

    Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

  • :description (String) —

    The description of the new resource.

  • :tags (Array<Types::Tag>) —

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :multicast_groups (Array<String>) —

    Multicast Group resources to add to the network analyzer configruation. Provide the MulticastGroupId of the resource to add in the input array.

Returns:



1139
1140
1141
1142
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1139

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

#create_service_profile(params = {}) ⇒ Types::CreateServiceProfileResponse

Creates a new service profile.

Examples:

Request syntax with placeholder values


resp = client.create_service_profile({
  name: "ServiceProfileName",
  lo_ra_wan: {
    add_gw_metadata: false,
    dr_min: 1,
    dr_max: 1,
    pr_allowed: false,
    ra_allowed: false,
    tx_power_index_min: 1,
    tx_power_index_max: 1,
    nb_trans_min: 1,
    nb_trans_max: 1,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
})

Response structure


resp.arn #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name of the new resource.

    The following special characters aren't accepted: <>^#~$

  • :lo_ra_wan (Types::LoRaWANServiceProfile) —

    The service profile information to use to create the service profile.

  • :tags (Array<Types::Tag>) —

    The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



1214
1215
1216
1217
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1214

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

#create_wireless_device(params = {}) ⇒ Types::CreateWirelessDeviceResponse

Provisions a wireless device.

Examples:

Request syntax with placeholder values


resp = client.create_wireless_device({
  type: "Sidewalk", # required, accepts Sidewalk, LoRaWAN
  name: "WirelessDeviceName",
  description: "Description",
  destination_name: "DestinationName", # required
  client_request_token: "ClientRequestToken",
  lo_ra_wan: {
    dev_eui: "DevEui",
    device_profile_id: "DeviceProfileId",
    service_profile_id: "ServiceProfileId",
    otaa_v1_1: {
      app_key: "AppKey",
      nwk_key: "NwkKey",
      join_eui: "JoinEui",
    },
    otaa_v1_0_x: {
      app_key: "AppKey",
      app_eui: "AppEui",
      join_eui: "JoinEui",
      gen_app_key: "GenAppKey",
    },
    abp_v1_1: {
      dev_addr: "DevAddr",
      session_keys: {
        f_nwk_s_int_key: "FNwkSIntKey",
        s_nwk_s_int_key: "SNwkSIntKey",
        nwk_s_enc_key: "NwkSEncKey",
        app_s_key: "AppSKey",
      },
      f_cnt_start: 1,
    },
    abp_v1_0_x: {
      dev_addr: "DevAddr",
      session_keys: {
        nwk_s_key: "NwkSKey",
        app_s_key: "AppSKey",
      },
      f_cnt_start: 1,
    },
    f_ports: {
      fuota: 1,
      multicast: 1,
      clock_sync: 1,
      positioning: {
        clock_sync: 1,
        stream: 1,
        gnss: 1,
      },
      applications: [
        {
          f_port: 1,
          type: "SemtechGeolocation", # accepts SemtechGeolocation
          destination_name: "DestinationName",
        },
      ],
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  positioning: "Enabled", # accepts Enabled, Disabled
  sidewalk: {
    device_profile_id: "DeviceProfileId",
  },
})

Response structure


resp.arn #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :type (required, String) —

    The wireless device type.

  • :name (String) —

    The name of the new resource.

    The following special characters aren't accepted: <>^#~$

  • :description (String) —

    The description of the new resource.

  • :destination_name (required, String) —

    The name of the destination to assign to the new wireless device.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :lo_ra_wan (Types::LoRaWANDevice) —

    The device configuration information to use to create the wireless device.

  • :tags (Array<Types::Tag>) —

    The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.

  • :positioning (String) —

    FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

  • :sidewalk (Types::SidewalkCreateWirelessDevice) —

    The device configuration information to use to create the Sidewalk device.

Returns:



1354
1355
1356
1357
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1354

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

#create_wireless_gateway(params = {}) ⇒ Types::CreateWirelessGatewayResponse

Provisions a wireless gateway.

When provisioning a wireless gateway, you might run into duplication errors for the following reasons.

  • If you specify a GatewayEui value that already exists.

  • If you used a ClientRequestToken with the same parameters within the last 10 minutes.

To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

Examples:

Request syntax with placeholder values


resp = client.create_wireless_gateway({
  name: "WirelessGatewayName",
  description: "Description",
  lo_ra_wan: { # required
    gateway_eui: "GatewayEui",
    rf_region: "RfRegion",
    join_eui_filters: [
      ["JoinEui"],
    ],
    net_id_filters: ["NetId"],
    sub_bands: [1],
    beaconing: {
      data_rate: 1,
      frequencies: [1],
    },
    max_eirp: 1.0,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
})

Response structure


resp.arn #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name of the new resource.

    The following special characters aren't accepted: <>^#~$

  • :description (String) —

    The description of the new resource.

  • :lo_ra_wan (required, Types::LoRaWANGateway) —

    The gateway configuration information to use to create the wireless gateway.

  • :tags (Array<Types::Tag>) —

    The tags to attach to the new wireless gateway. Tags are metadata that you can use to manage a resource.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



1450
1451
1452
1453
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1450

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

#create_wireless_gateway_task(params = {}) ⇒ Types::CreateWirelessGatewayTaskResponse

Creates a task for a wireless gateway.

Examples:

Request syntax with placeholder values


resp = client.create_wireless_gateway_task({
  id: "WirelessGatewayId", # required
  wireless_gateway_task_definition_id: "WirelessGatewayTaskDefinitionId", # required
})

Response structure


resp.wireless_gateway_task_definition_id #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "FIRST_RETRY", "SECOND_RETRY", "COMPLETED", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to update.

  • :wireless_gateway_task_definition_id (required, String) —

    The ID of the WirelessGatewayTaskDefinition.

Returns:



1482
1483
1484
1485
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1482

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

#create_wireless_gateway_task_definition(params = {}) ⇒ Types::CreateWirelessGatewayTaskDefinitionResponse

Creates a gateway task definition.

Examples:

Request syntax with placeholder values


resp = client.create_wireless_gateway_task_definition({
  auto_create_tasks: false, # required
  name: "WirelessGatewayTaskName",
  update: {
    update_data_source: "UpdateDataSource",
    update_data_role: "UpdateDataSource",
    lo_ra_wan: {
      update_signature: "UpdateSignature",
      sig_key_crc: 1,
      current_version: {
        package_version: "PackageVersion",
        model: "Model",
        station: "Station",
      },
      update_version: {
        package_version: "PackageVersion",
        model: "Model",
        station: "Station",
      },
    },
  },
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :auto_create_tasks (required, Boolean) —

    Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.

  • :name (String) —

    The name of the new resource.

  • :update (Types::UpdateWirelessGatewayTaskCreate) —

    Information about the gateways to update.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>) —

    The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Returns:



1566
1567
1568
1569
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1566

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

#delete_destination(params = {}) ⇒ Struct

Deletes a destination.

Examples:

Request syntax with placeholder values


resp = client.delete_destination({
  name: "DestinationName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.



1586
1587
1588
1589
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1586

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

#delete_device_profile(params = {}) ⇒ Struct

Deletes a device profile.

Examples:

Request syntax with placeholder values


resp = client.delete_device_profile({
  id: "DeviceProfileId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.



1606
1607
1608
1609
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1606

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

#delete_fuota_task(params = {}) ⇒ Struct

Deletes a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.delete_fuota_task({
  id: "FuotaTaskId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a FUOTA task.

Returns:

  • (Struct) —

    Returns an empty response.



1626
1627
1628
1629
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1626

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

#delete_multicast_group(params = {}) ⇒ Struct

Deletes a multicast group if it is not in use by a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.delete_multicast_group({
  id: "MulticastGroupId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

Returns:

  • (Struct) —

    Returns an empty response.



1646
1647
1648
1649
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1646

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

#delete_network_analyzer_configuration(params = {}) ⇒ Struct

Deletes a network analyzer configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_network_analyzer_configuration({
  configuration_name: "NetworkAnalyzerConfigurationName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :configuration_name (required, String) —

    Name of the network analyzer configuration.

Returns:

  • (Struct) —

    Returns an empty response.



1666
1667
1668
1669
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1666

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

#delete_queued_messages(params = {}) ⇒ Struct

Remove queued messages from the downlink queue.

Examples:

Request syntax with placeholder values


resp = client.delete_queued_messages({
  id: "WirelessDeviceId", # required
  message_id: "MessageId", # required
  wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a given wireless device for which downlink messages will be deleted.

  • :message_id (required, String) —

    If message ID is "*", it cleares the entire downlink queue for a given device, specified by the wireless device ID. Otherwise, the downlink message with the specified message ID will be deleted.

  • :wireless_device_type (String) —

    The wireless device type, which can be either Sidewalk or LoRaWAN.

Returns:

  • (Struct) —

    Returns an empty response.



1697
1698
1699
1700
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1697

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

#delete_service_profile(params = {}) ⇒ Struct

Deletes a service profile.

Examples:

Request syntax with placeholder values


resp = client.delete_service_profile({
  id: "ServiceProfileId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.



1717
1718
1719
1720
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1717

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

#delete_wireless_device(params = {}) ⇒ Struct

Deletes a wireless device.

Examples:

Request syntax with placeholder values


resp = client.delete_wireless_device({
  id: "WirelessDeviceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.



1737
1738
1739
1740
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1737

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

#delete_wireless_device_import_task(params = {}) ⇒ Struct

Delete an import task.

Examples:

Request syntax with placeholder values


resp = client.delete_wireless_device_import_task({
  id: "ImportTaskId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The unique identifier of the import task to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.



1757
1758
1759
1760
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1757

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

#delete_wireless_gateway(params = {}) ⇒ Struct

Deletes a wireless gateway.

When deleting a wireless gateway, you might run into duplication errors for the following reasons.

  • If you specify a GatewayEui value that already exists.

  • If you used a ClientRequestToken with the same parameters within the last 10 minutes.

To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

Examples:

Request syntax with placeholder values


resp = client.delete_wireless_gateway({
  id: "WirelessGatewayId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.



1790
1791
1792
1793
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1790

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

#delete_wireless_gateway_task(params = {}) ⇒ Struct

Deletes a wireless gateway task.

Examples:

Request syntax with placeholder values


resp = client.delete_wireless_gateway_task({
  id: "WirelessGatewayId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.



1810
1811
1812
1813
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1810

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

#delete_wireless_gateway_task_definition(params = {}) ⇒ Struct

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

Examples:

Request syntax with placeholder values


resp = client.delete_wireless_gateway_task_definition({
  id: "WirelessGatewayTaskDefinitionId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.



1831
1832
1833
1834
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1831

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

#deregister_wireless_device(params = {}) ⇒ Struct

Deregister a wireless device from AWS IoT Wireless.

Examples:

Request syntax with placeholder values


resp = client.deregister_wireless_device({
  identifier: "Identifier", # required
  wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the wireless device to deregister from AWS IoT Wireless.

  • :wireless_device_type (String) —

    The type of wireless device to deregister from AWS IoT Wireless, which can be LoRaWAN or Sidewalk.

Returns:

  • (Struct) —

    Returns an empty response.



1857
1858
1859
1860
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1857

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

#disassociate_aws_account_from_partner_account(params = {}) ⇒ Struct

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

Examples:

Request syntax with placeholder values


resp = client.({
  partner_account_id: "PartnerAccountId", # required
  partner_type: "Sidewalk", # required, accepts Sidewalk
})

Parameters:

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

    ({})

Options Hash (params):

  • :partner_account_id (required, String) —

    The partner account ID to disassociate from the AWS account.

  • :partner_type (required, String) —

    The partner type.

Returns:

  • (Struct) —

    Returns an empty response.



1883
1884
1885
1886
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1883

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

#disassociate_multicast_group_from_fuota_task(params = {}) ⇒ Struct

Disassociates a multicast group from a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.disassociate_multicast_group_from_fuota_task({
  id: "FuotaTaskId", # required
  multicast_group_id: "MulticastGroupId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a FUOTA task.

  • :multicast_group_id (required, String) —

    The ID of the multicast group.

Returns:

  • (Struct) —

    Returns an empty response.



1907
1908
1909
1910
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1907

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

#disassociate_wireless_device_from_fuota_task(params = {}) ⇒ Struct

Disassociates a wireless device from a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.disassociate_wireless_device_from_fuota_task({
  id: "FuotaTaskId", # required
  wireless_device_id: "WirelessDeviceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a FUOTA task.

  • :wireless_device_id (required, String) —

    The ID of the wireless device.

Returns:

  • (Struct) —

    Returns an empty response.



1931
1932
1933
1934
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1931

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

#disassociate_wireless_device_from_multicast_group(params = {}) ⇒ Struct

Disassociates a wireless device from a multicast group.

Examples:

Request syntax with placeholder values


resp = client.disassociate_wireless_device_from_multicast_group({
  id: "MulticastGroupId", # required
  wireless_device_id: "WirelessDeviceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

  • :wireless_device_id (required, String) —

    The ID of the wireless device.

Returns:

  • (Struct) —

    Returns an empty response.



1955
1956
1957
1958
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1955

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

#disassociate_wireless_device_from_thing(params = {}) ⇒ Struct

Disassociates a wireless device from its currently associated thing.

Examples:

Request syntax with placeholder values


resp = client.disassociate_wireless_device_from_thing({
  id: "WirelessDeviceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to update.

Returns:

  • (Struct) —

    Returns an empty response.



1975
1976
1977
1978
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1975

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

#disassociate_wireless_gateway_from_certificate(params = {}) ⇒ Struct

Disassociates a wireless gateway from its currently associated certificate.

Examples:

Request syntax with placeholder values


resp = client.disassociate_wireless_gateway_from_certificate({
  id: "WirelessGatewayId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to update.

Returns:

  • (Struct) —

    Returns an empty response.



1996
1997
1998
1999
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1996

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

#disassociate_wireless_gateway_from_thing(params = {}) ⇒ Struct

Disassociates a wireless gateway from its currently associated thing.

Examples:

Request syntax with placeholder values


resp = client.disassociate_wireless_gateway_from_thing({
  id: "WirelessGatewayId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to update.

Returns:

  • (Struct) —

    Returns an empty response.



2016
2017
2018
2019
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2016

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

#get_destination(params = {}) ⇒ Types::GetDestinationResponse

Gets information about a destination.

Examples:

Request syntax with placeholder values


resp = client.get_destination({
  name: "DestinationName", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.expression #=> String
resp.expression_type #=> String, one of "RuleName", "MqttTopic"
resp.description #=> String
resp.role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the resource to get.

Returns:



2052
2053
2054
2055
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2052

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

#get_device_profile(params = {}) ⇒ Types::GetDeviceProfileResponse

Gets information about a device profile.

Examples:

Request syntax with placeholder values


resp = client.get_device_profile({
  id: "DeviceProfileId", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.id #=> String
resp.lo_ra_wan.supports_class_b #=> Boolean
resp.lo_ra_wan.class_b_timeout #=> Integer
resp.lo_ra_wan.ping_slot_period #=> Integer
resp.lo_ra_wan.ping_slot_dr #=> Integer
resp.lo_ra_wan.ping_slot_freq #=> Integer
resp.lo_ra_wan.supports_class_c #=> Boolean
resp.lo_ra_wan.class_c_timeout #=> Integer
resp.lo_ra_wan.mac_version #=> String
resp.lo_ra_wan.reg_params_revision #=> String
resp.lo_ra_wan.rx_delay_1 #=> Integer
resp.lo_ra_wan.rx_dr_offset_1 #=> Integer
resp.lo_ra_wan.rx_data_rate_2 #=> Integer
resp.lo_ra_wan.rx_freq_2 #=> Integer
resp.lo_ra_wan.factory_preset_freqs_list #=> Array
resp.lo_ra_wan.factory_preset_freqs_list[0] #=> Integer
resp.lo_ra_wan.max_eirp #=> Integer
resp.lo_ra_wan.max_duty_cycle #=> Integer
resp.lo_ra_wan.rf_region #=> String
resp.lo_ra_wan.supports_join #=> Boolean
resp.lo_ra_wan.supports_32_bit_f_cnt #=> Boolean
resp.sidewalk.application_server_public_key #=> String
resp.sidewalk.qualification_status #=> Boolean
resp.sidewalk.dak_certificate_metadata #=> Array
resp.sidewalk.dak_certificate_metadata[0].certificate_id #=> String
resp.sidewalk.dak_certificate_metadata[0].max_allowed_signature #=> Integer
resp.sidewalk.dak_certificate_metadata[0].factory_support #=> Boolean
resp.sidewalk.dak_certificate_metadata[0].ap_id #=> String
resp.sidewalk.dak_certificate_metadata[0].device_type_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to get.

Returns:



2112
2113
2114
2115
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2112

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

#get_event_configuration_by_resource_types(params = {}) ⇒ Types::GetEventConfigurationByResourceTypesResponse

Get the event configuration based on resource types.

Examples:

Response structure


resp.device_registration_state.sidewalk.wireless_device_event_topic #=> String, one of "Enabled", "Disabled"
resp.proximity.sidewalk.wireless_device_event_topic #=> String, one of "Enabled", "Disabled"
resp.join.lo_ra_wan.wireless_device_event_topic #=> String, one of "Enabled", "Disabled"
resp.connection_status.lo_ra_wan.wireless_gateway_event_topic #=> String, one of "Enabled", "Disabled"
resp.message_delivery_status.sidewalk.wireless_device_event_topic #=> String, one of "Enabled", "Disabled"

Parameters:

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

    ({})

Returns:



2137
2138
2139
2140
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2137

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

#get_fuota_task(params = {}) ⇒ Types::GetFuotaTaskResponse

Gets information about a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.get_fuota_task({
  id: "FuotaTaskId", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.status #=> String, one of "Pending", "FuotaSession_Waiting", "In_FuotaSession", "FuotaDone", "Delete_Waiting"
resp.name #=> String
resp.description #=> String
resp.lo_ra_wan.rf_region #=> String
resp.lo_ra_wan.start_time #=> Time
resp.firmware_update_image #=> String
resp.firmware_update_role #=> String
resp.created_at #=> Time
resp.redundancy_percent #=> Integer
resp.fragment_size_bytes #=> Integer
resp.fragment_interval_ms #=> Integer
resp.descriptor #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a FUOTA task.

Returns:



2188
2189
2190
2191
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2188

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

#get_log_levels_by_resource_types(params = {}) ⇒ Types::GetLogLevelsByResourceTypesResponse

Returns current default log levels or log levels by resource types. Based on the resource type, log levels can be returned for wireless device, wireless gateway, or FUOTA task log options.

Examples:

Response structure


resp.default_log_level #=> String, one of "INFO", "ERROR", "DISABLED"
resp.wireless_gateway_log_options #=> Array
resp.wireless_gateway_log_options[0].type #=> String, one of "LoRaWAN"
resp.wireless_gateway_log_options[0].log_level #=> String, one of "INFO", "ERROR", "DISABLED"
resp.wireless_gateway_log_options[0].events #=> Array
resp.wireless_gateway_log_options[0].events[0].event #=> String, one of "CUPS_Request", "Certificate"
resp.wireless_gateway_log_options[0].events[0].log_level #=> String, one of "INFO", "ERROR", "DISABLED"
resp.wireless_device_log_options #=> Array
resp.wireless_device_log_options[0].type #=> String, one of "Sidewalk", "LoRaWAN"
resp.wireless_device_log_options[0].log_level #=> String, one of "INFO", "ERROR", "DISABLED"
resp.wireless_device_log_options[0].events #=> Array
resp.wireless_device_log_options[0].events[0].event #=> String, one of "Join", "Rejoin", "Uplink_Data", "Downlink_Data", "Registration"
resp.wireless_device_log_options[0].events[0].log_level #=> String, one of "INFO", "ERROR", "DISABLED"
resp.fuota_task_log_options #=> Array
resp.fuota_task_log_options[0].type #=> String, one of "LoRaWAN"
resp.fuota_task_log_options[0].log_level #=> String, one of "INFO", "ERROR", "DISABLED"
resp.fuota_task_log_options[0].events #=> Array
resp.fuota_task_log_options[0].events[0].event #=> String, one of "Fuota"
resp.fuota_task_log_options[0].events[0].log_level #=> String, one of "INFO", "ERROR", "DISABLED"

Parameters:

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

    ({})

Returns:



2228
2229
2230
2231
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2228

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

#get_metric_configuration(params = {}) ⇒ Types::GetMetricConfigurationResponse

Get the metric configuration status for this AWS account.

Examples:

Response structure


resp.summary_metric.status #=> String, one of "Enabled", "Disabled"

Parameters:

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

    ({})

Returns:



2245
2246
2247
2248
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2245

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

#get_metrics(params = {}) ⇒ Types::GetMetricsResponse

Get the summary metrics for this AWS account.

Examples:

Request syntax with placeholder values


resp = client.get_metrics({
  summary_metric_queries: [
    {
      query_id: "MetricQueryId",
      metric_name: "DeviceRSSI", # accepts DeviceRSSI, DeviceSNR, DeviceRoamingRSSI, DeviceRoamingSNR, DeviceUplinkCount, DeviceDownlinkCount, DeviceUplinkLostCount, DeviceUplinkLostRate, DeviceJoinRequestCount, DeviceJoinAcceptCount, DeviceRoamingUplinkCount, DeviceRoamingDownlinkCount, GatewayUpTime, GatewayDownTime, GatewayRSSI, GatewaySNR, GatewayUplinkCount, GatewayDownlinkCount, GatewayJoinRequestCount, GatewayJoinAcceptCount, AwsAccountUplinkCount, AwsAccountDownlinkCount, AwsAccountUplinkLostCount, AwsAccountUplinkLostRate, AwsAccountJoinRequestCount, AwsAccountJoinAcceptCount, AwsAccountRoamingUplinkCount, AwsAccountRoamingDownlinkCount, AwsAccountDeviceCount, AwsAccountGatewayCount, AwsAccountActiveDeviceCount, AwsAccountActiveGatewayCount
      dimensions: [
        {
          name: "DeviceId", # accepts DeviceId, GatewayId
          value: "DimensionValue",
        },
      ],
      aggregation_period: "OneHour", # accepts OneHour, OneDay, OneWeek
      start_timestamp: Time.now,
      end_timestamp: Time.now,
    },
  ],
})

Response structure


resp.summary_metric_query_results #=> Array
resp.summary_metric_query_results[0].query_id #=> String
resp.summary_metric_query_results[0].query_status #=> String, one of "Succeeded", "Failed"
resp.summary_metric_query_results[0].error #=> String
resp.summary_metric_query_results[0].metric_name #=> String, one of "DeviceRSSI", "DeviceSNR", "DeviceRoamingRSSI", "DeviceRoamingSNR", "DeviceUplinkCount", "DeviceDownlinkCount", "DeviceUplinkLostCount", "DeviceUplinkLostRate", "DeviceJoinRequestCount", "DeviceJoinAcceptCount", "DeviceRoamingUplinkCount", "DeviceRoamingDownlinkCount", "GatewayUpTime", "GatewayDownTime", "GatewayRSSI", "GatewaySNR", "GatewayUplinkCount", "GatewayDownlinkCount", "GatewayJoinRequestCount", "GatewayJoinAcceptCount", "AwsAccountUplinkCount", "AwsAccountDownlinkCount", "AwsAccountUplinkLostCount", "AwsAccountUplinkLostRate", "AwsAccountJoinRequestCount", "AwsAccountJoinAcceptCount", "AwsAccountRoamingUplinkCount", "AwsAccountRoamingDownlinkCount", "AwsAccountDeviceCount", "AwsAccountGatewayCount", "AwsAccountActiveDeviceCount", "AwsAccountActiveGatewayCount"
resp.summary_metric_query_results[0].dimensions #=> Array
resp.summary_metric_query_results[0].dimensions[0].name #=> String, one of "DeviceId", "GatewayId"
resp.summary_metric_query_results[0].dimensions[0].value #=> String
resp.summary_metric_query_results[0].aggregation_period #=> String, one of "OneHour", "OneDay", "OneWeek"
resp.summary_metric_query_results[0].start_timestamp #=> Time
resp.summary_metric_query_results[0].end_timestamp #=> Time
resp.summary_metric_query_results[0].timestamps #=> Array
resp.summary_metric_query_results[0].timestamps[0] #=> Time
resp.summary_metric_query_results[0].values #=> Array
resp.summary_metric_query_results[0].values[0].min #=> Float
resp.summary_metric_query_results[0].values[0].max #=> Float
resp.summary_metric_query_results[0].values[0].sum #=> Float
resp.summary_metric_query_results[0].values[0].avg #=> Float
resp.summary_metric_query_results[0].values[0].std #=> Float
resp.summary_metric_query_results[0].values[0].p90 #=> Float
resp.summary_metric_query_results[0].unit #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:



2305
2306
2307
2308
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2305

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

#get_multicast_group(params = {}) ⇒ Types::GetMulticastGroupResponse

Gets information about a multicast group.

Examples:

Request syntax with placeholder values


resp = client.get_multicast_group({
  id: "MulticastGroupId", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String
resp.lo_ra_wan.rf_region #=> String, one of "EU868", "US915", "AU915", "AS923-1", "AS923-2", "AS923-3", "AS923-4", "EU433", "CN470", "CN779", "RU864", "KR920", "IN865"
resp.lo_ra_wan.dl_class #=> String, one of "ClassB", "ClassC"
resp.lo_ra_wan.number_of_devices_requested #=> Integer
resp.lo_ra_wan.number_of_devices_in_group #=> Integer
resp.lo_ra_wan.participating_gateways.gateway_list #=> Array
resp.lo_ra_wan.participating_gateways.gateway_list[0] #=> String
resp.lo_ra_wan.participating_gateways.transmission_interval #=> Integer
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

Returns:



2349
2350
2351
2352
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2349

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

#get_multicast_group_session(params = {}) ⇒ Types::GetMulticastGroupSessionResponse

Gets information about a multicast group session.

Examples:

Request syntax with placeholder values


resp = client.get_multicast_group_session({
  id: "MulticastGroupId", # required
})

Response structure


resp.lo_ra_wan.dl_dr #=> Integer
resp.lo_ra_wan.dl_freq #=> Integer
resp.lo_ra_wan.session_start_time #=> Time
resp.lo_ra_wan.session_timeout #=> Integer
resp.lo_ra_wan.ping_slot_period #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

Returns:



2379
2380
2381
2382
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2379

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

#get_network_analyzer_configuration(params = {}) ⇒ Types::GetNetworkAnalyzerConfigurationResponse

Get network analyzer configuration.

Examples:

Request syntax with placeholder values


resp = client.get_network_analyzer_configuration({
  configuration_name: "NetworkAnalyzerConfigurationName", # required
})

Response structure


resp.trace_content.wireless_device_frame_info #=> String, one of "ENABLED", "DISABLED"
resp.trace_content.log_level #=> String, one of "INFO", "ERROR", "DISABLED"
resp.trace_content.multicast_frame_info #=> String, one of "ENABLED", "DISABLED"
resp.wireless_devices #=> Array
resp.wireless_devices[0] #=> String
resp.wireless_gateways #=> Array
resp.wireless_gateways[0] #=> String
resp.description #=> String
resp.arn #=> String
resp.name #=> String
resp.multicast_groups #=> Array
resp.multicast_groups[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :configuration_name (required, String) —

    Name of the network analyzer configuration.

Returns:



2422
2423
2424
2425
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2422

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

#get_partner_account(params = {}) ⇒ Types::GetPartnerAccountResponse

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

Examples:

Request syntax with placeholder values


resp = client.({
  partner_account_id: "PartnerAccountId", # required
  partner_type: "Sidewalk", # required, accepts Sidewalk
})

Response structure


resp.sidewalk.amazon_id #=> String
resp.sidewalk.fingerprint #=> String
resp.sidewalk.arn #=> String
resp. #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :partner_account_id (required, String) —

    The partner account ID to disassociate from the AWS account.

  • :partner_type (required, String) —

    The partner type.

Returns:



2457
2458
2459
2460
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2457

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

#get_position(params = {}) ⇒ Types::GetPositionResponse

Get the position information for a given resource.

This action is no longer supported. Calls to retrieve the position information should use the GetResourcePosition API operation instead.

Examples:

Request syntax with placeholder values


resp = client.get_position({
  resource_identifier: "PositionResourceIdentifier", # required
  resource_type: "WirelessDevice", # required, accepts WirelessDevice, WirelessGateway
})

Response structure


resp.position #=> Array
resp.position[0] #=> Float
resp.accuracy.horizontal_accuracy #=> Float
resp.accuracy.vertical_accuracy #=> Float
resp.solver_type #=> String, one of "GNSS"
resp.solver_provider #=> String, one of "Semtech"
resp.solver_version #=> String
resp.timestamp #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_identifier (required, String) —

    Resource identifier used to retrieve the position information.

  • :resource_type (required, String) —

    Resource type of the resource for which position information is retrieved.

Returns:



2508
2509
2510
2511
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2508

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

#get_position_configuration(params = {}) ⇒ Types::GetPositionConfigurationResponse

Get position configuration for a given resource.

This action is no longer supported. Calls to retrieve the position configuration should use the GetResourcePosition API operation instead.

Examples:

Request syntax with placeholder values


resp = client.get_position_configuration({
  resource_identifier: "PositionResourceIdentifier", # required
  resource_type: "WirelessDevice", # required, accepts WirelessDevice, WirelessGateway
})

Response structure


resp.solvers.semtech_gnss.provider #=> String, one of "Semtech"
resp.solvers.semtech_gnss.type #=> String, one of "GNSS"
resp.solvers.semtech_gnss.status #=> String, one of "Enabled", "Disabled"
resp.solvers.semtech_gnss.fec #=> String, one of "ROSE", "NONE"
resp.destination #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_identifier (required, String) —

    Resource identifier used in a position configuration.

  • :resource_type (required, String) —

    Resource type of the resource for which position configuration is retrieved.

Returns:



2552
2553
2554
2555
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2552

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

#get_position_estimate(params = {}) ⇒ Types::GetPositionEstimateResponse

Get estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party vendors.

Examples:

Request syntax with placeholder values


resp = client.get_position_estimate({
  wi_fi_access_points: [
    {
      mac_address: "MacAddress", # required
      rss: 1, # required
    },
  ],
  cell_towers: {
    gsm: [
      {
        mcc: 1, # required
        mnc: 1, # required
        lac: 1, # required
        geran_cid: 1, # required
        gsm_local_id: {
          bsic: 1, # required
          bcch: 1, # required
        },
        gsm_timing_advance: 1,
        rx_level: 1,
        gsm_nmr: [
          {
            bsic: 1, # required
            bcch: 1, # required
            rx_level: 1,
            global_identity: {
              lac: 1, # required
              geran_cid: 1, # required
            },
          },
        ],
      },
    ],
    wcdma: [
      {
        mcc: 1, # required
        mnc: 1, # required
        lac: 1,
        utran_cid: 1, # required
        wcdma_local_id: {
          uarfcndl: 1, # required
          psc: 1, # required
        },
        rscp: 1,
        path_loss: 1,
        wcdma_nmr: [
          {
            uarfcndl: 1, # required
            psc: 1, # required
            utran_cid: 1, # required
            rscp: 1,
            path_loss: 1,
          },
        ],
      },
    ],
    tdscdma: [
      {
        mcc: 1, # required
        mnc: 1, # required
        lac: 1,
        utran_cid: 1, # required
        tdscdma_local_id: {
          uarfcn: 1, # required
          cell_params: 1, # required
        },
        tdscdma_timing_advance: 1,
        rscp: 1,
        path_loss: 1,
        tdscdma_nmr: [
          {
            uarfcn: 1, # required
            cell_params: 1, # required
            utran_cid: 1,
            rscp: 1,
            path_loss: 1,
          },
        ],
      },
    ],
    lte: [
      {
        mcc: 1, # required
        mnc: 1, # required
        eutran_cid: 1, # required
        tac: 1,
        lte_local_id: {
          pci: 1, # required
          earfcn: 1, # required
        },
        lte_timing_advance: 1,
        rsrp: 1,
        rsrq: 1.0,
        nr_capable: false,
        lte_nmr: [
          {
            pci: 1, # required
            earfcn: 1, # required
            eutran_cid: 1,
            rsrp: 1,
            rsrq: 1.0,
          },
        ],
      },
    ],
    cdma: [
      {
        system_id: 1, # required
        network_id: 1, # required
        base_station_id: 1, # required
        registration_zone: 1,
        cdma_local_id: {
          pn_offset: 1, # required
          cdma_channel: 1, # required
        },
        pilot_power: 1,
        base_lat: 1.0,
        base_lng: 1.0,
        cdma_nmr: [
          {
            pn_offset: 1, # required
            cdma_channel: 1, # required
            pilot_power: 1,
            base_station_id: 1,
          },
        ],
      },
    ],
  },
  ip: {
    ip_address: "IPAddress", # required
  },
  gnss: {
    payload: "GnssNav", # required
    capture_time: 1.0,
    capture_time_accuracy: 1.0,
    assist_position: [1.0],
    assist_altitude: 1.0,
    use_2_d_solver: false,
  },
  timestamp: Time.now,
})

Response structure


resp.geo_json_payload #=> IO

Parameters:

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

    ({})

Options Hash (params):

  • :wi_fi_access_points (Array<Types::WiFiAccessPoint>) —

    Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.

  • :cell_towers (Types::CellTowers) —

    Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.

  • :ip (Types::Ip) —

    Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.

  • :gnss (Types::Gnss) —

    Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa Cloud.

  • :timestamp (Time, DateTime, Date, Integer, String) —

    Optional information that specifies the time when the position information will be resolved. It uses the Unix timestamp format. If not specified, the time at which the request was received will be used.

Returns:



2741
2742
2743
2744
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2741

def get_position_estimate(params = {}, options = {}, &block)
  req = build_request(:get_position_estimate, params)
  req.send_request(options, &block)
end

#get_resource_event_configuration(params = {}) ⇒ Types::GetResourceEventConfigurationResponse

Get the event configuration for a particular resource identifier.

Examples:

Request syntax with placeholder values


resp = client.get_resource_event_configuration({
  identifier: "Identifier", # required
  identifier_type: "PartnerAccountId", # required, accepts PartnerAccountId, DevEui, GatewayEui, WirelessDeviceId, WirelessGatewayId
  partner_type: "Sidewalk", # accepts Sidewalk
})

Response structure


resp.device_registration_state.sidewalk.amazon_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.device_registration_state.wireless_device_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.proximity.sidewalk.amazon_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.proximity.wireless_device_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.join.lo_ra_wan.dev_eui_event_topic #=> String, one of "Enabled", "Disabled"
resp.join.wireless_device_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.connection_status.lo_ra_wan.gateway_eui_event_topic #=> String, one of "Enabled", "Disabled"
resp.connection_status.wireless_gateway_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.message_delivery_status.sidewalk.amazon_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.message_delivery_status.wireless_device_id_event_topic #=> String, one of "Enabled", "Disabled"

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    Resource identifier to opt in for event messaging.

  • :identifier_type (required, String) —

    Identifier type of the particular resource identifier for event configuration.

  • :partner_type (String) —

    Partner type of the resource if the identifier type is PartnerAccountId.

Returns:



2790
2791
2792
2793
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2790

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

#get_resource_log_level(params = {}) ⇒ Types::GetResourceLogLevelResponse

Fetches the log-level override, if any, for a given resource ID and resource type..

Examples:

Request syntax with placeholder values


resp = client.get_resource_log_level({
  resource_identifier: "ResourceIdentifier", # required
  resource_type: "ResourceType", # required
})

Response structure


resp.log_level #=> String, one of "INFO", "ERROR", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :resource_identifier (required, String) —

    The unique identifier of the resource, which can be the wireless gateway ID, the wireless device ID, or the FUOTA task ID.

  • :resource_type (required, String) —

    The type of resource, which can be WirelessDevice, WirelessGateway, or FuotaTask.

Returns:



2823
2824
2825
2826
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2823

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

#get_resource_position(params = {}) ⇒ Types::GetResourcePositionResponse

Get the position information for a given wireless device or a wireless gateway resource. The position information uses the World Geodetic System (WGS84).

Examples:

Request syntax with placeholder values


resp = client.get_resource_position({
  resource_identifier: "PositionResourceIdentifier", # required
  resource_type: "WirelessDevice", # required, accepts WirelessDevice, WirelessGateway
})

Response structure


resp.geo_json_payload #=> IO

Parameters:

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

    ({})

Options Hash (params):

  • :resource_identifier (required, String) —

    The identifier of the resource for which position information is retrieved. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.

  • :resource_type (required, String) —

    The type of resource for which position information is retrieved, which can be a wireless device or a wireless gateway.

Returns:



2862
2863
2864
2865
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2862

def get_resource_position(params = {}, options = {}, &block)
  req = build_request(:get_resource_position, params)
  req.send_request(options, &block)
end

#get_service_endpoint(params = {}) ⇒ Types::GetServiceEndpointResponse

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

Examples:

Request syntax with placeholder values


resp = client.get_service_endpoint({
  service_type: "CUPS", # accepts CUPS, LNS
})

Response structure


resp.service_type #=> String, one of "CUPS", "LNS"
resp.service_endpoint #=> String
resp.server_trust #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_type (String) —

    The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint.

Returns:



2895
2896
2897
2898
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2895

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

#get_service_profile(params = {}) ⇒ Types::GetServiceProfileResponse

Gets information about a service profile.

Examples:

Request syntax with placeholder values


resp = client.get_service_profile({
  id: "ServiceProfileId", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.id #=> String
resp.lo_ra_wan.ul_rate #=> Integer
resp.lo_ra_wan.ul_bucket_size #=> Integer
resp.lo_ra_wan.ul_rate_policy #=> String
resp.lo_ra_wan.dl_rate #=> Integer
resp.lo_ra_wan.dl_bucket_size #=> Integer
resp.lo_ra_wan.dl_rate_policy #=> String
resp.lo_ra_wan.add_gw_metadata #=> Boolean
resp.lo_ra_wan.dev_status_req_freq #=> Integer
resp.lo_ra_wan.report_dev_status_battery #=> Boolean
resp.lo_ra_wan.report_dev_status_margin #=> Boolean
resp.lo_ra_wan.dr_min #=> Integer
resp.lo_ra_wan.dr_max #=> Integer
resp.lo_ra_wan.channel_mask #=> String
resp.lo_ra_wan.pr_allowed #=> Boolean
resp.lo_ra_wan.hr_allowed #=> Boolean
resp.lo_ra_wan.ra_allowed #=> Boolean
resp.lo_ra_wan.nwk_geo_loc #=> Boolean
resp.lo_ra_wan.target_per #=> Integer
resp.lo_ra_wan.min_gw_diversity #=> Integer
resp.lo_ra_wan.tx_power_index_min #=> Integer
resp.lo_ra_wan.tx_power_index_max #=> Integer
resp.lo_ra_wan.nb_trans_min #=> Integer
resp.lo_ra_wan.nb_trans_max #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to get.

Returns:



2949
2950
2951
2952
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2949

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

#get_wireless_device(params = {}) ⇒ Types::GetWirelessDeviceResponse

Gets information about a wireless device.

Examples:

Request syntax with placeholder values


resp = client.get_wireless_device({
  identifier: "Identifier", # required
  identifier_type: "WirelessDeviceId", # required, accepts WirelessDeviceId, DevEui, ThingName, SidewalkManufacturingSn
})

Response structure


resp.type #=> String, one of "Sidewalk", "LoRaWAN"
resp.name #=> String
resp.description #=> String
resp.destination_name #=> String
resp.id #=> String
resp.arn #=> String
resp.thing_name #=> String
resp.thing_arn #=> String
resp.lo_ra_wan.dev_eui #=> String
resp.lo_ra_wan.device_profile_id #=> String
resp.lo_ra_wan.service_profile_id #=> String
resp.lo_ra_wan.otaa_v1_1.app_key #=> String
resp.lo_ra_wan.otaa_v1_1.nwk_key #=> String
resp.lo_ra_wan.otaa_v1_1.join_eui #=> String
resp.lo_ra_wan.otaa_v1_0_x.app_key #=> String
resp.lo_ra_wan.otaa_v1_0_x.app_eui #=> String
resp.lo_ra_wan.otaa_v1_0_x.join_eui #=> String
resp.lo_ra_wan.otaa_v1_0_x.gen_app_key #=> String
resp.lo_ra_wan.abp_v1_1.dev_addr #=> String
resp.lo_ra_wan.abp_v1_1.session_keys.f_nwk_s_int_key #=> String
resp.lo_ra_wan.abp_v1_1.session_keys.s_nwk_s_int_key #=> String
resp.lo_ra_wan.abp_v1_1.session_keys.nwk_s_enc_key #=> String
resp.lo_ra_wan.abp_v1_1.session_keys.app_s_key #=> String
resp.lo_ra_wan.abp_v1_1.f_cnt_start #=> Integer
resp.lo_ra_wan.abp_v1_0_x.dev_addr #=> String
resp.lo_ra_wan.abp_v1_0_x.session_keys.nwk_s_key #=> String
resp.lo_ra_wan.abp_v1_0_x.session_keys.app_s_key #=> String
resp.lo_ra_wan.abp_v1_0_x.f_cnt_start #=> Integer
resp.lo_ra_wan.f_ports.fuota #=> Integer
resp.lo_ra_wan.f_ports.multicast #=> Integer
resp.lo_ra_wan.f_ports.clock_sync #=> Integer
resp.lo_ra_wan.f_ports.positioning.clock_sync #=> Integer
resp.lo_ra_wan.f_ports.positioning.stream #=> Integer
resp.lo_ra_wan.f_ports.positioning.gnss #=> Integer
resp.lo_ra_wan.f_ports.applications #=> Array
resp.lo_ra_wan.f_ports.applications[0].f_port #=> Integer
resp.lo_ra_wan.f_ports.applications[0].type #=> String, one of "SemtechGeolocation"
resp.lo_ra_wan.f_ports.applications[0].destination_name #=> String
resp.sidewalk.amazon_id #=> String
resp.sidewalk.sidewalk_id #=> String
resp.sidewalk.sidewalk_manufacturing_sn #=> String
resp.sidewalk.device_certificates #=> Array
resp.sidewalk.device_certificates[0].signing_alg #=> String, one of "Ed25519", "P256r1"
resp.sidewalk.device_certificates[0].value #=> String
resp.sidewalk.private_keys #=> Array
resp.sidewalk.private_keys[0].signing_alg #=> String, one of "Ed25519", "P256r1"
resp.sidewalk.private_keys[0].value #=> String
resp.sidewalk.device_profile_id #=> String
resp.sidewalk.certificate_id #=> String
resp.sidewalk.status #=> String, one of "PROVISIONED", "REGISTERED", "ACTIVATED", "UNKNOWN"
resp.positioning #=> String, one of "Enabled", "Disabled"

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the wireless device to get.

  • :identifier_type (required, String) —

    The type of identifier used in identifier.

Returns:



3039
3040
3041
3042
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3039

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

#get_wireless_device_import_task(params = {}) ⇒ Types::GetWirelessDeviceImportTaskResponse

Get information about an import task and count of device onboarding summary information for the import task.

Examples:

Request syntax with placeholder values


resp = client.get_wireless_device_import_task({
  id: "ImportTaskId", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.destination_name #=> String
resp.sidewalk.device_creation_file_list #=> Array
resp.sidewalk.device_creation_file_list[0] #=> String
resp.sidewalk.role #=> String
resp.creation_time #=> Time
resp.status #=> String, one of "INITIALIZING", "INITIALIZED", "PENDING", "COMPLETE", "FAILED", "DELETING"
resp.status_reason #=> String
resp.initialized_imported_device_count #=> Integer
resp.pending_imported_device_count #=> Integer
resp.onboarded_imported_device_count #=> Integer
resp.failed_imported_device_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The identifier of the import task for which information is requested.

Returns:



3088
3089
3090
3091
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3088

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

#get_wireless_device_statistics(params = {}) ⇒ Types::GetWirelessDeviceStatisticsResponse

Gets operating information about a wireless device.

Examples:

Request syntax with placeholder values


resp = client.get_wireless_device_statistics({
  wireless_device_id: "WirelessDeviceId", # required
})

Response structure


resp.wireless_device_id #=> String
resp.last_uplink_received_at #=> String
resp.lo_ra_wan.dev_eui #=> String
resp.lo_ra_wan.f_port #=> Integer
resp.lo_ra_wan.data_rate #=> Integer
resp.lo_ra_wan.frequency #=> Integer
resp.lo_ra_wan.timestamp #=> String
resp.lo_ra_wan.gateways #=> Array
resp.lo_ra_wan.gateways[0].gateway_eui #=> String
resp.lo_ra_wan.gateways[0].snr #=> Float
resp.lo_ra_wan.gateways[0].rssi #=> Float
resp.lo_ra_wan.public_gateways #=> Array
resp.lo_ra_wan.public_gateways[0].provider_net_id #=> String
resp.lo_ra_wan.public_gateways[0].id #=> String
resp.lo_ra_wan.public_gateways[0].rssi #=> Float
resp.lo_ra_wan.public_gateways[0].snr #=> Float
resp.lo_ra_wan.public_gateways[0].rf_region #=> String
resp.lo_ra_wan.public_gateways[0].dl_allowed #=> Boolean
resp.sidewalk.rssi #=> Integer
resp.sidewalk.battery_level #=> String, one of "normal", "low", "critical"
resp.sidewalk.event #=> String, one of "discovered", "lost", "ack", "nack", "passthrough"
resp.sidewalk.device_state #=> String, one of "Provisioned", "RegisteredNotSeen", "RegisteredReachable", "RegisteredUnreachable"

Parameters:

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

    ({})

Options Hash (params):

  • :wireless_device_id (required, String) —

    The ID of the wireless device for which to get the data.

Returns:



3138
3139
3140
3141
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3138

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

#get_wireless_gateway(params = {}) ⇒ Types::GetWirelessGatewayResponse

Gets information about a wireless gateway.

Examples:

Request syntax with placeholder values


resp = client.get_wireless_gateway({
  identifier: "Identifier", # required
  identifier_type: "GatewayEui", # required, accepts GatewayEui, WirelessGatewayId, ThingName
})

Response structure


resp.name #=> String
resp.id #=> String
resp.description #=> String
resp.lo_ra_wan.gateway_eui #=> String
resp.lo_ra_wan.rf_region #=> String
resp.lo_ra_wan.join_eui_filters #=> Array
resp.lo_ra_wan.join_eui_filters[0] #=> Array
resp.lo_ra_wan.join_eui_filters[0][0] #=> String
resp.lo_ra_wan.net_id_filters #=> Array
resp.lo_ra_wan.net_id_filters[0] #=> String
resp.lo_ra_wan.sub_bands #=> Array
resp.lo_ra_wan.sub_bands[0] #=> Integer
resp.lo_ra_wan.beaconing.data_rate #=> Integer
resp.lo_ra_wan.beaconing.frequencies #=> Array
resp.lo_ra_wan.beaconing.frequencies[0] #=> Integer
resp.lo_ra_wan.max_eirp #=> Float
resp.arn #=> String
resp.thing_name #=> String
resp.thing_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the wireless gateway to get.

  • :identifier_type (required, String) —

    The type of identifier used in identifier.

Returns:



3192
3193
3194
3195
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3192

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

#get_wireless_gateway_certificate(params = {}) ⇒ Types::GetWirelessGatewayCertificateResponse

Gets the ID of the certificate that is currently associated with a wireless gateway.

Examples:

Request syntax with placeholder values


resp = client.get_wireless_gateway_certificate({
  id: "WirelessGatewayId", # required
})

Response structure


resp.iot_certificate_id #=> String
resp.lo_ra_wan_network_server_certificate_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to get.

Returns:



3221
3222
3223
3224
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3221

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

#get_wireless_gateway_firmware_information(params = {}) ⇒ Types::GetWirelessGatewayFirmwareInformationResponse

Gets the firmware version and other information about a wireless gateway.

Examples:

Request syntax with placeholder values


resp = client.get_wireless_gateway_firmware_information({
  id: "WirelessGatewayId", # required
})

Response structure


resp.lo_ra_wan.current_version.package_version #=> String
resp.lo_ra_wan.current_version.model #=> String
resp.lo_ra_wan.current_version.station #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to get.

Returns:



3250
3251
3252
3253
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3250

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

#get_wireless_gateway_statistics(params = {}) ⇒ Types::GetWirelessGatewayStatisticsResponse

Gets operating information about a wireless gateway.

Examples:

Request syntax with placeholder values


resp = client.get_wireless_gateway_statistics({
  wireless_gateway_id: "WirelessGatewayId", # required
})

Response structure


resp.wireless_gateway_id #=> String
resp.last_uplink_received_at #=> String
resp.connection_status #=> String, one of "Connected", "Disconnected"

Parameters:

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

    ({})

Options Hash (params):

  • :wireless_gateway_id (required, String) —

    The ID of the wireless gateway for which to get the data.

Returns:



3280
3281
3282
3283
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3280

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

#get_wireless_gateway_task(params = {}) ⇒ Types::GetWirelessGatewayTaskResponse

Gets information about a wireless gateway task.

Examples:

Request syntax with placeholder values


resp = client.get_wireless_gateway_task({
  id: "WirelessGatewayId", # required
})

Response structure


resp.wireless_gateway_id #=> String
resp.wireless_gateway_task_definition_id #=> String
resp.last_uplink_received_at #=> String
resp.task_created_at #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "FIRST_RETRY", "SECOND_RETRY", "COMPLETED", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to get.

Returns:



3314
3315
3316
3317
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3314

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

#get_wireless_gateway_task_definition(params = {}) ⇒ Types::GetWirelessGatewayTaskDefinitionResponse

Gets information about a wireless gateway task definition.

Examples:

Request syntax with placeholder values


resp = client.get_wireless_gateway_task_definition({
  id: "WirelessGatewayTaskDefinitionId", # required
})

Response structure


resp.auto_create_tasks #=> Boolean
resp.name #=> String
resp.update.update_data_source #=> String
resp.update.update_data_role #=> String
resp.update.lo_ra_wan.update_signature #=> String
resp.update.lo_ra_wan.sig_key_crc #=> Integer
resp.update.lo_ra_wan.current_version.package_version #=> String
resp.update.lo_ra_wan.current_version.model #=> String
resp.update.lo_ra_wan.current_version.station #=> String
resp.update.lo_ra_wan.update_version.package_version #=> String
resp.update.lo_ra_wan.update_version.model #=> String
resp.update.lo_ra_wan.update_version.station #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to get.

Returns:



3355
3356
3357
3358
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3355

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

#list_destinations(params = {}) ⇒ Types::ListDestinationsResponse

Lists the destinations registered to your AWS account.

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_destinations({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.destination_list #=> Array
resp.destination_list[0].arn #=> String
resp.destination_list[0].name #=> String
resp.destination_list[0].expression_type #=> String, one of "RuleName", "MqttTopic"
resp.destination_list[0].expression #=> String
resp.destination_list[0].description #=> String
resp.destination_list[0].role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in this operation.

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

Returns:



3397
3398
3399
3400
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3397

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

#list_device_profiles(params = {}) ⇒ Types::ListDeviceProfilesResponse

Lists the device profiles registered to your AWS account.

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_device_profiles({
  next_token: "NextToken",
  max_results: 1,
  device_profile_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
})

Response structure


resp.next_token #=> String
resp.device_profile_list #=> Array
resp.device_profile_list[0].arn #=> String
resp.device_profile_list[0].name #=> String
resp.device_profile_list[0].id #=> 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 in this operation.

  • :device_profile_type (String) —

    A filter to list only device profiles that use this type, which can be LoRaWAN or Sidewalk.

Returns:



3441
3442
3443
3444
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3441

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

#list_devices_for_wireless_device_import_task(params = {}) ⇒ Types::ListDevicesForWirelessDeviceImportTaskResponse

List the Sidewalk devices in an import task and their onboarding status.

Examples:

Request syntax with placeholder values


resp = client.list_devices_for_wireless_device_import_task({
  id: "ImportTaskId", # required
  max_results: 1,
  next_token: "NextToken",
  status: "INITIALIZED", # accepts INITIALIZED, PENDING, ONBOARDED, FAILED
})

Response structure


resp.next_token #=> String
resp.destination_name #=> String
resp.imported_wireless_device_list #=> Array
resp.imported_wireless_device_list[0].sidewalk.sidewalk_manufacturing_sn #=> String
resp.imported_wireless_device_list[0].sidewalk.onboarding_status #=> String, one of "INITIALIZED", "PENDING", "ONBOARDED", "FAILED"
resp.imported_wireless_device_list[0].sidewalk.onboarding_status_reason #=> String
resp.imported_wireless_device_list[0].sidewalk.last_update_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The identifier of the import task for which wireless devices are listed.

  • :max_results (Integer) —

    The maximum number of results to return in this operation.

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

  • :status (String) —

    The status of the devices in the import task.

Returns:



3491
3492
3493
3494
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3491

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

#list_event_configurations(params = {}) ⇒ Types::ListEventConfigurationsResponse

List event configurations where at least one event topic has been enabled.

Examples:

Request syntax with placeholder values


resp = client.list_event_configurations({
  resource_type: "SidewalkAccount", # required, accepts SidewalkAccount, WirelessDevice, WirelessGateway
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.event_configurations_list #=> Array
resp.event_configurations_list[0].identifier #=> String
resp.event_configurations_list[0].identifier_type #=> String, one of "PartnerAccountId", "DevEui", "GatewayEui", "WirelessDeviceId", "WirelessGatewayId"
resp.event_configurations_list[0].partner_type #=> String, one of "Sidewalk"
resp.event_configurations_list[0].events.device_registration_state.sidewalk.amazon_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.event_configurations_list[0].events.device_registration_state.wireless_device_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.event_configurations_list[0].events.proximity.sidewalk.amazon_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.event_configurations_list[0].events.proximity.wireless_device_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.event_configurations_list[0].events.join.lo_ra_wan.dev_eui_event_topic #=> String, one of "Enabled", "Disabled"
resp.event_configurations_list[0].events.join.wireless_device_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.event_configurations_list[0].events.connection_status.lo_ra_wan.gateway_eui_event_topic #=> String, one of "Enabled", "Disabled"
resp.event_configurations_list[0].events.connection_status.wireless_gateway_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.event_configurations_list[0].events.message_delivery_status.sidewalk.amazon_id_event_topic #=> String, one of "Enabled", "Disabled"
resp.event_configurations_list[0].events.message_delivery_status.wireless_device_id_event_topic #=> String, one of "Enabled", "Disabled"

Parameters:

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

    ({})

Options Hash (params):

  • :resource_type (required, String) —

    Resource type to filter event configurations.

  • :max_results (Integer) —

    The maximum number of results to return in this operation.

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

Returns:



3543
3544
3545
3546
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3543

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

#list_fuota_tasks(params = {}) ⇒ Types::ListFuotaTasksResponse

Lists the FUOTA tasks registered to your AWS account.

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_fuota_tasks({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.fuota_task_list #=> Array
resp.fuota_task_list[0].id #=> String
resp.fuota_task_list[0].arn #=> String
resp.fuota_task_list[0].name #=> 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 in this operation.

Returns:



3582
3583
3584
3585
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3582

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

#list_multicast_groups(params = {}) ⇒ Types::ListMulticastGroupsResponse

Lists the multicast groups registered to your AWS account.

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_multicast_groups({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.multicast_group_list #=> Array
resp.multicast_group_list[0].id #=> String
resp.multicast_group_list[0].arn #=> String
resp.multicast_group_list[0].name #=> 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 in this operation.

Returns:



3621
3622
3623
3624
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3621

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

#list_multicast_groups_by_fuota_task(params = {}) ⇒ Types::ListMulticastGroupsByFuotaTaskResponse

List all multicast groups associated with a FUOTA task.

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_multicast_groups_by_fuota_task({
  id: "FuotaTaskId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.multicast_group_list #=> Array
resp.multicast_group_list[0].id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a FUOTA task.

  • :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 in this operation.

Returns:



3662
3663
3664
3665
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3662

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

#list_network_analyzer_configurations(params = {}) ⇒ Types::ListNetworkAnalyzerConfigurationsResponse

Lists the network analyzer configurations.

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_network_analyzer_configurations({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.network_analyzer_configuration_list #=> Array
resp.network_analyzer_configuration_list[0].arn #=> String
resp.network_analyzer_configuration_list[0].name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in this operation.

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

Returns:



3700
3701
3702
3703
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3700

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

#list_partner_accounts(params = {}) ⇒ Types::ListPartnerAccountsResponse

Lists the partner accounts associated with your AWS account.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.sidewalk #=> Array
resp.sidewalk[0].amazon_id #=> String
resp.sidewalk[0].fingerprint #=> String
resp.sidewalk[0].arn #=> 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 in this operation.

Returns:



3737
3738
3739
3740
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3737

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

#list_position_configurations(params = {}) ⇒ Types::ListPositionConfigurationsResponse

List position configurations for a given resource, such as positioning solvers.

This action is no longer supported. Calls to retrieve position information should use the GetResourcePosition API operation instead.

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_position_configurations({
  resource_type: "WirelessDevice", # accepts WirelessDevice, WirelessGateway
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.position_configuration_list #=> Array
resp.position_configuration_list[0].resource_identifier #=> String
resp.position_configuration_list[0].resource_type #=> String, one of "WirelessDevice", "WirelessGateway"
resp.position_configuration_list[0].solvers.semtech_gnss.provider #=> String, one of "Semtech"
resp.position_configuration_list[0].solvers.semtech_gnss.type #=> String, one of "GNSS"
resp.position_configuration_list[0].solvers.semtech_gnss.status #=> String, one of "Enabled", "Disabled"
resp.position_configuration_list[0].solvers.semtech_gnss.fec #=> String, one of "ROSE", "NONE"
resp.position_configuration_list[0].destination #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_type (String) —

    Resource type for which position configurations are listed.

  • :max_results (Integer) —

    The maximum number of results to return in this operation.

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

Returns:



3793
3794
3795
3796
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3793

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

#list_queued_messages(params = {}) ⇒ Types::ListQueuedMessagesResponse

List queued messages in the downlink queue.

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_queued_messages({
  id: "WirelessDeviceId", # required
  next_token: "NextToken",
  max_results: 1,
  wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
})

Response structure


resp.next_token #=> String
resp.downlink_queue_messages_list #=> Array
resp.downlink_queue_messages_list[0].message_id #=> String
resp.downlink_queue_messages_list[0].transmit_mode #=> Integer
resp.downlink_queue_messages_list[0].received_at #=> String
resp.downlink_queue_messages_list[0].lo_ra_wan.f_port #=> Integer
resp.downlink_queue_messages_list[0].lo_ra_wan.participating_gateways.downlink_mode #=> String, one of "SEQUENTIAL", "CONCURRENT", "USING_UPLINK_GATEWAY"
resp.downlink_queue_messages_list[0].lo_ra_wan.participating_gateways.gateway_list #=> Array
resp.downlink_queue_messages_list[0].lo_ra_wan.participating_gateways.gateway_list[0].gateway_id #=> String
resp.downlink_queue_messages_list[0].lo_ra_wan.participating_gateways.gateway_list[0].downlink_frequency #=> Integer
resp.downlink_queue_messages_list[0].lo_ra_wan.participating_gateways.transmission_interval #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a given wireless device which the downlink message packets are being sent.

  • :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 in this operation.

  • :wireless_device_type (String) —

    The wireless device type, whic can be either Sidewalk or LoRaWAN.

Returns:



3847
3848
3849
3850
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3847

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

#list_service_profiles(params = {}) ⇒ Types::ListServiceProfilesResponse

Lists the service profiles registered to your AWS account.

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_service_profiles({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.service_profile_list #=> Array
resp.service_profile_list[0].arn #=> String
resp.service_profile_list[0].name #=> String
resp.service_profile_list[0].id #=> 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 in this operation.

Returns:



3886
3887
3888
3889
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3886

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource for which you want to list tags.

Returns:



3914
3915
3916
3917
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3914

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

#list_wireless_device_import_tasks(params = {}) ⇒ Types::ListWirelessDeviceImportTasksResponse

List wireless devices that have been added to an import task.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.wireless_device_import_task_list #=> Array
resp.wireless_device_import_task_list[0].id #=> String
resp.wireless_device_import_task_list[0].arn #=> String
resp.wireless_device_import_task_list[0].destination_name #=> String
resp.wireless_device_import_task_list[0].sidewalk.device_creation_file_list #=> Array
resp.wireless_device_import_task_list[0].sidewalk.device_creation_file_list[0] #=> String
resp.wireless_device_import_task_list[0].sidewalk.role #=> String
resp.wireless_device_import_task_list[0].creation_time #=> Time
resp.wireless_device_import_task_list[0].status #=> String, one of "INITIALIZING", "INITIALIZED", "PENDING", "COMPLETE", "FAILED", "DELETING"
resp.wireless_device_import_task_list[0].status_reason #=> String
resp.wireless_device_import_task_list[0].initialized_imported_device_count #=> Integer
resp.wireless_device_import_task_list[0].pending_imported_device_count #=> Integer
resp.wireless_device_import_task_list[0].onboarded_imported_device_count #=> Integer
resp.wireless_device_import_task_list[0].failed_imported_device_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in this operation.

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

Returns:



3961
3962
3963
3964
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3961

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

#list_wireless_devices(params = {}) ⇒ Types::ListWirelessDevicesResponse

Lists the wireless devices registered to your AWS account.

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_wireless_devices({
  max_results: 1,
  next_token: "NextToken",
  destination_name: "DestinationName",
  device_profile_id: "DeviceProfileId",
  service_profile_id: "ServiceProfileId",
  wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
  fuota_task_id: "FuotaTaskId",
  multicast_group_id: "MulticastGroupId",
})

Response structure


resp.next_token #=> String
resp.wireless_device_list #=> Array
resp.wireless_device_list[0].arn #=> String
resp.wireless_device_list[0].id #=> String
resp.wireless_device_list[0].type #=> String, one of "Sidewalk", "LoRaWAN"
resp.wireless_device_list[0].name #=> String
resp.wireless_device_list[0].destination_name #=> String
resp.wireless_device_list[0].last_uplink_received_at #=> String
resp.wireless_device_list[0].lo_ra_wan.dev_eui #=> String
resp.wireless_device_list[0].sidewalk.amazon_id #=> String
resp.wireless_device_list[0].sidewalk.sidewalk_id #=> String
resp.wireless_device_list[0].sidewalk.sidewalk_manufacturing_sn #=> String
resp.wireless_device_list[0].sidewalk.device_certificates #=> Array
resp.wireless_device_list[0].sidewalk.device_certificates[0].signing_alg #=> String, one of "Ed25519", "P256r1"
resp.wireless_device_list[0].sidewalk.device_certificates[0].value #=> String
resp.wireless_device_list[0].sidewalk.device_profile_id #=> String
resp.wireless_device_list[0].sidewalk.status #=> String, one of "PROVISIONED", "REGISTERED", "ACTIVATED", "UNKNOWN"
resp.wireless_device_list[0].fuota_device_status #=> String, one of "Initial", "Package_Not_Supported", "FragAlgo_unsupported", "Not_enough_memory", "FragIndex_unsupported", "Wrong_descriptor", "SessionCnt_replay", "MissingFrag", "MemoryError", "MICError", "Successful", "Device_exist_in_conflict_fuota_task"
resp.wireless_device_list[0].multicast_device_status #=> String
resp.wireless_device_list[0].mc_group_id #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in this operation.

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

  • :destination_name (String) —

    A filter to list only the wireless devices that use this destination.

  • :device_profile_id (String) —

    A filter to list only the wireless devices that use this device profile.

  • :service_profile_id (String) —

    A filter to list only the wireless devices that use this service profile.

  • :wireless_device_type (String) —

    A filter to list only the wireless devices that use this wireless device type.

  • :fuota_task_id (String) —

    The ID of a FUOTA task.

  • :multicast_group_id (String) —

    The ID of the multicast group.

Returns:



4042
4043
4044
4045
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4042

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

#list_wireless_gateway_task_definitions(params = {}) ⇒ Types::ListWirelessGatewayTaskDefinitionsResponse

List the wireless gateway tasks definitions registered to your AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_wireless_gateway_task_definitions({
  max_results: 1,
  next_token: "NextToken",
  task_definition_type: "UPDATE", # accepts UPDATE
})

Response structure


resp.next_token #=> String
resp.task_definitions #=> Array
resp.task_definitions[0].id #=> String
resp.task_definitions[0].lo_ra_wan.current_version.package_version #=> String
resp.task_definitions[0].lo_ra_wan.current_version.model #=> String
resp.task_definitions[0].lo_ra_wan.current_version.station #=> String
resp.task_definitions[0].lo_ra_wan.update_version.package_version #=> String
resp.task_definitions[0].lo_ra_wan.update_version.model #=> String
resp.task_definitions[0].lo_ra_wan.update_version.station #=> String
resp.task_definitions[0].arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in this operation.

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

  • :task_definition_type (String) —

    A filter to list only the wireless gateway task definitions that use this task definition type.

Returns:



4090
4091
4092
4093
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4090

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

#list_wireless_gateways(params = {}) ⇒ Types::ListWirelessGatewaysResponse

Lists the wireless gateways registered to your AWS account.

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_wireless_gateways({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.wireless_gateway_list #=> Array
resp.wireless_gateway_list[0].arn #=> String
resp.wireless_gateway_list[0].id #=> String
resp.wireless_gateway_list[0].name #=> String
resp.wireless_gateway_list[0].description #=> String
resp.wireless_gateway_list[0].lo_ra_wan.gateway_eui #=> String
resp.wireless_gateway_list[0].lo_ra_wan.rf_region #=> String
resp.wireless_gateway_list[0].lo_ra_wan.join_eui_filters #=> Array
resp.wireless_gateway_list[0].lo_ra_wan.join_eui_filters[0] #=> Array
resp.wireless_gateway_list[0].lo_ra_wan.join_eui_filters[0][0] #=> String
resp.wireless_gateway_list[0].lo_ra_wan.net_id_filters #=> Array
resp.wireless_gateway_list[0].lo_ra_wan.net_id_filters[0] #=> String
resp.wireless_gateway_list[0].lo_ra_wan.sub_bands #=> Array
resp.wireless_gateway_list[0].lo_ra_wan.sub_bands[0] #=> Integer
resp.wireless_gateway_list[0].lo_ra_wan.beaconing.data_rate #=> Integer
resp.wireless_gateway_list[0].lo_ra_wan.beaconing.frequencies #=> Array
resp.wireless_gateway_list[0].lo_ra_wan.beaconing.frequencies[0] #=> Integer
resp.wireless_gateway_list[0].lo_ra_wan.max_eirp #=> Float
resp.wireless_gateway_list[0].last_uplink_received_at #=> 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 in this operation.

Returns:



4144
4145
4146
4147
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4144

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

#put_position_configuration(params = {}) ⇒ Struct

Put position configuration for a given resource.

This action is no longer supported. Calls to update the position configuration should use the UpdateResourcePosition API operation instead.

Examples:

Request syntax with placeholder values


resp = client.put_position_configuration({
  resource_identifier: "PositionResourceIdentifier", # required
  resource_type: "WirelessDevice", # required, accepts WirelessDevice, WirelessGateway
  solvers: {
    semtech_gnss: {
      status: "Enabled", # required, accepts Enabled, Disabled
      fec: "ROSE", # required, accepts ROSE, NONE
    },
  },
  destination: "DestinationName",
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_identifier (required, String) —

    Resource identifier used to update the position configuration.

  • :resource_type (required, String) —

    Resource type of the resource for which you want to update the position configuration.

  • :solvers (Types::PositionSolverConfigurations) —

    The positioning solvers used to update the position configuration of the resource.

  • :destination (String) —

    The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

Returns:

  • (Struct) —

    Returns an empty response.



4193
4194
4195
4196
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4193

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

#put_resource_log_level(params = {}) ⇒ Struct

Sets the log-level override for a resource ID and resource type. A limit of 200 log level override can be set per account.

Examples:

Request syntax with placeholder values


resp = client.put_resource_log_level({
  resource_identifier: "ResourceIdentifier", # required
  resource_type: "ResourceType", # required
  log_level: "INFO", # required, accepts INFO, ERROR, DISABLED
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_identifier (required, String) —

    The unique identifier of the resource, which can be the wireless gateway ID, the wireless device ID, or the FUOTA task ID.

  • :resource_type (required, String) —

    The type of resource, which can be WirelessDevice, WirelessGateway, or FuotaTask.

  • :log_level (required, String) —

    The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

Returns:

  • (Struct) —

    Returns an empty response.



4226
4227
4228
4229
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4226

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

#reset_all_resource_log_levels(params = {}) ⇒ Struct

Removes the log-level overrides for all resources; wireless devices, wireless gateways, and FUOTA tasks.

Parameters:

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

    ({})

Returns:

  • (Struct) —

    Returns an empty response.



4238
4239
4240
4241
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4238

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

#reset_resource_log_level(params = {}) ⇒ Struct

Removes the log-level override, if any, for a specific resource ID and resource type. It can be used for a wireless device, a wireless gateway, or a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.reset_resource_log_level({
  resource_identifier: "ResourceIdentifier", # required
  resource_type: "ResourceType", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_identifier (required, String) —

    The unique identifier of the resource, which can be the wireless gateway ID, the wireless device ID, or the FUOTA task ID.

  • :resource_type (required, String) —

    The type of resource, which can be WirelessDevice, WirelessGateway, or FuotaTask.

Returns:

  • (Struct) —

    Returns an empty response.



4266
4267
4268
4269
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4266

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

#send_data_to_multicast_group(params = {}) ⇒ Types::SendDataToMulticastGroupResponse

Sends the specified data to a multicast group.

Examples:

Request syntax with placeholder values


resp = client.send_data_to_multicast_group({
  id: "MulticastGroupId", # required
  payload_data: "PayloadData", # required
  wireless_metadata: { # required
    lo_ra_wan: {
      f_port: 1,
    },
  },
})

Response structure


resp.message_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

  • :payload_data (required, String) —

    The binary to be sent to the end device, encoded in base64.

  • :wireless_metadata (required, Types::MulticastWirelessMetadata) —

    Wireless metadata that is to be sent to multicast group.

Returns:



4304
4305
4306
4307
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4304

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

#send_data_to_wireless_device(params = {}) ⇒ Types::SendDataToWirelessDeviceResponse

Sends a decrypted application data frame to a device.

Examples:

Request syntax with placeholder values


resp = client.send_data_to_wireless_device({
  id: "WirelessDeviceId", # required
  transmit_mode: 1, # required
  payload_data: "PayloadData", # required
  wireless_metadata: {
    lo_ra_wan: {
      f_port: 1,
      participating_gateways: {
        downlink_mode: "SEQUENTIAL", # required, accepts SEQUENTIAL, CONCURRENT, USING_UPLINK_GATEWAY
        gateway_list: [ # required
          {
            gateway_id: "WirelessGatewayId", # required
            downlink_frequency: 1, # required
          },
        ],
        transmission_interval: 1, # required
      },
    },
    sidewalk: {
      seq: 1,
      message_type: "CUSTOM_COMMAND_ID_NOTIFY", # accepts CUSTOM_COMMAND_ID_NOTIFY, CUSTOM_COMMAND_ID_GET, CUSTOM_COMMAND_ID_SET, CUSTOM_COMMAND_ID_RESP
      ack_mode_retry_duration_secs: 1,
    },
  },
})

Response structure


resp.message_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the wireless device to receive the data.

  • :transmit_mode (required, Integer) —

    The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

  • :payload_data (required, String) —

    The binary to be sent to the end device, encoded in base64.

  • :wireless_metadata (Types::WirelessMetadata) —

    Metadata about the message request.

Returns:



4362
4363
4364
4365
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4362

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

#start_bulk_associate_wireless_device_with_multicast_group(params = {}) ⇒ Struct

Starts a bulk association of all qualifying wireless devices with a multicast group.

Examples:

Request syntax with placeholder values


resp = client.start_bulk_associate_wireless_device_with_multicast_group({
  id: "MulticastGroupId", # required
  query_string: "QueryString",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

  • :query_string (String) —

    Query string used to search for wireless devices as part of the bulk associate and disassociate process.

  • :tags (Array<Types::Tag>) —

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Returns:

  • (Struct) —

    Returns an empty response.



4398
4399
4400
4401
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4398

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

#start_bulk_disassociate_wireless_device_from_multicast_group(params = {}) ⇒ Struct

Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.

Examples:

Request syntax with placeholder values


resp = client.start_bulk_disassociate_wireless_device_from_multicast_group({
  id: "MulticastGroupId", # required
  query_string: "QueryString",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

  • :query_string (String) —

    Query string used to search for wireless devices as part of the bulk associate and disassociate process.

  • :tags (Array<Types::Tag>) —

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Returns:

  • (Struct) —

    Returns an empty response.



4434
4435
4436
4437
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4434

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

#start_fuota_task(params = {}) ⇒ Struct

Starts a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.start_fuota_task({
  id: "FuotaTaskId", # required
  lo_ra_wan: {
    start_time: Time.now,
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a FUOTA task.

  • :lo_ra_wan (Types::LoRaWANStartFuotaTask) —

    The LoRaWAN information used to start a FUOTA task.

Returns:

  • (Struct) —

    Returns an empty response.



4460
4461
4462
4463
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4460

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

#start_multicast_group_session(params = {}) ⇒ Struct

Starts a multicast group session.

Examples:

Request syntax with placeholder values


resp = client.start_multicast_group_session({
  id: "MulticastGroupId", # required
  lo_ra_wan: { # required
    dl_dr: 1,
    dl_freq: 1,
    session_start_time: Time.now,
    session_timeout: 1,
    ping_slot_period: 1,
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

  • :lo_ra_wan (required, Types::LoRaWANMulticastSession) —

    The LoRaWAN information used with the multicast session.

Returns:

  • (Struct) —

    Returns an empty response.



4490
4491
4492
4493
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4490

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

#start_single_wireless_device_import_task(params = {}) ⇒ Types::StartSingleWirelessDeviceImportTaskResponse

Start import task for a single wireless device.

Examples:

Request syntax with placeholder values


resp = client.start_single_wireless_device_import_task({
  destination_name: "DestinationName", # required
  client_request_token: "ClientRequestToken",
  device_name: "DeviceName",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  sidewalk: { # required
    sidewalk_manufacturing_sn: "SidewalkManufacturingSn",
  },
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :destination_name (required, String) —

    The name of the Sidewalk destination that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :device_name (String) —

    The name of the wireless device for which an import task is being started.

  • :tags (Array<Types::Tag>) —

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

  • :sidewalk (required, Types::SidewalkSingleStartImportInfo) —

    The Sidewalk-related parameters for importing a single wireless device.

Returns:



4561
4562
4563
4564
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4561

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

#start_wireless_device_import_task(params = {}) ⇒ Types::StartWirelessDeviceImportTaskResponse

Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.

Examples:

Request syntax with placeholder values


resp = client.start_wireless_device_import_task({
  destination_name: "DestinationName", # required
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  sidewalk: { # required
    device_creation_file: "DeviceCreationFile",
    role: "Role",
  },
})

Response structure


resp.id #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :destination_name (required, String) —

    The name of the Sidewalk destination that describes the IoT rule to route messages from the devices in the import task that are onboarded to AWS IoT Wireless.

  • :client_request_token (String) —

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>) —

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

  • :sidewalk (required, Types::SidewalkStartImportInfo) —

    The Sidewalk-related parameters for importing wireless devices that need to be provisioned in bulk.

Returns:



4629
4630
4631
4632
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4629

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

#tag_resource(params = {}) ⇒ Struct

Adds a tag to a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to add tags to.

  • :tags (required, Array<Types::Tag>) —

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

Returns:

  • (Struct) —

    Returns an empty response.



4659
4660
4661
4662
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4659

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

#test_wireless_device(params = {}) ⇒ Types::TestWirelessDeviceResponse

Simulates a provisioned device by sending an uplink data payload of Hello.

Examples:

Request syntax with placeholder values


resp = client.test_wireless_device({
  id: "WirelessDeviceId", # required
})

Response structure


resp.result #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the wireless device to test.

Returns:



4686
4687
4688
4689
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4686

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

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from a resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to remove tags from.

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

    A list of the keys of the tags to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.



4710
4711
4712
4713
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4710

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

#update_destination(params = {}) ⇒ Struct

Updates properties of a destination.

Examples:

Request syntax with placeholder values


resp = client.update_destination({
  name: "DestinationName", # required
  expression_type: "RuleName", # accepts RuleName, MqttTopic
  expression: "Expression",
  description: "Description",
  role_arn: "RoleArn",
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The new name of the resource.

  • :expression_type (String) —

    The type of value in Expression.

  • :expression (String) —

    The new rule name or topic rule to send messages to.

  • :description (String) —

    A new description of the resource.

  • :role_arn (String) —

    The ARN of the IAM Role that authorizes the destination.

Returns:

  • (Struct) —

    Returns an empty response.



4746
4747
4748
4749
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4746

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

#update_event_configuration_by_resource_types(params = {}) ⇒ Struct

Update the event configuration based on resource types.

Examples:

Request syntax with placeholder values


resp = client.update_event_configuration_by_resource_types({
  device_registration_state: {
    sidewalk: {
      wireless_device_event_topic: "Enabled", # accepts Enabled, Disabled
    },
  },
  proximity: {
    sidewalk: {
      wireless_device_event_topic: "Enabled", # accepts Enabled, Disabled
    },
  },
  join: {
    lo_ra_wan: {
      wireless_device_event_topic: "Enabled", # accepts Enabled, Disabled
    },
  },
  connection_status: {
    lo_ra_wan: {
      wireless_gateway_event_topic: "Enabled", # accepts Enabled, Disabled
    },
  },
  message_delivery_status: {
    sidewalk: {
      wireless_device_event_topic: "Enabled", # accepts Enabled, Disabled
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.



4807
4808
4809
4810
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4807

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

#update_fuota_task(params = {}) ⇒ Struct

Updates properties of a FUOTA task.

Examples:

Request syntax with placeholder values


resp = client.update_fuota_task({
  id: "FuotaTaskId", # required
  name: "FuotaTaskName",
  description: "Description",
  lo_ra_wan: {
    rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1, AS923-2, AS923-3, AS923-4, EU433, CN470, CN779, RU864, KR920, IN865
  },
  firmware_update_image: "FirmwareUpdateImage",
  firmware_update_role: "FirmwareUpdateRole",
  redundancy_percent: 1,
  fragment_size_bytes: 1,
  fragment_interval_ms: 1,
  descriptor: "FileDescriptor",
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of a FUOTA task.

  • :name (String) —

    The name of a FUOTA task.

  • :description (String) —

    The description of the new resource.

  • :lo_ra_wan (Types::LoRaWANFuotaTask) —

    The LoRaWAN information used with a FUOTA task.

  • :firmware_update_image (String) —

    The S3 URI points to a firmware update image that is to be used with a FUOTA task.

  • :firmware_update_role (String) —

    The firmware update role that is to be used with a FUOTA task.

  • :redundancy_percent (Integer) —

    The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

  • :fragment_size_bytes (Integer) —

    The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

  • :fragment_interval_ms (Integer) —

    The interval for sending fragments in milliseconds, rounded to the nearest second.

    This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

  • :descriptor (String) —

    The descriptor is the metadata about the file that is transferred to the device using FUOTA, such as the software version. It is a binary field encoded in base64.

Returns:

  • (Struct) —

    Returns an empty response.



4880
4881
4882
4883
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4880

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

#update_log_levels_by_resource_types(params = {}) ⇒ Struct

Set default log level, or log levels by resource types. This can be for wireless device, wireless gateway, or FUOTA task log options, and is used to control the log messages that'll be displayed in CloudWatch.

Examples:

Request syntax with placeholder values


resp = client.update_log_levels_by_resource_types({
  default_log_level: "INFO", # accepts INFO, ERROR, DISABLED
  fuota_task_log_options: [
    {
      type: "LoRaWAN", # required, accepts LoRaWAN
      log_level: "INFO", # required, accepts INFO, ERROR, DISABLED
      events: [
        {
          event: "Fuota", # required, accepts Fuota
          log_level: "INFO", # required, accepts INFO, ERROR, DISABLED
        },
      ],
    },
  ],
  wireless_device_log_options: [
    {
      type: "Sidewalk", # required, accepts Sidewalk, LoRaWAN
      log_level: "INFO", # required, accepts INFO, ERROR, DISABLED
      events: [
        {
          event: "Join", # required, accepts Join, Rejoin, Uplink_Data, Downlink_Data, Registration
          log_level: "INFO", # required, accepts INFO, ERROR, DISABLED
        },
      ],
    },
  ],
  wireless_gateway_log_options: [
    {
      type: "LoRaWAN", # required, accepts LoRaWAN
      log_level: "INFO", # required, accepts INFO, ERROR, DISABLED
      events: [
        {
          event: "CUPS_Request", # required, accepts CUPS_Request, Certificate
          log_level: "INFO", # required, accepts INFO, ERROR, DISABLED
        },
      ],
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :default_log_level (String) —

    The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

  • :fuota_task_log_options (Array<Types::FuotaTaskLogOption>) —

    The list of FUOTA task log options.

  • :wireless_device_log_options (Array<Types::WirelessDeviceLogOption>) —

    The list of wireless device log options.

  • :wireless_gateway_log_options (Array<Types::WirelessGatewayLogOption>) —

    The list of wireless gateway log options.

Returns:

  • (Struct) —

    Returns an empty response.



4950
4951
4952
4953
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4950

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

#update_metric_configuration(params = {}) ⇒ Struct

Update the summary metric configuration.

Examples:

Request syntax with placeholder values


resp = client.update_metric_configuration({
  summary_metric: {
    status: "Enabled", # accepts Enabled, Disabled
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.



4972
4973
4974
4975
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4972

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

#update_multicast_group(params = {}) ⇒ Struct

Updates properties of a multicast group session.

Examples:

Request syntax with placeholder values


resp = client.update_multicast_group({
  id: "MulticastGroupId", # required
  name: "MulticastGroupName",
  description: "Description",
  lo_ra_wan: {
    rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1, AS923-2, AS923-3, AS923-4, EU433, CN470, CN779, RU864, KR920, IN865
    dl_class: "ClassB", # accepts ClassB, ClassC
    participating_gateways: {
      gateway_list: ["WirelessGatewayId"],
      transmission_interval: 1,
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the multicast group.

  • :name (String) —

    The name of the multicast group.

  • :description (String) —

    The description of the new resource.

  • :lo_ra_wan (Types::LoRaWANMulticast) —

    The LoRaWAN information that is to be used with the multicast group.

Returns:

  • (Struct) —

    Returns an empty response.



5011
5012
5013
5014
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 5011

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

#update_network_analyzer_configuration(params = {}) ⇒ Struct

Update network analyzer configuration.

Examples:

Request syntax with placeholder values


resp = client.update_network_analyzer_configuration({
  configuration_name: "NetworkAnalyzerConfigurationName", # required
  trace_content: {
    wireless_device_frame_info: "ENABLED", # accepts ENABLED, DISABLED
    log_level: "INFO", # accepts INFO, ERROR, DISABLED
    multicast_frame_info: "ENABLED", # accepts ENABLED, DISABLED
  },
  wireless_devices_to_add: ["WirelessDeviceId"],
  wireless_devices_to_remove: ["WirelessDeviceId"],
  wireless_gateways_to_add: ["WirelessGatewayId"],
  wireless_gateways_to_remove: ["WirelessGatewayId"],
  description: "Description",
  multicast_groups_to_add: ["MulticastGroupId"],
  multicast_groups_to_remove: ["MulticastGroupId"],
})

Parameters:

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

    ({})

Options Hash (params):

  • :configuration_name (required, String) —

    Name of the network analyzer configuration.

  • :trace_content (Types::TraceContent) —

    Trace content for your wireless devices, gateways, and multicast groups.

  • :wireless_devices_to_add (Array<String>) —

    Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

  • :wireless_devices_to_remove (Array<String>) —

    Wireless device resources to remove from the network analyzer configuration. Provide the WirelessDeviceId of the resources to remove in the input array.

  • :wireless_gateways_to_add (Array<String>) —

    Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

  • :wireless_gateways_to_remove (Array<String>) —

    Wireless gateway resources to remove from the network analyzer configuration. Provide the WirelessGatewayId of the resources to remove in the input array.

  • :description (String) —

    The description of the new resource.

  • :multicast_groups_to_add (Array<String>) —

    Multicast group resources to add to the network analyzer configuration. Provide the MulticastGroupId of the resource to add in the input array.

  • :multicast_groups_to_remove (Array<String>) —

    Multicast group resources to remove from the network analyzer configuration. Provide the MulticastGroupId of the resources to remove in the input array.

Returns:

  • (Struct) —

    Returns an empty response.



5080
5081
5082
5083
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 5080

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

#update_partner_account(params = {}) ⇒ Struct

Updates properties of a partner account.

Examples:

Request syntax with placeholder values


resp = client.({
  sidewalk: { # required
    app_server_private_key: "AppServerPrivateKey",
  },
  partner_account_id: "PartnerAccountId", # required
  partner_type: "Sidewalk", # required, accepts Sidewalk
})

Parameters:

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

    ({})

Options Hash (params):

  • :sidewalk (required, Types::SidewalkUpdateAccount) —

    The Sidewalk account credentials.

  • :partner_account_id (required, String) —

    The ID of the partner account to update.

  • :partner_type (required, String) —

    The partner type.

Returns:

  • (Struct) —

    Returns an empty response.



5110
5111
5112
5113
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 5110

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

#update_position(params = {}) ⇒ Struct

Update the position information of a resource.

This action is no longer supported. Calls to update the position information should use the UpdateResourcePosition API operation instead.

Examples:

Request syntax with placeholder values


resp = client.update_position({
  resource_identifier: "PositionResourceIdentifier", # required
  resource_type: "WirelessDevice", # required, accepts WirelessDevice, WirelessGateway
  position: [1.0], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_identifier (required, String) —

    Resource identifier of the resource for which position is updated.

  • :resource_type (required, String) —

    Resource type of the resource for which position is updated.

  • :position (required, Array<Float>) —

    The position information of the resource.

Returns:

  • (Struct) —

    Returns an empty response.



5146
5147
5148
5149
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 5146

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

#update_resource_event_configuration(params = {}) ⇒ Struct

Update the event configuration for a particular resource identifier.

Examples:

Request syntax with placeholder values


resp = client.update_resource_event_configuration({
  identifier: "Identifier", # required
  identifier_type: "PartnerAccountId", # required, accepts PartnerAccountId, DevEui, GatewayEui, WirelessDeviceId, WirelessGatewayId
  partner_type: "Sidewalk", # accepts Sidewalk
  device_registration_state: {
    sidewalk: {
      amazon_id_event_topic: "Enabled", # accepts Enabled, Disabled
    },
    wireless_device_id_event_topic: "Enabled", # accepts Enabled, Disabled
  },
  proximity: {
    sidewalk: {
      amazon_id_event_topic: "Enabled", # accepts Enabled, Disabled
    },
    wireless_device_id_event_topic: "Enabled", # accepts Enabled, Disabled
  },
  join: {
    lo_ra_wan: {
      dev_eui_event_topic: "Enabled", # accepts Enabled, Disabled
    },
    wireless_device_id_event_topic: "Enabled", # accepts Enabled, Disabled
  },
  connection_status: {
    lo_ra_wan: {
      gateway_eui_event_topic: "Enabled", # accepts Enabled, Disabled
    },
    wireless_gateway_id_event_topic: "Enabled", # accepts Enabled, Disabled
  },
  message_delivery_status: {
    sidewalk: {
      amazon_id_event_topic: "Enabled", # accepts Enabled, Disabled
    },
    wireless_device_id_event_topic: "Enabled", # accepts Enabled, Disabled
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.



5221
5222
5223
5224
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 5221

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

#update_resource_position(params = {}) ⇒ Struct

Update the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the World Geodetic System (WGS84).

Examples:

Request syntax with placeholder values


resp = client.update_resource_position({
  resource_identifier: "PositionResourceIdentifier", # required
  resource_type: "WirelessDevice", # required, accepts WirelessDevice, WirelessGateway
  geo_json_payload: "data",
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_identifier (required, String) —

    The identifier of the resource for which position information is updated. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.

  • :resource_type (required, String) —

    The type of resource for which position information is updated, which can be a wireless device or a wireless gateway.

  • :geo_json_payload (String, StringIO, File) —

    The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.

Returns:

  • (Struct) —

    Returns an empty response.



5265
5266
5267
5268
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 5265

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

#update_wireless_device(params = {}) ⇒ Struct

Updates properties of a wireless device.

Examples:

Request syntax with placeholder values


resp = client.update_wireless_device({
  id: "WirelessDeviceId", # required
  destination_name: "DestinationName",
  name: "WirelessDeviceName",
  description: "Description",
  lo_ra_wan: {
    device_profile_id: "DeviceProfileId",
    service_profile_id: "ServiceProfileId",
    abp_v1_1: {
      f_cnt_start: 1,
    },
    abp_v1_0_x: {
      f_cnt_start: 1,
    },
    f_ports: {
      positioning: {
        clock_sync: 1,
        stream: 1,
        gnss: 1,
      },
      applications: [
        {
          f_port: 1,
          type: "SemtechGeolocation", # accepts SemtechGeolocation
          destination_name: "DestinationName",
        },
      ],
    },
  },
  positioning: "Enabled", # accepts Enabled, Disabled
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to update.

  • :destination_name (String) —

    The name of the new destination for the device.

  • :name (String) —

    The new name of the resource.

    The following special characters aren't accepted: <>^#~$

  • :description (String) —

    A new description of the resource.

  • :lo_ra_wan (Types::LoRaWANUpdateDevice) —

    The updated wireless device's configuration.

  • :positioning (String) —

    FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

Returns:

  • (Struct) —

    Returns an empty response.



5333
5334
5335
5336
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 5333

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

#update_wireless_device_import_task(params = {}) ⇒ Struct

Update an import task to add more devices to the task.

Examples:

Request syntax with placeholder values


resp = client.update_wireless_device_import_task({
  id: "ImportTaskId", # required
  sidewalk: { # required
    device_creation_file: "DeviceCreationFile",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The identifier of the import task to be updated.

  • :sidewalk (required, Types::SidewalkUpdateImportInfo) —

    The Sidewalk-related parameters of the import task to be updated.

Returns:

  • (Struct) —

    Returns an empty response.



5359
5360
5361
5362
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 5359

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

#update_wireless_gateway(params = {}) ⇒ Struct

Updates properties of a wireless gateway.

Examples:

Request syntax with placeholder values


resp = client.update_wireless_gateway({
  id: "WirelessGatewayId", # required
  name: "WirelessGatewayName",
  description: "Description",
  join_eui_filters: [
    ["JoinEui"],
  ],
  net_id_filters: ["NetId"],
  max_eirp: 1.0,
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the resource to update.

  • :name (String) —

    The new name of the resource.

    The following special characters aren't accepted: <>^#~$

  • :description (String) —

    A new description of the resource.

  • :join_eui_filters (Array<Array>) —

    A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

  • :net_id_filters (Array<String>) —

    A list of NetId values that are used by LoRa gateways to filter the uplink frames.

  • :max_eirp (Float) —

    The MaxEIRP value.

Returns:

  • (Struct) —

    Returns an empty response.



5406
5407
5408
5409
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 5406

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