@aws-sdk/client-location 3.36.0 → 3.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/Location.js +0 -3
  3. package/dist-cjs/LocationClient.js +0 -8
  4. package/dist-cjs/commands/AssociateTrackerConsumerCommand.js +0 -30
  5. package/dist-cjs/commands/BatchDeleteDevicePositionHistoryCommand.js +0 -24
  6. package/dist-cjs/commands/BatchDeleteGeofenceCommand.js +0 -27
  7. package/dist-cjs/commands/BatchEvaluateGeofencesCommand.js +0 -44
  8. package/dist-cjs/commands/BatchGetDevicePositionCommand.js +0 -24
  9. package/dist-cjs/commands/BatchPutGeofenceCommand.js +0 -25
  10. package/dist-cjs/commands/BatchUpdateDevicePositionCommand.js +0 -34
  11. package/dist-cjs/commands/CalculateRouteCommand.js +0 -54
  12. package/dist-cjs/commands/CreateGeofenceCollectionCommand.js +0 -24
  13. package/dist-cjs/commands/CreateMapCommand.js +0 -25
  14. package/dist-cjs/commands/CreatePlaceIndexCommand.js +0 -25
  15. package/dist-cjs/commands/CreateRouteCalculatorCommand.js +0 -27
  16. package/dist-cjs/commands/CreateTrackerCommand.js +0 -25
  17. package/dist-cjs/commands/DeleteGeofenceCollectionCommand.js +0 -28
  18. package/dist-cjs/commands/DeleteMapCommand.js +0 -28
  19. package/dist-cjs/commands/DeletePlaceIndexCommand.js +0 -27
  20. package/dist-cjs/commands/DeleteRouteCalculatorCommand.js +0 -27
  21. package/dist-cjs/commands/DeleteTrackerCommand.js +0 -29
  22. package/dist-cjs/commands/DescribeGeofenceCollectionCommand.js +0 -24
  23. package/dist-cjs/commands/DescribeMapCommand.js +0 -24
  24. package/dist-cjs/commands/DescribePlaceIndexCommand.js +0 -24
  25. package/dist-cjs/commands/DescribeRouteCalculatorCommand.js +0 -24
  26. package/dist-cjs/commands/DescribeTrackerCommand.js +0 -24
  27. package/dist-cjs/commands/DisassociateTrackerConsumerCommand.js +0 -28
  28. package/dist-cjs/commands/GetDevicePositionCommand.js +0 -27
  29. package/dist-cjs/commands/GetDevicePositionHistoryCommand.js +0 -28
  30. package/dist-cjs/commands/GetGeofenceCommand.js +0 -24
  31. package/dist-cjs/commands/GetMapGlyphsCommand.js +0 -24
  32. package/dist-cjs/commands/GetMapSpritesCommand.js +0 -26
  33. package/dist-cjs/commands/GetMapStyleDescriptorCommand.js +0 -27
  34. package/dist-cjs/commands/GetMapTileCommand.js +0 -29
  35. package/dist-cjs/commands/ListDevicePositionsCommand.js +0 -24
  36. package/dist-cjs/commands/ListGeofenceCollectionsCommand.js +0 -24
  37. package/dist-cjs/commands/ListGeofencesCommand.js +0 -24
  38. package/dist-cjs/commands/ListMapsCommand.js +0 -24
  39. package/dist-cjs/commands/ListPlaceIndexesCommand.js +0 -24
  40. package/dist-cjs/commands/ListRouteCalculatorsCommand.js +0 -24
  41. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -24
  42. package/dist-cjs/commands/ListTrackerConsumersCommand.js +0 -24
  43. package/dist-cjs/commands/ListTrackersCommand.js +0 -24
  44. package/dist-cjs/commands/PutGeofenceCommand.js +0 -25
  45. package/dist-cjs/commands/SearchPlaceIndexForPositionCommand.js +0 -25
  46. package/dist-cjs/commands/SearchPlaceIndexForTextCommand.js +0 -32
  47. package/dist-cjs/commands/TagResourceCommand.js +0 -37
  48. package/dist-cjs/commands/UntagResourceCommand.js +0 -24
  49. package/dist-cjs/commands/UpdateGeofenceCollectionCommand.js +0 -24
  50. package/dist-cjs/commands/UpdateMapCommand.js +0 -24
  51. package/dist-cjs/commands/UpdatePlaceIndexCommand.js +0 -24
  52. package/dist-cjs/commands/UpdateRouteCalculatorCommand.js +0 -24
  53. package/dist-cjs/commands/UpdateTrackerCommand.js +0 -24
  54. package/dist-cjs/commands/index.js +53 -0
  55. package/dist-cjs/endpoints.js +6 -1
  56. package/dist-cjs/index.js +4 -62
  57. package/dist-cjs/models/models_0.js +0 -429
  58. package/dist-cjs/pagination/GetDevicePositionHistoryPaginator.js +0 -10
  59. package/dist-cjs/pagination/ListDevicePositionsPaginator.js +0 -10
  60. package/dist-cjs/pagination/ListGeofenceCollectionsPaginator.js +0 -10
  61. package/dist-cjs/pagination/ListGeofencesPaginator.js +0 -10
  62. package/dist-cjs/pagination/ListMapsPaginator.js +0 -10
  63. package/dist-cjs/pagination/ListPlaceIndexesPaginator.js +0 -10
  64. package/dist-cjs/pagination/ListRouteCalculatorsPaginator.js +0 -10
  65. package/dist-cjs/pagination/ListTrackerConsumersPaginator.js +0 -10
  66. package/dist-cjs/pagination/ListTrackersPaginator.js +0 -10
  67. package/dist-cjs/pagination/index.js +13 -0
  68. package/dist-cjs/protocols/Aws_restJson1.js +0 -5
  69. package/dist-cjs/runtimeConfig.browser.js +1 -5
  70. package/dist-cjs/runtimeConfig.js +1 -5
  71. package/dist-cjs/runtimeConfig.native.js +0 -3
  72. package/dist-cjs/runtimeConfig.shared.js +0 -3
  73. package/dist-es/commands/index.js +50 -0
  74. package/dist-es/endpoints.js +6 -1
  75. package/dist-es/index.js +4 -62
  76. package/dist-es/pagination/index.js +10 -0
  77. package/dist-types/commands/index.d.ts +50 -0
  78. package/dist-types/index.d.ts +4 -62
  79. package/dist-types/pagination/index.d.ts +10 -0
  80. package/dist-types/ts3.4/Location.d.ts +51 -292
  81. package/dist-types/ts3.4/LocationClient.d.ts +24 -89
  82. package/dist-types/ts3.4/commands/AssociateTrackerConsumerCommand.d.ts +2 -26
  83. package/dist-types/ts3.4/commands/BatchDeleteDevicePositionHistoryCommand.d.ts +2 -20
  84. package/dist-types/ts3.4/commands/BatchDeleteGeofenceCommand.d.ts +2 -23
  85. package/dist-types/ts3.4/commands/BatchEvaluateGeofencesCommand.d.ts +2 -40
  86. package/dist-types/ts3.4/commands/BatchGetDevicePositionCommand.d.ts +2 -20
  87. package/dist-types/ts3.4/commands/BatchPutGeofenceCommand.d.ts +2 -21
  88. package/dist-types/ts3.4/commands/BatchUpdateDevicePositionCommand.d.ts +2 -30
  89. package/dist-types/ts3.4/commands/CalculateRouteCommand.d.ts +2 -50
  90. package/dist-types/ts3.4/commands/CreateGeofenceCollectionCommand.d.ts +2 -20
  91. package/dist-types/ts3.4/commands/CreateMapCommand.d.ts +2 -21
  92. package/dist-types/ts3.4/commands/CreatePlaceIndexCommand.d.ts +2 -21
  93. package/dist-types/ts3.4/commands/CreateRouteCalculatorCommand.d.ts +2 -23
  94. package/dist-types/ts3.4/commands/CreateTrackerCommand.d.ts +2 -21
  95. package/dist-types/ts3.4/commands/DeleteGeofenceCollectionCommand.d.ts +2 -24
  96. package/dist-types/ts3.4/commands/DeleteMapCommand.d.ts +2 -24
  97. package/dist-types/ts3.4/commands/DeletePlaceIndexCommand.d.ts +2 -23
  98. package/dist-types/ts3.4/commands/DeleteRouteCalculatorCommand.d.ts +2 -23
  99. package/dist-types/ts3.4/commands/DeleteTrackerCommand.d.ts +2 -25
  100. package/dist-types/ts3.4/commands/DescribeGeofenceCollectionCommand.d.ts +2 -20
  101. package/dist-types/ts3.4/commands/DescribeMapCommand.d.ts +2 -20
  102. package/dist-types/ts3.4/commands/DescribePlaceIndexCommand.d.ts +2 -20
  103. package/dist-types/ts3.4/commands/DescribeRouteCalculatorCommand.d.ts +2 -20
  104. package/dist-types/ts3.4/commands/DescribeTrackerCommand.d.ts +2 -20
  105. package/dist-types/ts3.4/commands/DisassociateTrackerConsumerCommand.d.ts +2 -24
  106. package/dist-types/ts3.4/commands/GetDevicePositionCommand.d.ts +2 -23
  107. package/dist-types/ts3.4/commands/GetDevicePositionHistoryCommand.d.ts +2 -24
  108. package/dist-types/ts3.4/commands/GetGeofenceCommand.d.ts +2 -20
  109. package/dist-types/ts3.4/commands/GetMapGlyphsCommand.d.ts +2 -20
  110. package/dist-types/ts3.4/commands/GetMapSpritesCommand.d.ts +2 -22
  111. package/dist-types/ts3.4/commands/GetMapStyleDescriptorCommand.d.ts +2 -23
  112. package/dist-types/ts3.4/commands/GetMapTileCommand.d.ts +2 -25
  113. package/dist-types/ts3.4/commands/ListDevicePositionsCommand.d.ts +2 -20
  114. package/dist-types/ts3.4/commands/ListGeofenceCollectionsCommand.d.ts +2 -20
  115. package/dist-types/ts3.4/commands/ListGeofencesCommand.d.ts +2 -20
  116. package/dist-types/ts3.4/commands/ListMapsCommand.d.ts +2 -20
  117. package/dist-types/ts3.4/commands/ListPlaceIndexesCommand.d.ts +2 -20
  118. package/dist-types/ts3.4/commands/ListRouteCalculatorsCommand.d.ts +2 -20
  119. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
  120. package/dist-types/ts3.4/commands/ListTrackerConsumersCommand.d.ts +2 -20
  121. package/dist-types/ts3.4/commands/ListTrackersCommand.d.ts +2 -20
  122. package/dist-types/ts3.4/commands/PutGeofenceCommand.d.ts +2 -21
  123. package/dist-types/ts3.4/commands/SearchPlaceIndexForPositionCommand.d.ts +2 -21
  124. package/dist-types/ts3.4/commands/SearchPlaceIndexForTextCommand.d.ts +2 -28
  125. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -33
  126. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  127. package/dist-types/ts3.4/commands/UpdateGeofenceCollectionCommand.d.ts +2 -20
  128. package/dist-types/ts3.4/commands/UpdateMapCommand.d.ts +2 -20
  129. package/dist-types/ts3.4/commands/UpdatePlaceIndexCommand.d.ts +2 -20
  130. package/dist-types/ts3.4/commands/UpdateRouteCalculatorCommand.d.ts +2 -20
  131. package/dist-types/ts3.4/commands/UpdateTrackerCommand.d.ts +2 -20
  132. package/dist-types/ts3.4/commands/index.d.ts +50 -0
  133. package/dist-types/ts3.4/index.d.ts +4 -62
  134. package/dist-types/ts3.4/models/models_0.d.ts +580 -3098
  135. package/dist-types/ts3.4/pagination/index.d.ts +10 -0
  136. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  137. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  138. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  139. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  140. package/package.json +32 -32
