Skip to content

Commit 94b6569

Browse files
author
awstools
committed
feat(client-iot-wireless): This release includes a new feature for customers to calculate the position of their devices by adding three new APIs: UpdateResourcePosition, GetResourcePosition, and GetPositionEstimate.
1 parent e573378 commit 94b6569

28 files changed

+6682
-2803
lines changed

clients/client-iot-wireless/src/IoTWireless.ts

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,11 @@ import {
232232
GetPositionConfigurationCommandInput,
233233
GetPositionConfigurationCommandOutput,
234234
} from "./commands/GetPositionConfigurationCommand";
235+
import {
236+
GetPositionEstimateCommand,
237+
GetPositionEstimateCommandInput,
238+
GetPositionEstimateCommandOutput,
239+
} from "./commands/GetPositionEstimateCommand";
235240
import {
236241
GetResourceEventConfigurationCommand,
237242
GetResourceEventConfigurationCommandInput,
@@ -242,6 +247,11 @@ import {
242247
GetResourceLogLevelCommandInput,
243248
GetResourceLogLevelCommandOutput,
244249
} from "./commands/GetResourceLogLevelCommand";
250+
import {
251+
GetResourcePositionCommand,
252+
GetResourcePositionCommandInput,
253+
GetResourcePositionCommandOutput,
254+
} from "./commands/GetResourcePositionCommand";
245255
import {
246256
GetServiceEndpointCommand,
247257
GetServiceEndpointCommandInput,
@@ -473,6 +483,11 @@ import {
473483
UpdateResourceEventConfigurationCommandInput,
474484
UpdateResourceEventConfigurationCommandOutput,
475485
} from "./commands/UpdateResourceEventConfigurationCommand";
486+
import {
487+
UpdateResourcePositionCommand,
488+
UpdateResourcePositionCommandInput,
489+
UpdateResourcePositionCommandOutput,
490+
} from "./commands/UpdateResourcePositionCommand";
476491
import {
477492
UpdateWirelessDeviceCommand,
478493
UpdateWirelessDeviceCommandInput,
@@ -1954,7 +1969,14 @@ export class IoTWireless extends IoTWirelessClient {
19541969
}
19551970

19561971
/**
1972+
* @deprecated
1973+
*
19571974
* <p>Get the position information for a given resource.</p>
1975+
* <important>
1976+
* <p>This action is no longer supported. Calls to retrieve the position information
1977+
* should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html">GetResourcePosition</a>
1978+
* API operation instead.</p>
1979+
* </important>
19581980
*/
19591981
public getPosition(args: GetPositionCommandInput, options?: __HttpHandlerOptions): Promise<GetPositionCommandOutput>;
19601982
public getPosition(args: GetPositionCommandInput, cb: (err: any, data?: GetPositionCommandOutput) => void): void;
@@ -1980,7 +2002,14 @@ export class IoTWireless extends IoTWirelessClient {
19802002
}
19812003

19822004
/**
2005+
* @deprecated
2006+
*
19832007
* <p>Get position configuration for a given resource.</p>
2008+
* <important>
2009+
* <p>This action is no longer supported. Calls to retrieve the position configuration
2010+
* should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html">GetResourcePosition</a>
2011+
* API operation instead.</p>
2012+
* </important>
19842013
*/
19852014
public getPositionConfiguration(
19862015
args: GetPositionConfigurationCommandInput,
@@ -2011,6 +2040,39 @@ export class IoTWireless extends IoTWirelessClient {
20112040
}
20122041
}
20132042

2043+
/**
2044+
* <p>Get estimated position information as a payload in GeoJSON format. The payload measurement data is
2045+
* resolved using solvers that are provided by third-party vendors.</p>
2046+
*/
2047+
public getPositionEstimate(
2048+
args: GetPositionEstimateCommandInput,
2049+
options?: __HttpHandlerOptions
2050+
): Promise<GetPositionEstimateCommandOutput>;
2051+
public getPositionEstimate(
2052+
args: GetPositionEstimateCommandInput,
2053+
cb: (err: any, data?: GetPositionEstimateCommandOutput) => void
2054+
): void;
2055+
public getPositionEstimate(
2056+
args: GetPositionEstimateCommandInput,
2057+
options: __HttpHandlerOptions,
2058+
cb: (err: any, data?: GetPositionEstimateCommandOutput) => void
2059+
): void;
2060+
public getPositionEstimate(
2061+
args: GetPositionEstimateCommandInput,
2062+
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPositionEstimateCommandOutput) => void),
2063+
cb?: (err: any, data?: GetPositionEstimateCommandOutput) => void
2064+
): Promise<GetPositionEstimateCommandOutput> | void {
2065+
const command = new GetPositionEstimateCommand(args);
2066+
if (typeof optionsOrCb === "function") {
2067+
this.send(command, optionsOrCb);
2068+
} else if (typeof cb === "function") {
2069+
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
2070+
this.send(command, optionsOrCb || {}, cb);
2071+
} else {
2072+
return this.send(command, optionsOrCb);
2073+
}
2074+
}
2075+
20142076
/**
20152077
* <p>Get the event configuration for a particular resource identifier.</p>
20162078
*/
@@ -2076,6 +2138,40 @@ export class IoTWireless extends IoTWirelessClient {
20762138
}
20772139
}
20782140

