AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing IoTWireless

AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.

Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.

You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.

To connect to the AWS IoT Wireless Service, use the Service endpoints as described in IoT Wireless Service endpoints in the AWS General Reference.

Inheritance Hierarchy

Amazon.IoTWireless.IAmazonIoTWireless

Namespace: Amazon.IoTWireless
Assembly: AWSSDK.IoTWireless.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonIoTWireless
         IAmazonService, IDisposable

The IAmazonIoTWireless type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.IoTWireless.Model.IIoTWirelessPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateAwsAccountWithPartnerAccount(AssociateAwsAccountWithPartnerAccountRequest)

Associates a partner account with your AWS account.

Public Method AssociateAwsAccountWithPartnerAccountAsync(AssociateAwsAccountWithPartnerAccountRequest, CancellationToken)

Associates a partner account with your AWS account.

Public Method AssociateMulticastGroupWithFuotaTask(AssociateMulticastGroupWithFuotaTaskRequest)

Associate a multicast group with a FUOTA task.

Public Method AssociateMulticastGroupWithFuotaTaskAsync(AssociateMulticastGroupWithFuotaTaskRequest, CancellationToken)

Associate a multicast group with a FUOTA task.

Public Method AssociateWirelessDeviceWithFuotaTask(AssociateWirelessDeviceWithFuotaTaskRequest)

Associate a wireless device with a FUOTA task.

Public Method AssociateWirelessDeviceWithFuotaTaskAsync(AssociateWirelessDeviceWithFuotaTaskRequest, CancellationToken)

Associate a wireless device with a FUOTA task.

Public Method AssociateWirelessDeviceWithMulticastGroup(AssociateWirelessDeviceWithMulticastGroupRequest)

Associates a wireless device with a multicast group.

Public Method AssociateWirelessDeviceWithMulticastGroupAsync(AssociateWirelessDeviceWithMulticastGroupRequest, CancellationToken)

Associates a wireless device with a multicast group.

Public Method AssociateWirelessDeviceWithThing(AssociateWirelessDeviceWithThingRequest)

Associates a wireless device with a thing.

Public Method AssociateWirelessDeviceWithThingAsync(AssociateWirelessDeviceWithThingRequest, CancellationToken)

Associates a wireless device with a thing.

Public Method AssociateWirelessGatewayWithCertificate(AssociateWirelessGatewayWithCertificateRequest)

Associates a wireless gateway with a certificate.

Public Method AssociateWirelessGatewayWithCertificateAsync(AssociateWirelessGatewayWithCertificateRequest, CancellationToken)

Associates a wireless gateway with a certificate.

Public Method AssociateWirelessGatewayWithThing(AssociateWirelessGatewayWithThingRequest)

Associates a wireless gateway with a thing.

Public Method AssociateWirelessGatewayWithThingAsync(AssociateWirelessGatewayWithThingRequest, CancellationToken)

Associates a wireless gateway with a thing.

Public Method CancelMulticastGroupSession(CancelMulticastGroupSessionRequest)

Cancels an existing multicast group session.

Public Method CancelMulticastGroupSessionAsync(CancelMulticastGroupSessionRequest, CancellationToken)

Cancels an existing multicast group session.

Public Method CreateDestination(CreateDestinationRequest)

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

Public Method CreateDestinationAsync(CreateDestinationRequest, CancellationToken)

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

Public Method CreateDeviceProfile(CreateDeviceProfileRequest)

Creates a new device profile.

Public Method CreateDeviceProfileAsync(CreateDeviceProfileRequest, CancellationToken)

Creates a new device profile.

Public Method CreateFuotaTask(CreateFuotaTaskRequest)

Creates a FUOTA task.

Public Method CreateFuotaTaskAsync(CreateFuotaTaskRequest, CancellationToken)

Creates a FUOTA task.

Public Method CreateMulticastGroup(CreateMulticastGroupRequest)

Creates a multicast group.

Public Method CreateMulticastGroupAsync(CreateMulticastGroupRequest, CancellationToken)

Creates a multicast group.

Public Method CreateNetworkAnalyzerConfiguration(CreateNetworkAnalyzerConfigurationRequest)

Creates a new network analyzer configuration.

Public Method CreateNetworkAnalyzerConfigurationAsync(CreateNetworkAnalyzerConfigurationRequest, CancellationToken)