@@ -59,124 +59,59 @@ import { UpdateTrackerCommandInput, UpdateTrackerCommandOutput } from "./command
59
59
  export declare type ServiceInputTypes = AssociateTrackerConsumerCommandInput | BatchDeleteDevicePositionHistoryCommandInput | BatchDeleteGeofenceCommandInput | BatchEvaluateGeofencesCommandInput | BatchGetDevicePositionCommandInput | BatchPutGeofenceCommandInput | BatchUpdateDevicePositionCommandInput | CalculateRouteCommandInput | CreateGeofenceCollectionCommandInput | CreateMapCommandInput | CreatePlaceIndexCommandInput | CreateRouteCalculatorCommandInput | CreateTrackerCommandInput | DeleteGeofenceCollectionCommandInput | DeleteMapCommandInput | DeletePlaceIndexCommandInput | DeleteRouteCalculatorCommandInput | DeleteTrackerCommandInput | DescribeGeofenceCollectionCommandInput | DescribeMapCommandInput | DescribePlaceIndexCommandInput | DescribeRouteCalculatorCommandInput | DescribeTrackerCommandInput | DisassociateTrackerConsumerCommandInput | GetDevicePositionCommandInput | GetDevicePositionHistoryCommandInput | GetGeofenceCommandInput | GetMapGlyphsCommandInput | GetMapSpritesCommandInput | GetMapStyleDescriptorCommandInput | GetMapTileCommandInput | ListDevicePositionsCommandInput | ListGeofenceCollectionsCommandInput | ListGeofencesCommandInput | ListMapsCommandInput | ListPlaceIndexesCommandInput | ListRouteCalculatorsCommandInput | ListTagsForResourceCommandInput | ListTrackerConsumersCommandInput | ListTrackersCommandInput | PutGeofenceCommandInput | SearchPlaceIndexForPositionCommandInput | SearchPlaceIndexForTextCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGeofenceCollectionCommandInput | UpdateMapCommandInput | UpdatePlaceIndexCommandInput | UpdateRouteCalculatorCommandInput | UpdateTrackerCommandInput;
