@aws-sdk/client-iot 3.300.0 → 3.301.0

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

@@ -27,33 +27,33 @@ export interface CreateOTAUpdateCommandOutput extends CreateOTAUpdateResponse, _
  * import { IoTClient, CreateOTAUpdateCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateOTAUpdateCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateOTAUpdateRequest
  *   otaUpdateId: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
- *   targets: [ // required
+ *   targets: [ // Targets // required
  *     "STRING_VALUE",
  *   ],
- *   protocols: [
+ *   protocols: [ // Protocols
  *     "MQTT" || "HTTP",
  *   ],
  *   targetSelection: "CONTINUOUS" || "SNAPSHOT",
- *   awsJobExecutionsRolloutConfig: {
+ *   awsJobExecutionsRolloutConfig: { // AwsJobExecutionsRolloutConfig
  *     maximumPerMinute: Number("int"),
- *     exponentialRate: {
+ *     exponentialRate: { // AwsJobExponentialRolloutRate
  *       baseRatePerMinute: Number("int"), // required
  *       incrementFactor: Number("double"), // required
- *       rateIncreaseCriteria: {
+ *       rateIncreaseCriteria: { // AwsJobRateIncreaseCriteria
  *         numberOfNotifiedThings: Number("int"),
  *         numberOfSucceededThings: Number("int"),
  *       },
  *     },
  *   },
- *   awsJobPresignedUrlConfig: {
+ *   awsJobPresignedUrlConfig: { // AwsJobPresignedUrlConfig
  *     expiresInSec: Number("long"),
  *   },
- *   awsJobAbortConfig: {
- *     abortCriteriaList: [ // required
- *       {
+ *   awsJobAbortConfig: { // AwsJobAbortConfig
+ *     abortCriteriaList: [ // AwsJobAbortCriteriaList // required
+ *       { // AwsJobAbortCriteria
  *         failureType: "FAILED" || "REJECTED" || "TIMED_OUT" || "ALL", // required
  *         action: "CANCEL", // required
  *         thresholdPercentage: Number("double"), // required
@@ -61,46 +61,46 @@ export interface CreateOTAUpdateCommandOutput extends CreateOTAUpdateResponse, _
  *       },
  *     ],
  *   },
- *   awsJobTimeoutConfig: {
+ *   awsJobTimeoutConfig: { // AwsJobTimeoutConfig
  *     inProgressTimeoutInMinutes: Number("long"),
  *   },
- *   files: [ // required
- *     {
+ *   files: [ // OTAUpdateFiles // required
+ *     { // OTAUpdateFile
  *       fileName: "STRING_VALUE",
  *       fileType: Number("int"),
  *       fileVersion: "STRING_VALUE",
- *       fileLocation: {
- *         stream: {
+ *       fileLocation: { // FileLocation
+ *         stream: { // Stream
  *           streamId: "STRING_VALUE",
  *           fileId: Number("int"),
  *         },
- *         s3Location: {
+ *         s3Location: { // S3Location
  *           bucket: "STRING_VALUE",
  *           key: "STRING_VALUE",
  *           version: "STRING_VALUE",
  *         },
  *       },
- *       codeSigning: {
+ *       codeSigning: { // CodeSigning
  *         awsSignerJobId: "STRING_VALUE",
- *         startSigningJobParameter: {
- *           signingProfileParameter: {
+ *         startSigningJobParameter: { // StartSigningJobParameter
+ *           signingProfileParameter: { // SigningProfileParameter
  *             certificateArn: "STRING_VALUE",
  *             platform: "STRING_VALUE",
  *             certificatePathOnDevice: "STRING_VALUE",
  *           },
  *           signingProfileName: "STRING_VALUE",
- *           destination: {
- *             s3Destination: {
+ *           destination: { // Destination
+ *             s3Destination: { // S3Destination
  *               bucket: "STRING_VALUE",
  *               prefix: "STRING_VALUE",
  *             },
  *           },
  *         },
- *         customCodeSigning: {
- *           signature: {
+ *         customCodeSigning: { // CustomCodeSigning
+ *           signature: { // CodeSigningSignature
  *             inlineDocument: "BLOB_VALUE",
  *           },
- *           certificateChain: {
+ *           certificateChain: { // CodeSigningCertificateChain
  *             certificateName: "STRING_VALUE",
  *             inlineDocument: "STRING_VALUE",
  *           },
@@ -108,17 +108,17 @@ export interface CreateOTAUpdateCommandOutput extends CreateOTAUpdateResponse, _
  *           signatureAlgorithm: "STRING_VALUE",
  *         },
  *       },
- *       attributes: {
+ *       attributes: { // AttributesMap
  *         "<keys>": "STRING_VALUE",
  *       },
  *     },
  *   ],
  *   roleArn: "STRING_VALUE", // required
- *   additionalParameters: {
+ *   additionalParameters: { // AdditionalParameterMap
  *     "<keys>": "STRING_VALUE",
  *   },
- *   tags: [
- *     {
+ *   tags: [ // TagList
+ *     { // Tag
  *       Key: "STRING_VALUE", // required
  *       Value: "STRING_VALUE",
  *     },

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

@@ -30,11 +30,11 @@ export interface CreatePolicyCommandOutput extends CreatePolicyResponse, __Metad
  * import { IoTClient, CreatePolicyCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreatePolicyCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreatePolicyRequest
  *   policyName: "STRING_VALUE", // required
  *   policyDocument: "STRING_VALUE", // required
- *   tags: [
- *     {
+ *   tags: [ // TagList
+ *     { // Tag
  *       Key: "STRING_VALUE", // required
  *       Value: "STRING_VALUE",
  *     },

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

@@ -33,7 +33,7 @@ export interface CreatePolicyVersionCommandOutput extends CreatePolicyVersionRes
  * import { IoTClient, CreatePolicyVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreatePolicyVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreatePolicyVersionRequest
  *   policyName: "STRING_VALUE", // required
  *   policyDocument: "STRING_VALUE", // required
  *   setAsDefault: true || false,

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

@@ -27,7 +27,7 @@ export interface CreateProvisioningClaimCommandOutput extends CreateProvisioning
  * import { IoTClient, CreateProvisioningClaimCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateProvisioningClaimCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateProvisioningClaimRequest
  *   templateName: "STRING_VALUE", // required
  * };
  * const command = new CreateProvisioningClaimCommand(input);

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

@@ -27,18 +27,18 @@ export interface CreateProvisioningTemplateCommandOutput extends CreateProvision
  * import { IoTClient, CreateProvisioningTemplateCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateProvisioningTemplateCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateProvisioningTemplateRequest
  *   templateName: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
  *   templateBody: "STRING_VALUE", // required
  *   enabled: true || false,
  *   provisioningRoleArn: "STRING_VALUE", // required
- *   preProvisioningHook: {
+ *   preProvisioningHook: { // ProvisioningHook
  *     payloadVersion: "STRING_VALUE",
  *     targetArn: "STRING_VALUE", // required
  *   },
- *   tags: [
- *     {
+ *   tags: [ // TagList
+ *     { // Tag
  *       Key: "STRING_VALUE", // required
  *       Value: "STRING_VALUE",
  *     },

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

@@ -27,7 +27,7 @@ export interface CreateProvisioningTemplateVersionCommandOutput extends CreatePr
  * import { IoTClient, CreateProvisioningTemplateVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateProvisioningTemplateVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateProvisioningTemplateVersionRequest
  *   templateName: "STRING_VALUE", // required
  *   templateBody: "STRING_VALUE", // required
  *   setAsDefault: true || false,

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

@@ -27,12 +27,12 @@ export interface CreateRoleAliasCommandOutput extends CreateRoleAliasResponse, _
  * import { IoTClient, CreateRoleAliasCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateRoleAliasCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateRoleAliasRequest
  *   roleAlias: "STRING_VALUE", // required
  *   roleArn: "STRING_VALUE", // required
  *   credentialDurationSeconds: Number("int"),
- *   tags: [
- *     {
+ *   tags: [ // TagList
+ *     { // Tag
  *       Key: "STRING_VALUE", // required
  *       Value: "STRING_VALUE",
  *     },

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

@@ -28,16 +28,16 @@ export interface CreateScheduledAuditCommandOutput extends CreateScheduledAuditR
  * import { IoTClient, CreateScheduledAuditCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateScheduledAuditCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateScheduledAuditRequest
  *   frequency: "DAILY" || "WEEKLY" || "BIWEEKLY" || "MONTHLY", // required
  *   dayOfMonth: "STRING_VALUE",
  *   dayOfWeek: "SUN" || "MON" || "TUE" || "WED" || "THU" || "FRI" || "SAT",
- *   targetCheckNames: [ // required
+ *   targetCheckNames: [ // TargetAuditCheckNames // required
  *     "STRING_VALUE",
  *   ],
  *   scheduledAuditName: "STRING_VALUE", // required
- *   tags: [
- *     {
+ *   tags: [ // TagList
+ *     { // Tag
  *       Key: "STRING_VALUE", // required
  *       Value: "STRING_VALUE",
  *     },

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

@@ -27,59 +27,59 @@ export interface CreateSecurityProfileCommandOutput extends CreateSecurityProfil
  * import { IoTClient, CreateSecurityProfileCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateSecurityProfileCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateSecurityProfileRequest
  *   securityProfileName: "STRING_VALUE", // required
  *   securityProfileDescription: "STRING_VALUE",
- *   behaviors: [
- *     {
+ *   behaviors: [ // Behaviors
+ *     { // Behavior
  *       name: "STRING_VALUE", // required
  *       metric: "STRING_VALUE",
- *       metricDimension: {
+ *       metricDimension: { // MetricDimension
  *         dimensionName: "STRING_VALUE", // required
  *         operator: "IN" || "NOT_IN",
  *       },
- *       criteria: {
+ *       criteria: { // BehaviorCriteria
  *         comparisonOperator: "less-than" || "less-than-equals" || "greater-than" || "greater-than-equals" || "in-cidr-set" || "not-in-cidr-set" || "in-port-set" || "not-in-port-set" || "in-set" || "not-in-set",
- *         value: {
+ *         value: { // MetricValue
  *           count: Number("long"),
- *           cidrs: [
+ *           cidrs: [ // Cidrs
  *             "STRING_VALUE",
  *           ],
- *           ports: [
+ *           ports: [ // Ports
  *             Number("int"),
  *           ],
  *           number: Number("double"),
- *           numbers: [
+ *           numbers: [ // NumberList
  *             Number("double"),
  *           ],
- *           strings: [
+ *           strings: [ // StringList
  *             "STRING_VALUE",
  *           ],
  *         },
  *         durationSeconds: Number("int"),
  *         consecutiveDatapointsToAlarm: Number("int"),
  *         consecutiveDatapointsToClear: Number("int"),
- *         statisticalThreshold: {
+ *         statisticalThreshold: { // StatisticalThreshold
  *           statistic: "STRING_VALUE",
  *         },
- *         mlDetectionConfig: {
+ *         mlDetectionConfig: { // MachineLearningDetectionConfig
  *           confidenceLevel: "LOW" || "MEDIUM" || "HIGH", // required
  *         },
  *       },
  *       suppressAlerts: true || false,
  *     },
  *   ],
- *   alertTargets: {
- *     "<keys>": {
+ *   alertTargets: { // AlertTargets
+ *     "<keys>": { // AlertTarget
  *       alertTargetArn: "STRING_VALUE", // required
  *       roleArn: "STRING_VALUE", // required
  *     },
  *   },
- *   additionalMetricsToRetain: [
+ *   additionalMetricsToRetain: [ // AdditionalMetricsToRetainList
  *     "STRING_VALUE",
  *   ],
- *   additionalMetricsToRetainV2: [
- *     {
+ *   additionalMetricsToRetainV2: [ // AdditionalMetricsToRetainV2List
+ *     { // MetricToRetain
  *       metric: "STRING_VALUE", // required
  *       metricDimension: {
  *         dimensionName: "STRING_VALUE", // required
@@ -87,8 +87,8 @@ export interface CreateSecurityProfileCommandOutput extends CreateSecurityProfil
  *       },
  *     },
  *   ],
- *   tags: [
- *     {
+ *   tags: [ // TagList
+ *     { // Tag
  *       Key: "STRING_VALUE", // required
  *       Value: "STRING_VALUE",
  *     },

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

@@ -29,13 +29,13 @@ export interface CreateStreamCommandOutput extends CreateStreamResponse, __Metad
  * import { IoTClient, CreateStreamCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateStreamCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateStreamRequest
  *   streamId: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
- *   files: [ // required
- *     {
+ *   files: [ // StreamFiles // required
+ *     { // StreamFile
  *       fileId: Number("int"),
- *       s3Location: {
+ *       s3Location: { // S3Location
  *         bucket: "STRING_VALUE",
  *         key: "STRING_VALUE",
  *         version: "STRING_VALUE",
@@ -43,8 +43,8 @@ export interface CreateStreamCommandOutput extends CreateStreamResponse, __Metad
  *     },
  *   ],
  *   roleArn: "STRING_VALUE", // required
- *   tags: [
- *     {
+ *   tags: [ // TagList
+ *     { // Tag
  *       Key: "STRING_VALUE", // required
  *       Value: "STRING_VALUE",
  *     },

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

@@ -34,11 +34,11 @@ export interface CreateThingCommandOutput extends CreateThingResponse, __Metadat
  * import { IoTClient, CreateThingCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateThingRequest
  *   thingName: "STRING_VALUE", // required
  *   thingTypeName: "STRING_VALUE",
- *   attributePayload: {
- *     attributes: {
+ *   attributePayload: { // AttributePayload
+ *     attributes: { // Attributes
  *       "<keys>": "STRING_VALUE",
  *     },
  *     merge: true || false,

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

@@ -31,20 +31,20 @@ export interface CreateThingGroupCommandOutput extends CreateThingGroupResponse,
  * import { IoTClient, CreateThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateThingGroupRequest
  *   thingGroupName: "STRING_VALUE", // required
  *   parentGroupName: "STRING_VALUE",
- *   thingGroupProperties: {
+ *   thingGroupProperties: { // ThingGroupProperties
  *     thingGroupDescription: "STRING_VALUE",
- *     attributePayload: {
- *       attributes: {
+ *     attributePayload: { // AttributePayload
+ *       attributes: { // Attributes
  *         "<keys>": "STRING_VALUE",
  *       },
  *       merge: true || false,
  *     },
  *   },
- *   tags: [
- *     {
+ *   tags: [ // TagList
+ *     { // Tag
  *       Key: "STRING_VALUE", // required
  *       Value: "STRING_VALUE",
  *     },

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

@@ -27,16 +27,16 @@ export interface CreateThingTypeCommandOutput extends CreateThingTypeResponse, _
  * import { IoTClient, CreateThingTypeCommand } from "@aws-sdk/client-iot"; // ES Modules import
  * // const { IoTClient, CreateThingTypeCommand } = require("@aws-sdk/client-iot"); // CommonJS import
  * const client = new IoTClient(config);
- * const input = {
+ * const input = { // CreateThingTypeRequest
  *   thingTypeName: "STRING_VALUE", // required
- *   thingTypeProperties: {
+ *   thingTypeProperties: { // ThingTypeProperties
  *     thingTypeDescription: "STRING_VALUE",
- *     searchableAttributes: [
+ *     searchableAttributes: [ // SearchableAttributes
  *       "STRING_VALUE",
  *     ],
  *   },
- *   tags: [
- *     {
+ *   tags: [ // TagList
+ *     { // Tag
  *       Key: "STRING_VALUE", // required
  *       Value: "STRING_VALUE",
  *     },