@aws-sdk/client-iot 3.325.0 → 3.327.0

package/dist-types/commands/GetJobDocumentCommand.d.ts

@@ -32,6 +32,10 @@ export interface GetJobDocumentCommandOutput extends GetJobDocumentResponse, __M
  * };
  * const command = new GetJobDocumentCommand(input);
  * const response = await client.send(command);
+ * // { // GetJobDocumentResponse
+ * //   document: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param GetJobDocumentCommandInput - {@link GetJobDocumentCommandInput}
@@ -52,6 +56,8 @@ export interface GetJobDocumentCommandOutput extends GetJobDocumentResponse, __M
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The rate exceeds the limit.</p>
  *
+ * @throws {@link IoTServiceException}
+ * <p>Base exception class for all service exceptions from IoT service.</p>
  *
  */
 export declare class GetJobDocumentCommand extends $Command<GetJobDocumentCommandInput, GetJobDocumentCommandOutput, IoTClientResolvedConfig> {

package/dist-types/commands/GetLoggingOptionsCommand.d.ts

@@ -32,6 +32,11 @@ export interface GetLoggingOptionsCommandOutput extends GetLoggingOptionsRespons
  * const input = {};
  * const command = new GetLoggingOptionsCommand(input);
  * const response = await client.send(command);
+ * // { // GetLoggingOptionsResponse
+ * //   roleArn: "STRING_VALUE",
+ * //   logLevel: "DEBUG" || "INFO" || "ERROR" || "WARN" || "DISABLED",
+ * // };
+ *
  * ```
  *
  * @param GetLoggingOptionsCommandInput - {@link GetLoggingOptionsCommandInput}
@@ -49,6 +54,8 @@ export interface GetLoggingOptionsCommandOutput extends GetLoggingOptionsRespons
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The service is temporarily unavailable.</p>
  *
+ * @throws {@link IoTServiceException}
+ * <p>Base exception class for all service exceptions from IoT service.</p>
  *
  */
 export declare class GetLoggingOptionsCommand extends $Command<GetLoggingOptionsCommandInput, GetLoggingOptionsCommandOutput, IoTClientResolvedConfig> {

package/dist-types/commands/GetOTAUpdateCommand.d.ts

@@ -32,6 +32,96 @@ export interface GetOTAUpdateCommandOutput extends GetOTAUpdateResponse, __Metad
  * };
  * const command = new GetOTAUpdateCommand(input);
  * const response = await client.send(command);
+ * // { // GetOTAUpdateResponse
+ * //   otaUpdateInfo: { // OTAUpdateInfo
+ * //     otaUpdateId: "STRING_VALUE",
+ * //     otaUpdateArn: "STRING_VALUE",
+ * //     creationDate: new Date("TIMESTAMP"),
+ * //     lastModifiedDate: new Date("TIMESTAMP"),
+ * //     description: "STRING_VALUE",
+ * //     targets: [ // Targets
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     protocols: [ // Protocols
+ * //       "MQTT" || "HTTP",
+ * //     ],
+ * //     awsJobExecutionsRolloutConfig: { // AwsJobExecutionsRolloutConfig
+ * //       maximumPerMinute: Number("int"),
+ * //       exponentialRate: { // AwsJobExponentialRolloutRate
+ * //         baseRatePerMinute: Number("int"), // required
+ * //         incrementFactor: Number("double"), // required
+ * //         rateIncreaseCriteria: { // AwsJobRateIncreaseCriteria
+ * //           numberOfNotifiedThings: Number("int"),
+ * //           numberOfSucceededThings: Number("int"),
+ * //         },
+ * //       },
+ * //     },
+ * //     awsJobPresignedUrlConfig: { // AwsJobPresignedUrlConfig
+ * //       expiresInSec: Number("long"),
+ * //     },
+ * //     targetSelection: "CONTINUOUS" || "SNAPSHOT",
+ * //     otaUpdateFiles: [ // OTAUpdateFiles
+ * //       { // OTAUpdateFile
+ * //         fileName: "STRING_VALUE",
+ * //         fileType: Number("int"),
+ * //         fileVersion: "STRING_VALUE",
+ * //         fileLocation: { // FileLocation
+ * //           stream: { // Stream
+ * //             streamId: "STRING_VALUE",
+ * //             fileId: Number("int"),
+ * //           },
+ * //           s3Location: { // S3Location
+ * //             bucket: "STRING_VALUE",
+ * //             key: "STRING_VALUE",
+ * //             version: "STRING_VALUE",
+ * //           },
+ * //         },
+ * //         codeSigning: { // CodeSigning
+ * //           awsSignerJobId: "STRING_VALUE",
+ * //           startSigningJobParameter: { // StartSigningJobParameter
+ * //             signingProfileParameter: { // SigningProfileParameter
+ * //               certificateArn: "STRING_VALUE",
+ * //               platform: "STRING_VALUE",
+ * //               certificatePathOnDevice: "STRING_VALUE",
+ * //             },
+ * //             signingProfileName: "STRING_VALUE",
+ * //             destination: { // Destination
+ * //               s3Destination: { // S3Destination
+ * //                 bucket: "STRING_VALUE",
+ * //                 prefix: "STRING_VALUE",
+ * //               },
+ * //             },
+ * //           },
+ * //           customCodeSigning: { // CustomCodeSigning
+ * //             signature: { // CodeSigningSignature
+ * //               inlineDocument: "BLOB_VALUE",
+ * //             },
+ * //             certificateChain: { // CodeSigningCertificateChain
+ * //               certificateName: "STRING_VALUE",
+ * //               inlineDocument: "STRING_VALUE",
+ * //             },
+ * //             hashAlgorithm: "STRING_VALUE",
+ * //             signatureAlgorithm: "STRING_VALUE",
+ * //           },
+ * //         },
+ * //         attributes: { // AttributesMap
+ * //           "<keys>": "STRING_VALUE",
+ * //         },
+ * //       },
+ * //     ],
+ * //     otaUpdateStatus: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_COMPLETE" || "CREATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
+ * //     awsIotJobId: "STRING_VALUE",
+ * //     awsIotJobArn: "STRING_VALUE",
+ * //     errorInfo: { // ErrorInfo
+ * //       code: "STRING_VALUE",
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     additionalParameters: { // AdditionalParameterMap
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetOTAUpdateCommandInput - {@link GetOTAUpdateCommandInput}
@@ -58,6 +148,8 @@ export interface GetOTAUpdateCommandOutput extends GetOTAUpdateResponse, __Metad
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>You are not authorized to perform this operation.</p>
  *
+ * @throws {@link IoTServiceException}
+ * <p>Base exception class for all service exceptions from IoT service.</p>
  *
  */
 export declare class GetOTAUpdateCommand extends $Command<GetOTAUpdateCommandInput, GetOTAUpdateCommandOutput, IoTClientResolvedConfig> {

package/dist-types/commands/GetPercentilesCommand.d.ts

@@ -46,6 +46,15 @@ export interface GetPercentilesCommandOutput extends GetPercentilesResponse, __M
  * };
  * const command = new GetPercentilesCommand(input);
  * const response = await client.send(command);
+ * // { // GetPercentilesResponse
+ * //   percentiles: [ // Percentiles
+ * //     { // PercentPair
+ * //       percent: Number("double"),
+ * //       value: Number("double"),
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param GetPercentilesCommandInput - {@link GetPercentilesCommandInput}
@@ -81,6 +90,8 @@ export interface GetPercentilesCommandOutput extends GetPercentilesResponse, __M
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>You are not authorized to perform this operation.</p>
  *
+ * @throws {@link IoTServiceException}
+ * <p>Base exception class for all service exceptions from IoT service.</p>
  *
  */
 export declare class GetPercentilesCommand extends $Command<GetPercentilesCommandInput, GetPercentilesCommandOutput, IoTClientResolvedConfig> {

package/dist-types/commands/GetPolicyCommand.d.ts

@@ -33,6 +33,16 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea
  * };
  * const command = new GetPolicyCommand(input);
  * const response = await client.send(command);
+ * // { // GetPolicyResponse
+ * //   policyName: "STRING_VALUE",
+ * //   policyArn: "STRING_VALUE",
+ * //   policyDocument: "STRING_VALUE",
+ * //   defaultVersionId: "STRING_VALUE",
+ * //   creationDate: new Date("TIMESTAMP"),
+ * //   lastModifiedDate: new Date("TIMESTAMP"),
+ * //   generationId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param GetPolicyCommandInput - {@link GetPolicyCommandInput}
@@ -59,6 +69,8 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>You are not authorized to perform this operation.</p>
  *
+ * @throws {@link IoTServiceException}
+ * <p>Base exception class for all service exceptions from IoT service.</p>
  *
  */
 export declare class GetPolicyCommand extends $Command<GetPolicyCommandInput, GetPolicyCommandOutput, IoTClientResolvedConfig> {

package/dist-types/commands/GetPolicyVersionCommand.d.ts

@@ -33,6 +33,17 @@ export interface GetPolicyVersionCommandOutput extends GetPolicyVersionResponse,
  * };
  * const command = new GetPolicyVersionCommand(input);
  * const response = await client.send(command);
+ * // { // GetPolicyVersionResponse
+ * //   policyArn: "STRING_VALUE",
+ * //   policyName: "STRING_VALUE",
+ * //   policyDocument: "STRING_VALUE",
+ * //   policyVersionId: "STRING_VALUE",
+ * //   isDefaultVersion: true || false,
+ * //   creationDate: new Date("TIMESTAMP"),
+ * //   lastModifiedDate: new Date("TIMESTAMP"),
+ * //   generationId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param GetPolicyVersionCommandInput - {@link GetPolicyVersionCommandInput}
@@ -59,6 +70,8 @@ export interface GetPolicyVersionCommandOutput extends GetPolicyVersionResponse,
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>You are not authorized to perform this operation.</p>
  *
+ * @throws {@link IoTServiceException}
+ * <p>Base exception class for all service exceptions from IoT service.</p>
  *
  */
 export declare class GetPolicyVersionCommand extends $Command<GetPolicyVersionCommandInput, GetPolicyVersionCommandOutput, IoTClientResolvedConfig> {

package/dist-types/commands/GetRegistrationCodeCommand.d.ts

@@ -30,6 +30,10 @@ export interface GetRegistrationCodeCommandOutput extends GetRegistrationCodeRes
  * const input = {};
  * const command = new GetRegistrationCodeCommand(input);
  * const response = await client.send(command);
+ * // { // GetRegistrationCodeResponse
+ * //   registrationCode: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param GetRegistrationCodeCommandInput - {@link GetRegistrationCodeCommandInput}
@@ -53,6 +57,8 @@ export interface GetRegistrationCodeCommandOutput extends GetRegistrationCodeRes
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>You are not authorized to perform this operation.</p>
  *
+ * @throws {@link IoTServiceException}
+ * <p>Base exception class for all service exceptions from IoT service.</p>
  *
  */
 export declare class GetRegistrationCodeCommand extends $Command<GetRegistrationCodeCommandInput, GetRegistrationCodeCommandOutput, IoTClientResolvedConfig> {

package/dist-types/commands/GetStatisticsCommand.d.ts

@@ -37,6 +37,19 @@ export interface GetStatisticsCommandOutput extends GetStatisticsResponse, __Met
  * };
  * const command = new GetStatisticsCommand(input);
  * const response = await client.send(command);
+ * // { // GetStatisticsResponse
+ * //   statistics: { // Statistics
+ * //     count: Number("int"),
+ * //     average: Number("double"),
+ * //     sum: Number("double"),
+ * //     minimum: Number("double"),
+ * //     maximum: Number("double"),
+ * //     sumOfSquares: Number("double"),
+ * //     variance: Number("double"),
+ * //     stdDeviation: Number("double"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetStatisticsCommandInput - {@link GetStatisticsCommandInput}
@@ -72,6 +85,8 @@ export interface GetStatisticsCommandOutput extends GetStatisticsResponse, __Met
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>You are not authorized to perform this operation.</p>
  *
+ * @throws {@link IoTServiceException}
+ * <p>Base exception class for all service exceptions from IoT service.</p>
  *
  */
 export declare class GetStatisticsCommand extends $Command<GetStatisticsCommandInput, GetStatisticsCommandOutput, IoTClientResolvedConfig> {