2141+
/**
2142+
* <p>Get the position information for a given wireless device or a wireless gateway resource. The postion
2143+
* information uses the <a href="https://gisgeography.com/wgs84-world-geodetic-system/">
2144+
* World Geodetic System (WGS84)</a>.</p>
2145+
*/
2146+
public getResourcePosition(
2147+
args: GetResourcePositionCommandInput,
2148+
options?: __HttpHandlerOptions
2149+
): Promise<GetResourcePositionCommandOutput>;
2150+
public getResourcePosition(
2151+
args: GetResourcePositionCommandInput,
2152+
cb: (err: any, data?: GetResourcePositionCommandOutput) => void
2153+
): void;
2154+
public getResourcePosition(
2155+
args: GetResourcePositionCommandInput,
2156+
options: __HttpHandlerOptions,
2157+
cb: (err: any, data?: GetResourcePositionCommandOutput) => void
2158+
): void;
2159+
public getResourcePosition(
2160+
args: GetResourcePositionCommandInput,
2161+
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourcePositionCommandOutput) => void),
2162+
cb?: (err: any, data?: GetResourcePositionCommandOutput) => void
2163+
): Promise<GetResourcePositionCommandOutput> | void {
2164+
const command = new GetResourcePositionCommand(args);
2165+
if (typeof optionsOrCb === "function") {
2166+
this.send(command, optionsOrCb);
2167+
} else if (typeof cb === "function") {
2168+
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
2169+
this.send(command, optionsOrCb || {}, cb);
2170+
} else {
2171+
return this.send(command, optionsOrCb);
2172+
}
2173+
}
2174+
20792175
/**
20802176
* <p>Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.</p>
20812177
*/
@@ -2655,7 +2751,14 @@ export class IoTWireless extends IoTWirelessClient {
26552751
}
26562752