Creates a new network analyzer configuration.

Public Method CreateServiceProfile(CreateServiceProfileRequest)

Creates a new service profile.

Public Method CreateServiceProfileAsync(CreateServiceProfileRequest, CancellationToken)

Creates a new service profile.

Public Method CreateWirelessDevice(CreateWirelessDeviceRequest)

Provisions a wireless device.

Public Method CreateWirelessDeviceAsync(CreateWirelessDeviceRequest, CancellationToken)

Provisions a wireless device.

Public Method CreateWirelessGateway(CreateWirelessGatewayRequest)

Provisions a wireless gateway.

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

  • If you specify a GatewayEui value that already exists.

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

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

Public Method CreateWirelessGatewayAsync(CreateWirelessGatewayRequest, CancellationToken)

Provisions a wireless gateway.

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

  • If you specify a GatewayEui value that already exists.

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

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

Public Method CreateWirelessGatewayTask(CreateWirelessGatewayTaskRequest)

Creates a task for a wireless gateway.

Public Method CreateWirelessGatewayTaskAsync(CreateWirelessGatewayTaskRequest, CancellationToken)

Creates a task for a wireless gateway.

Public Method CreateWirelessGatewayTaskDefinition(CreateWirelessGatewayTaskDefinitionRequest)

Creates a gateway task definition.

Public Method CreateWirelessGatewayTaskDefinitionAsync(CreateWirelessGatewayTaskDefinitionRequest, CancellationToken)

Creates a gateway task definition.

Public Method DeleteDestination(DeleteDestinationRequest)

Deletes a destination.

Public Method DeleteDestinationAsync(DeleteDestinationRequest, CancellationToken)

Deletes a destination.

Public Method DeleteDeviceProfile(DeleteDeviceProfileRequest)

Deletes a device profile.

Public Method DeleteDeviceProfileAsync(DeleteDeviceProfileRequest, CancellationToken)

Deletes a device profile.

Public Method DeleteFuotaTask(DeleteFuotaTaskRequest)

Deletes a FUOTA task.

Public Method DeleteFuotaTaskAsync(DeleteFuotaTaskRequest, CancellationToken)

Deletes a FUOTA task.

Public Method DeleteMulticastGroup(DeleteMulticastGroupRequest)

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

Public Method DeleteMulticastGroupAsync(DeleteMulticastGroupRequest, CancellationToken)

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

Public Method DeleteNetworkAnalyzerConfiguration(DeleteNetworkAnalyzerConfigurationRequest)

Deletes a network analyzer configuration.

Public Method DeleteNetworkAnalyzerConfigurationAsync(DeleteNetworkAnalyzerConfigurationRequest, CancellationToken)

Deletes a network analyzer configuration.

Public Method DeleteQueuedMessages(DeleteQueuedMessagesRequest)

Remove queued messages from the downlink queue.

Public Method DeleteQueuedMessagesAsync(DeleteQueuedMessagesRequest, CancellationToken)

Remove queued messages from the downlink queue.

Public Method DeleteServiceProfile(DeleteServiceProfileRequest)

Deletes a service profile.

Public Method DeleteServiceProfileAsync(DeleteServiceProfileRequest, CancellationToken)

Deletes a service profile.

Public Method DeleteWirelessDevice(DeleteWirelessDeviceRequest)

Deletes a wireless device.

Public Method DeleteWirelessDeviceAsync(DeleteWirelessDeviceRequest, CancellationToken)

Deletes a wireless device.

Public Method DeleteWirelessDeviceImportTask(DeleteWirelessDeviceImportTaskRequest)

Delete an import task.

Public Method DeleteWirelessDeviceImportTaskAsync(DeleteWirelessDeviceImportTaskRequest, CancellationToken)

Delete an import task.

Public Method DeleteWirelessGateway(DeleteWirelessGatewayRequest)

Deletes a wireless gateway.

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

  • If you specify a GatewayEui value that already exists.

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

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

Public Method DeleteWirelessGatewayAsync(DeleteWirelessGatewayRequest, CancellationToken)

Deletes a wireless gateway.

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

  • If you specify a GatewayEui value that already exists.

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

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

Public Method DeleteWirelessGatewayTask(DeleteWirelessGatewayTaskRequest)

Deletes a wireless gateway task.

