|
| 1 | +// smithy-typescript generated code |
| 2 | +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 5 | +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; |
| 6 | + |
| 7 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 8 | +import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; |
| 9 | +import { |
| 10 | + GetThingConnectivityDataRequest, |
| 11 | + GetThingConnectivityDataRequestFilterSensitiveLog, |
| 12 | + GetThingConnectivityDataResponse, |
| 13 | + GetThingConnectivityDataResponseFilterSensitiveLog, |
| 14 | +} from "../models/models_1"; |
| 15 | +import { de_GetThingConnectivityDataCommand, se_GetThingConnectivityDataCommand } from "../protocols/Aws_restJson1"; |
| 16 | + |
| 17 | +/** |
| 18 | + * @public |
| 19 | + */ |
| 20 | +export type { __MetadataBearer }; |
| 21 | +export { $Command }; |
| 22 | +/** |
| 23 | + * @public |
| 24 | + * |
| 25 | + * The input for {@link GetThingConnectivityDataCommand}. |
| 26 | + */ |
| 27 | +export interface GetThingConnectivityDataCommandInput extends GetThingConnectivityDataRequest {} |
| 28 | +/** |
| 29 | + * @public |
| 30 | + * |
| 31 | + * The output of {@link GetThingConnectivityDataCommand}. |
| 32 | + */ |
| 33 | +export interface GetThingConnectivityDataCommandOutput extends GetThingConnectivityDataResponse, __MetadataBearer {} |
| 34 | + |
| 35 | +/** |
| 36 | + * <p>Retrieves the live connectivity status per device.</p> |
| 37 | + * @example |
| 38 | + * Use a bare-bones client and the command you need to make an API call. |
| 39 | + * ```javascript |
| 40 | + * import { IoTClient, GetThingConnectivityDataCommand } from "@aws-sdk/client-iot"; // ES Modules import |
| 41 | + * // const { IoTClient, GetThingConnectivityDataCommand } = require("@aws-sdk/client-iot"); // CommonJS import |
| 42 | + * const client = new IoTClient(config); |
| 43 | + * const input = { // GetThingConnectivityDataRequest |
| 44 | + * thingName: "STRING_VALUE", // required |
| 45 | + * }; |
| 46 | + * const command = new GetThingConnectivityDataCommand(input); |
| 47 | + * const response = await client.send(command); |
| 48 | + * // { // GetThingConnectivityDataResponse |
| 49 | + * // thingName: "STRING_VALUE", |
| 50 | + * // connected: true || false, |
| 51 | + * // timestamp: new Date("TIMESTAMP"), |
| 52 | + * // disconnectReason: "AUTH_ERROR" || "CLIENT_INITIATED_DISCONNECT" || "CLIENT_ERROR" || "CONNECTION_LOST" || "DUPLICATE_CLIENTID" || "FORBIDDEN_ACCESS" || "MQTT_KEEP_ALIVE_TIMEOUT" || "SERVER_ERROR" || "SERVER_INITIATED_DISCONNECT" || "THROTTLED" || "WEBSOCKET_TTL_EXPIRATION" || "CUSTOMAUTH_TTL_EXPIRATION" || "UNKNOWN" || "NONE", |
| 53 | + * // }; |
| 54 | + * |
| 55 | + * ``` |
| 56 | + * |
| 57 | + * @param GetThingConnectivityDataCommandInput - {@link GetThingConnectivityDataCommandInput} |
| 58 | + * @returns {@link GetThingConnectivityDataCommandOutput} |
| 59 | + * @see {@link GetThingConnectivityDataCommandInput} for command's `input` shape. |
| 60 | + * @see {@link GetThingConnectivityDataCommandOutput} for command's `response` shape. |
| 61 | + * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape. |
| 62 | + * |
| 63 | + * @throws {@link IndexNotReadyException} (client fault) |
| 64 | + * <p>The index is not ready.</p> |
| 65 | + * |
| 66 | + * @throws {@link InternalFailureException} (server fault) |
| 67 | + * <p>An unexpected error has occurred.</p> |
| 68 | + * |
| 69 | + * @throws {@link InvalidRequestException} (client fault) |
| 70 | + * <p>The request is not valid.</p> |
| 71 | + * |
| 72 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 73 | + * <p>The specified resource does not exist.</p> |
| 74 | + * |
| 75 | + * @throws {@link ServiceUnavailableException} (server fault) |
| 76 | + * <p>The service is temporarily unavailable.</p> |
| 77 | + * |
| 78 | + * @throws {@link ThrottlingException} (client fault) |
| 79 | + * <p>The rate exceeds the limit.</p> |
| 80 | + * |
| 81 | + * @throws {@link UnauthorizedException} (client fault) |
| 82 | + * <p>You are not authorized to perform this operation.</p> |
| 83 | + * |
| 84 | + * @throws {@link IoTServiceException} |
| 85 | + * <p>Base exception class for all service exceptions from IoT service.</p> |
| 86 | + * |
| 87 | + * @public |
| 88 | + */ |
| 89 | +export class GetThingConnectivityDataCommand extends $Command |
| 90 | + .classBuilder< |
| 91 | + GetThingConnectivityDataCommandInput, |
| 92 | + GetThingConnectivityDataCommandOutput, |
| 93 | + IoTClientResolvedConfig, |
| 94 | + ServiceInputTypes, |
| 95 | + ServiceOutputTypes |
| 96 | + >() |
| 97 | + .ep(commonParams) |
| 98 | + .m(function (this: any, Command: any, cs: any, config: IoTClientResolvedConfig, o: any) { |
| 99 | + return [ |
| 100 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 101 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 102 | + ]; |
| 103 | + }) |
| 104 | + .s("AWSIotService", "GetThingConnectivityData", {}) |
| 105 | + .n("IoTClient", "GetThingConnectivityDataCommand") |
| 106 | + .f(GetThingConnectivityDataRequestFilterSensitiveLog, GetThingConnectivityDataResponseFilterSensitiveLog) |
| 107 | + .ser(se_GetThingConnectivityDataCommand) |
| 108 | + .de(de_GetThingConnectivityDataCommand) |
| 109 | + .build() { |
| 110 | + /** @internal type navigation helper, not in runtime. */ |
| 111 | + protected declare static __types: { |
| 112 | + api: { |
| 113 | + input: GetThingConnectivityDataRequest; |
| 114 | + output: GetThingConnectivityDataResponse; |
| 115 | + }; |
| 116 | + sdk: { |
| 117 | + input: GetThingConnectivityDataCommandInput; |
| 118 | + output: GetThingConnectivityDataCommandOutput; |
| 119 | + }; |
| 120 | + }; |
| 121 | +} |
0 commit comments