60
60
  export declare type ServiceOutputTypes = AssociateTrackerConsumerCommandOutput | BatchDeleteDevicePositionHistoryCommandOutput | BatchDeleteGeofenceCommandOutput | BatchEvaluateGeofencesCommandOutput | BatchGetDevicePositionCommandOutput | BatchPutGeofenceCommandOutput | BatchUpdateDevicePositionCommandOutput | CalculateRouteCommandOutput | CreateGeofenceCollectionCommandOutput | CreateMapCommandOutput | CreatePlaceIndexCommandOutput | CreateRouteCalculatorCommandOutput | CreateTrackerCommandOutput | DeleteGeofenceCollectionCommandOutput | DeleteMapCommandOutput | DeletePlaceIndexCommandOutput | DeleteRouteCalculatorCommandOutput | DeleteTrackerCommandOutput | DescribeGeofenceCollectionCommandOutput | DescribeMapCommandOutput | DescribePlaceIndexCommandOutput | DescribeRouteCalculatorCommandOutput | DescribeTrackerCommandOutput | DisassociateTrackerConsumerCommandOutput | GetDevicePositionCommandOutput | GetDevicePositionHistoryCommandOutput | GetGeofenceCommandOutput | GetMapGlyphsCommandOutput | GetMapSpritesCommandOutput | GetMapStyleDescriptorCommandOutput | GetMapTileCommandOutput | ListDevicePositionsCommandOutput | ListGeofenceCollectionsCommandOutput | ListGeofencesCommandOutput | ListMapsCommandOutput | ListPlaceIndexesCommandOutput | ListRouteCalculatorsCommandOutput | ListTagsForResourceCommandOutput | ListTrackerConsumersCommandOutput | ListTrackersCommandOutput | PutGeofenceCommandOutput | SearchPlaceIndexForPositionCommandOutput | SearchPlaceIndexForTextCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGeofenceCollectionCommandOutput | UpdateMapCommandOutput | UpdatePlaceIndexCommandOutput | UpdateRouteCalculatorCommandOutput | UpdateTrackerCommandOutput;