Public Method DeleteWirelessGatewayTaskAsync(DeleteWirelessGatewayTaskRequest, CancellationToken)

Deletes a wireless gateway task.

Public Method DeleteWirelessGatewayTaskDefinition(DeleteWirelessGatewayTaskDefinitionRequest)

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

Public Method DeleteWirelessGatewayTaskDefinitionAsync(DeleteWirelessGatewayTaskDefinitionRequest, CancellationToken)

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

Public Method DeregisterWirelessDevice(DeregisterWirelessDeviceRequest)

Deregister a wireless device from AWS IoT Wireless.

Public Method DeregisterWirelessDeviceAsync(DeregisterWirelessDeviceRequest, CancellationToken)

Deregister a wireless device from AWS IoT Wireless.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method DisassociateAwsAccountFromPartnerAccount(DisassociateAwsAccountFromPartnerAccountRequest)

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

Public Method DisassociateAwsAccountFromPartnerAccountAsync(DisassociateAwsAccountFromPartnerAccountRequest, CancellationToken)

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

Public Method DisassociateMulticastGroupFromFuotaTask(DisassociateMulticastGroupFromFuotaTaskRequest)

Disassociates a multicast group from a fuota task.

Public Method DisassociateMulticastGroupFromFuotaTaskAsync(DisassociateMulticastGroupFromFuotaTaskRequest, CancellationToken)

Disassociates a multicast group from a fuota task.

Public Method DisassociateWirelessDeviceFromFuotaTask(DisassociateWirelessDeviceFromFuotaTaskRequest)

Disassociates a wireless device from a FUOTA task.

Public Method DisassociateWirelessDeviceFromFuotaTaskAsync(DisassociateWirelessDeviceFromFuotaTaskRequest, CancellationToken)

Disassociates a wireless device from a FUOTA task.

Public Method DisassociateWirelessDeviceFromMulticastGroup(DisassociateWirelessDeviceFromMulticastGroupRequest)

Disassociates a wireless device from a multicast group.

Public Method DisassociateWirelessDeviceFromMulticastGroupAsync(DisassociateWirelessDeviceFromMulticastGroupRequest, CancellationToken)

Disassociates a wireless device from a multicast group.

Public Method DisassociateWirelessDeviceFromThing(DisassociateWirelessDeviceFromThingRequest)

Disassociates a wireless device from its currently associated thing.

Public Method DisassociateWirelessDeviceFromThingAsync(DisassociateWirelessDeviceFromThingRequest, CancellationToken)

Disassociates a wireless device from its currently associated thing.

Public Method DisassociateWirelessGatewayFromCertificate(DisassociateWirelessGatewayFromCertificateRequest)

Disassociates a wireless gateway from its currently associated certificate.

Public Method DisassociateWirelessGatewayFromCertificateAsync(DisassociateWirelessGatewayFromCertificateRequest, CancellationToken)

Disassociates a wireless gateway from its currently associated certificate.

Public Method DisassociateWirelessGatewayFromThing(DisassociateWirelessGatewayFromThingRequest)

Disassociates a wireless gateway from its currently associated thing.

Public Method DisassociateWirelessGatewayFromThingAsync(DisassociateWirelessGatewayFromThingRequest, CancellationToken)

Disassociates a wireless gateway from its currently associated thing.

Public Method GetDestination(GetDestinationRequest)

Gets information about a destination.

Public Method GetDestinationAsync(GetDestinationRequest, CancellationToken)

Gets information about a destination.

Public Method GetDeviceProfile(GetDeviceProfileRequest)

Gets information about a device profile.

Public Method GetDeviceProfileAsync(GetDeviceProfileRequest, CancellationToken)

Gets information about a device profile.

Public Method GetEventConfigurationByResourceTypes(GetEventConfigurationByResourceTypesRequest)

Get the event configuration based on resource types.

Public Method GetEventConfigurationByResourceTypesAsync(GetEventConfigurationByResourceTypesRequest, CancellationToken)

Get the event configuration based on resource types.

Public Method GetFuotaTask(GetFuotaTaskRequest)

Gets information about a FUOTA task.

Public Method GetFuotaTaskAsync(GetFuotaTaskRequest, CancellationToken)

Gets information about a FUOTA task.

Public Method GetLogLevelsByResourceTypes(GetLogLevelsByResourceTypesRequest)

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.

