diff --git a/clients/client-iot-wireless/README.md b/clients/client-iot-wireless/README.md index 0b46638e150e..8bc12e4244ca 100644 --- a/clients/client-iot-wireless/README.md +++ b/clients/client-iot-wireless/README.md @@ -6,17 +6,19 @@ AWS SDK for JavaScript IoTWireless Client for Node.js, Browser and React Native. -
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.
+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.
## Installing diff --git a/clients/client-iot-wireless/src/IoTWireless.ts b/clients/client-iot-wireless/src/IoTWireless.ts index 8c09f3208863..62a87b467803 100644 --- a/clients/client-iot-wireless/src/IoTWireless.ts +++ b/clients/client-iot-wireless/src/IoTWireless.ts @@ -2465,17 +2465,19 @@ export interface IoTWireless { /** * @public - *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.
+ *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.
*/ export class IoTWireless extends IoTWirelessClient implements IoTWireless {} createAggregatedClient(commands, IoTWireless); diff --git a/clients/client-iot-wireless/src/IoTWirelessClient.ts b/clients/client-iot-wireless/src/IoTWirelessClient.ts index 5c7584a0e716..bb8bef149ecf 100644 --- a/clients/client-iot-wireless/src/IoTWirelessClient.ts +++ b/clients/client-iot-wireless/src/IoTWirelessClient.ts @@ -814,17 +814,19 @@ export interface IoTWirelessClientResolvedConfig extends IoTWirelessClientResolv /** * @public - *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.
+ *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.
*/ export class IoTWirelessClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-iot-wireless/src/commands/CreateNetworkAnalyzerConfigurationCommand.ts b/clients/client-iot-wireless/src/commands/CreateNetworkAnalyzerConfigurationCommand.ts index 6c006a81bf18..13474bbf244a 100644 --- a/clients/client-iot-wireless/src/commands/CreateNetworkAnalyzerConfigurationCommand.ts +++ b/clients/client-iot-wireless/src/commands/CreateNetworkAnalyzerConfigurationCommand.ts @@ -56,6 +56,7 @@ export interface CreateNetworkAnalyzerConfigurationCommandOutput * TraceContent: { // TraceContent * WirelessDeviceFrameInfo: "ENABLED" || "DISABLED", * LogLevel: "INFO" || "ERROR" || "DISABLED", + * MulticastFrameInfo: "ENABLED" || "DISABLED", * }, * WirelessDevices: [ // WirelessDeviceList * "STRING_VALUE", @@ -71,6 +72,9 @@ export interface CreateNetworkAnalyzerConfigurationCommandOutput * }, * ], * ClientRequestToken: "STRING_VALUE", + * MulticastGroups: [ // NetworkAnalyzerMulticastGroupList + * "STRING_VALUE", + * ], * }; * const command = new CreateNetworkAnalyzerConfigurationCommand(input); * const response = await client.send(command); diff --git a/clients/client-iot-wireless/src/commands/DeleteWirelessGatewayTaskDefinitionCommand.ts b/clients/client-iot-wireless/src/commands/DeleteWirelessGatewayTaskDefinitionCommand.ts index d42e9d90a44a..fbd61c4fcdbc 100644 --- a/clients/client-iot-wireless/src/commands/DeleteWirelessGatewayTaskDefinitionCommand.ts +++ b/clients/client-iot-wireless/src/commands/DeleteWirelessGatewayTaskDefinitionCommand.ts @@ -44,7 +44,8 @@ export interface DeleteWirelessGatewayTaskDefinitionCommandOutput /** * @public - *Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.
+ *Deletes a wireless gateway task definition. Deleting this task definition does not + * affect tasks that are currently in progress.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-iot-wireless/src/commands/DisassociateAwsAccountFromPartnerAccountCommand.ts b/clients/client-iot-wireless/src/commands/DisassociateAwsAccountFromPartnerAccountCommand.ts index 1f4aeb844656..cf663800c787 100644 --- a/clients/client-iot-wireless/src/commands/DisassociateAwsAccountFromPartnerAccountCommand.ts +++ b/clients/client-iot-wireless/src/commands/DisassociateAwsAccountFromPartnerAccountCommand.ts @@ -45,7 +45,9 @@ export interface DisassociateAwsAccountFromPartnerAccountCommandOutput /** * @public - *Disassociates your AWS account from a partner account. If PartnerAccountId
and PartnerType
are null
, disassociates your AWS account from all partner accounts.
Disassociates your AWS account from a partner account. If
+ * PartnerAccountId
and PartnerType
are null
,
+ * disassociates your AWS account from all partner accounts.
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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-iot-wireless/src/commands/GetNetworkAnalyzerConfigurationCommand.ts b/clients/client-iot-wireless/src/commands/GetNetworkAnalyzerConfigurationCommand.ts index 4b1edbca37db..1a0b601c7c30 100644 --- a/clients/client-iot-wireless/src/commands/GetNetworkAnalyzerConfigurationCommand.ts +++ b/clients/client-iot-wireless/src/commands/GetNetworkAnalyzerConfigurationCommand.ts @@ -57,6 +57,7 @@ export interface GetNetworkAnalyzerConfigurationCommandOutput * // TraceContent: { // TraceContent * // WirelessDeviceFrameInfo: "ENABLED" || "DISABLED", * // LogLevel: "INFO" || "ERROR" || "DISABLED", + * // MulticastFrameInfo: "ENABLED" || "DISABLED", * // }, * // WirelessDevices: [ // WirelessDeviceList * // "STRING_VALUE", @@ -67,6 +68,9 @@ export interface GetNetworkAnalyzerConfigurationCommandOutput * // Description: "STRING_VALUE", * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", + * // MulticastGroups: [ // NetworkAnalyzerMulticastGroupList + * // "STRING_VALUE", + * // ], * // }; * * ``` diff --git a/clients/client-iot-wireless/src/commands/GetPartnerAccountCommand.ts b/clients/client-iot-wireless/src/commands/GetPartnerAccountCommand.ts index 6215768b67c0..08c6140db018 100644 --- a/clients/client-iot-wireless/src/commands/GetPartnerAccountCommand.ts +++ b/clients/client-iot-wireless/src/commands/GetPartnerAccountCommand.ts @@ -40,7 +40,8 @@ export interface GetPartnerAccountCommandOutput extends GetPartnerAccountRespons /** * @public - *Gets information about a partner account. If PartnerAccountId
and PartnerType
are null
, returns all partner accounts.
Gets information about a partner account. If PartnerAccountId
and
+ * PartnerType
are null
, returns all partner accounts.
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.
+ * should use the GetResourcePosition API operation instead. *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.
+ * should use the GetResourcePosition API operation instead. *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-iot-wireless/src/commands/GetResourceLogLevelCommand.ts b/clients/client-iot-wireless/src/commands/GetResourceLogLevelCommand.ts index db95c4ed07b3..075e86ead066 100644 --- a/clients/client-iot-wireless/src/commands/GetResourceLogLevelCommand.ts +++ b/clients/client-iot-wireless/src/commands/GetResourceLogLevelCommand.ts @@ -36,8 +36,8 @@ export interface GetResourceLogLevelCommandOutput extends GetResourceLogLevelRes /** * @public - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-iot-wireless/src/commands/GetResourcePositionCommand.ts b/clients/client-iot-wireless/src/commands/GetResourcePositionCommand.ts index 2245aeee3e0c..b273571267bc 100644 --- a/clients/client-iot-wireless/src/commands/GetResourcePositionCommand.ts +++ b/clients/client-iot-wireless/src/commands/GetResourcePositionCommand.ts @@ -36,8 +36,8 @@ export interface GetResourcePositionCommandOutput extends GetResourcePositionRes /** * @public - *Get the position information for a given wireless device or a wireless gateway resource.
- * The position information uses the World Geodetic System
+ * Get the position information for a given wireless device or a wireless gateway
+ * resource. The position information uses the World Geodetic System
* (WGS84). Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections. Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol
+ * or LoRaWAN Network Server (LNS) connections. Gets the ID of the certificate that is currently associated with a wireless gateway. Gets the ID of the certificate that is currently associated with a wireless
+ * gateway. 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. This action is no longer supported. Calls to retrieve position information should
+ * use the GetResourcePosition API operation instead. 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. 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. Removes the log-level overrides for all resources; both wireless devices and wireless gateways. Removes the log-level overrides for all resources; both wireless devices and wireless
+ * gateways. 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. 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. Starts a bulk association of all qualifying wireless devices with a multicast group. Starts a bulk association of all qualifying wireless devices with a multicast
+ * group. Starts a bulk disassociatin of all qualifying wireless devices from a multicast group. Starts a bulk disassociatin of all qualifying wireless devices from a multicast
+ * group. Simulates a provisioned device by sending an uplink data payload of Simulates a provisioned device by sending an uplink data payload of
+ * 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. 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. 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. 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. The accuracy of the estimated position in meters. An empty value indicates that no position data is available.
- * A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information
- * that you specified instead of the position computed by solver. The accuracy of the estimated position in meters. An empty value indicates that no
+ * position data is available. A value of ‘0.0’ value indicates that position data is
+ * available. This data corresponds to the position information that you specified instead
+ * of the position computed by solver. The horizontal accuracy of the estimated position, which is the difference between the estimated
- * location and the actual device location. The horizontal accuracy of the estimated position, which is the difference between the
+ * estimated location and the actual device location. The vertical accuracy of the estimated position, which is the difference between the estimated
- * altitude and actual device latitude in meters. The vertical accuracy of the estimated position, which is the difference between the
+ * estimated altitude and actual device latitude in meters. 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. 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.
+ * The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource. The tags to attach to the specified resource. Tags are metadata that you can use to
+ * manage a resource. Denotes whether the gateway EUI connection status event topic is enabled or disabled. Denotes whether the gateway EUI connection status event topic is enabled or
+ * disabled. Connection status event configuration object for enabling or disabling LoRaWAN related event topics. Connection status event configuration object for enabling or disabling LoRaWAN related
+ * event topics. Denotes whether the wireless gateway ID connection status event topic is enabled or disabled. Denotes whether the wireless gateway ID connection status event topic is enabled or
+ * disabled. Denotes whether the wireless gateway connection status event topic is enabled or disabled. Denotes whether the wireless gateway connection status event topic is enabled or
+ * disabled. Connection status resource type event configuration object for enabling or disabling topic. Connection status resource type event configuration object for enabling or disabling
+ * topic. Connection status resource type event configuration object for enabling or disabling LoRaWAN related
- * event topics. Connection status resource type event configuration object for enabling or disabling
+ * LoRaWAN related event topics. The tags to attach to the new destination. Tags are metadata that you can use to manage a resource. The tags to attach to the new destination. Tags are metadata that you can use to
+ * manage a resource. 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. 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.
+ * The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile. The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device
+ * profile. The tags to attach to the new device profile. Tags are metadata that you can use to manage a resource. The tags to attach to the new device profile. Tags are metadata that you can use to
+ * manage a resource. 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. 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.
+ * 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. 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. The S3 URI points to a firmware update image that is to be used with a FUOTA task. The S3 URI points to a firmware update image that is to be used with a FUOTA
+ * task. The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource. The tag to attach to the specified resource. Tags are metadata that you can use to
+ * manage a resource. The percentage of added redundant fragments. For example, if firmware file is
- * 100 bytes and fragment size is 10 bytes, with The percentage of the added fragments that are redundant. For example, if the size of
+ * the firmware image file is 100 bytes and the fragment size is 10 bytes, with
+ * The size of each fragment in bytes. Currently only supported in fuota tasks with multicast groups. The size of each fragment in bytes. This parameter is supported only for FUOTA tasks
+ * with multicast groups. The interval of sending fragments in milliseconds. Currently the interval will be rounded to the nearest second.
- * Note that this interval only controls the timing when the cloud sends the fragments down.
- * The actual delay of receiving fragments at device side depends on the device's class and the communication delay with the cloud. The interval for sending fragments in milliseconds, rounded to the nearest
+ * second. This interval only determines the timing for when the Cloud sends down the
+ * fragments to yor device. There can be a delay for when your device will receive
+ * these fragments. This delay depends on the device's class and the communication
+ * delay with the cloud. 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. 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.
+ * The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource. The tag to attach to the specified resource. Tags are metadata that you can use to
+ * manage a resource.
- * Hello
.Hello
.RedundancyPercent
set to 50(%),
- * the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.RedundancyPercent
set to 50(%), the final number of encoded fragments
+ * is (100 / 10) + (100 / 10 * 50%) = 15.FrameInfo
of your wireless device resources for the trace content. Use FrameInfo to debug
- * the communication between your LoRaWAN end devices and the network server.FrameInfo
of your wireless device resources for the trace content. Use
+ * FrameInfo to debug the communication between your LoRaWAN end devices and the network
+ * server.
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.
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.
+ * FrameInfo
of your multicast group resources for the trace content. Use
+ * FrameInfo to debug the multicast communication between your LoRaWAN end devices and the network server.
Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId
of the resource to add in the input array.
Wireless device resources to add to the network analyzer configuration. Provide the
+ * WirelessDeviceId
of the resource to add in the input array.
Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId
of the resource to add in the input array.
Wireless gateway resources to add to the network analyzer configuration. Provide the
+ * WirelessGatewayId
of the resource to add in the input array.
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
+ *The tag to attach to the specified resource. Tags are metadata that you can use to + * manage a resource.
*/ Tags?: Tag[]; /** - *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.
+ *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.
*/ ClientRequestToken?: string; + + /** + *Multicast Group resources to add to the network analyzer configruation. Provide the
+ * MulticastGroupId
of the resource to add in the input array.
The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.
+ *The tags to attach to the new service profile. Tags are metadata that you can use to + * manage a resource.
*/ Tags?: Tag[]; /** - *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.
+ *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. + *
*/ ClientRequestToken?: string; } @@ -1794,7 +1866,8 @@ export interface FPorts { ClockSync?: number; /** - *FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
+ *FPort values for the GNSS, stream, and ClockSync functions of the positioning + * information.
*/ Positioning?: Positioning; @@ -1956,7 +2029,10 @@ export interface CreateWirelessDeviceRequest { DestinationName: string | undefined; /** - *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.
+ *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. + *
*/ ClientRequestToken?: string; @@ -1966,12 +2042,14 @@ export interface CreateWirelessDeviceRequest { LoRaWAN?: LoRaWANDevice; /** - *The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.
+ *The tags to attach to the new wireless device. Tags are metadata that you can use to + * manage a resource.
*/ Tags?: Tag[]; /** - *FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
+ *FPort values for the GNSS, stream, and ClockSync functions of the positioning + * information.
*/ Positioning?: PositioningConfigStatus | string; @@ -2017,7 +2095,8 @@ export interface LoRaWANGateway { JoinEuiFilters?: string[][]; /** - *A list of NetId values that are used by LoRa gateways to filter the uplink frames.
+ *A list of NetId values that are used by LoRa gateways to filter the uplink + * frames.
*/ NetIdFilters?: string[]; @@ -2027,7 +2106,8 @@ export interface LoRaWANGateway { SubBands?: number[]; /** - *Beaconing object information, which consists of the data rate and frequency parameters.
+ *Beaconing object information, which consists of the data rate and frequency + * parameters.
*/ Beaconing?: Beaconing; @@ -2057,12 +2137,16 @@ export interface CreateWirelessGatewayRequest { LoRaWAN: LoRaWANGateway | undefined; /** - *The tags to attach to the new wireless gateway. Tags are metadata that you can use to manage a resource.
+ *The tags to attach to the new wireless gateway. Tags are metadata that you can use to + * manage a resource.
*/ Tags?: Tag[]; /** - *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.
+ *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. + *
*/ ClientRequestToken?: string; } @@ -2203,7 +2287,9 @@ export interface UpdateWirelessGatewayTaskCreate { */ export interface CreateWirelessGatewayTaskDefinitionRequest { /** - *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
.
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
.
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.
+ *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. + *
*/ ClientRequestToken?: string; /** - *The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
+ *The tags to attach to the specified resource. Tags are metadata that you can use to + * manage a resource.
*/ Tags?: Tag[]; } @@ -2562,8 +2652,8 @@ export type DeviceProfileType = (typeof DeviceProfileType)[keyof typeof DevicePr /** * @public *
- * SidewalkEventNotificationConfigurations
object, which is the event configuration
- * object for Sidewalk-related event topics.
SidewalkEventNotificationConfigurations
object, which is the event
+ * configuration object for Sidewalk-related event topics.
*/
export interface SidewalkEventNotificationConfigurations {
/**
@@ -2574,24 +2664,27 @@ export interface SidewalkEventNotificationConfigurations {
/**
* @public
- * Device registration state event configuration object for enabling and disabling relevant topics.
+ *Device registration state event configuration object for enabling and disabling + * relevant topics.
*/ export interface DeviceRegistrationStateEventConfiguration { /** - *Device registration state event configuration object for enabling or disabling Sidewalk related event - * topics.
+ *Device registration state event configuration object for enabling or disabling + * Sidewalk related event topics.
*/ Sidewalk?: SidewalkEventNotificationConfigurations; /** - *Denotes whether the wireless device ID device registration state event topic is enabled or disabled.
+ *Denotes whether the wireless device ID device registration state event topic is + * enabled or disabled.
*/ WirelessDeviceIdEventTopic?: EventNotificationTopicStatus | string; } /** * @public - *Sidewalk resource type event configuration object for enabling or disabling topic.
+ *Sidewalk resource type event configuration object for enabling or disabling + * topic.
*/ export interface SidewalkResourceTypeEventConfiguration { /** @@ -2602,12 +2695,13 @@ export interface SidewalkResourceTypeEventConfiguration { /** * @public - *Device registration state resource type event configuration object for enabling or disabling topic.
+ *Device registration state resource type event configuration object for enabling or + * disabling topic.
*/ export interface DeviceRegistrationStateResourceTypeEventConfiguration { /** - *Device registration resource type state event configuration object for enabling or disabling Sidewalk - * related event topics.
+ *Device registration resource type state event configuration object for enabling or + * disabling Sidewalk related event topics.
*/ Sidewalk?: SidewalkResourceTypeEventConfiguration; } @@ -2783,42 +2877,44 @@ export type DownlinkMode = (typeof DownlinkMode)[keyof typeof DownlinkMode]; /** * @public - *Gateway list item object that specifies the frequency and list of gateways for which the downlink message - * should be sent.
+ *Gateway list item object that specifies the frequency and list of gateways for which + * the downlink message should be sent.
*/ export interface GatewayListItem { /** - *The ID of the wireless gateways that you want to add to the list of gateways when sending - * downlink messages.
+ *The ID of the wireless gateways that you want to add to the list of gateways when + * sending downlink messages.
*/ GatewayId: string | undefined; /** - *The frequency to use for the gateways when sending a downlink message to the wireless device.
+ *The frequency to use for the gateways when sending a downlink message to the wireless + * device.
*/ DownlinkFrequency: number | undefined; } /** * @public - *Specify the list of gateways to which you want to send downlink data traffic when the wireless - * device is running in class B or class C mode.
+ *Specify the list of gateways to which you want to send downlink data traffic when the + * wireless device is running in class B or class C mode.
*/ export interface ParticipatingGateways { /** - *Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use - * only the chosen gateways from the previous uplink message transmission.
+ *Indicates whether to send the downlink message in sequential mode or concurrent mode, + * or to use only the chosen gateways from the previous uplink message transmission.
*/ DownlinkMode: DownlinkMode | string | undefined; /** - *The list of gateways that you want to use for sending the downlink data traffic.
+ *The list of gateways that you want to use for sending the downlink data + * traffic.
*/ GatewayList: GatewayListItem[] | undefined; /** - *The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the - * payload to the next gateway.
+ *The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting + * the payload to the next gateway.
*/ TransmissionInterval: number | undefined; } @@ -2834,8 +2930,8 @@ export interface LoRaWANSendDataToDevice { FPort?: number; /** - *Choose the gateways that you want to use for the downlink data traffic when the wireless device - * is running in class B or class C mode.
+ *Choose the gateways that you want to use for the downlink data traffic when the + * wireless device is running in class B or class C mode.
*/ ParticipatingGateways?: ParticipatingGateways; } @@ -2846,14 +2942,15 @@ export interface LoRaWANSendDataToDevice { */ export interface DownlinkQueueMessage { /** - *The message ID assigned by IoT Wireless to each downlink message, which helps identify the - * message.
+ *The message ID assigned by IoT Wireless to each downlink message, which helps + * identify the message.
*/ MessageId?: string; /** - *The transmit mode to use for sending data to the wireless device. This can be 0
for UM (unacknowledge mode)
- * or 1
for AM (acknowledge mode).
The transmit mode to use for sending data to the wireless device. This can be
+ * 0
for UM (unacknowledge mode) or 1
for AM (acknowledge
+ * mode).
Join event configuration object for enabling or disabling LoRaWAN related event topics.
+ *Join event configuration object for enabling or disabling LoRaWAN related event + * topics.
*/ LoRaWAN?: LoRaWANJoinEventNotificationConfigurations; @@ -2920,8 +3018,8 @@ export interface JoinEventConfiguration { export interface MessageDeliveryStatusEventConfiguration { /** *
- * SidewalkEventNotificationConfigurations
object, which is the event configuration
- * object for Sidewalk-related event topics.
SidewalkEventNotificationConfigurations
object, which is the event
+ * configuration object for Sidewalk-related event topics.
*/
Sidewalk?: SidewalkEventNotificationConfigurations;
@@ -2934,16 +3032,19 @@ export interface MessageDeliveryStatusEventConfiguration {
/**
* @public
- * Proximity event configuration object for enabling and disabling relevant topics.
+ *Proximity event configuration object for enabling and disabling relevant + * topics.
*/ export interface ProximityEventConfiguration { /** - *Proximity event configuration object for enabling or disabling Sidewalk related event topics.
+ *Proximity event configuration object for enabling or disabling Sidewalk related event + * topics.
*/ Sidewalk?: SidewalkEventNotificationConfigurations; /** - *Denotes whether the wireless device ID proximity event topic is enabled or disabled.
+ *Denotes whether the wireless device ID proximity event topic is enabled or + * disabled.
*/ WirelessDeviceIdEventTopic?: EventNotificationTopicStatus | string; } @@ -3241,31 +3342,34 @@ export interface LoRaWANJoinResourceTypeEventConfiguration { */ export interface JoinResourceTypeEventConfiguration { /** - *Join resource type event configuration object for enabling or disabling LoRaWAN related - * event topics.
+ *Join resource type event configuration object for enabling or disabling LoRaWAN + * related event topics.
*/ LoRaWAN?: LoRaWANJoinResourceTypeEventConfiguration; } /** * @public - *Message delivery status resource type event configuration object for enabling or disabling - * relevant topic.
+ *Message delivery status resource type event configuration object for enabling or + * disabling relevant topic.
*/ export interface MessageDeliveryStatusResourceTypeEventConfiguration { /** - *Sidewalk resource type event configuration object for enabling or disabling topic.
+ *Sidewalk resource type event configuration object for enabling or disabling + * topic.
*/ Sidewalk?: SidewalkResourceTypeEventConfiguration; } /** * @public - *Proximity resource type event configuration object for enabling or disabling topic.
+ *Proximity resource type event configuration object for enabling or disabling + * topic.
*/ export interface ProximityResourceTypeEventConfiguration { /** - *Proximity resource type event configuration object for enabling and disabling wireless device topic.
+ *Proximity resource type event configuration object for enabling and disabling wireless + * device topic.
*/ Sidewalk?: SidewalkResourceTypeEventConfiguration; } @@ -3361,7 +3465,8 @@ export interface GetFuotaTaskResponse { LoRaWAN?: LoRaWANFuotaTaskGetInfo; /** - *The S3 URI points to a firmware update image that is to be used with a FUOTA task.
+ *The S3 URI points to a firmware update image that is to be used with a FUOTA + * task.
*/ FirmwareUpdateImage?: string; @@ -3376,21 +3481,28 @@ export interface GetFuotaTaskResponse { CreatedAt?: Date; /** - *The percentage of added redundant fragments. For example, if firmware file is
- * 100 bytes and fragment size is 10 bytes, with RedundancyPercent
set to 50(%),
- * the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.
The percentage of the added fragments that are redundant. For example, if the size of
+ * the firmware image file is 100 bytes and the fragment size is 10 bytes, with
+ * RedundancyPercent
set to 50(%), the final number of encoded fragments
+ * is (100 / 10) + (100 / 10 * 50%) = 15.
The size of each fragment in bytes. Currently only supported in fuota tasks with multicast groups.
+ *The size of each fragment in bytes. This parameter is supported only for FUOTA tasks + * with multicast groups.
*/ FragmentSizeBytes?: number; /** - *The interval of sending fragments in milliseconds. Currently the interval will be rounded to the nearest second. - * Note that this interval only controls the timing when the cloud sends the fragments down. - * The actual delay of receiving fragments at device side depends on the device's class and the communication delay with the cloud.
+ *The interval for sending fragments in milliseconds, rounded to the nearest + * second.
+ *This interval only determines the timing for when the Cloud sends down the + * fragments to yor device. There can be a delay for when your device will receive + * these fragments. This delay depends on the device's class and the communication + * delay with the cloud.
+ *The log options for a wireless device event and can be used to set log levels for a specific wireless device event.
- *For a LoRaWAN device, possible events for a log messsage are: Join
, Rejoin
,
- * Downlink_Data
, and Uplink_Data
. For a Sidewalk device, possible events for a log message are
- * Registration
, Downlink_Data
, and Uplink_Data
.
The log options for a wireless device event and can be used to set log levels for a + * specific wireless device event.
+ *For a LoRaWAN device, possible events for a log messsage are: Join
,
+ * Rejoin
, Downlink_Data
, and Uplink_Data
. For a
+ * Sidewalk device, possible events for a log message are Registration
,
+ * Downlink_Data
, and Uplink_Data
.
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.
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.
The log options for wireless devices and can be used to set log levels for a specific type of wireless device.
+ *The log options for wireless devices and can be used to set log levels for a specific + * type of wireless device.
*/ export interface WirelessDeviceLogOption { /** @@ -3448,8 +3564,9 @@ export interface WirelessDeviceLogOption { Type: WirelessDeviceType | string | undefined; /** - *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.
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.
The log options for a wireless gateway event and can be used to set log levels for a specific wireless gateway event.
- *For a LoRaWAN gateway, possible events for a log message are CUPS_Request
and Certificate
.
The log options for a wireless gateway event and can be used to set log levels for a + * specific wireless gateway event.
+ *For a LoRaWAN gateway, possible events for a log message are CUPS_Request
+ * and Certificate
.
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.
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.
The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.
+ *The log options for wireless gateways and can be used to set log levels for a specific + * type of wireless gateway.
*/ export interface WirelessGatewayLogOption { /** @@ -3515,8 +3636,9 @@ export interface WirelessGatewayLogOption { Type: WirelessGatewayType | string | undefined; /** - *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.
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.
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.
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.
The LoRaWAN information that is to be returned from getting multicast group information.
+ *The LoRaWAN information that is to be returned from getting multicast group + * information.
*/ export interface LoRaWANMulticastGet { /** @@ -3613,7 +3737,8 @@ export interface GetMulticastGroupResponse { Status?: string; /** - *The LoRaWAN information that is to be returned from getting multicast group information.
+ *The LoRaWAN information that is to be returned from getting multicast group + * information.
*/ LoRaWAN?: LoRaWANMulticastGet; @@ -3694,12 +3819,14 @@ export interface GetNetworkAnalyzerConfigurationResponse { TraceContent?: TraceContent; /** - *List of wireless gateway resources that have been added to the network analyzer configuration.
+ *List of wireless gateway resources that have been added to the network analyzer + * configuration.
*/ WirelessDevices?: string[]; /** - *List of wireless gateway resources that have been added to the network analyzer configuration.
+ *List of wireless gateway resources that have been added to the network analyzer + * configuration.
*/ WirelessGateways?: string[]; @@ -3717,6 +3844,12 @@ export interface GetNetworkAnalyzerConfigurationResponse { *Name of the network analyzer configuration.
*/ Name?: string; + + /** + *List of multicast group resources that have been added to the network analyzer + * configuration.
+ */ + MulticastGroups?: string[]; } /** @@ -3835,9 +3968,10 @@ export interface GetPositionResponse { Position?: number[]; /** - *The accuracy of the estimated position in meters. An empty value indicates that no position data is available. - * A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information - * that you specified instead of the position computed by solver.
+ *The accuracy of the estimated position in meters. An empty value indicates that no + * position data is available. A value of ‘0.0’ value indicates that position data is + * available. This data corresponds to the position information that you specified instead + * of the position computed by solver.
*/ Accuracy?: Accuracy; @@ -3953,8 +4087,8 @@ export interface GetPositionConfigurationResponse { Solvers?: PositionSolverDetails; /** - *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.
+ *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.
*/ Destination?: string; } @@ -4032,26 +4166,27 @@ export interface WiFiAccessPoint { */ export interface GetPositionEstimateRequest { /** - *Retrieves an estimated device position by resolving WLAN measurement data. The position is - * resolved using HERE's Wi-Fi based solver.
+ *Retrieves an estimated device position by resolving WLAN measurement data. The + * position is resolved using HERE's Wi-Fi based solver.
*/ WiFiAccessPoints?: WiFiAccessPoint[]; /** - *Retrieves an estimated device position by resolving measurement data from cellular radio towers. The - * position is resolved using HERE's cellular-based solver.
+ *Retrieves an estimated device position by resolving measurement data from cellular + * radio towers. The position is resolved using HERE's cellular-based solver.
*/ CellTowers?: CellTowers; /** - *Retrieves an estimated device position by resolving the IP address information from the device. The - * position is resolved using MaxMind's IP-based solver.
+ *Retrieves an estimated device position by resolving the IP address information from + * the device. The position is resolved using MaxMind's IP-based solver.
*/ Ip?: Ip; /** - *Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) - * scan data. The position is resolved using the GNSS solver powered by LoRa Cloud.
+ *Retrieves an estimated device position by resolving the global navigation satellite + * system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa + * Cloud.
*/ Gnss?: Gnss; @@ -4068,8 +4203,9 @@ export interface GetPositionEstimateRequest { */ export interface GetPositionEstimateResponse { /** - *The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, - * which a format that's used to encode geographic data structures. For more information, see GeoJSON.
+ *The position information of the resource, displayed as a JSON payload. The payload + * uses the GeoJSON format, which a format that's used to encode geographic data + * structures. For more information, see GeoJSON.
*/ GeoJsonPayload?: Uint8Array; } @@ -4089,7 +4225,8 @@ export interface GetResourceEventConfigurationRequest { IdentifierType: IdentifierType | string | undefined; /** - *Partner type of the resource if the identifier type is PartnerAccountId
.
Partner type of the resource if the identifier type is
+ * PartnerAccountId
.
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.
+ *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.
*/ ResourceIdentifier: string | undefined; /** - *The type of the resource, which can be WirelessDevice
or WirelessGateway
.
The type of the resource, which can be WirelessDevice
or
+ * WirelessGateway
.
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.
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.
The type of resource for which position information is retrieved, which can be a wireless device or a - * wireless gateway.
+ *The type of resource for which position information is retrieved, which can be a + * wireless device or a wireless gateway.
*/ ResourceType: PositionResourceType | string | undefined; } @@ -4174,8 +4313,9 @@ export interface GetResourcePositionRequest { */ export interface GetResourcePositionResponse { /** - *The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, - * which a format that's used to encode geographic data structures. For more information, see GeoJSON.
+ *The position information of the resource, displayed as a JSON payload. The payload + * uses the GeoJSON format, which a format that's used to encode geographic data + * structures. For more information, see GeoJSON.
*/ GeoJsonPayload?: Uint8Array; } @@ -4199,9 +4339,9 @@ export type WirelessGatewayServiceType = (typeof WirelessGatewayServiceType)[key */ export interface GetServiceEndpointRequest { /** - *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.
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.
The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.
+ *The name of the thing associated with the wireless device. The value is empty if a + * thing isn't associated with the device.
*/ ThingName?: string; @@ -4511,7 +4652,8 @@ export interface GetWirelessDeviceResponse { Sidewalk?: SidewalkDevice; /** - *FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
+ *FPort values for the GNSS, stream, and ClockSync functions of the positioning + * information.
*/ Positioning?: PositioningConfigStatus | string; } @@ -4725,6 +4867,9 @@ export interface GetWirelessDeviceStatisticsResponse { /** *The date and time when the most recent uplink was received.
+ *This value is only valid for 3 months.
+ *The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.
+ *The name of the thing associated with the wireless gateway. The value is empty if a + * thing isn't associated with the gateway.
*/ ThingName?: string; @@ -4829,7 +4975,8 @@ export interface GetWirelessGatewayCertificateResponse { IotCertificateId?: string; /** - *The ID of the certificate that is associated with the wireless gateway and used for the LoRaWANNetworkServer endpoint.
+ *The ID of the certificate that is associated with the wireless gateway and used for + * the LoRaWANNetworkServer endpoint.
*/ LoRaWANNetworkServerCertificateId?: string; } @@ -4886,6 +5033,9 @@ export interface GetWirelessGatewayStatisticsResponse { /** *The date and time when the most recent uplink was received.
+ *This value is only valid for 3 months.
+ *The date and time when the most recent uplink was received.
+ *This value is only valid for 3 months.
+ *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
.
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
.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response;
- * otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response;
- * otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null
- * to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
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.
+ *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.
*/ Destination?: string; } @@ -5445,13 +5623,15 @@ export interface ListPositionConfigurationsResponse { */ export interface ListQueuedMessagesRequest { /** - *The ID of a given wireless device which the downlink message packets are being sent.
+ *The ID of a given wireless device which the downlink message packets are being + * sent.
*/ Id: string | undefined; /** - *To retrieve the next set of results, the nextToken
value from a previous response; otherwise
- * null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response;
- * otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
+ *The tags to attach to the specified resource. Tags are metadata that you can use to + * manage a resource.
*/ Tags?: Tag[]; } @@ -5661,7 +5845,9 @@ export interface ListWirelessDevicesRequest { MaxResults?: number; /** - *To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
Sidewalk object used by list functions.
- */ -export interface SidewalkListDevice { - /** - *The Sidewalk Amazon ID.
- */ - AmazonId?: string; - - /** - *The sidewalk device identification.
- */ - SidewalkId?: string; - - /** - *The Sidewalk manufacturing series number.
- */ - SidewalkManufacturingSn?: string; - - /** - *The sidewalk device certificates for Ed25519 and P256r1.
- */ - DeviceCertificates?: CertificateList[]; - - /** - *Sidewalk object used by list functions.
- */ - DeviceProfileId?: string; - - /** - *The status of the Sidewalk devices, such as provisioned or registered.
- */ - Status?: WirelessDeviceSidewalkStatus | string; -} - /** * @internal */ diff --git a/clients/client-iot-wireless/src/models/models_1.ts b/clients/client-iot-wireless/src/models/models_1.ts index 3a045e75becc..f0507f1e0f57 100644 --- a/clients/client-iot-wireless/src/models/models_1.ts +++ b/clients/client-iot-wireless/src/models/models_1.ts @@ -4,6 +4,7 @@ import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from " import { IoTWirelessServiceException as __BaseException } from "./IoTWirelessServiceException"; import { ApplicationConfig, + CertificateList, ConnectionStatusEventConfiguration, ConnectionStatusResourceTypeEventConfiguration, DeviceRegistrationStateEventConfiguration, @@ -32,14 +33,50 @@ import { PositionResourceType, ProximityEventConfiguration, ProximityResourceTypeEventConfiguration, - SidewalkListDevice, Tag, TraceContent, WirelessDeviceLogOption, + WirelessDeviceSidewalkStatus, WirelessDeviceType, WirelessGatewayLogOption, } from "./models_0"; +/** + * @public + *Sidewalk object used by list functions.
+ */ +export interface SidewalkListDevice { + /** + *The Sidewalk Amazon ID.
+ */ + AmazonId?: string; + + /** + *The sidewalk device identification.
+ */ + SidewalkId?: string; + + /** + *The Sidewalk manufacturing series number.
+ */ + SidewalkManufacturingSn?: string; + + /** + *The sidewalk device certificates for Ed25519 and P256r1.
+ */ + DeviceCertificates?: CertificateList[]; + + /** + *Sidewalk object used by list functions.
+ */ + DeviceProfileId?: string; + + /** + *The status of the Sidewalk devices, such as provisioned or registered.
+ */ + Status?: WirelessDeviceSidewalkStatus | string; +} + /** * @public *Information about a wireless device's operation.
@@ -72,6 +109,9 @@ export interface WirelessDeviceStatistics { /** *The date and time when the most recent uplink was received.
+ *Theis value is only valid for 3 months.
+ *To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
The date and time when the most recent uplink was received.
+ *This value is only valid for 3 months.
+ *To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous
+ * response; otherwise null to receive the first set of
+ * results.
A filter to list only the wireless gateway task definitions that use this task definition type.
+ *A filter to list only the wireless gateway task definitions that use this task + * definition type.
*/ TaskDefinitionType?: WirelessGatewayTaskDefinitionType | string; } @@ -305,18 +353,20 @@ export interface PutPositionConfigurationRequest { ResourceIdentifier: string | undefined; /** - *Resource type of the resource for which you want to update the position configuration.
+ *Resource type of the resource for which you want to update the position + * configuration.
*/ ResourceType: PositionResourceType | string | undefined; /** - *The positioning solvers used to update the position configuration of the resource.
+ *The positioning solvers used to update the position configuration of the + * resource.
*/ Solvers?: PositionSolverConfigurations; /** - *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.
+ *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.
*/ Destination?: string; } @@ -331,19 +381,21 @@ export interface PutPositionConfigurationResponse {} */ export interface PutResourceLogLevelRequest { /** - *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.
+ *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.
*/ ResourceIdentifier: string | undefined; /** - *The type of the resource, which can be WirelessDevice
or WirelessGateway
.
The type of the resource, which can be WirelessDevice
or
+ * WirelessGateway
.
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.
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.
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.
+ *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.
*/ ResourceIdentifier: string | undefined; /** - *The type of the resource, which can be WirelessDevice
or WirelessGateway
.
The type of the resource, which can be WirelessDevice
or
+ * WirelessGateway
.
Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY
.
Sidewalk device message type. Default value is
+ * CUSTOM_COMMAND_ID_NOTIFY
.
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).
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).
Query string used to search for wireless devices as part of the bulk associate and disassociate process.
+ *Query string used to search for wireless devices as part of the bulk associate and + * disassociate process.
*/ QueryString?: string; /** - *The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
+ *The tag to attach to the specified resource. Tags are metadata that you can use to + * manage a resource.
*/ Tags?: Tag[]; } @@ -559,12 +616,14 @@ export interface StartBulkDisassociateWirelessDeviceFromMulticastGroupRequest { Id: string | undefined; /** - *Query string used to search for wireless devices as part of the bulk associate and disassociate process.
+ *Query string used to search for wireless devices as part of the bulk associate and + * disassociate process.
*/ QueryString?: string; /** - *The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
+ *The tag to attach to the specified resource. Tags are metadata that you can use to + * manage a resource.
*/ Tags?: Tag[]; } @@ -647,7 +706,10 @@ export interface StartSingleWirelessDeviceImportTaskRequest { DestinationName: string | undefined; /** - *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.
+ *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.
*/ ClientRequestToken?: string; @@ -657,7 +719,8 @@ export interface StartSingleWirelessDeviceImportTaskRequest { DeviceName?: string; /** - *The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
+ *The tag to attach to the specified resource. Tags are metadata that you can use to + * manage a resource.
*/ Tags?: Tag[]; @@ -709,12 +772,16 @@ export interface StartWirelessDeviceImportTaskRequest { DestinationName: string | undefined; /** - *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.
+ *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.
*/ ClientRequestToken?: string; /** - *The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
+ *The tag to attach to the specified resource. Tags are metadata that you can use to + * manage a resource.
*/ Tags?: Tag[]; @@ -749,7 +816,8 @@ export interface TagResourceRequest { ResourceArn: string | undefined; /** - *Adds to or modifies the tags of the given resource. Tags are metadata that you can use to manage a resource.
+ *Adds to or modifies the tags of the given resource. Tags are metadata that you can use + * to manage a resource.
*/ Tags: Tag[] | undefined; } @@ -866,28 +934,32 @@ export interface UpdateDestinationResponse {} */ export interface UpdateEventConfigurationByResourceTypesRequest { /** - *Device registration state resource type event configuration object for enabling and disabling wireless - * gateway topic.
+ *Device registration state resource type event configuration object for enabling and + * disabling wireless gateway topic.
*/ DeviceRegistrationState?: DeviceRegistrationStateResourceTypeEventConfiguration; /** - *Proximity resource type event configuration object for enabling and disabling wireless gateway topic.
+ *Proximity resource type event configuration object for enabling and disabling wireless + * gateway topic.
*/ Proximity?: ProximityResourceTypeEventConfiguration; /** - *Join resource type event configuration object for enabling and disabling wireless device topic.
+ *Join resource type event configuration object for enabling and disabling wireless + * device topic.
*/ Join?: JoinResourceTypeEventConfiguration; /** - *Connection status resource type event configuration object for enabling and disabling wireless gateway topic.
+ *Connection status resource type event configuration object for enabling and disabling + * wireless gateway topic.
*/ ConnectionStatus?: ConnectionStatusResourceTypeEventConfiguration; /** - *Message delivery status resource type event configuration object for enabling and disabling wireless device topic.
+ *Message delivery status resource type event configuration object for enabling and + * disabling wireless device topic.
*/ MessageDeliveryStatus?: MessageDeliveryStatusResourceTypeEventConfiguration; } @@ -922,7 +994,8 @@ export interface UpdateFuotaTaskRequest { LoRaWAN?: LoRaWANFuotaTask; /** - *The S3 URI points to a firmware update image that is to be used with a FUOTA task.
+ *The S3 URI points to a firmware update image that is to be used with a FUOTA + * task.
*/ FirmwareUpdateImage?: string; @@ -932,21 +1005,28 @@ export interface UpdateFuotaTaskRequest { FirmwareUpdateRole?: string; /** - *The percentage of added redundant fragments. For example, if firmware file is
- * 100 bytes and fragment size is 10 bytes, with RedundancyPercent
set to 50(%),
- * the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.
The percentage of the added fragments that are redundant. For example, if the size of
+ * the firmware image file is 100 bytes and the fragment size is 10 bytes, with
+ * RedundancyPercent
set to 50(%), the final number of encoded fragments
+ * is (100 / 10) + (100 / 10 * 50%) = 15.
The size of each fragment in bytes. Currently only supported in fuota tasks with multicast groups.
+ *The size of each fragment in bytes. This parameter is supported only for FUOTA tasks + * with multicast groups.
*/ FragmentSizeBytes?: number; /** - *The interval of sending fragments in milliseconds. Currently the interval will be rounded to the nearest second. - * Note that this interval only controls the timing when the cloud sends the fragments down. - * The actual delay of receiving fragments at device side depends on the device's class and the communication delay with the cloud.
+ *The interval for sending fragments in milliseconds, rounded to the nearest + * second.
+ *This interval only determines the timing for when the Cloud sends down the + * fragments to yor device. There can be a delay for when your device will receive + * these fragments. This delay depends on the device's class and the communication + * delay with the cloud.
+ *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.
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 resources to add to the network analyzer configuration. Provide the
- * WirelessDeviceId
of the resource to add in the input array.
WirelessDeviceId
of the resource to add in the input array.
*/
WirelessDevicesToAdd?: string[];
/**
- * Wireless device resources to remove from the network analyzer configuration. Provide the
- * WirelessDeviceId
of the resources to remove in the input array.
Wireless device resources to remove from the network analyzer configuration. Provide
+ * the WirelessDeviceId
of the resources to remove in the input array.
Wireless gateway resources to add to the network analyzer configuration. Provide the
- * WirelessGatewayId
of the resource to add in the input array.
WirelessGatewayId
of the resource to add in the input array.
*/
WirelessGatewaysToAdd?: string[];
/**
- * Wireless gateway resources to remove from the network analyzer configuration. Provide the
- * WirelessGatewayId
of the resources to remove in the input array.
Wireless gateway resources to remove from the network analyzer configuration. Provide
+ * the WirelessGatewayId
of the resources to remove in the input array.
The description of the new resource.
*/ Description?: string; + + /** + *Multicast group resources to add to the network analyzer configuration. Provide the
+ * MulticastGroupId
of the resource to add in the input array.
Multicast group resources to remove from the network analyzer configuration. Provide the
+ * MulticastGroupId
of the resource to remove in the input array.
Partner type of the resource if the identifier type is PartnerAccountId
+ *
Partner type of the resource if the identifier type is
+ * PartnerAccountId
*
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
+ *FPort values for the GNSS, stream, and ClockSync functions of the positioning + * information.
*/ Positioning?: PositioningConfigStatus | string; } @@ -1366,7 +1461,8 @@ export interface UpdateWirelessGatewayRequest { JoinEuiFilters?: string[][]; /** - *A list of NetId values that are used by LoRa gateways to filter the uplink frames.
+ *A list of NetId values that are used by LoRa gateways to filter the uplink + * frames.
*/ NetIdFilters?: string[]; diff --git a/clients/client-iot-wireless/src/protocols/Aws_restJson1.ts b/clients/client-iot-wireless/src/protocols/Aws_restJson1.ts index 0c6c0e832a75..af655c80a817 100644 --- a/clients/client-iot-wireless/src/protocols/Aws_restJson1.ts +++ b/clients/client-iot-wireless/src/protocols/Aws_restJson1.ts @@ -888,6 +888,7 @@ export const se_CreateNetworkAnalyzerConfigurationCommand = async ( take(input, { ClientRequestToken: [true, (_) => _ ?? generateIdempotencyToken()], Description: [], + MulticastGroups: (_) => _json(_), Name: [], Tags: (_) => _json(_), TraceContent: (_) => _json(_), @@ -3491,6 +3492,8 @@ export const se_UpdateNetworkAnalyzerConfigurationCommand = async ( body = JSON.stringify( take(input, { Description: [], + MulticastGroupsToAdd: (_) => _json(_), + MulticastGroupsToRemove: (_) => _json(_), TraceContent: (_) => _json(_), WirelessDevicesToAdd: (_) => _json(_), WirelessDevicesToRemove: (_) => _json(_), @@ -6443,6 +6446,7 @@ export const de_GetNetworkAnalyzerConfigurationCommand = async ( const doc = take(data, { Arn: __expectString, Description: __expectString, + MulticastGroups: _json, Name: __expectString, TraceContent: _json, WirelessDevices: _json, @@ -10558,6 +10562,8 @@ const se_LteObj = (input: LteObj, context: __SerdeContext): any => { // se_NetIdFilters omitted. +// se_NetworkAnalyzerMulticastGroupList omitted. + // se_OtaaV1_0_x omitted. // se_OtaaV1_1 omitted. @@ -10903,6 +10909,8 @@ const de_LoRaWANMulticastSession = (output: any, context: __SerdeContext): LoRaW // de_NetworkAnalyzerConfigurations omitted. +// de_NetworkAnalyzerMulticastGroupList omitted. + // de_OtaaV1_0_x omitted. // de_OtaaV1_1 omitted. diff --git a/codegen/sdk-codegen/aws-models/iot-wireless.json b/codegen/sdk-codegen/aws-models/iot-wireless.json index b23caac9f23d..e2bb7d3d0c63 100644 --- a/codegen/sdk-codegen/aws-models/iot-wireless.json +++ b/codegen/sdk-codegen/aws-models/iot-wireless.json @@ -106,18 +106,18 @@ "HorizontalAccuracy": { "target": "com.amazonaws.iotwireless#HorizontalAccuracy", "traits": { - "smithy.api#documentation": "The horizontal accuracy of the estimated position, which is the difference between the estimated\n location and the actual device location.
" + "smithy.api#documentation": "The horizontal accuracy of the estimated position, which is the difference between the\n estimated location and the actual device location.
" } }, "VerticalAccuracy": { "target": "com.amazonaws.iotwireless#VerticalAccuracy", "traits": { - "smithy.api#documentation": "The vertical accuracy of the estimated position, which is the difference between the estimated\n altitude and actual device latitude in meters.
" + "smithy.api#documentation": "The vertical accuracy of the estimated position, which is the difference between the\n estimated altitude and actual device latitude in meters.
" } } }, "traits": { - "smithy.api#documentation": "The accuracy of the estimated position in meters. An empty value indicates that no position data is available. \n A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information\n that you specified instead of the position computed by solver.
" + "smithy.api#documentation": "The accuracy of the estimated position in meters. An empty value indicates that no\n position data is available. A value of ‘0.0’ value indicates that position data is\n available. This data corresponds to the position information that you specified instead\n of the position computed by solver.
" } }, "com.amazonaws.iotwireless#AckModeRetryDurationSecs": { @@ -305,14 +305,14 @@ "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.iotwireless#TagList", "traits": { - "smithy.api#documentation": "The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
" + "smithy.api#documentation": "The tags to attach to the specified resource. Tags are metadata that you can use to\n manage a resource.
" } } }, @@ -1205,7 +1205,7 @@ "com.amazonaws.iotwireless#ClientRequestToken": { "type": "string", "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client\n request.
", "smithy.api#length": { "min": 1, "max": 64 @@ -1261,13 +1261,13 @@ "LoRaWAN": { "target": "com.amazonaws.iotwireless#LoRaWANConnectionStatusEventNotificationConfigurations", "traits": { - "smithy.api#documentation": "Connection status event configuration object for enabling or disabling LoRaWAN related event topics.
" + "smithy.api#documentation": "Connection status event configuration object for enabling or disabling LoRaWAN related\n event topics.
" } }, "WirelessGatewayIdEventTopic": { "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", "traits": { - "smithy.api#documentation": "Denotes whether the wireless gateway ID connection status event topic is enabled or disabled.
" + "smithy.api#documentation": "Denotes whether the wireless gateway ID connection status event topic is enabled or\n disabled.
" } } }, @@ -1281,12 +1281,12 @@ "LoRaWAN": { "target": "com.amazonaws.iotwireless#LoRaWANConnectionStatusResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Connection status resource type event configuration object for enabling or disabling LoRaWAN related\n event topics.
" + "smithy.api#documentation": "Connection status resource type event configuration object for enabling or disabling\n LoRaWAN related event topics.
" } } }, "traits": { - "smithy.api#documentation": "Connection status resource type event configuration object for enabling or disabling topic.
" + "smithy.api#documentation": "Connection status resource type event configuration object for enabling or disabling\n topic.
" } }, "com.amazonaws.iotwireless#Coordinate": { @@ -1378,13 +1378,13 @@ "Tags": { "target": "com.amazonaws.iotwireless#TagList", "traits": { - "smithy.api#documentation": "The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.
" + "smithy.api#documentation": "The tags to attach to the new destination. Tags are metadata that you can use to\n manage a resource.
" } }, "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", "smithy.api#idempotencyToken": {} } } @@ -1465,13 +1465,13 @@ "Tags": { "target": "com.amazonaws.iotwireless#TagList", "traits": { - "smithy.api#documentation": "The tags to attach to the new device profile. Tags are metadata that you can use to manage a resource.
" + "smithy.api#documentation": "The tags to attach to the new device profile. Tags are metadata that you can use to\n manage a resource.
" } }, "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", "smithy.api#idempotencyToken": {} } }, @@ -1656,7 +1656,7 @@ "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new resource with the\n same token as a resource that already exists, an exception occurs. If you omit this value,\n AWS SDKs will automatically generate a unique client request.
", + "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", "smithy.api#idempotencyToken": {} } }, @@ -1740,13 +1740,13 @@ "WirelessDevices": { "target": "com.amazonaws.iotwireless#WirelessDeviceList", "traits": { - "smithy.api#documentation": "Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId
of the resource to add in the input array.
Wireless device resources to add to the network analyzer configuration. Provide the\n WirelessDeviceId
of the resource to add in the input array.
Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId
of the resource to add in the input array.
Wireless gateway resources to add to the network analyzer configuration. Provide the\n WirelessGatewayId
of the resource to add in the input array.
Multicast Group resources to add to the network analyzer configruation. Provide the\n MulticastGroupId
of the resource to add in the input array.
The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.
" + "smithy.api#documentation": "The tags to attach to the new service profile. Tags are metadata that you can use to\n manage a resource.
" } }, "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", "smithy.api#idempotencyToken": {} } } @@ -1939,7 +1945,7 @@ "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", "smithy.api#idempotencyToken": {} } }, @@ -1952,13 +1958,13 @@ "Tags": { "target": "com.amazonaws.iotwireless#TagList", "traits": { - "smithy.api#documentation": "The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.
" + "smithy.api#documentation": "The tags to attach to the new wireless device. Tags are metadata that you can use to\n manage a resource.
" } }, "Positioning": { "target": "com.amazonaws.iotwireless#PositioningConfigStatus", "traits": { - "smithy.api#documentation": "FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
" + "smithy.api#documentation": "FPort values for the GNSS, stream, and ClockSync functions of the positioning\n information.
" } }, "Sidewalk": { @@ -2051,13 +2057,13 @@ "Tags": { "target": "com.amazonaws.iotwireless#TagList", "traits": { - "smithy.api#documentation": "The tags to attach to the new wireless gateway. Tags are metadata that you can use to manage a resource.
" + "smithy.api#documentation": "The tags to attach to the new wireless gateway. Tags are metadata that you can use to\n manage a resource.
" } }, "ClientRequestToken": { "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", "smithy.api#idempotencyToken": {} } } @@ -2167,7 +2173,7 @@ "target": "com.amazonaws.iotwireless#AutoCreateTasks", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "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
.
Whether to automatically create tasks using this task definition for all gateways with\n the specified current version. If false
, the task must me created by\n calling CreateWirelessGatewayTask
.
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.
", + "smithy.api#documentation": "Each resource must have a unique client request token. If you try to create a new\n resource with the same token as a resource that already exists, an exception occurs. If\n you omit this value, AWS SDKs will automatically generate a unique client request.\n
", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.iotwireless#TagList", "traits": { - "smithy.api#documentation": "The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
" + "smithy.api#documentation": "The tags to attach to the specified resource. Tags are metadata that you can use to\n manage a resource.
" } } }, @@ -2993,7 +2999,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.
", + "smithy.api#documentation": "Deletes a wireless gateway task definition. Deleting this task definition does not\n affect tasks that are currently in progress.
", "smithy.api#http": { "method": "DELETE", "uri": "/wireless-gateway-task-definitions/{Id}", @@ -3305,18 +3311,18 @@ "Sidewalk": { "target": "com.amazonaws.iotwireless#SidewalkEventNotificationConfigurations", "traits": { - "smithy.api#documentation": "Device registration state event configuration object for enabling or disabling Sidewalk related event\n topics.
" + "smithy.api#documentation": "Device registration state event configuration object for enabling or disabling\n Sidewalk related event topics.
" } }, "WirelessDeviceIdEventTopic": { "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", "traits": { - "smithy.api#documentation": "Denotes whether the wireless device ID device registration state event topic is enabled or disabled.
" + "smithy.api#documentation": "Denotes whether the wireless device ID device registration state event topic is\n enabled or disabled.
" } } }, "traits": { - "smithy.api#documentation": "Device registration state event configuration object for enabling and disabling relevant topics.
" + "smithy.api#documentation": "Device registration state event configuration object for enabling and disabling\n relevant topics.
" } }, "com.amazonaws.iotwireless#DeviceRegistrationStateResourceTypeEventConfiguration": { @@ -3325,12 +3331,12 @@ "Sidewalk": { "target": "com.amazonaws.iotwireless#SidewalkResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Device registration resource type state event configuration object for enabling or disabling Sidewalk\n related event topics.
" + "smithy.api#documentation": "Device registration resource type state event configuration object for enabling or\n disabling Sidewalk related event topics.
" } } }, "traits": { - "smithy.api#documentation": "Device registration state resource type event configuration object for enabling or disabling topic.
" + "smithy.api#documentation": "Device registration state resource type event configuration object for enabling or\n disabling topic.
" } }, "com.amazonaws.iotwireless#DeviceState": { @@ -3397,7 +3403,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates your AWS account from a partner account. If PartnerAccountId
and PartnerType
are null
, disassociates your AWS account from all partner accounts.
Disassociates your AWS account from a partner account. If\n PartnerAccountId
and PartnerType
are null
,\n disassociates your AWS account from all partner accounts.
The message ID assigned by IoT Wireless to each downlink message, which helps identify the\n message.
" + "smithy.api#documentation": "The message ID assigned by IoT Wireless to each downlink message, which helps\n identify the message.
" } }, "TransmitMode": { "target": "com.amazonaws.iotwireless#TransmitMode", "traits": { - "smithy.api#documentation": "The transmit mode to use for sending data to the wireless device. This can be 0
for UM (unacknowledge mode)\n or 1
for AM (acknowledge mode).
The transmit mode to use for sending data to the wireless device. This can be\n 0
for UM (unacknowledge mode) or 1
for AM (acknowledge\n mode).
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
" + "smithy.api#documentation": "FPort values for the GNSS, stream, and ClockSync functions of the positioning\n information.
" } }, "Applications": { @@ -4283,7 +4289,7 @@ "com.amazonaws.iotwireless#FirmwareUpdateImage": { "type": "string", "traits": { - "smithy.api#documentation": "The S3 URI points to a firmware update image that is to be used with a FUOTA task.
", + "smithy.api#documentation": "The S3 URI points to a firmware update image that is to be used with a FUOTA\n task.
", "smithy.api#length": { "min": 1, "max": 4096 @@ -4303,7 +4309,7 @@ "com.amazonaws.iotwireless#FragmentIntervalMS": { "type": "integer", "traits": { - "smithy.api#documentation": "The interval of sending fragments in milliseconds. Currently the interval will be rounded to the nearest second.\n Note that this interval only controls the timing when the cloud sends the fragments down.\n The actual delay of receiving fragments at device side depends on the device's class and the communication delay with the cloud.
", + "smithy.api#documentation": "The interval for sending fragments in milliseconds, rounded to the nearest\n second.
\nThis interval only determines the timing for when the Cloud sends down the\n fragments to yor device. There can be a delay for when your device will receive\n these fragments. This delay depends on the device's class and the communication\n delay with the cloud.
\nThe size of each fragment in bytes. Currently only supported in fuota tasks with multicast groups.
", + "smithy.api#documentation": "The size of each fragment in bytes. This parameter is supported only for FUOTA tasks\n with multicast groups.
", "smithy.api#range": { "min": 1 } @@ -4507,20 +4513,20 @@ "GatewayId": { "target": "com.amazonaws.iotwireless#WirelessGatewayId", "traits": { - "smithy.api#documentation": "The ID of the wireless gateways that you want to add to the list of gateways when sending\n downlink messages.
", + "smithy.api#documentation": "The ID of the wireless gateways that you want to add to the list of gateways when\n sending downlink messages.
", "smithy.api#required": {} } }, "DownlinkFrequency": { "target": "com.amazonaws.iotwireless#DownlinkFrequency", "traits": { - "smithy.api#documentation": "The frequency to use for the gateways when sending a downlink message to the wireless device.
", + "smithy.api#documentation": "The frequency to use for the gateways when sending a downlink message to the wireless\n device.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Gateway list item object that specifies the frequency and list of gateways for which the downlink message\n should be sent.
" + "smithy.api#documentation": "Gateway list item object that specifies the frequency and list of gateways for which\n the downlink message should be sent.
" } }, "com.amazonaws.iotwireless#GatewayMaxEirp": { @@ -4924,7 +4930,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns current default log levels or log levels by resource types. Based on resource types, log levels can be\n for wireless device log options or wireless gateway log options.
", + "smithy.api#documentation": "Returns current default log levels or log levels by resource types. Based on resource\n types, log levels can be for wireless device log options or wireless gateway log\n options.
", "smithy.api#http": { "method": "GET", "uri": "/log-levels", @@ -5152,13 +5158,13 @@ "WirelessDevices": { "target": "com.amazonaws.iotwireless#WirelessDeviceList", "traits": { - "smithy.api#documentation": "List of wireless gateway resources that have been added to the network analyzer configuration.
" + "smithy.api#documentation": "List of wireless gateway resources that have been added to the network analyzer\n configuration.
" } }, "WirelessGateways": { "target": "com.amazonaws.iotwireless#WirelessGatewayList", "traits": { - "smithy.api#documentation": "List of wireless gateway resources that have been added to the network analyzer configuration.
" + "smithy.api#documentation": "List of wireless gateway resources that have been added to the network analyzer\n configuration.
" } }, "Description": { @@ -5172,6 +5178,12 @@ }, "Name": { "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationName" + }, + "MulticastGroups": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerMulticastGroupList", + "traits": { + "smithy.api#documentation": "List of multicast group resources that have been added to the network analyzer\n configuration.
" + } } }, "traits": { @@ -5201,7 +5213,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a partner account. If PartnerAccountId
and PartnerType
are null
, returns all partner accounts.
Gets information about a partner account. If PartnerAccountId
and\n PartnerType
are null
, returns all partner accounts.
Get the position information for a given resource.
\nThis action is no longer supported. Calls to retrieve the position information\n should use the GetResourcePosition \n API operation instead.
\nGet the position information for a given resource.
\nThis action is no longer supported. Calls to retrieve the position information\n should use the GetResourcePosition API operation instead.
\nGet position configuration for a given resource.
\nThis action is no longer supported. Calls to retrieve the position configuration\n should use the GetResourcePosition \n API operation instead.
\nGet position configuration for a given resource.
\nThis action is no longer supported. Calls to retrieve the position configuration\n should use the GetResourcePosition API operation instead.
\nThe position data destination that describes the AWS IoT rule that processes the device's position data for use by\n AWS IoT Core for LoRaWAN.
" + "smithy.api#documentation": "The position data destination that describes the AWS IoT rule that processes the\n device's position data for use by AWS IoT Core for LoRaWAN.
" } } }, @@ -5404,7 +5416,7 @@ } ], "traits": { - "smithy.api#documentation": "Get estimated position information as a payload in GeoJSON format. The payload measurement data is \n resolved using solvers that are provided by third-party vendors.
", + "smithy.api#documentation": "Get estimated position information as a payload in GeoJSON format. The payload\n measurement data is resolved using solvers that are provided by third-party\n vendors.
", "smithy.api#http": { "method": "POST", "uri": "/position-estimate", @@ -5418,25 +5430,25 @@ "WiFiAccessPoints": { "target": "com.amazonaws.iotwireless#WiFiAccessPoints", "traits": { - "smithy.api#documentation": "Retrieves an estimated device position by resolving WLAN measurement data. The position is\n resolved using HERE's Wi-Fi based solver.
" + "smithy.api#documentation": "Retrieves an estimated device position by resolving WLAN measurement data. The\n position is resolved using HERE's Wi-Fi based solver.
" } }, "CellTowers": { "target": "com.amazonaws.iotwireless#CellTowers", "traits": { - "smithy.api#documentation": "Retrieves an estimated device position by resolving measurement data from cellular radio towers. The \n position is resolved using HERE's cellular-based solver.
" + "smithy.api#documentation": "Retrieves an estimated device position by resolving measurement data from cellular\n radio towers. The position is resolved using HERE's cellular-based solver.
" } }, "Ip": { "target": "com.amazonaws.iotwireless#Ip", "traits": { - "smithy.api#documentation": "Retrieves an estimated device position by resolving the IP address information from the device. The\n position is resolved using MaxMind's IP-based solver.
" + "smithy.api#documentation": "Retrieves an estimated device position by resolving the IP address information from\n the device. The position is resolved using MaxMind's IP-based solver.
" } }, "Gnss": { "target": "com.amazonaws.iotwireless#Gnss", "traits": { - "smithy.api#documentation": "Retrieves an estimated device position by resolving the global navigation satellite system (GNSS)\n scan data. The position is resolved using the GNSS solver powered by LoRa Cloud.
" + "smithy.api#documentation": "Retrieves an estimated device position by resolving the global navigation satellite\n system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa\n Cloud.
" } }, "Timestamp": { @@ -5456,7 +5468,7 @@ "GeoJsonPayload": { "target": "com.amazonaws.iotwireless#GeoJsonPayload", "traits": { - "smithy.api#documentation": "The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, \n which a format that's used to encode geographic data structures. For more information, see GeoJSON.
", + "smithy.api#documentation": "The position information of the resource, displayed as a JSON payload. The payload\n uses the GeoJSON format, which a format that's used to encode geographic data\n structures. For more information, see GeoJSON.
", "smithy.api#httpPayload": {} } } @@ -5504,7 +5516,7 @@ "Accuracy": { "target": "com.amazonaws.iotwireless#Accuracy", "traits": { - "smithy.api#documentation": "The accuracy of the estimated position in meters. An empty value indicates that no position data is available.\n A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information\n that you specified instead of the position computed by solver.
" + "smithy.api#documentation": "The accuracy of the estimated position in meters. An empty value indicates that no\n position data is available. A value of ‘0.0’ value indicates that position data is\n available. This data corresponds to the position information that you specified instead\n of the position computed by solver.
" } }, "SolverType": { @@ -5595,7 +5607,7 @@ "PartnerType": { "target": "com.amazonaws.iotwireless#EventNotificationPartnerType", "traits": { - "smithy.api#documentation": "Partner type of the resource if the identifier type is PartnerAccountId
.
Partner type of the resource if the identifier type is\n PartnerAccountId
.
Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for\n a wireless device or a wireless gateway.
", + "smithy.api#documentation": "Fetches the log-level override, if any, for a given resource-ID and resource-type. It\n can be used for a wireless device or a wireless gateway.
", "smithy.api#http": { "method": "GET", "uri": "/log-levels/{ResourceIdentifier}", @@ -5689,7 +5701,7 @@ "ResourceType": { "target": "com.amazonaws.iotwireless#ResourceType", "traits": { - "smithy.api#documentation": "The type of the resource, which can be WirelessDevice
or WirelessGateway
.
The type of the resource, which can be WirelessDevice
or\n WirelessGateway
.
Get the position information for a given wireless device or a wireless gateway resource.\n The position information uses the World Geodetic System\n (WGS84).
", + "smithy.api#documentation": "Get the position information for a given wireless device or a wireless gateway\n resource. The position information uses the World Geodetic System\n (WGS84).
", "smithy.api#http": { "method": "GET", "uri": "/resource-positions/{ResourceIdentifier}", @@ -5758,7 +5770,7 @@ "ResourceType": { "target": "com.amazonaws.iotwireless#PositionResourceType", "traits": { - "smithy.api#documentation": "The type of resource for which position information is retrieved, which can be a wireless device or a\n wireless gateway.
", + "smithy.api#documentation": "The type of resource for which position information is retrieved, which can be a\n wireless device or a wireless gateway.
", "smithy.api#httpQuery": "resourceType", "smithy.api#required": {} } @@ -5774,7 +5786,7 @@ "GeoJsonPayload": { "target": "com.amazonaws.iotwireless#GeoJsonPayload", "traits": { - "smithy.api#documentation": "The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, \n which a format that's used to encode geographic data structures. For more information, see GeoJSON.
", + "smithy.api#documentation": "The position information of the resource, displayed as a JSON payload. The payload\n uses the GeoJSON format, which a format that's used to encode geographic data\n structures. For more information, see GeoJSON.
", "smithy.api#httpPayload": {} } } @@ -5806,7 +5818,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
", + "smithy.api#documentation": "Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol\n or LoRaWAN Network Server (LNS) connections.
", "smithy.api#http": { "method": "GET", "uri": "/service-endpoint", @@ -5820,7 +5832,7 @@ "ServiceType": { "target": "com.amazonaws.iotwireless#WirelessGatewayServiceType", "traits": { - "smithy.api#documentation": "The service type for which to get endpoint information about. Can be CUPS
for the\n Configuration and Update Server endpoint, or LNS
for the LoRaWAN Network Server endpoint or\n CLAIM
for the global endpoint.
The service type for which to get endpoint information about. Can be CUPS
\n for the Configuration and Update Server endpoint, or LNS
for the LoRaWAN\n Network Server endpoint or CLAIM
for the global endpoint.
The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.
" + "smithy.api#documentation": "The name of the thing associated with the wireless device. The value is empty if a\n thing isn't associated with the device.
" } }, "ThingArn": { @@ -6188,7 +6200,7 @@ "Positioning": { "target": "com.amazonaws.iotwireless#PositioningConfigStatus", "traits": { - "smithy.api#documentation": "FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
" + "smithy.api#documentation": "FPort values for the GNSS, stream, and ClockSync functions of the positioning\n information.
" } } }, @@ -6258,7 +6270,7 @@ "LastUplinkReceivedAt": { "target": "com.amazonaws.iotwireless#ISODateTimeString", "traits": { - "smithy.api#documentation": "The date and time when the most recent uplink was received.
" + "smithy.api#documentation": "The date and time when the most recent uplink was received.
\nThis value is only valid for 3 months.
\nGets the ID of the certificate that is currently associated with a wireless gateway.
", + "smithy.api#documentation": "Gets the ID of the certificate that is currently associated with a wireless\n gateway.
", "smithy.api#http": { "method": "GET", "uri": "/wireless-gateways/{Id}/certificate", @@ -6374,7 +6386,7 @@ "LoRaWANNetworkServerCertificateId": { "target": "com.amazonaws.iotwireless#IotCertificateId", "traits": { - "smithy.api#documentation": "The ID of the certificate that is associated with the wireless gateway and used for the LoRaWANNetworkServer endpoint.
" + "smithy.api#documentation": "The ID of the certificate that is associated with the wireless gateway and used for\n the LoRaWANNetworkServer endpoint.
" } } }, @@ -6506,7 +6518,7 @@ "ThingName": { "target": "com.amazonaws.iotwireless#ThingName", "traits": { - "smithy.api#documentation": "The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.
" + "smithy.api#documentation": "The name of the thing associated with the wireless gateway. The value is empty if a\n thing isn't associated with the gateway.
" } }, "ThingArn": { @@ -6582,7 +6594,7 @@ "LastUplinkReceivedAt": { "target": "com.amazonaws.iotwireless#ISODateTimeString", "traits": { - "smithy.api#documentation": "The date and time when the most recent uplink was received.
" + "smithy.api#documentation": "The date and time when the most recent uplink was received.
\nThis value is only valid for 3 months.
\nWhether 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
.
Whether to automatically create tasks using this task definition for all gateways with\n the specified current version. If false
, the task must me created by\n calling CreateWirelessGatewayTask
.
The date and time when the most recent uplink was received.
" + "smithy.api#documentation": "The date and time when the most recent uplink was received.
\nThis value is only valid for 3 months.
\nA pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.
", + "smithy.api#documentation": "A pair of join EUI describing a range [BegEui, EndEui], both ends are\n inclusive.
", "smithy.api#length": { "min": 2, "max": 2 @@ -7252,7 +7264,7 @@ "LoRaWAN": { "target": "com.amazonaws.iotwireless#LoRaWANJoinEventNotificationConfigurations", "traits": { - "smithy.api#documentation": "Join event configuration object for enabling or disabling LoRaWAN related event topics.
" + "smithy.api#documentation": "Join event configuration object for enabling or disabling LoRaWAN related event\n topics.
" } }, "WirelessDeviceIdEventTopic": { @@ -7272,7 +7284,7 @@ "LoRaWAN": { "target": "com.amazonaws.iotwireless#LoRaWANJoinResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Join resource type event configuration object for enabling or disabling LoRaWAN related\n event topics.
" + "smithy.api#documentation": "Join resource type event configuration object for enabling or disabling LoRaWAN\n related event topics.
" } } }, @@ -7345,7 +7357,7 @@ "NextToken": { "target": "com.amazonaws.iotwireless#NextToken", "traits": { - "smithy.api#documentation": "To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response;\n otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response;\n otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
List position configurations for a given resource, such as positioning solvers.
\nThis action is no longer supported. Calls to retrieve position information\n should use the GetResourcePosition \n API operation instead.
\nList position configurations for a given resource, such as positioning solvers.
\nThis action is no longer supported. Calls to retrieve position information should\n use the GetResourcePosition API operation instead.
\nTo retrieve the next set of results, the nextToken
value from a previous response; otherwise null \n to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
The ID of a given wireless device which the downlink message packets are being sent.
", + "smithy.api#documentation": "The ID of a given wireless device which the downlink message packets are being\n sent.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8175,7 +8187,7 @@ "NextToken": { "target": "com.amazonaws.iotwireless#NextToken", "traits": { - "smithy.api#documentation": "To retrieve the next set of results, the nextToken
value from a previous response; otherwise \n null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; \n otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
" + "smithy.api#documentation": "The tags to attach to the specified resource. Tags are metadata that you can use to\n manage a resource.
" } } }, @@ -8491,7 +8503,7 @@ "NextToken": { "target": "com.amazonaws.iotwireless#NextToken", "traits": { - "smithy.api#documentation": "To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
A filter to list only the wireless gateway task definitions that use this task definition type.
", + "smithy.api#documentation": "A filter to list only the wireless gateway task definitions that use this task\n definition type.
", "smithy.api#httpQuery": "taskDefinitionType" } } @@ -8683,7 +8695,7 @@ "NextToken": { "target": "com.amazonaws.iotwireless#NextToken", "traits": { - "smithy.api#documentation": "To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
To retrieve the next set of results, the nextToken
value from a previous\n response; otherwise null to receive the first set of\n results.
Denotes whether the gateway EUI connection status event topic is enabled or disabled.
" + "smithy.api#documentation": "Denotes whether the gateway EUI connection status event topic is enabled or\n disabled.
" } } }, @@ -8740,7 +8752,7 @@ "WirelessGatewayEventTopic": { "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", "traits": { - "smithy.api#documentation": "Denotes whether the wireless gateway connection status event topic is enabled or disabled.
" + "smithy.api#documentation": "Denotes whether the wireless gateway connection status event topic is enabled or\n disabled.
" } } }, @@ -8895,7 +8907,7 @@ "MacVersion": { "target": "com.amazonaws.iotwireless#MacVersion", "traits": { - "smithy.api#documentation": "The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.
" + "smithy.api#documentation": "The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device\n profile.
" } }, "RegParamsRevision": { @@ -9022,7 +9034,7 @@ "Beaconing": { "target": "com.amazonaws.iotwireless#Beaconing", "traits": { - "smithy.api#documentation": "Beaconing object information, which consists of the data rate and frequency parameters.
" + "smithy.api#documentation": "Beaconing object information, which consists of the data rate and frequency\n parameters.
" } }, "MaxEirp": { @@ -9313,7 +9325,7 @@ } }, "traits": { - "smithy.api#documentation": "The LoRaWAN information that is to be returned from getting multicast group information.
" + "smithy.api#documentation": "The LoRaWAN information that is to be returned from getting multicast group\n information.
" } }, "com.amazonaws.iotwireless#LoRaWANMulticastMetadata": { @@ -9362,7 +9374,7 @@ "ParticipatingGateways": { "target": "com.amazonaws.iotwireless#ParticipatingGateways", "traits": { - "smithy.api#documentation": "Choose the gateways that you want to use for the downlink data traffic when the wireless device\n is running in class B or class C mode.
" + "smithy.api#documentation": "Choose the gateways that you want to use for the downlink data traffic when the\n wireless device is running in class B or class C mode.
" } } }, @@ -9535,7 +9547,7 @@ } }, "traits": { - "smithy.api#documentation": "The log level for a log message. The log levels can be disabled, or set to ERROR
to display\n less verbose logs containing only error information, or to INFO
for more detailed logs.
The log level for a log message. The log levels can be disabled, or set to\n ERROR
to display less verbose logs containing only error information,\n or to INFO
for more detailed logs.
Message delivery status resource type event configuration object for enabling or disabling\n relevant topic.
" + "smithy.api#documentation": "Message delivery status resource type event configuration object for enabling or\n disabling relevant topic.
" } }, "com.amazonaws.iotwireless#MessageId": { @@ -9854,7 +9866,7 @@ } }, "traits": { - "smithy.api#documentation": "Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY
.
Sidewalk device message type. Default value is\n CUSTOM_COMMAND_ID_NOTIFY
.
\n FrameInfo
of your multicast group resources for the trace content. Use\n FrameInfo to debug the multicast communication between your LoRaWAN end devices and the network server.
A list of NetId values that are used by LoRa gateways to filter the uplink frames.
", + "smithy.api#documentation": "A list of NetId values that are used by LoRa gateways to filter the uplink\n frames.
", "smithy.api#length": { "min": 0, "max": 10 @@ -10060,6 +10092,18 @@ "smithy.api#documentation": "Network analyzer configurations.
" } }, + "com.amazonaws.iotwireless#NetworkAnalyzerMulticastGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#MulticastGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.iotwireless#NetworkId": { "type": "integer", "traits": { @@ -10231,27 +10275,27 @@ "DownlinkMode": { "target": "com.amazonaws.iotwireless#DownlinkMode", "traits": { - "smithy.api#documentation": "Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use\n only the chosen gateways from the previous uplink message transmission.
", + "smithy.api#documentation": "Indicates whether to send the downlink message in sequential mode or concurrent mode,\n or to use only the chosen gateways from the previous uplink message transmission.
", "smithy.api#required": {} } }, "GatewayList": { "target": "com.amazonaws.iotwireless#GatewayList", "traits": { - "smithy.api#documentation": "The list of gateways that you want to use for sending the downlink data traffic.
", + "smithy.api#documentation": "The list of gateways that you want to use for sending the downlink data\n traffic.
", "smithy.api#required": {} } }, "TransmissionInterval": { "target": "com.amazonaws.iotwireless#TransmissionInterval", "traits": { - "smithy.api#documentation": "The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the\n payload to the next gateway.
", + "smithy.api#documentation": "The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting\n the payload to the next gateway.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specify the list of gateways to which you want to send downlink data traffic when the wireless \n device is running in class B or class C mode.
" + "smithy.api#documentation": "Specify the list of gateways to which you want to send downlink data traffic when the\n wireless device is running in class B or class C mode.
" } }, "com.amazonaws.iotwireless#PartnerAccountArn": { @@ -10383,7 +10427,7 @@ "Destination": { "target": "com.amazonaws.iotwireless#DestinationName", "traits": { - "smithy.api#documentation": "The position data destination that describes the AWS IoT rule that processes the device's position \n data for use by AWS IoT Core for LoRaWAN.
" + "smithy.api#documentation": "The position data destination that describes the AWS IoT rule that processes the\n device's position data for use by AWS IoT Core for LoRaWAN.
" } } }, @@ -10567,18 +10611,18 @@ "Sidewalk": { "target": "com.amazonaws.iotwireless#SidewalkEventNotificationConfigurations", "traits": { - "smithy.api#documentation": "Proximity event configuration object for enabling or disabling Sidewalk related event topics.
" + "smithy.api#documentation": "Proximity event configuration object for enabling or disabling Sidewalk related event\n topics.
" } }, "WirelessDeviceIdEventTopic": { "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", "traits": { - "smithy.api#documentation": "Denotes whether the wireless device ID proximity event topic is enabled or disabled.
" + "smithy.api#documentation": "Denotes whether the wireless device ID proximity event topic is enabled or\n disabled.
" } } }, "traits": { - "smithy.api#documentation": "Proximity event configuration object for enabling and disabling relevant topics.
" + "smithy.api#documentation": "Proximity event configuration object for enabling and disabling relevant\n topics.
" } }, "com.amazonaws.iotwireless#ProximityResourceTypeEventConfiguration": { @@ -10587,12 +10631,12 @@ "Sidewalk": { "target": "com.amazonaws.iotwireless#SidewalkResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Proximity resource type event configuration object for enabling and disabling wireless device topic.
" + "smithy.api#documentation": "Proximity resource type event configuration object for enabling and disabling wireless\n device topic.
" } } }, "traits": { - "smithy.api#documentation": "Proximity resource type event configuration object for enabling or disabling topic.
" + "smithy.api#documentation": "Proximity resource type event configuration object for enabling or disabling\n topic.
" } }, "com.amazonaws.iotwireless#PutPositionConfiguration": { @@ -10646,7 +10690,7 @@ "ResourceType": { "target": "com.amazonaws.iotwireless#PositionResourceType", "traits": { - "smithy.api#documentation": "Resource type of the resource for which you want to update the position configuration.
", + "smithy.api#documentation": "Resource type of the resource for which you want to update the position\n configuration.
", "smithy.api#httpQuery": "resourceType", "smithy.api#required": {} } @@ -10654,13 +10698,13 @@ "Solvers": { "target": "com.amazonaws.iotwireless#PositionSolverConfigurations", "traits": { - "smithy.api#documentation": "The positioning solvers used to update the position configuration of the resource.
" + "smithy.api#documentation": "The positioning solvers used to update the position configuration of the\n resource.
" } }, "Destination": { "target": "com.amazonaws.iotwireless#DestinationName", "traits": { - "smithy.api#documentation": "The position data destination that describes the AWS IoT rule that processes the device's position\n data for use by AWS IoT Core for LoRaWAN.
" + "smithy.api#documentation": "The position data destination that describes the AWS IoT rule that processes the\n device's position data for use by AWS IoT Core for LoRaWAN.
" } } }, @@ -10707,7 +10751,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway \n or a wireless device. A limit of 200 log level override can be set per account.
", + "smithy.api#documentation": "Sets the log-level override for a resource-ID and resource-type. This option can be\n specified for a wireless gateway or a wireless device. A limit of 200 log level override\n can be set per account.
", "smithy.api#http": { "method": "PUT", "uri": "/log-levels/{ResourceIdentifier}", @@ -10728,7 +10772,7 @@ "ResourceType": { "target": "com.amazonaws.iotwireless#ResourceType", "traits": { - "smithy.api#documentation": "The type of the resource, which can be WirelessDevice
or WirelessGateway
.
The type of the resource, which can be WirelessDevice
or\n WirelessGateway
.
Query string used to search for wireless devices as part of the bulk associate and disassociate process.
", + "smithy.api#documentation": "Query string used to search for wireless devices as part of the bulk associate and\n disassociate process.
", "smithy.api#length": { "min": 0, "max": 4096 @@ -10809,7 +10853,7 @@ "com.amazonaws.iotwireless#RedundancyPercent": { "type": "integer", "traits": { - "smithy.api#documentation": "The percentage of added redundant fragments. For example, if firmware file is\n 100 bytes and fragment size is 10 bytes, with RedundancyPercent
set to 50(%),\n the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.
The percentage of the added fragments that are redundant. For example, if the size of\n the firmware image file is 100 bytes and the fragment size is 10 bytes, with\n RedundancyPercent
set to 50(%), the final number of encoded fragments\n is (100 / 10) + (100 / 10 * 50%) = 15.
Removes the log-level overrides for all resources; both wireless devices and wireless gateways.
", + "smithy.api#documentation": "Removes the log-level overrides for all resources; both wireless devices and wireless\n gateways.
", "smithy.api#http": { "method": "DELETE", "uri": "/log-levels", @@ -10920,7 +10964,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for\n a wireless device or a wireless gateway.
", + "smithy.api#documentation": "Removes the log-level override, if any, for a specific resource-ID and resource-type.\n It can be used for a wireless device or a wireless gateway.
", "smithy.api#http": { "method": "DELETE", "uri": "/log-levels/{ResourceIdentifier}", @@ -10941,7 +10985,7 @@ "ResourceType": { "target": "com.amazonaws.iotwireless#ResourceType", "traits": { - "smithy.api#documentation": "The type of the resource, which can be WirelessDevice
or WirelessGateway
.
The type of the resource, which can be WirelessDevice
or\n WirelessGateway
.
The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, \n it is the wireless gateway ID.
", + "smithy.api#documentation": "The identifier of the resource. For a Wireless Device, it is the wireless device ID.\n For a wireless gateway, it is the wireless gateway ID.
", "smithy.api#length": { "min": 0, "max": 256 @@ -11261,7 +11305,7 @@ "TransmitMode": { "target": "com.amazonaws.iotwireless#TransmitMode", "traits": { - "smithy.api#documentation": "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).
The transmit mode to use to send data to the wireless device. Can be: 0
\n for UM (unacknowledge mode) or 1
for AM (acknowledge mode).
\n SidewalkEventNotificationConfigurations
object, which is the event configuration\n object for Sidewalk-related event topics.
\n SidewalkEventNotificationConfigurations
object, which is the event\n configuration object for Sidewalk-related event topics.
Sidewalk resource type event configuration object for enabling or disabling topic.
" + "smithy.api#documentation": "Sidewalk resource type event configuration object for enabling or disabling\n topic.
" } }, "com.amazonaws.iotwireless#SidewalkSendDataToDevice": { @@ -11853,7 +11897,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a bulk association of all qualifying wireless devices with a multicast group.
", + "smithy.api#documentation": "Starts a bulk association of all qualifying wireless devices with a multicast\n group.
", "smithy.api#http": { "method": "PATCH", "uri": "/multicast-groups/{Id}/bulk", @@ -11915,7 +11959,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.
", + "smithy.api#documentation": "Starts a bulk disassociatin of all qualifying wireless devices from a multicast\n group.
", "smithy.api#http": { "method": "POST", "uri": "/multicast-groups/{Id}/bulk", @@ -12477,7 +12521,7 @@ "target": "com.amazonaws.iotwireless#Tag" }, "traits": { - "smithy.api#documentation": "The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
", + "smithy.api#documentation": "The tag to attach to the specified resource. Tags are metadata that you can use to\n manage a resource.
", "smithy.api#length": { "min": 0, "max": 200 @@ -12535,7 +12579,7 @@ "Tags": { "target": "com.amazonaws.iotwireless#TagList", "traits": { - "smithy.api#documentation": "Adds to or modifies the tags of the given resource. Tags are metadata that you can use to manage a resource.
", + "smithy.api#documentation": "Adds to or modifies the tags of the given resource. Tags are metadata that you can use\n to manage a resource.
", "smithy.api#required": {} } } @@ -12753,7 +12797,7 @@ } ], "traits": { - "smithy.api#documentation": "Simulates a provisioned device by sending an uplink data payload of Hello
.
Simulates a provisioned device by sending an uplink data payload of\n Hello
.
Device registration state resource type event configuration object for enabling and disabling wireless\n gateway topic.
" + "smithy.api#documentation": "Device registration state resource type event configuration object for enabling and\n disabling wireless gateway topic.
" } }, "Proximity": { "target": "com.amazonaws.iotwireless#ProximityResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Proximity resource type event configuration object for enabling and disabling wireless gateway topic.
" + "smithy.api#documentation": "Proximity resource type event configuration object for enabling and disabling wireless\n gateway topic.
" } }, "Join": { "target": "com.amazonaws.iotwireless#JoinResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Join resource type event configuration object for enabling and disabling wireless device topic.
" + "smithy.api#documentation": "Join resource type event configuration object for enabling and disabling wireless\n device topic.
" } }, "ConnectionStatus": { "target": "com.amazonaws.iotwireless#ConnectionStatusResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Connection status resource type event configuration object for enabling and disabling wireless gateway topic.
" + "smithy.api#documentation": "Connection status resource type event configuration object for enabling and disabling\n wireless gateway topic.
" } }, "MessageDeliveryStatus": { "target": "com.amazonaws.iotwireless#MessageDeliveryStatusResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Message delivery status resource type event configuration object for enabling and disabling wireless device topic.
" + "smithy.api#documentation": "Message delivery status resource type event configuration object for enabling and\n disabling wireless device topic.
" } } }, @@ -13297,7 +13344,7 @@ } ], "traits": { - "smithy.api#documentation": "Set default log level, or log levels by resource types. This can be for wireless device log options or\n wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.
", + "smithy.api#documentation": "Set default log level, or log levels by resource types. This can be for wireless\n device log options or wireless gateways log options and is used to control the log\n messages that'll be displayed in CloudWatch.
", "smithy.api#http": { "method": "POST", "uri": "/log-levels", @@ -13447,29 +13494,41 @@ "WirelessDevicesToAdd": { "target": "com.amazonaws.iotwireless#WirelessDeviceList", "traits": { - "smithy.api#documentation": "Wireless device resources to add to the network analyzer configuration. Provide the \n WirelessDeviceId
of the resource to add in the input array.
Wireless device resources to add to the network analyzer configuration. Provide the\n WirelessDeviceId
of the resource to add in the input array.
Wireless device resources to remove from the network analyzer configuration. Provide the \n WirelessDeviceId
of the resources to remove in the input array.
Wireless device resources to remove from the network analyzer configuration. Provide\n the WirelessDeviceId
of the resources to remove in the input array.
Wireless gateway resources to add to the network analyzer configuration. Provide the \n WirelessGatewayId
of the resource to add in the input array.
Wireless gateway resources to add to the network analyzer configuration. Provide the\n WirelessGatewayId
of the resource to add in the input array.
Wireless gateway resources to remove from the network analyzer configuration. Provide the \n WirelessGatewayId
of the resources to remove in the input array.
Wireless gateway resources to remove from the network analyzer configuration. Provide\n the WirelessGatewayId
of the resources to remove in the input array.
Multicast group resources to add to the network analyzer configuration. Provide the\n MulticastGroupId
of the resource to add in the input array.
Multicast group resources to remove from the network analyzer configuration. Provide the\n MulticastGroupId
of the resource to remove in the input array.
Partner type of the resource if the identifier type is PartnerAccountId
\n
Partner type of the resource if the identifier type is\n PartnerAccountId
\n
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
" + "smithy.api#documentation": "FPort values for the GNSS, stream, and ClockSync functions of the positioning\n information.
" } } }, @@ -14374,7 +14433,7 @@ } }, "traits": { - "smithy.api#documentation": "The log options for a wireless device event and can be used to set log levels for a specific wireless device event.
\nFor a LoRaWAN device, possible events for a log messsage are: Join
, Rejoin
, \n Downlink_Data
, and Uplink_Data
. For a Sidewalk device, possible events for a log message are \n Registration
, Downlink_Data
, and Uplink_Data
.
The log options for a wireless device event and can be used to set log levels for a\n specific wireless device event.
\nFor a LoRaWAN device, possible events for a log messsage are: Join
,\n Rejoin
, Downlink_Data
, and Uplink_Data
. For a\n Sidewalk device, possible events for a log message are Registration
,\n Downlink_Data
, and Uplink_Data
.
\n FrameInfo
of your wireless device resources for the trace content. Use FrameInfo to debug\n the communication between your LoRaWAN end devices and the network server.
\n FrameInfo
of your wireless device resources for the trace content. Use\n FrameInfo to debug the communication between your LoRaWAN end devices and the network\n server.
The log options for wireless devices and can be used to set log levels for a specific type of wireless device.
" + "smithy.api#documentation": "The log options for wireless devices and can be used to set log levels for a specific\n type of wireless device.
" } }, "com.amazonaws.iotwireless#WirelessDeviceLogOptionList": { @@ -14644,7 +14703,7 @@ "LastUplinkReceivedAt": { "target": "com.amazonaws.iotwireless#ISODateTimeString", "traits": { - "smithy.api#documentation": "The date and time when the most recent uplink was received.
" + "smithy.api#documentation": "The date and time when the most recent uplink was received.
\nTheis value is only valid for 3 months.
\nThe log options for a wireless gateway event and can be used to set log levels for a specific wireless gateway event.
\nFor a LoRaWAN gateway, possible events for a log message are CUPS_Request
and Certificate
.
The log options for a wireless gateway event and can be used to set log levels for a\n specific wireless gateway event.
\nFor a LoRaWAN gateway, possible events for a log message are CUPS_Request
\n and Certificate
.
The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.
" + "smithy.api#documentation": "The log options for wireless gateways and can be used to set log levels for a specific\n type of wireless gateway.
" } }, "com.amazonaws.iotwireless#WirelessGatewayLogOptionList": { @@ -14883,7 +14942,7 @@ "LastUplinkReceivedAt": { "target": "com.amazonaws.iotwireless#ISODateTimeString", "traits": { - "smithy.api#documentation": "The date and time when the most recent uplink was received.
" + "smithy.api#documentation": "The date and time when the most recent uplink was received.
\nThis value is only valid for 3 months.
\nAWS IoT Wireless provides bi-directional communication between internet-connected wireless\n\t devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the \n\t IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) \n\t communication protocol to communicate with AWS IoT.
\nUsing the API, you can perform create, read, update, and delete operations for your wireless\n\t devices, gateways, destinations, and profiles. After onboarding your devices, you \n\t can use the API operations to set log levels and monitor your devices with CloudWatch.
\nYou can also use the API operations to create multicast groups and schedule a multicast session for\n\t sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air\n\t (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware\n\t of individual devices or an entire group of devices in a multicast group.
", + "smithy.api#documentation": "AWS IoT Wireless provides bi-directional communication between internet-connected\n wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS\n IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area\n Networking (LPWAN) communication protocol to communicate with AWS IoT.
\nUsing the API, you can perform create, read, update, and delete operations for your\n wireless devices, gateways, destinations, and profiles. After onboarding your devices,\n you can use the API operations to set log levels and monitor your devices with\n CloudWatch.
\nYou can also use the API operations to create multicast groups and schedule a\n multicast session for sending a downlink message to devices in the group. By using\n Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and\n schedule a session to update the firmware of individual devices or an entire group of\n devices in a multicast group.
", "smithy.api#title": "AWS IoT Wireless", "smithy.rules#endpointRuleSet": { "version": "1.0",