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

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['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)
  • :active_endpoint_cache (Boolean) — default: false

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

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

  • :client_side_monitoring_client_id (String) — default: ""

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

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

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

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

  • :convert_params (Boolean) — default: true

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

  • :correct_clock_skew (Boolean) — default: true

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :endpoint (String)

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

  • :endpoint_cache_max_entries (Integer) — default: 1000

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

  • :endpoint_cache_max_threads (Integer) — default: 10

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

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

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

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

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

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

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

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

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

  • :http_read_timeout (Float) — default: 60

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

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



348
349
350
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 348

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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    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:



401
402
403
404
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 401

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.



425
426
427
428
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 425

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.



449
450
451
452
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 449

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.



473
474
475
476
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 473

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.



497
498
499
500
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 497

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:



527
528
529
530
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 527

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.



551
552
553
554
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 551

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.



571
572
573
574
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 571

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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

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

Returns:



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

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",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (String)

    The name of the new resource.

  • :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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

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

Returns:



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

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
  },
  firmware_update_image: "FirmwareUpdateImage", # required
  firmware_update_role: "FirmwareUpdateRole", # required
  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 a FUOTA task.

  • :description (String)

    The description of the new resource.

  • :client_request_token (String)

    Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    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.

Returns:



775
776
777
778
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 775

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
    dl_class: "ClassB", # accepts ClassB, ClassC
  },
  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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    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:



834
835
836
837
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 834

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
  },
  wireless_devices: ["WirelessDeviceId"],
  wireless_gateways: ["WirelessGatewayId"],
  description: "Description",
  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)

    Name of the network analyzer configuration.

  • :trace_content (Types::TraceContent)

    Trace content for your wireless gateway and wireless device resources.

  • :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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

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

Returns:



905
906
907
908
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 905

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,
  },
  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.

  • :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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

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

Returns:



959
960
961
962
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 959

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",
      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,
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

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.

  • :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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    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.

Returns:



1066
1067
1068
1069
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1066

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.

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],
  },
  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.

  • :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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

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

Returns:



1131
1132
1133
1134
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1131

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:



1163
1164
1165
1166
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1163

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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    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:



1238
1239
1240
1241
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1238

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.



1258
1259
1260
1261
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1258

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.



1278
1279
1280
1281
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1278

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.



1298
1299
1300
1301
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1298

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.



1318
1319
1320
1321
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1318

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.



1338
1339
1340
1341
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1338

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.



1369
1370
1371
1372
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1369

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.



1389
1390
1391
1392
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1389

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.



1409
1410
1411
1412
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1409

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

#delete_wireless_gateway(params = {}) ⇒ Struct

Deletes a wireless gateway.

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.



1429
1430
1431
1432
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1429

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.



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

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.



1470
1471
1472
1473
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1470

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



1496
1497
1498
1499
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1496

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.



1520
1521
1522
1523
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1520

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.



1544
1545
1546
1547
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1544

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.



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

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.



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

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.



1609
1610
1611
1612
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1609

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.



1629
1630
1631
1632
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1629

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:



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

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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the resource to get.

Returns:



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

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"

Parameters:

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

    ({})

Returns:



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

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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of a FUOTA task.

Returns:



1782
1783
1784
1785
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1782

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 resource types, log levels can be for wireless device log options or wireless gateway 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"

Parameters:

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

    ({})

Returns:



1815
1816
1817
1818
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1815

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_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"
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.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the multicast group.

Returns:



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

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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the multicast group.

Returns:



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

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

Parameters:

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

    ({})

Options Hash (params):

  • :configuration_name (required, String)

    Name of the network analyzer configuration.

Returns:



1924
1925
1926
1927
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1924

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:



1959
1960
1961
1962
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 1959

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.

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:



2002
2003
2004
2005
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2002

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.

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:



2038
2039
2040
2041
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2038

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

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:



2084
2085
2086
2087
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2084

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. It can be used for a wireless device or a wireless gateway.

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 identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

  • :resource_type (required, String)

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