61
61
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
62
- /**
63
- * The HTTP handler to use. Fetch in browser and Https in Nodejs.
64
- */
62
+
65
63
  requestHandler?: __HttpHandler;
66
- /**
67
- * A constructor for a class implementing the {@link __Hash} interface
68
- * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
69
- * @internal
70
- */
64
+
71
65
  sha256?: __HashConstructor;
72
- /**
73
- * The function that will be used to convert strings into HTTP endpoints.
74
- * @internal
75
- */
66
+
76
67
  urlParser?: __UrlParser;
77
- /**
78
- * A function that can calculate the length of a request body.
79
- * @internal
80
- */
68
+
81
69
  bodyLengthChecker?: (body: any) => number | undefined;
82
- /**
83
- * A function that converts a stream into an array of bytes.
84
- * @internal
85
- */
70
+
86
71
  streamCollector?: __StreamCollector;
87
- /**
88
- * The function that will be used to convert a base64-encoded string to a byte array.
89
- * @internal
90
- */
72
+
91
73
  base64Decoder?: __Decoder;
92
- /**
93
- * The function that will be used to convert binary data to a base64-encoded string.
94
- * @internal
95
- */
74
+
96
75
  base64Encoder?: __Encoder;
97
- /**
98
- * The function that will be used to convert a UTF8-encoded string to a byte array.
99
- * @internal
100
- */
76
+
101
77
  utf8Decoder?: __Decoder;
102
- /**
103
- * The function that will be used to convert binary data to a UTF-8 encoded string.
104
- * @internal
105
- */
78
+
106
79
  utf8Encoder?: __Encoder;
107
- /**
108
- * The runtime environment.
109
- * @internal
110
- */
80
+
111
81
  runtime?: string;
112
- /**
113
- * Disable dyanamically changing the endpoint of the client based on the hostPrefix
114
- * trait of an operation.
115
- */
82
+
116
83
  disableHostPrefix?: boolean;
117
- /**
118
- * Value for how many times a request will be made at most in case of retry.
119
- */
84
+
120
85
  maxAttempts?: number | __Provider<number>;
121
- /**
122
- * Specifies which retry algorithm to use.
123
- */
86
+
124
87
  retryMode?: string | __Provider<string>;
125
- /**
126
- * Optional logger for logging debug/info/warn/error.
127
- */
88
+
128
89
  logger?: __Logger;
129
- /**
130
- * Unique service identifier.
131
- * @internal
132
- */
90
+
133
91
  serviceId?: string;
134
- /**
135
- * The AWS region to which this client will send requests
136
- */
92
+
137
93
  region?: string | __Provider<string>;
138
- /**
139
- * Default credentials provider; Not available in browser runtime.
140
- * @internal
141
- */
94
+
142
95
  credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
143
- /**
144
- * Fetch related hostname, signing name or signing region with given region.
145
- * @internal
146
- */
96
+
147
97
  regionInfoProvider?: RegionInfoProvider;
148
- /**
149
- * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
150
- * @internal
151
- */
98
+
152
99
  defaultUserAgentProvider?: Provider<__UserAgent>;
153
100
  }
154
101
  declare type LocationClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
155
- /**
156
- * The configuration interface of LocationClient class constructor that set the region, credentials and other options.
157
- */
102
+
158
103
  export interface LocationClientConfig extends LocationClientConfigType {
159
104
  }
160
105
  declare type LocationClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
161
- /**
162
- * The resolved configuration interface of LocationClient class. This is resolved and normalized from the {@link LocationClientConfig | constructor configuration interface}.
163
- */
106
+
164
107
  export interface LocationClientResolvedConfig extends LocationClientResolvedConfigType {
165
108
  }