Public Method GetLogLevelsByResourceTypesAsync(GetLogLevelsByResourceTypesRequest, CancellationToken)

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.

Public Method GetMetricConfiguration(GetMetricConfigurationRequest)

Get the metric configuration status for this AWS account.

Public Method GetMetricConfigurationAsync(GetMetricConfigurationRequest, CancellationToken)

Get the metric configuration status for this AWS account.

Public Method GetMetrics(GetMetricsRequest)

Get the summary metrics for this AWS account.

Public Method GetMetricsAsync(GetMetricsRequest, CancellationToken)

Get the summary metrics for this AWS account.

Public Method GetMulticastGroup(GetMulticastGroupRequest)

Gets information about a multicast group.

Public Method GetMulticastGroupAsync(GetMulticastGroupRequest, CancellationToken)

Gets information about a multicast group.

Public Method GetMulticastGroupSession(GetMulticastGroupSessionRequest)

Gets information about a multicast group session.

Public Method GetMulticastGroupSessionAsync(GetMulticastGroupSessionRequest, CancellationToken)

Gets information about a multicast group session.

Public Method GetNetworkAnalyzerConfiguration(GetNetworkAnalyzerConfigurationRequest)

Get network analyzer configuration.

Public Method GetNetworkAnalyzerConfigurationAsync(GetNetworkAnalyzerConfigurationRequest, CancellationToken)

Get network analyzer configuration.

Public Method GetPartnerAccount(GetPartnerAccountRequest)

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

Public Method GetPartnerAccountAsync(GetPartnerAccountRequest, CancellationToken)

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

Public Method GetPosition(GetPositionRequest)

Get the position information for a given resource.

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

Public Method GetPositionAsync(GetPositionRequest, CancellationToken)

Get the position information for a given resource.

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

Public Method GetPositionConfiguration(GetPositionConfigurationRequest)

Get position configuration for a given resource.

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

Public Method GetPositionConfigurationAsync(GetPositionConfigurationRequest, CancellationToken)

Get position configuration for a given resource.

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

Public Method GetPositionEstimate(GetPositionEstimateRequest)

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

Public Method GetPositionEstimateAsync(GetPositionEstimateRequest, CancellationToken)

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

Public Method GetResourceEventConfiguration(GetResourceEventConfigurationRequest)

Get the event configuration for a particular resource identifier.

Public Method GetResourceEventConfigurationAsync(GetResourceEventConfigurationRequest, CancellationToken)

Get the event configuration for a particular resource identifier.

Public Method GetResourceLogLevel(GetResourceLogLevelRequest)

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

Public Method GetResourceLogLevelAsync(GetResourceLogLevelRequest, CancellationToken)

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

Public Method GetResourcePosition(GetResourcePositionRequest)

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

Public Method GetResourcePositionAsync(GetResourcePositionRequest, CancellationToken)

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

Public Method GetServiceEndpoint(GetServiceEndpointRequest)

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

Public Method GetServiceEndpointAsync(GetServiceEndpointRequest, CancellationToken)

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

Public Method GetServiceProfile(GetServiceProfileRequest)

Gets information about a service profile.

Public Method GetServiceProfileAsync(GetServiceProfileRequest, CancellationToken)

Gets information about a service profile.

Public Method GetWirelessDevice(GetWirelessDeviceRequest)

Gets information about a wireless device.

Public Method GetWirelessDeviceAsync(GetWirelessDeviceRequest, CancellationToken)

Gets information about a wireless device.

Public Method GetWirelessDeviceImportTask(GetWirelessDeviceImportTaskRequest)

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

Public Method GetWirelessDeviceImportTaskAsync(GetWirelessDeviceImportTaskRequest, CancellationToken)

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

Public Method GetWirelessDeviceStatistics(GetWirelessDeviceStatisticsRequest)

Gets operating information about a wireless device.

Public Method GetWirelessDeviceStatisticsAsync(GetWirelessDeviceStatisticsRequest, CancellationToken)

Gets operating information about a wireless device.

Public Method GetWirelessGateway(GetWirelessGatewayRequest)

Gets information about a wireless gateway.

Public Method GetWirelessGatewayAsync(GetWirelessGatewayRequest, CancellationToken)

Gets information about a wireless gateway.