26572753
/**
2754+
* @deprecated
2755+
*
26582756
* <p>List position configurations for a given resource, such as positioning solvers.</p>
2757+
* <important>
2758+
* <p>This action is no longer supported. Calls to retrieve position information
2759+
* should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html">GetResourcePosition</a>
2760+
* API operation instead.</p>
2761+
* </important>
26592762
*/
26602763
public listPositionConfigurations(
26612764
args: ListPositionConfigurationsCommandInput,
@@ -2879,7 +2982,13 @@ export class IoTWireless extends IoTWirelessClient {
28792982
}
28802983

28812984
/**
2985+
* @deprecated
2986+
*
28822987
* <p>Put position configuration for a given resource.</p>
2988+
* <important>
2989+
* <p>This action is no longer supported. Calls to update the position configuration
2990+
* should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html">UpdateResourcePosition</a> API operation instead.</p>
2991+
* </important>
28832992
*/
28842993
public putPositionConfiguration(
28852994
args: PutPositionConfigurationCommandInput,
@@ -3522,7 +3631,13 @@ export class IoTWireless extends IoTWirelessClient {
35223631
}
35233632

35243633
/**
3634+
* @deprecated
3635+
*
35253636
* <p>Update the position information of a resource.</p>
3637+
* <important>
3638+
* <p>This action is no longer supported. Calls to update the position information
3639+
* should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html">UpdateResourcePosition</a> API operation instead.</p>
3640+
* </important>
35263641
*/
35273642
public updatePosition(
35283643
args: UpdatePositionCommandInput,
@@ -3585,6 +3700,40 @@ export class IoTWireless extends IoTWirelessClient {
35853700
}
35863701
}
35873702

3703+
/**
3704+
* <p>Update the position information of a given wireless device or a wireless gateway resource. The postion
3705+
* coordinates are based on the <a href="https://gisgeography.com/wgs84-world-geodetic-system/">
3706+
* World Geodetic System (WGS84)</a>.</p>
3707+
*/
3708+
public updateResourcePosition(
3709+
args: UpdateResourcePositionCommandInput,
3710+
options?: __HttpHandlerOptions
3711+
): Promise<UpdateResourcePositionCommandOutput>;
3712+
public updateResourcePosition(
3713+
args: UpdateResourcePositionCommandInput,
3714+
cb: (err: any, data?: UpdateResourcePositionCommandOutput) => void
3715+
): void;
3716+
public updateResourcePosition(
3717+
args: UpdateResourcePositionCommandInput,
3718+
options: __HttpHandlerOptions,
3719+
cb: (err: any, data?: UpdateResourcePositionCommandOutput) => void
3720+
): void;
3721+
public updateResourcePosition(
3722+
args: UpdateResourcePositionCommandInput,
3723+
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateResourcePositionCommandOutput) => void),
3724+
cb?: (err: any, data?: UpdateResourcePositionCommandOutput) => void
3725+
): Promise<UpdateResourcePositionCommandOutput> | void {
3726+
const command = new UpdateResourcePositionCommand(args);
3727+
if (typeof optionsOrCb === "function") {
3728+
this.send(command, optionsOrCb);
3729+
} else if (typeof cb === "function") {
3730+
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
3731+
this.send(command, optionsOrCb || {}, cb);
3732+
} else {
3733+
return this.send(command, optionsOrCb);
3734+
}
3735+
}
3736+
35883737
/**
35893738
* <p>Updates properties of a wireless device.</p>
35903739
*/