166
- /**
167
- * Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing
168
- */
109
+
169
110
  export declare class LocationClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, LocationClientResolvedConfig> {
170
- /**
171
- * The resolved configuration of LocationClient class. This is resolved and normalized from the {@link LocationClientConfig | constructor configuration interface}.
172
- */
111
+
173
112
  readonly config: LocationClientResolvedConfig;
174
113
  constructor(configuration: LocationClientConfig);
175
- /**
176
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
177
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
178
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
179
- */
114
+
180
115
  destroy(): void;
181
116
  }
182
117
  export {};
@@ -6,35 +6,11 @@ export interface AssociateTrackerConsumerCommandInput extends AssociateTrackerCo
6
6
  }
7
7
  export interface AssociateTrackerConsumerCommandOutput extends AssociateTrackerConsumerResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates an association between a geofence collection and a tracker resource. This
11
- * allows the tracker resource to communicate location data to the linked geofence
12
- * collection. </p>
13
- * <p>You can associate up to five geofence collections to each tracker resource.</p>
14
- * <note>
15
- * <p>Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.</p>
16
- * </note>
17
- * @example
18
- * Use a bare-bones client and the command you need to make an API call.
19
- * ```javascript
20
- * import { LocationClient, AssociateTrackerConsumerCommand } from "@aws-sdk/client-location"; // ES Modules import
21
- * // const { LocationClient, AssociateTrackerConsumerCommand } = require("@aws-sdk/client-location"); // CommonJS import
22
- * const client = new LocationClient(config);
23
- * const command = new AssociateTrackerConsumerCommand(input);
24
- * const response = await client.send(command);
25
- * ```
26
- *
27
- * @see {@link AssociateTrackerConsumerCommandInput} for command's `input` shape.
28
- * @see {@link AssociateTrackerConsumerCommandOutput} for command's `response` shape.
29
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
30
- *
31
- */
9
+
32
10
  export declare class AssociateTrackerConsumerCommand extends $Command<AssociateTrackerConsumerCommandInput, AssociateTrackerConsumerCommandOutput, LocationClientResolvedConfig> {
33
11
  readonly input: AssociateTrackerConsumerCommandInput;
34
12
  constructor(input: AssociateTrackerConsumerCommandInput);
35
- /**
36
- * @internal
37
- */
13
+
38
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateTrackerConsumerCommandInput, AssociateTrackerConsumerCommandOutput>;
39
15
  private serialize;
40
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface BatchDeleteDevicePositionHistoryCommandInput extends BatchDelet
6
6
  }
7
7
  export interface BatchDeleteDevicePositionHistoryCommandOutput extends BatchDeleteDevicePositionHistoryResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes the position history of one or more devices from a tracker resource.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { LocationClient, BatchDeleteDevicePositionHistoryCommand } from "@aws-sdk/client-location"; // ES Modules import