Public Method GetWirelessGatewayCertificate(GetWirelessGatewayCertificateRequest)

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

Public Method GetWirelessGatewayCertificateAsync(GetWirelessGatewayCertificateRequest, CancellationToken)

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

Public Method GetWirelessGatewayFirmwareInformation(GetWirelessGatewayFirmwareInformationRequest)

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

Public Method GetWirelessGatewayFirmwareInformationAsync(GetWirelessGatewayFirmwareInformationRequest, CancellationToken)

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

Public Method GetWirelessGatewayStatistics(GetWirelessGatewayStatisticsRequest)

Gets operating information about a wireless gateway.

Public Method GetWirelessGatewayStatisticsAsync(GetWirelessGatewayStatisticsRequest, CancellationToken)

Gets operating information about a wireless gateway.

Public Method GetWirelessGatewayTask(GetWirelessGatewayTaskRequest)

Gets information about a wireless gateway task.

Public Method GetWirelessGatewayTaskAsync(GetWirelessGatewayTaskRequest, CancellationToken)

Gets information about a wireless gateway task.

Public Method GetWirelessGatewayTaskDefinition(GetWirelessGatewayTaskDefinitionRequest)

Gets information about a wireless gateway task definition.

Public Method GetWirelessGatewayTaskDefinitionAsync(GetWirelessGatewayTaskDefinitionRequest, CancellationToken)

Gets information about a wireless gateway task definition.

Public Method ListDestinations(ListDestinationsRequest)

Lists the destinations registered to your AWS account.

Public Method ListDestinationsAsync(ListDestinationsRequest, CancellationToken)

Lists the destinations registered to your AWS account.

Public Method ListDeviceProfiles(ListDeviceProfilesRequest)

Lists the device profiles registered to your AWS account.

Public Method ListDeviceProfilesAsync(ListDeviceProfilesRequest, CancellationToken)

Lists the device profiles registered to your AWS account.

Public Method ListDevicesForWirelessDeviceImportTask(ListDevicesForWirelessDeviceImportTaskRequest)

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

Public Method ListDevicesForWirelessDeviceImportTaskAsync(ListDevicesForWirelessDeviceImportTaskRequest, CancellationToken)

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

Public Method ListEventConfigurations(ListEventConfigurationsRequest)

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

Public Method ListEventConfigurationsAsync(ListEventConfigurationsRequest, CancellationToken)

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

Public Method ListFuotaTasks(ListFuotaTasksRequest)

Lists the FUOTA tasks registered to your AWS account.

Public Method ListFuotaTasksAsync(ListFuotaTasksRequest, CancellationToken)

Lists the FUOTA tasks registered to your AWS account.

Public Method ListMulticastGroups(ListMulticastGroupsRequest)

Lists the multicast groups registered to your AWS account.

Public Method ListMulticastGroupsAsync(ListMulticastGroupsRequest, CancellationToken)

Lists the multicast groups registered to your AWS account.

Public Method ListMulticastGroupsByFuotaTask(ListMulticastGroupsByFuotaTaskRequest)

List all multicast groups associated with a fuota task.

Public Method ListMulticastGroupsByFuotaTaskAsync(ListMulticastGroupsByFuotaTaskRequest, CancellationToken)

List all multicast groups associated with a fuota task.

Public Method ListNetworkAnalyzerConfigurations(ListNetworkAnalyzerConfigurationsRequest)

Lists the network analyzer configurations.

Public Method ListNetworkAnalyzerConfigurationsAsync(ListNetworkAnalyzerConfigurationsRequest, CancellationToken)

Lists the network analyzer configurations.

Public Method ListPartnerAccounts(ListPartnerAccountsRequest)

Lists the partner accounts associated with your AWS account.

Public Method ListPartnerAccountsAsync(ListPartnerAccountsRequest, CancellationToken)

Lists the partner accounts associated with your AWS account.

Public Method ListPositionConfigurations(ListPositionConfigurationsRequest)

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

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

Public Method ListPositionConfigurationsAsync(ListPositionConfigurationsRequest, CancellationToken)

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

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

Public Method ListQueuedMessages(ListQueuedMessagesRequest)

List queued messages in the downlink queue.

Public Method ListQueuedMessagesAsync(ListQueuedMessagesRequest, CancellationToken)

List queued messages in the downlink queue.