clients/client-iot-wireless/src/IoTWirelessClient.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,10 @@ import {
205205
GetPositionConfigurationCommandInput,
206206
GetPositionConfigurationCommandOutput,
207207
} from "./commands/GetPositionConfigurationCommand";
208+
import {
209+
GetPositionEstimateCommandInput,
210+
GetPositionEstimateCommandOutput,
211+
} from "./commands/GetPositionEstimateCommand";
208212
import {
209213
GetResourceEventConfigurationCommandInput,
210214
GetResourceEventConfigurationCommandOutput,
@@ -213,6 +217,10 @@ import {
213217
GetResourceLogLevelCommandInput,
214218
GetResourceLogLevelCommandOutput,
215219
} from "./commands/GetResourceLogLevelCommand";
220+
import {
221+
GetResourcePositionCommandInput,
222+
GetResourcePositionCommandOutput,
223+
} from "./commands/GetResourcePositionCommand";
216224
import { GetServiceEndpointCommandInput, GetServiceEndpointCommandOutput } from "./commands/GetServiceEndpointCommand";
217225
import { GetServiceProfileCommandInput, GetServiceProfileCommandOutput } from "./commands/GetServiceProfileCommand";
218226
import { GetWirelessDeviceCommandInput, GetWirelessDeviceCommandOutput } from "./commands/GetWirelessDeviceCommand";
@@ -356,6 +364,10 @@ import {
356364
UpdateResourceEventConfigurationCommandInput,
357365
UpdateResourceEventConfigurationCommandOutput,
358366
} from "./commands/UpdateResourceEventConfigurationCommand";
367+
import {
368+
UpdateResourcePositionCommandInput,
369+
UpdateResourcePositionCommandOutput,
370+
} from "./commands/UpdateResourcePositionCommand";
359371
import {
360372
UpdateWirelessDeviceCommandInput,
361373
UpdateWirelessDeviceCommandOutput,
@@ -420,8 +432,10 @@ export type ServiceInputTypes =
420432
| GetPartnerAccountCommandInput
421433
| GetPositionCommandInput
422434
| GetPositionConfigurationCommandInput
435+
| GetPositionEstimateCommandInput
423436
| GetResourceEventConfigurationCommandInput
424437
| GetResourceLogLevelCommandInput
438+
| GetResourcePositionCommandInput
425439
| GetServiceEndpointCommandInput
426440
| GetServiceProfileCommandInput
427441
| GetWirelessDeviceCommandInput
@@ -469,6 +483,7 @@ export type ServiceInputTypes =
469483
| UpdatePartnerAccountCommandInput
470484
| UpdatePositionCommandInput
471485
| UpdateResourceEventConfigurationCommandInput
486+
| UpdateResourcePositionCommandInput
472487
| UpdateWirelessDeviceCommandInput
473488
| UpdateWirelessGatewayCommandInput;
474489

@@ -520,8 +535,10 @@ export type ServiceOutputTypes =
520535
| GetPartnerAccountCommandOutput
521536
| GetPositionCommandOutput
522537
| GetPositionConfigurationCommandOutput
538+
| GetPositionEstimateCommandOutput
523539
| GetResourceEventConfigurationCommandOutput
524540
| GetResourceLogLevelCommandOutput
541+
| GetResourcePositionCommandOutput
525542
| GetServiceEndpointCommandOutput
526543
| GetServiceProfileCommandOutput
527544
| GetWirelessDeviceCommandOutput
@@ -569,6 +586,7 @@ export type ServiceOutputTypes =
569586
| UpdatePartnerAccountCommandOutput
570587
| UpdatePositionCommandOutput
571588
| UpdateResourceEventConfigurationCommandOutput
589+
| UpdateResourcePositionCommandOutput
572590
| UpdateWirelessDeviceCommandOutput
573591
| UpdateWirelessGatewayCommandOutput;
574592

clients/client-iot-wireless/src/commands/GetPositionCommand.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,14 @@ export interface GetPositionCommandInput extends GetPositionRequest {}
2929
export interface GetPositionCommandOutput extends GetPositionResponse, __MetadataBearer {}
3030

3131
/**
32+
* @deprecated
33+
*
3234
* <p>Get the position information for a given resource.</p>
35+
* <important>
36+
* <p>This action is no longer supported. Calls to retrieve the position information
37+
* should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html">GetResourcePosition</a>
38+
* API operation instead.</p>
39+
* </important>
3340
* @example
3441
* Use a bare-bones client and the command you need to make an API call.
3542
* ```javascript

clients/client-iot-wireless/src/commands/GetPositionConfigurationCommand.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,14 @@ export interface GetPositionConfigurationCommandInput extends GetPositionConfigu
2929
export interface GetPositionConfigurationCommandOutput extends GetPositionConfigurationResponse, __MetadataBearer {}
3030

3131
/**
32+
* @deprecated
33+
*
3234
* <p>Get position configuration for a given resource.</p>
35+
* <important>
36+
* <p>This action is no longer supported. Calls to retrieve the position configuration
37+
* should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html">GetResourcePosition</a>
38+
* API operation instead.</p>
39+
* </important>
3340
* @example
3441
* Use a bare-bones client and the command you need to make an API call.
3542
* ```javascript

0 commit comments

Comments
 (0)