15
- * // const { LocationClient, BatchDeleteDevicePositionHistoryCommand } = require("@aws-sdk/client-location"); // CommonJS import
16
- * const client = new LocationClient(config);
17
- * const command = new BatchDeleteDevicePositionHistoryCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link BatchDeleteDevicePositionHistoryCommandInput} for command's `input` shape.
22
- * @see {@link BatchDeleteDevicePositionHistoryCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class BatchDeleteDevicePositionHistoryCommand extends $Command<BatchDeleteDevicePositionHistoryCommandInput, BatchDeleteDevicePositionHistoryCommandOutput, LocationClientResolvedConfig> {
27
11
  readonly input: BatchDeleteDevicePositionHistoryCommandInput;
28
12
  constructor(input: BatchDeleteDevicePositionHistoryCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDeleteDevicePositionHistoryCommandInput, BatchDeleteDevicePositionHistoryCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,32 +6,11 @@ export interface BatchDeleteGeofenceCommandInput extends BatchDeleteGeofenceRequ
6
6
  }
7
7
  export interface BatchDeleteGeofenceCommandOutput extends BatchDeleteGeofenceResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes a batch of geofences from a geofence collection.</p>
11
- * <note>
12
- * <p>This operation deletes the resource permanently.</p>
13
- * </note>
14
- * @example
15
- * Use a bare-bones client and the command you need to make an API call.
16
- * ```javascript
17
- * import { LocationClient, BatchDeleteGeofenceCommand } from "@aws-sdk/client-location"; // ES Modules import
18
- * // const { LocationClient, BatchDeleteGeofenceCommand } = require("@aws-sdk/client-location"); // CommonJS import
19
- * const client = new LocationClient(config);
20
- * const command = new BatchDeleteGeofenceCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link BatchDeleteGeofenceCommandInput} for command's `input` shape.
25
- * @see {@link BatchDeleteGeofenceCommandOutput} for command's `response` shape.
26
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
9
+
29
10
  export declare class BatchDeleteGeofenceCommand extends $Command<BatchDeleteGeofenceCommandInput, BatchDeleteGeofenceCommandOutput, LocationClientResolvedConfig> {
30
11
  readonly input: BatchDeleteGeofenceCommandInput;
31
12
  constructor(input: BatchDeleteGeofenceCommandInput);
32
- /**
33
- * @internal
34
- */
13
+
35
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDeleteGeofenceCommandInput, BatchDeleteGeofenceCommandOutput>;
36
15
  private serialize;
37
16
  private deserialize;
@@ -6,49 +6,11 @@ export interface BatchEvaluateGeofencesCommandInput extends BatchEvaluateGeofenc
6
6
  }
7
7
  export interface BatchEvaluateGeofencesCommandOutput extends BatchEvaluateGeofencesResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Evaluates device positions against the geofence geometries from a given geofence
11
- * collection.</p>
12
- * <p>This operation always returns an empty response because geofences are asynchronously
13
- * evaluated. The evaluation determines if the device has entered or exited a geofenced
14
- * area, and then publishes one of the following events to Amazon EventBridge:</p>
15
- * <ul>
16
- * <li>
17
- * <p>
18
- * <code>ENTER</code> if Amazon Location determines that the tracked device has entered
19
- * a geofenced area.</p>
20
- * </li>
21
- * <li>
22
- * <p>
23
- * <code>EXIT</code> if Amazon Location determines that the tracked device has exited a
24
- * geofenced area.</p>
25
- * </li>
26
- * </ul>
27
- * <note>
28
- * <p>The last geofence that a device was observed within is tracked for 30 days after
29
- * the most recent device position update.</p>
30
- * </note>
31
- * @example
32
- * Use a bare-bones client and the command you need to make an API call.
33
- * ```javascript
34
- * import { LocationClient, BatchEvaluateGeofencesCommand } from "@aws-sdk/client-location"; // ES Modules import
35
- * // const { LocationClient, BatchEvaluateGeofencesCommand } = require("@aws-sdk/client-location"); // CommonJS import
36
- * const client = new LocationClient(config);
37
- * const command = new BatchEvaluateGeofencesCommand(input);
38
- * const response = await client.send(command);
39
- * ```
40
- *
41
- * @see {@link BatchEvaluateGeofencesCommandInput} for command's `input` shape.
42
- * @see {@link BatchEvaluateGeofencesCommandOutput} for command's `response` shape.
43
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
44
- *
45
- */
9
+
46
10
  export declare class BatchEvaluateGeofencesCommand extends $Command<BatchEvaluateGeofencesCommandInput, BatchEvaluateGeofencesCommandOutput, LocationClientResolvedConfig> {
47
11
  readonly input: BatchEvaluateGeofencesCommandInput;
48
12
  constructor(input: BatchEvaluateGeofencesCommandInput);
49
- /**
50
- * @internal
51
- */
13
+
52
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchEvaluateGeofencesCommandInput, BatchEvaluateGeofencesCommandOutput>;
53
15
  private serialize;
54
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface BatchGetDevicePositionCommandInput extends BatchGetDevicePositi
6
6
  }
7
7
  export interface BatchGetDevicePositionCommandOutput extends BatchGetDevicePositionResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Lists the latest device positions for requested devices.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { LocationClient, BatchGetDevicePositionCommand } from "@aws-sdk/client-location"; // ES Modules import
15
- * // const { LocationClient, BatchGetDevicePositionCommand } = require("@aws-sdk/client-location"); // CommonJS import
16
- * const client = new LocationClient(config);
17
- * const command = new BatchGetDevicePositionCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link BatchGetDevicePositionCommandInput} for command's `input` shape.
22
- * @see {@link BatchGetDevicePositionCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class BatchGetDevicePositionCommand extends $Command<BatchGetDevicePositionCommandInput, BatchGetDevicePositionCommandOutput, LocationClientResolvedConfig> {
27
11
  readonly input: BatchGetDevicePositionCommandInput;
28
12
  constructor(input: BatchGetDevicePositionCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetDevicePositionCommandInput, BatchGetDevicePositionCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface BatchPutGeofenceCommandInput extends BatchPutGeofenceRequest {
6
6
  }
7
7
  export interface BatchPutGeofenceCommandOutput extends BatchPutGeofenceResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>A batch request for storing geofence geometries into a given geofence collection, or
11
- * updates the geometry of an existing geofence if a geofence ID is included in the request.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { LocationClient, BatchPutGeofenceCommand } from "@aws-sdk/client-location"; // ES Modules import
16
- * // const { LocationClient, BatchPutGeofenceCommand } = require("@aws-sdk/client-location"); // CommonJS import
17
- * const client = new LocationClient(config);
18
- * const command = new BatchPutGeofenceCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link BatchPutGeofenceCommandInput} for command's `input` shape.
23
- * @see {@link BatchPutGeofenceCommandOutput} for command's `response` shape.
24
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class BatchPutGeofenceCommand extends $Command<BatchPutGeofenceCommandInput, BatchPutGeofenceCommandOutput, LocationClientResolvedConfig> {
28
11
  readonly input: BatchPutGeofenceCommandInput;
29
12
  constructor(input: BatchPutGeofenceCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchPutGeofenceCommandInput, BatchPutGeofenceCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,39 +6,11 @@ export interface BatchUpdateDevicePositionCommandInput extends BatchUpdateDevice
6
6
  }
7
7
  export interface BatchUpdateDevicePositionCommandOutput extends BatchUpdateDevicePositionResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Uploads position update data for one or more devices to a tracker resource. Amazon Location
11
- * uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30
12
- * days.</p>
13
- * <note>
14
- * <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker.
15
- * When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections,
16
- * and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than
17
- * every 30 seconds, only one update per 30 seconds is stored for each unique device ID.
18
- * When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence
19
- * collections only if the device has moved more than 30 m (98.4 ft).</p>
20
- * </note>
21
- * @example
22
- * Use a bare-bones client and the command you need to make an API call.
23
- * ```javascript
24
- * import { LocationClient, BatchUpdateDevicePositionCommand } from "@aws-sdk/client-location"; // ES Modules import
25
- * // const { LocationClient, BatchUpdateDevicePositionCommand } = require("@aws-sdk/client-location"); // CommonJS import
26
- * const client = new LocationClient(config);
27
- * const command = new BatchUpdateDevicePositionCommand(input);
28
- * const response = await client.send(command);
29
- * ```
30
- *
31
- * @see {@link BatchUpdateDevicePositionCommandInput} for command's `input` shape.
32
- * @see {@link BatchUpdateDevicePositionCommandOutput} for command's `response` shape.
33
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
34
- *
35
- */
9
+
36
10
  export declare class BatchUpdateDevicePositionCommand extends $Command<BatchUpdateDevicePositionCommandInput, BatchUpdateDevicePositionCommandOutput, LocationClientResolvedConfig> {
37
11
  readonly input: BatchUpdateDevicePositionCommandInput;
38
12
  constructor(input: BatchUpdateDevicePositionCommandInput);
39
- /**
40
- * @internal
41
- */
13
+
42
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchUpdateDevicePositionCommandInput, BatchUpdateDevicePositionCommandOutput>;
43
15
  private serialize;
44
16
  private deserialize;
@@ -6,59 +6,11 @@ export interface CalculateRouteCommandInput extends CalculateRouteRequest {
6
6
  }
7
7
  export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>
11
- * <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters:
12
- * <code>DeparturePostiton</code> and <code>DestinationPosition</code>. Requires that
13
- * you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
14
- * route calculator resource</a>
15
- * </p>
16
- * <p>By default, a request that doesn't specify a departure time uses the best time of day
17
- * to travel with the best traffic conditions when calculating the route.</p>
18
- * <p>Additional options include:</p>
19
- * <ul>
20
- * <li>
21
- * <p>
22
- * <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#departure-time">Specifying a departure time</a> using either <code>DepartureTime</code> or
23
- * <code>DepartureNow</code>. This calculates a route based on predictive
24
- * traffic data at the given time. </p>
25
- * <note>
26
- * <p>You can't specify both <code>DepartureTime</code> and
27
- * <code>DepartureNow</code> in a single request. Specifying both
28
- * parameters returns an error message.</p>
29
- * </note>
30
- * </li>
31
- * <li>
32
- * <p>
33
- * <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#travel-mode">Specifying a travel mode</a> using TravelMode. This lets you specify an
34
- * additional route preference such as <code>CarModeOptions</code> if traveling by
35
- * <code>Car</code>, or <code>TruckModeOptions</code> if traveling by
36
- * <code>Truck</code>.</p>
37
- * </li>
38
- * </ul>
39
- * <p>
40
- * </p>
41
- * @example
42
- * Use a bare-bones client and the command you need to make an API call.
43
- * ```javascript
44
- * import { LocationClient, CalculateRouteCommand } from "@aws-sdk/client-location"; // ES Modules import
45
- * // const { LocationClient, CalculateRouteCommand } = require("@aws-sdk/client-location"); // CommonJS import
46
- * const client = new LocationClient(config);
47
- * const command = new CalculateRouteCommand(input);
48
- * const response = await client.send(command);
49
- * ```
50
- *
51
- * @see {@link CalculateRouteCommandInput} for command's `input` shape.
52
- * @see {@link CalculateRouteCommandOutput} for command's `response` shape.
53
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
54
- *
55
- */
9
+
56
10
  export declare class CalculateRouteCommand extends $Command<CalculateRouteCommandInput, CalculateRouteCommandOutput, LocationClientResolvedConfig> {
57
11
  readonly input: CalculateRouteCommandInput;
58
12
  constructor(input: CalculateRouteCommandInput);
59
- /**
60
- * @internal
61
- */
13
+
62
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CalculateRouteCommandInput, CalculateRouteCommandOutput>;
63
15
  private serialize;
64
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface CreateGeofenceCollectionCommandInput extends CreateGeofenceColl
6
6
  }
7
7
  export interface CreateGeofenceCollectionCommandOutput extends CreateGeofenceCollectionResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates a geofence collection, which manages and stores geofences.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { LocationClient, CreateGeofenceCollectionCommand } from "@aws-sdk/client-location"; // ES Modules import
15
- * // const { LocationClient, CreateGeofenceCollectionCommand } = require("@aws-sdk/client-location"); // CommonJS import
16
- * const client = new LocationClient(config);
17
- * const command = new CreateGeofenceCollectionCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link CreateGeofenceCollectionCommandInput} for command's `input` shape.
22
- * @see {@link CreateGeofenceCollectionCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class CreateGeofenceCollectionCommand extends $Command<CreateGeofenceCollectionCommandInput, CreateGeofenceCollectionCommandOutput, LocationClientResolvedConfig> {
27
11
  readonly input: CreateGeofenceCollectionCommandInput;
28
12
  constructor(input: CreateGeofenceCollectionCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGeofenceCollectionCommandInput, CreateGeofenceCollectionCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface CreateMapCommandInput extends CreateMapRequest {
6
6
  }
7
7
  export interface CreateMapCommandOutput extends CreateMapResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates a map resource in your AWS account, which provides map tiles of different
11
- * styles sourced from global location data providers.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { LocationClient, CreateMapCommand } from "@aws-sdk/client-location"; // ES Modules import
16
- * // const { LocationClient, CreateMapCommand } = require("@aws-sdk/client-location"); // CommonJS import
17
- * const client = new LocationClient(config);
18
- * const command = new CreateMapCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link CreateMapCommandInput} for command's `input` shape.
23
- * @see {@link CreateMapCommandOutput} for command's `response` shape.
24
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class CreateMapCommand extends $Command<CreateMapCommandInput, CreateMapCommandOutput, LocationClientResolvedConfig> {
28
11
  readonly input: CreateMapCommandInput;
29
12
  constructor(input: CreateMapCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateMapCommandInput, CreateMapCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface CreatePlaceIndexCommandInput extends CreatePlaceIndexRequest {
6
6
  }
7
7
  export interface CreatePlaceIndexCommandOutput extends CreatePlaceIndexResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates a place index resource in your AWS account, which supports functions with
11
- * geospatial data sourced from your chosen data provider.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { LocationClient, CreatePlaceIndexCommand } from "@aws-sdk/client-location"; // ES Modules import
16
- * // const { LocationClient, CreatePlaceIndexCommand } = require("@aws-sdk/client-location"); // CommonJS import
17
- * const client = new LocationClient(config);
18
- * const command = new CreatePlaceIndexCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link CreatePlaceIndexCommandInput} for command's `input` shape.
23
- * @see {@link CreatePlaceIndexCommandOutput} for command's `response` shape.
24
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class CreatePlaceIndexCommand extends $Command<CreatePlaceIndexCommandInput, CreatePlaceIndexCommandOutput, LocationClientResolvedConfig> {
28
11
  readonly input: CreatePlaceIndexCommandInput;
29
12
  constructor(input: CreatePlaceIndexCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePlaceIndexCommandInput, CreatePlaceIndexCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,32 +6,11 @@ export interface CreateRouteCalculatorCommandInput extends CreateRouteCalculator
6
6
  }
7
7
  export interface CreateRouteCalculatorCommandOutput extends CreateRouteCalculatorResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates a route calculator resource in your AWS account.</p>
11
- * <p>You can send requests to a route calculator resource to estimate travel time,
12
- * distance, and get directions. A route calculator sources traffic and road network data
13
- * from your chosen data provider.</p>
14
- * @example
15
- * Use a bare-bones client and the command you need to make an API call.
16
- * ```javascript
17
- * import { LocationClient, CreateRouteCalculatorCommand } from "@aws-sdk/client-location"; // ES Modules import
18
- * // const { LocationClient, CreateRouteCalculatorCommand } = require("@aws-sdk/client-location"); // CommonJS import
19
- * const client = new LocationClient(config);
20
- * const command = new CreateRouteCalculatorCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link CreateRouteCalculatorCommandInput} for command's `input` shape.
25
- * @see {@link CreateRouteCalculatorCommandOutput} for command's `response` shape.
26
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
9
+
29
10
  export declare class CreateRouteCalculatorCommand extends $Command<CreateRouteCalculatorCommandInput, CreateRouteCalculatorCommandOutput, LocationClientResolvedConfig> {
30
11
  readonly input: CreateRouteCalculatorCommandInput;
31
12
  constructor(input: CreateRouteCalculatorCommandInput);
32
- /**
33
- * @internal
34
- */
13
+
35
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRouteCalculatorCommandInput, CreateRouteCalculatorCommandOutput>;
36
15
  private serialize;
37
16
  private deserialize;