Public Method ListServiceProfiles(ListServiceProfilesRequest)

Lists the service profiles registered to your AWS account.

Public Method ListServiceProfilesAsync(ListServiceProfilesRequest, CancellationToken)

Lists the service profiles registered to your AWS account.

Public Method ListTagsForResource(ListTagsForResourceRequest)

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

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

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

Public Method ListWirelessDeviceImportTasks(ListWirelessDeviceImportTasksRequest)

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

Public Method ListWirelessDeviceImportTasksAsync(ListWirelessDeviceImportTasksRequest, CancellationToken)

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

Public Method ListWirelessDevices(ListWirelessDevicesRequest)

Lists the wireless devices registered to your AWS account.

Public Method ListWirelessDevicesAsync(ListWirelessDevicesRequest, CancellationToken)

Lists the wireless devices registered to your AWS account.

Public Method ListWirelessGateways(ListWirelessGatewaysRequest)

Lists the wireless gateways registered to your AWS account.

Public Method ListWirelessGatewaysAsync(ListWirelessGatewaysRequest, CancellationToken)

Lists the wireless gateways registered to your AWS account.

Public Method ListWirelessGatewayTaskDefinitions(ListWirelessGatewayTaskDefinitionsRequest)

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

Public Method ListWirelessGatewayTaskDefinitionsAsync(ListWirelessGatewayTaskDefinitionsRequest, CancellationToken)

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

Public Method PutPositionConfiguration(PutPositionConfigurationRequest)

Put position configuration for a given resource.

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

Public Method PutPositionConfigurationAsync(PutPositionConfigurationRequest, CancellationToken)

Put position configuration for a given resource.

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

Public Method PutResourceLogLevel(PutResourceLogLevelRequest)

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.

Public Method PutResourceLogLevelAsync(PutResourceLogLevelRequest, CancellationToken)

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.

Public Method ResetAllResourceLogLevels(ResetAllResourceLogLevelsRequest)

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

Public Method ResetAllResourceLogLevelsAsync(ResetAllResourceLogLevelsRequest, CancellationToken)

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

Public Method ResetResourceLogLevel(ResetResourceLogLevelRequest)

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

Public Method ResetResourceLogLevelAsync(ResetResourceLogLevelRequest, CancellationToken)

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

Public Method SendDataToMulticastGroup(SendDataToMulticastGroupRequest)

Sends the specified data to a multicast group.

Public Method SendDataToMulticastGroupAsync(SendDataToMulticastGroupRequest, CancellationToken)

Sends the specified data to a multicast group.

Public Method SendDataToWirelessDevice(SendDataToWirelessDeviceRequest)

Sends a decrypted application data frame to a device.

Public Method SendDataToWirelessDeviceAsync(SendDataToWirelessDeviceRequest, CancellationToken)

Sends a decrypted application data frame to a device.

Public Method StartBulkAssociateWirelessDeviceWithMulticastGroup(StartBulkAssociateWirelessDeviceWithMulticastGroupRequest)

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

Public Method StartBulkAssociateWirelessDeviceWithMulticastGroupAsync(StartBulkAssociateWirelessDeviceWithMulticastGroupRequest, CancellationToken)

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

Public Method StartBulkDisassociateWirelessDeviceFromMulticastGroup(StartBulkDisassociateWirelessDeviceFromMulticastGroupRequest)

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

Public Method StartBulkDisassociateWirelessDeviceFromMulticastGroupAsync(StartBulkDisassociateWirelessDeviceFromMulticastGroupRequest, CancellationToken)

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

Public Method StartFuotaTask(StartFuotaTaskRequest)

Starts a FUOTA task.

Public Method StartFuotaTaskAsync(StartFuotaTaskRequest, CancellationToken)

Starts a FUOTA task.

Public Method StartMulticastGroupSession(StartMulticastGroupSessionRequest)

Starts a multicast group session.

Public Method StartMulticastGroupSessionAsync(StartMulticastGroupSessionRequest, CancellationToken)

Starts a multicast group session.

Public Method StartSingleWirelessDeviceImportTask(StartSingleWirelessDeviceImportTaskRequest)

Start import task for a single wireless device.

Public Method StartSingleWirelessDeviceImportTaskAsync(StartSingleWirelessDeviceImportTaskRequest, CancellationToken)