Returns:



2119
2120
2121
2122
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2119

def get_resource_log_level(params = {}, options = {})
  req = build_request(:get_resource_log_level, params)
  req.send_request(options)
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 or CLAIM for the global endpoint.

Returns:



2153
2154
2155
2156
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2153

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. #=> 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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the resource to get.

Returns:



2203
2204
2205
2206
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2203

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

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:



2280
2281
2282
2283
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2280

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



2323
2324
2325
2326
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2323

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



2373
2374
2375
2376
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2373

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:



2402
2403
2404
2405
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2402

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:



2431
2432
2433
2434
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2431

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:



2461
2462
2463
2464
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2461

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:



2495
2496
2497
2498
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2495

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:



2536
2537
2538
2539
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2536

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:



2578
2579
2580
2581
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2578

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,
})

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.

Returns:



2617
2618
2619
2620
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2617

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

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:



2667
2668
2669
2670
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2667

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:



2706
2707
2708
2709
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2706

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:



2745
2746
2747
2748
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2745

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:



2786
2787
2788
2789
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2786

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:



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

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:



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

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.

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:



2909
2910
2911
2912
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2909

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

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:



2958
2959
2960
2961
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2958

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:



2997
2998
2999
3000
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 2997

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:



3025
3026
3027
3028
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3025

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



3104
3105
3106
3107
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3104

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:



3152
3153
3154
3155
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3152

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



3202
3203
3204
3205
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3202

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.

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.



3243
3244
3245
3246
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3243

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. This option can be specified for a wireless gateway or a wireless device. 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 identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

  • :resource_type (required, String)

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

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



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

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; both wireless devices and wireless gateways.

Parameters:

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

    ({})

Returns:

  • (Struct)

    Returns an empty response.



3290
3291
3292
3293
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3290

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 or a wireless gateway.

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 identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

  • :resource_type (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.



3319
3320
3321
3322
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3319

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:



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

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,
    },
    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
    },
  },
})

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:



3404
3405
3406
3407
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3404

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.



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

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.



3476
3477
3478
3479
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3476

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.



3502
3503
3504
3505
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3502

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,
  },
})

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.



3531
3532
3533
3534
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3531

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



3561
3562
3563
3564
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3561

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:



3588
3589
3590
3591
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3588

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.



3612
3613
3614
3615
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3612

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.



3648
3649
3650
3651
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3648

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
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct)

    Returns an empty response.



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

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
  },
  firmware_update_image: "FirmwareUpdateImage",
  firmware_update_role: "FirmwareUpdateRole",
})

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.

Returns:

  • (Struct)

    Returns an empty response.



3743
3744
3745
3746
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3743

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 log options or wireless gateways 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
  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.

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



3798
3799
3800
3801
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3798

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_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
    dl_class: "ClassB", # accepts ClassB, ClassC
  },
})

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.



3833
3834
3835
3836
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3833

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
  },
  wireless_devices_to_add: ["WirelessDeviceId"],
  wireless_devices_to_remove: ["WirelessDeviceId"],
  wireless_gateways_to_add: ["WirelessGatewayId"],
  wireless_gateways_to_remove: ["WirelessGatewayId"],
  description: "Description",
})

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 gateway and wireless device resources.

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

Returns:

  • (Struct)

    Returns an empty response.



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

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.



3918
3919
3920
3921
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3918

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.

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.



3946
3947
3948
3949
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 3946

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
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct)

    Returns an empty response.



4012
4013
4014
4015
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4012

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

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.

  • :description (String)

    A new description of the resource.

  • :lo_ra_wan (Types::LoRaWANUpdateDevice)

    The updated wireless device's configuration.

Returns:

  • (Struct)

    Returns an empty response.



4064
4065
4066
4067
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4064

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

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.

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

Returns:

  • (Struct)

    Returns an empty response.



4103
4104
4105
4106
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/client.rb', line 4103

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