diff --git a/clients/client-iot-wireless/src/commands/CreateWirelessGatewayCommand.ts b/clients/client-iot-wireless/src/commands/CreateWirelessGatewayCommand.ts index 4266f116ae20..afa2d43dadb6 100644 --- a/clients/client-iot-wireless/src/commands/CreateWirelessGatewayCommand.ts +++ b/clients/client-iot-wireless/src/commands/CreateWirelessGatewayCommand.ts @@ -28,6 +28,21 @@ export interface CreateWirelessGatewayCommandOutput extends CreateWirelessGatewa /** *

Provisions a wireless gateway.

+ * + *

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

+ * + *

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

+ * * @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/DeleteWirelessGatewayCommand.ts b/clients/client-iot-wireless/src/commands/DeleteWirelessGatewayCommand.ts index 088afa6e6f2b..0a901ec4219e 100644 --- a/clients/client-iot-wireless/src/commands/DeleteWirelessGatewayCommand.ts +++ b/clients/client-iot-wireless/src/commands/DeleteWirelessGatewayCommand.ts @@ -28,6 +28,21 @@ export interface DeleteWirelessGatewayCommandOutput extends DeleteWirelessGatewa /** *

Deletes a wireless gateway.

+ * + *

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

+ * + *

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

+ * * @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/GetMetricConfigurationCommand.ts b/clients/client-iot-wireless/src/commands/GetMetricConfigurationCommand.ts index 083571ee1956..7e7ba108c6dd 100644 --- a/clients/client-iot-wireless/src/commands/GetMetricConfigurationCommand.ts +++ b/clients/client-iot-wireless/src/commands/GetMetricConfigurationCommand.ts @@ -27,7 +27,7 @@ export interface GetMetricConfigurationCommandInput extends GetMetricConfigurati export interface GetMetricConfigurationCommandOutput extends GetMetricConfigurationResponse, __MetadataBearer {} /** - *

Get the metric configuration status for this account.

+ *

Get the metric configuration status for this AWS account.

* @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/GetMetricsCommand.ts b/clients/client-iot-wireless/src/commands/GetMetricsCommand.ts index 6de64e94b08a..0a6fb791154c 100644 --- a/clients/client-iot-wireless/src/commands/GetMetricsCommand.ts +++ b/clients/client-iot-wireless/src/commands/GetMetricsCommand.ts @@ -27,7 +27,7 @@ export interface GetMetricsCommandInput extends GetMetricsRequest {} export interface GetMetricsCommandOutput extends GetMetricsResponse, __MetadataBearer {} /** - *

Get metrics.

+ *

Get the summary metrics for this AWS account.

* @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/GetWirelessDeviceStatisticsCommand.ts b/clients/client-iot-wireless/src/commands/GetWirelessDeviceStatisticsCommand.ts index 532715ea885b..4e4ad8a4bb03 100644 --- a/clients/client-iot-wireless/src/commands/GetWirelessDeviceStatisticsCommand.ts +++ b/clients/client-iot-wireless/src/commands/GetWirelessDeviceStatisticsCommand.ts @@ -60,6 +60,16 @@ export interface GetWirelessDeviceStatisticsCommandOutput * // Rssi: Number("double"), * // }, * // ], + * // PublicGateways: [ // LoRaWANPublicGatewayMetadataList + * // { // LoRaWANPublicGatewayMetadata + * // ProviderNetId: "STRING_VALUE", + * // Id: "STRING_VALUE", + * // Rssi: Number("double"), + * // Snr: Number("double"), + * // RfRegion: "STRING_VALUE", + * // DlAllowed: true || false, + * // }, + * // ], * // }, * // Sidewalk: { // SidewalkDeviceMetadata * // Rssi: Number("int"), diff --git a/clients/client-iot-wireless/src/commands/ListPositionConfigurationsCommand.ts b/clients/client-iot-wireless/src/commands/ListPositionConfigurationsCommand.ts index 5fb2492b02d2..f396189cc3a8 100644 --- a/clients/client-iot-wireless/src/commands/ListPositionConfigurationsCommand.ts +++ b/clients/client-iot-wireless/src/commands/ListPositionConfigurationsCommand.ts @@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; import { IoTWirelessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTWirelessClient"; -import { ListPositionConfigurationsRequest } from "../models/models_0"; -import { ListPositionConfigurationsResponse } from "../models/models_1"; +import { ListPositionConfigurationsRequest, ListPositionConfigurationsResponse } from "../models/models_1"; import { de_ListPositionConfigurationsCommand, se_ListPositionConfigurationsCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-iot-wireless/src/commands/UpdateMetricConfigurationCommand.ts b/clients/client-iot-wireless/src/commands/UpdateMetricConfigurationCommand.ts index 27c768eee68e..6a955b24268d 100644 --- a/clients/client-iot-wireless/src/commands/UpdateMetricConfigurationCommand.ts +++ b/clients/client-iot-wireless/src/commands/UpdateMetricConfigurationCommand.ts @@ -27,7 +27,7 @@ export interface UpdateMetricConfigurationCommandInput extends UpdateMetricConfi export interface UpdateMetricConfigurationCommandOutput extends UpdateMetricConfigurationResponse, __MetadataBearer {} /** - *

Update the metric configuration.

+ *

Update the summary metric configuration.

* @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/models/models_0.ts b/clients/client-iot-wireless/src/models/models_0.ts index 36a33bbaf07d..02cc7523b6dc 100644 --- a/clients/client-iot-wireless/src/models/models_0.ts +++ b/clients/client-iot-wireless/src/models/models_0.ts @@ -245,10 +245,12 @@ export interface AssociateAwsAccountWithPartnerAccountRequest { Sidewalk: SidewalkAccountInfo | 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. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -1405,10 +1407,12 @@ export interface CreateDestinationRequest { 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. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -1582,10 +1586,12 @@ export interface CreateDeviceProfileRequest { 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. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -1668,10 +1674,12 @@ export interface CreateFuotaTaskRequest { Description?: string; /** - *

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

+ *

Each resource must have a unique client request token. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -1798,10 +1806,12 @@ export interface CreateMulticastGroupRequest { Description?: string; /** - *

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

+ *

Each resource must have a unique client request token. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -1905,7 +1915,8 @@ export interface TraceContent { /** *

* FrameInfo of your multicast group resources for the trace content. Use - * FrameInfo to debug the multicast communication between your multicast groups and the network server.

+ * FrameInfo to debug the multicast communication between your multicast groups and the + * network server.

* @public */ MulticastFrameInfo?: MulticastFrameInfo; @@ -1955,10 +1966,12 @@ export interface CreateNetworkAnalyzerConfigurationRequest { 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. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -2048,10 +2061,12 @@ export interface CreateServiceProfileRequest { 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. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -2147,7 +2162,8 @@ export interface OtaaV1_0_x { AppKey?: string; /** - *

The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or v1.0.3.

+ *

The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or + * v1.0.3.

* @public */ AppEui?: string; @@ -2313,10 +2329,12 @@ 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. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -2445,10 +2463,12 @@ export interface CreateWirelessGatewayRequest { 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. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -2626,10 +2646,12 @@ export interface CreateWirelessGatewayTaskDefinitionRequest { Update?: UpdateWirelessGatewayTaskCreate; /** - *

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. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -4179,12 +4201,12 @@ export type SummaryMetricConfigurationStatus = (typeof SummaryMetricConfigurationStatus)[keyof typeof SummaryMetricConfigurationStatus]; /** - *

The configuration of summary metric.

+ *

The configuration of summary metrics.

* @public */ export interface SummaryMetricConfiguration { /** - *

The configuration of summary metric.

+ *

The status of the configuration of summary metrics.

* @public */ Status?: SummaryMetricConfigurationStatus; @@ -4195,7 +4217,7 @@ export interface SummaryMetricConfiguration { */ export interface GetMetricConfigurationResponse { /** - *

The account's configuration status for summary metric aggregation.

+ *

The configuration status of the AWS account for summary metric aggregation.

* @public */ SummaryMetric?: SummaryMetricConfiguration; @@ -4244,12 +4266,12 @@ export const MetricName = { export type MetricName = (typeof MetricName)[keyof typeof MetricName]; /** - *

The metric query object.

+ *

The summary metric query object.

* @public */ export interface SummaryMetricQuery { /** - *

The id of the query.

+ *

The id of the summary metric query.

* @public */ QueryId?: string; @@ -4261,25 +4283,25 @@ export interface SummaryMetricQuery { MetricName?: MetricName; /** - *

The dimensions of the metric.

+ *

The dimensions of the summary metric.

* @public */ Dimensions?: Dimension[]; /** - *

The aggregation period of the metric.

+ *

The aggregation period of the summary metric.

* @public */ AggregationPeriod?: AggregationPeriod; /** - *

The start timestamp for summary metric query.

+ *

The start timestamp for the summary metric query.

* @public */ StartTimestamp?: Date; /** - *

The end timestamp for summary metric query.

+ *

The end timestamp for the summary metric query.

* @public */ EndTimestamp?: Date; @@ -4290,7 +4312,7 @@ export interface SummaryMetricQuery { */ export interface GetMetricsRequest { /** - *

The list of queries to retrieve summary metrics.

+ *

The list of queries to retrieve the summary metrics.

* @public */ SummaryMetricQueries?: SummaryMetricQuery[]; @@ -4316,67 +4338,73 @@ export type MetricQueryStatus = (typeof MetricQueryStatus)[keyof typeof MetricQu */ export interface MetricQueryValue { /** - *

The minimum of the values of the all data points collected during the period.

+ *

The minimum of the values of all data points collected during the aggregation + * period.

* @public */ Min?: number; /** - *

The maximum of the values of the all data points collected during the period.

+ *

The maximum of the values of all the data points collected during the aggregation + * period.

* @public */ Max?: number; /** - *

The sum of the values of the all data points collected during the period.

+ *

The sum of the values of all data points collected during the aggregation + * period.

* @public */ Sum?: number; /** - *

The average of the values of the all data points collected during the period.

+ *

The average of the values of all data points collected during the aggregation + * period.

* @public */ Avg?: number; /** - *

The standard deviation of the values of the all data points collected during the period.

+ *

The standard deviation of the values of all data points collected during the + * aggregation period.

* @public */ Std?: number; /** - *

The 90th percentile of the values of the all data points collected during the period.

+ *

The 90th percentile of the values of all data points collected during the aggregation + * period.

* @public */ P90?: number; } /** - *

The result of metrics aggregation operation.

+ *

The result of the summary metrics aggregation operation.

* @public */ export interface SummaryMetricQueryResult { /** - *

The id of the query.

+ *

The ID of the summary metric results query operation.

* @public */ QueryId?: string; /** - *

The status of the metric query.

+ *

The status of the summary metric query result.

* @public */ QueryStatus?: MetricQueryStatus; /** - *

The error message for the summary metric query.

+ *

The error message for the summary metric query result.

* @public */ Error?: string; /** - *

The name of the metric.

+ *

The name of the summary metric query result.

* @public */ MetricName?: MetricName; @@ -4394,13 +4422,13 @@ export interface SummaryMetricQueryResult { AggregationPeriod?: AggregationPeriod; /** - *

The start timestamp for summary metric query.

+ *

The start timestamp for the summary metric query.

* @public */ StartTimestamp?: Date; /** - *

The end timestamp for summary metric query.

+ *

The end timestamp for the summary metric query.

* @public */ EndTimestamp?: Date; @@ -4412,7 +4440,7 @@ export interface SummaryMetricQueryResult { Timestamps?: Date[]; /** - *

The list of aggregated metrics.

+ *

The list of aggregated summary metric query results.

* @public */ Values?: MetricQueryValue[]; @@ -4429,7 +4457,7 @@ export interface SummaryMetricQueryResult { */ export interface GetMetricsResponse { /** - *

The list of retrieved metrics.

+ *

The list of summary metrics that were retrieved.

* @public */ SummaryMetricQueryResults?: SummaryMetricQueryResult[]; @@ -5718,6 +5746,48 @@ export interface LoRaWANGatewayMetadata { Rssi?: number; } +/** + *

LoRaWAN public gateway metadata.

+ * @public + */ +export interface LoRaWANPublicGatewayMetadata { + /** + *

The ID of the LoRaWAN public network provider.

+ * @public + */ + ProviderNetId?: string; + + /** + *

The ID of the gateways that are operated by the network provider.

+ * @public + */ + Id?: string; + + /** + *

The RSSI (received signal strength indicator) value.

+ * @public + */ + Rssi?: number; + + /** + *

The SNR (signal to noise ratio) value.

+ * @public + */ + Snr?: number; + + /** + *

The frequency band (RFRegion) value.

+ * @public + */ + RfRegion?: string; + + /** + *

Boolean that indicates whether downlink is allowed using the network.

+ * @public + */ + DlAllowed?: boolean; +} + /** *

LoRaWAN device metatdata.

* @public @@ -5758,6 +5828,12 @@ export interface LoRaWANDeviceMetadata { * @public */ Gateways?: LoRaWANGatewayMetadata[]; + + /** + *

Information about the LoRaWAN public network accessed by the device.

+ * @public + */ + PublicGateways?: LoRaWANPublicGatewayMetadata[]; } /** @@ -6576,31 +6652,6 @@ export interface ListPartnerAccountsResponse { Sidewalk?: SidewalkAccountInfoWithFingerprint[]; } -/** - * @public - */ -export interface ListPositionConfigurationsRequest { - /** - *

Resource type for which position configurations are listed.

- * @public - */ - ResourceType?: PositionResourceType; - - /** - *

The maximum number of results to return in this operation.

- * @public - */ - 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.

- * @public - */ - NextToken?: 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 a48275a24909..1a02f7664160 100644 --- a/clients/client-iot-wireless/src/models/models_1.ts +++ b/clients/client-iot-wireless/src/models/models_1.ts @@ -46,6 +46,31 @@ import { WirelessGatewayLogOption, } from "./models_0"; +/** + * @public + */ +export interface ListPositionConfigurationsRequest { + /** + *

Resource type for which position configurations are listed.

+ * @public + */ + ResourceType?: PositionResourceType; + + /** + *

The maximum number of results to return in this operation.

+ * @public + */ + 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.

+ * @public + */ + NextToken?: string; +} + /** *

The wrapper for a position configuration.

* @public @@ -1156,10 +1181,12 @@ 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. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -1233,10 +1260,12 @@ 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. The client token is used to implement + * idempotency. It ensures that the request completes no more than one time. If you retry a request + * with the same token and the same parameters, the request will complete successfully. However, if + * you try to create a new resource using the same token but different parameters, an HTTP 409 + * conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. + * For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

* @public */ ClientRequestToken?: string; @@ -1661,14 +1690,14 @@ export interface UpdateNetworkAnalyzerConfigurationRequest { /** *

Multicast group resources to add to the network analyzer configuration. Provide the - * MulticastGroupId of the resource to add in the input array.

+ * MulticastGroupId of the resource to add in the input array.

* @public */ MulticastGroupsToAdd?: string[]; /** - *

Multicast group resources to remove from the network analyzer configuration. Provide the - * MulticastGroupId of the resources to remove in the input array.

+ *

Multicast group resources to remove from the network analyzer configuration. Provide + * the MulticastGroupId of the resources to remove in the input array.

* @public */ MulticastGroupsToRemove?: string[]; diff --git a/clients/client-iot-wireless/src/protocols/Aws_restJson1.ts b/clients/client-iot-wireless/src/protocols/Aws_restJson1.ts index ddb452db5605..cb91a1356a41 100644 --- a/clients/client-iot-wireless/src/protocols/Aws_restJson1.ts +++ b/clients/client-iot-wireless/src/protocols/Aws_restJson1.ts @@ -446,6 +446,7 @@ import { LoRaWANJoinResourceTypeEventConfiguration, LoRaWANMulticast, LoRaWANMulticastSession, + LoRaWANPublicGatewayMetadata, LoRaWANSendDataToDevice, LoRaWANServiceProfile, LoRaWANUpdateGatewayTaskCreate, @@ -5813,6 +5814,7 @@ const de_LoRaWANDeviceMetadata = (output: any, context: __SerdeContext): LoRaWAN FPort: __expectInt32, Frequency: __expectInt32, Gateways: (_: any) => de_LoRaWANGatewayMetadataList(_, context), + PublicGateways: (_: any) => de_LoRaWANPublicGatewayMetadataList(_, context), Timestamp: __expectString, }) as any; }; @@ -5894,6 +5896,32 @@ const de_LoRaWANMulticastSession = (output: any, context: __SerdeContext): LoRaW }) as any; }; +/** + * deserializeAws_restJson1LoRaWANPublicGatewayMetadata + */ +const de_LoRaWANPublicGatewayMetadata = (output: any, context: __SerdeContext): LoRaWANPublicGatewayMetadata => { + return take(output, { + DlAllowed: __expectBoolean, + Id: __expectString, + ProviderNetId: __expectString, + RfRegion: __expectString, + Rssi: __limitedParseDouble, + Snr: __limitedParseDouble, + }) as any; +}; + +/** + * deserializeAws_restJson1LoRaWANPublicGatewayMetadataList + */ +const de_LoRaWANPublicGatewayMetadataList = (output: any, context: __SerdeContext): LoRaWANPublicGatewayMetadata[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_LoRaWANPublicGatewayMetadata(entry, context); + }); + return retVal; +}; + // de_LoRaWANSendDataToDevice omitted. // de_LoRaWANUpdateGatewayTaskCreate omitted. diff --git a/codegen/sdk-codegen/aws-models/iot-wireless.json b/codegen/sdk-codegen/aws-models/iot-wireless.json index 3bbd23d9e4ba..e340d1548902 100644 --- a/codegen/sdk-codegen/aws-models/iot-wireless.json +++ b/codegen/sdk-codegen/aws-models/iot-wireless.json @@ -328,7 +328,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\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#documentation": "

Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

", "smithy.api#idempotencyToken": {} } }, @@ -1231,7 +1231,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\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#documentation": "

Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

", "smithy.api#length": { "min": 1, "max": 64 @@ -1410,7 +1410,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\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#documentation": "

Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

", "smithy.api#idempotencyToken": {} } } @@ -1497,7 +1497,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\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#documentation": "

Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

", "smithy.api#idempotencyToken": {} } }, @@ -1682,7 +1682,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\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#documentation": "

Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

", "smithy.api#idempotencyToken": {} } }, @@ -1873,7 +1873,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\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#documentation": "

Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

", "smithy.api#idempotencyToken": {} } } @@ -1971,7 +1971,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\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#documentation": "

Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

", "smithy.api#idempotencyToken": {} } }, @@ -2050,7 +2050,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provisions a wireless gateway.

", + "smithy.api#documentation": "

Provisions a wireless gateway.

\n \n

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

\n \n

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

\n ", "smithy.api#http": { "method": "POST", "uri": "/wireless-gateways", @@ -2089,7 +2089,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\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#documentation": "

Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

", "smithy.api#idempotencyToken": {} } } @@ -2218,7 +2218,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\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#documentation": "

Each resource must have a unique client request token. The client token is used to implement\n idempotency. It ensures that the request completes no more than one time. If you retry a request\n with the same token and the same parameters, the request will complete successfully. However, if\n you try to create a new resource using the same token but different parameters, an HTTP 409\n conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

", "smithy.api#idempotencyToken": {} } }, @@ -2934,7 +2934,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a wireless gateway.

", + "smithy.api#documentation": "

Deletes a wireless gateway.

\n \n

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

\n \n

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

\n ", "smithy.api#http": { "method": "DELETE", "uri": "/wireless-gateways/{Id}", @@ -3895,6 +3895,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotwireless#DlAllowed": { + "type": "boolean" + }, "com.amazonaws.iotwireless#DlBucketSize": { "type": "integer", "traits": { @@ -5075,7 +5078,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get the metric configuration status for this account.

", + "smithy.api#documentation": "

Get the metric configuration status for this AWS account.

", "smithy.api#http": { "method": "GET", "uri": "/metric-configuration", @@ -5096,7 +5099,7 @@ "SummaryMetric": { "target": "com.amazonaws.iotwireless#SummaryMetricConfiguration", "traits": { - "smithy.api#documentation": "

The account's configuration status for summary metric aggregation.

" + "smithy.api#documentation": "

The configuration status of the AWS account for summary metric aggregation.

" } } }, @@ -5133,7 +5136,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get metrics.

", + "smithy.api#documentation": "

Get the summary metrics for this AWS account.

", "smithy.api#http": { "method": "POST", "uri": "/metrics", @@ -5147,7 +5150,7 @@ "SummaryMetricQueries": { "target": "com.amazonaws.iotwireless#SummaryMetricQueries", "traits": { - "smithy.api#documentation": "

The list of queries to retrieve summary metrics.

" + "smithy.api#documentation": "

The list of queries to retrieve the summary metrics.

" } } }, @@ -5161,7 +5164,7 @@ "SummaryMetricQueryResults": { "target": "com.amazonaws.iotwireless#SummaryMetricQueryResults", "traits": { - "smithy.api#documentation": "

The list of retrieved metrics.

" + "smithy.api#documentation": "

The list of summary metrics that were retrieved.

" } } }, @@ -7235,6 +7238,15 @@ "smithy.api#pattern": "^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" } }, + "com.amazonaws.iotwireless#Id": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.iotwireless#Identifier": { "type": "string", "traits": { @@ -9058,6 +9070,12 @@ "traits": { "smithy.api#documentation": "

Information about the gateways accessed by the device.

" } + }, + "PublicGateways": { + "target": "com.amazonaws.iotwireless#LoRaWANPublicGatewayMetadataList", + "traits": { + "smithy.api#documentation": "

Information about the LoRaWAN public network accessed by the device.

" + } } }, "traits": { @@ -9572,6 +9590,53 @@ "smithy.api#documentation": "

The LoRaWAN information used with the multicast session.

" } }, + "com.amazonaws.iotwireless#LoRaWANPublicGatewayMetadata": { + "type": "structure", + "members": { + "ProviderNetId": { + "target": "com.amazonaws.iotwireless#ProviderNetId", + "traits": { + "smithy.api#documentation": "

The ID of the LoRaWAN public network provider.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#Id", + "traits": { + "smithy.api#documentation": "

The ID of the gateways that are operated by the network provider.

" + } + }, + "Rssi": { + "target": "com.amazonaws.iotwireless#Double", + "traits": { + "smithy.api#documentation": "

The RSSI (received signal strength indicator) value.

" + } + }, + "Snr": { + "target": "com.amazonaws.iotwireless#Double", + "traits": { + "smithy.api#documentation": "

The SNR (signal to noise ratio) value.

" + } + }, + "RfRegion": { + "target": "com.amazonaws.iotwireless#RfRegion" + }, + "DlAllowed": { + "target": "com.amazonaws.iotwireless#DlAllowed", + "traits": { + "smithy.api#documentation": "

Boolean that indicates whether downlink is allowed using the network.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

LoRaWAN public gateway metadata.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANPublicGatewayMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#LoRaWANPublicGatewayMetadata" + } + }, "com.amazonaws.iotwireless#LoRaWANSendDataToDevice": { "type": "structure", "members": { @@ -10326,37 +10391,37 @@ "Min": { "target": "com.amazonaws.iotwireless#Min", "traits": { - "smithy.api#documentation": "

The minimum of the values of the all data points collected during the period.

" + "smithy.api#documentation": "

The minimum of the values of all data points collected during the aggregation\n period.

" } }, "Max": { "target": "com.amazonaws.iotwireless#Max", "traits": { - "smithy.api#documentation": "

The maximum of the values of the all data points collected during the period.

" + "smithy.api#documentation": "

The maximum of the values of all the data points collected during the aggregation\n period.

" } }, "Sum": { "target": "com.amazonaws.iotwireless#Sum", "traits": { - "smithy.api#documentation": "

The sum of the values of the all data points collected during the period.

" + "smithy.api#documentation": "

The sum of the values of all data points collected during the aggregation\n period.

" } }, "Avg": { "target": "com.amazonaws.iotwireless#Avg", "traits": { - "smithy.api#documentation": "

The average of the values of the all data points collected during the period.

" + "smithy.api#documentation": "

The average of the values of all data points collected during the aggregation\n period.

" } }, "Std": { "target": "com.amazonaws.iotwireless#Std", "traits": { - "smithy.api#documentation": "

The standard deviation of the values of the all data points collected during the period.

" + "smithy.api#documentation": "

The standard deviation of the values of all data points collected during the\n aggregation period.

" } }, "P90": { "target": "com.amazonaws.iotwireless#P90", "traits": { - "smithy.api#documentation": "

The 90th percentile of the values of the all data points collected during the period.

" + "smithy.api#documentation": "

The 90th percentile of the values of all data points collected during the aggregation\n period.

" } } }, @@ -10426,7 +10491,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n FrameInfo of your multicast group resources for the trace content. Use\n FrameInfo to debug the multicast communication between your multicast groups and the network server.

" + "smithy.api#documentation": "

\n FrameInfo of your multicast group resources for the trace content. Use\n FrameInfo to debug the multicast communication between your multicast groups and the\n network server.

" } }, "com.amazonaws.iotwireless#MulticastGroup": { @@ -10715,13 +10780,13 @@ "AppEui": { "target": "com.amazonaws.iotwireless#AppEui", "traits": { - "smithy.api#documentation": "

The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or v1.0.3.

" + "smithy.api#documentation": "

The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or\n v1.0.3.

" } }, "JoinEui": { "target": "com.amazonaws.iotwireless#JoinEui", "traits": { - "smithy.api#documentation": "

The JoinEUI value. You specify this value instead of the AppEUI when using LoRaWAN \n version v1.0.4.

" + "smithy.api#documentation": "

The JoinEUI value. You specify this value instead of the AppEUI when using LoRaWAN\n version v1.0.4.

" } }, "GenAppKey": { @@ -11126,6 +11191,15 @@ "target": "com.amazonaws.iotwireless#CertificateList" } }, + "com.amazonaws.iotwireless#ProviderNetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.iotwireless#ProximityEventConfiguration": { "type": "structure", "members": { @@ -12879,12 +12953,12 @@ "Status": { "target": "com.amazonaws.iotwireless#SummaryMetricConfigurationStatus", "traits": { - "smithy.api#documentation": "

The configuration of summary metric.

" + "smithy.api#documentation": "

The status of the configuration of summary metrics.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration of summary metric.

" + "smithy.api#documentation": "

The configuration of summary metrics.

" } }, "com.amazonaws.iotwireless#SummaryMetricConfigurationStatus": { @@ -12916,7 +12990,7 @@ "QueryId": { "target": "com.amazonaws.iotwireless#MetricQueryId", "traits": { - "smithy.api#documentation": "

The id of the query.

" + "smithy.api#documentation": "

The id of the summary metric query.

" } }, "MetricName": { @@ -12928,30 +13002,30 @@ "Dimensions": { "target": "com.amazonaws.iotwireless#Dimensions", "traits": { - "smithy.api#documentation": "

The dimensions of the metric.

" + "smithy.api#documentation": "

The dimensions of the summary metric.

" } }, "AggregationPeriod": { "target": "com.amazonaws.iotwireless#AggregationPeriod", "traits": { - "smithy.api#documentation": "

The aggregation period of the metric.

" + "smithy.api#documentation": "

The aggregation period of the summary metric.

" } }, "StartTimestamp": { "target": "com.amazonaws.iotwireless#MetricQueryStartTimestamp", "traits": { - "smithy.api#documentation": "

The start timestamp for summary metric query.

" + "smithy.api#documentation": "

The start timestamp for the summary metric query.

" } }, "EndTimestamp": { "target": "com.amazonaws.iotwireless#MetricQueryEndTimestamp", "traits": { - "smithy.api#documentation": "

The end timestamp for summary metric query.

" + "smithy.api#documentation": "

The end timestamp for the summary metric query.

" } } }, "traits": { - "smithy.api#documentation": "

The metric query object.

" + "smithy.api#documentation": "

The summary metric query object.

" } }, "com.amazonaws.iotwireless#SummaryMetricQueryResult": { @@ -12960,25 +13034,25 @@ "QueryId": { "target": "com.amazonaws.iotwireless#MetricQueryId", "traits": { - "smithy.api#documentation": "

The id of the query.

" + "smithy.api#documentation": "

The ID of the summary metric results query operation.

" } }, "QueryStatus": { "target": "com.amazonaws.iotwireless#MetricQueryStatus", "traits": { - "smithy.api#documentation": "

The status of the metric query.

" + "smithy.api#documentation": "

The status of the summary metric query result.

" } }, "Error": { "target": "com.amazonaws.iotwireless#MetricQueryError", "traits": { - "smithy.api#documentation": "

The error message for the summary metric query.

" + "smithy.api#documentation": "

The error message for the summary metric query result.

" } }, "MetricName": { "target": "com.amazonaws.iotwireless#MetricName", "traits": { - "smithy.api#documentation": "

The name of the metric.

" + "smithy.api#documentation": "

The name of the summary metric query result.

" } }, "Dimensions": { @@ -12996,13 +13070,13 @@ "StartTimestamp": { "target": "com.amazonaws.iotwireless#MetricQueryStartTimestamp", "traits": { - "smithy.api#documentation": "

The start timestamp for summary metric query.

" + "smithy.api#documentation": "

The start timestamp for the summary metric query.

" } }, "EndTimestamp": { "target": "com.amazonaws.iotwireless#MetricQueryEndTimestamp", "traits": { - "smithy.api#documentation": "

The end timestamp for summary metric query.

" + "smithy.api#documentation": "

The end timestamp for the summary metric query.

" } }, "Timestamps": { @@ -13014,7 +13088,7 @@ "Values": { "target": "com.amazonaws.iotwireless#MetricQueryValues", "traits": { - "smithy.api#documentation": "

The list of aggregated metrics.

" + "smithy.api#documentation": "

The list of aggregated summary metric query results.

" } }, "Unit": { @@ -13025,7 +13099,7 @@ } }, "traits": { - "smithy.api#documentation": "

The result of metrics aggregation operation.

" + "smithy.api#documentation": "

The result of the summary metrics aggregation operation.

" } }, "com.amazonaws.iotwireless#SummaryMetricQueryResults": { @@ -14092,7 +14166,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update the metric configuration.

", + "smithy.api#documentation": "

Update the summary metric configuration.

", "smithy.api#http": { "method": "PUT", "uri": "/metric-configuration", @@ -14267,13 +14341,13 @@ "MulticastGroupsToAdd": { "target": "com.amazonaws.iotwireless#NetworkAnalyzerMulticastGroupList", "traits": { - "smithy.api#documentation": "

Multicast group resources to add to the network analyzer configuration. Provide the\n MulticastGroupId of the resource to add in the input array.

" + "smithy.api#documentation": "

Multicast group resources to add to the network analyzer configuration. Provide the\n MulticastGroupId of the resource to add in the input array.

" } }, "MulticastGroupsToRemove": { "target": "com.amazonaws.iotwireless#NetworkAnalyzerMulticastGroupList", "traits": { - "smithy.api#documentation": "

Multicast group resources to remove from the network analyzer configuration. Provide the\n MulticastGroupId of the resources to remove in the input array.

" + "smithy.api#documentation": "

Multicast group resources to remove from the network analyzer configuration. Provide\n the MulticastGroupId of the resources to remove in the input array.

" } } },