Start import task for a single wireless device.

Public Method StartWirelessDeviceImportTask(StartWirelessDeviceImportTaskRequest)

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

Public Method StartWirelessDeviceImportTaskAsync(StartWirelessDeviceImportTaskRequest, CancellationToken)

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

Public Method TagResource(TagResourceRequest)

Adds a tag to a resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds a tag to a resource.

Public Method TestWirelessDevice(TestWirelessDeviceRequest)

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

Public Method TestWirelessDeviceAsync(TestWirelessDeviceRequest, CancellationToken)

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

Public Method UntagResource(UntagResourceRequest)

Removes one or more tags from a resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes one or more tags from a resource.

Public Method UpdateDestination(UpdateDestinationRequest)

Updates properties of a destination.

Public Method UpdateDestinationAsync(UpdateDestinationRequest, CancellationToken)

Updates properties of a destination.

Public Method UpdateEventConfigurationByResourceTypes(UpdateEventConfigurationByResourceTypesRequest)

Update the event configuration based on resource types.

Public Method UpdateEventConfigurationByResourceTypesAsync(UpdateEventConfigurationByResourceTypesRequest, CancellationToken)

Update the event configuration based on resource types.

Public Method UpdateFuotaTask(UpdateFuotaTaskRequest)

Updates properties of a FUOTA task.

Public Method UpdateFuotaTaskAsync(UpdateFuotaTaskRequest, CancellationToken)

Updates properties of a FUOTA task.

Public Method UpdateLogLevelsByResourceTypes(UpdateLogLevelsByResourceTypesRequest)

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.

Public Method UpdateLogLevelsByResourceTypesAsync(UpdateLogLevelsByResourceTypesRequest, CancellationToken)

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.

Public Method UpdateMetricConfiguration(UpdateMetricConfigurationRequest)

Update the summary metric configuration.

Public Method UpdateMetricConfigurationAsync(UpdateMetricConfigurationRequest, CancellationToken)

Update the summary metric configuration.

Public Method UpdateMulticastGroup(UpdateMulticastGroupRequest)

Updates properties of a multicast group session.

Public Method UpdateMulticastGroupAsync(UpdateMulticastGroupRequest, CancellationToken)

Updates properties of a multicast group session.

Public Method UpdateNetworkAnalyzerConfiguration(UpdateNetworkAnalyzerConfigurationRequest)

Update network analyzer configuration.

Public Method UpdateNetworkAnalyzerConfigurationAsync(UpdateNetworkAnalyzerConfigurationRequest, CancellationToken)

Update network analyzer configuration.

Public Method UpdatePartnerAccount(UpdatePartnerAccountRequest)

Updates properties of a partner account.

Public Method UpdatePartnerAccountAsync(UpdatePartnerAccountRequest, CancellationToken)

Updates properties of a partner account.

Public Method UpdatePosition(UpdatePositionRequest)

Update the position information of a resource.

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

Public Method UpdatePositionAsync(UpdatePositionRequest, CancellationToken)

Update the position information of a resource.

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

Public Method UpdateResourceEventConfiguration(UpdateResourceEventConfigurationRequest)

Update the event configuration for a particular resource identifier.

Public Method UpdateResourceEventConfigurationAsync(UpdateResourceEventConfigurationRequest, CancellationToken)

Update the event configuration for a particular resource identifier.

Public Method UpdateResourcePosition(UpdateResourcePositionRequest)

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

Public Method UpdateResourcePositionAsync(UpdateResourcePositionRequest, CancellationToken)

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

Public Method UpdateWirelessDevice(UpdateWirelessDeviceRequest)

Updates properties of a wireless device.

Public Method UpdateWirelessDeviceAsync(UpdateWirelessDeviceRequest, CancellationToken)

Updates properties of a wireless device.

Public Method UpdateWirelessDeviceImportTask(UpdateWirelessDeviceImportTaskRequest)

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

Public Method UpdateWirelessDeviceImportTaskAsync(UpdateWirelessDeviceImportTaskRequest, CancellationToken)

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

Public Method UpdateWirelessGateway(UpdateWirelessGatewayRequest)

Updates properties of a wireless gateway.

Public Method UpdateWirelessGatewayAsync(UpdateWirelessGatewayRequest, CancellationToken)

Updates properties of a wireless gateway.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5