@aws-sdk/client-iot 3.299.0 → 3.301.0

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

@@ -27,6 +27,103 @@ 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 = { // CreateOTAUpdateRequest
+ *   otaUpdateId: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   targets: [ // Targets // required
+ *     "STRING_VALUE",
+ *   ],
+ *   protocols: [ // Protocols
+ *     "MQTT" || "HTTP",
+ *   ],
+ *   targetSelection: "CONTINUOUS" || "SNAPSHOT",
+ *   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"),
+ *   },
+ *   awsJobAbortConfig: { // AwsJobAbortConfig
+ *     abortCriteriaList: [ // AwsJobAbortCriteriaList // required
+ *       { // AwsJobAbortCriteria
+ *         failureType: "FAILED" || "REJECTED" || "TIMED_OUT" || "ALL", // required
+ *         action: "CANCEL", // required
+ *         thresholdPercentage: Number("double"), // required
+ *         minNumberOfExecutedThings: Number("int"), // required
+ *       },
+ *     ],
+ *   },
+ *   awsJobTimeoutConfig: { // AwsJobTimeoutConfig
+ *     inProgressTimeoutInMinutes: Number("long"),
+ *   },
+ *   files: [ // OTAUpdateFiles // required
+ *     { // 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",
+ *       },
+ *     },
+ *   ],
+ *   roleArn: "STRING_VALUE", // required
+ *   additionalParameters: { // AdditionalParameterMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new CreateOTAUpdateCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -30,6 +30,16 @@ 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 = { // CreatePolicyRequest
+ *   policyName: "STRING_VALUE", // required
+ *   policyDocument: "STRING_VALUE", // required
+ *   tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new CreatePolicyCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -33,6 +33,11 @@ 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 = { // CreatePolicyVersionRequest
+ *   policyName: "STRING_VALUE", // required
+ *   policyDocument: "STRING_VALUE", // required
+ *   setAsDefault: true || false,
+ * };
  * const command = new CreatePolicyVersionCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -27,6 +27,9 @@ 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 = { // CreateProvisioningClaimRequest
+ *   templateName: "STRING_VALUE", // required
+ * };
  * const command = new CreateProvisioningClaimCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -27,6 +27,24 @@ 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 = { // CreateProvisioningTemplateRequest
+ *   templateName: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   templateBody: "STRING_VALUE", // required
+ *   enabled: true || false,
+ *   provisioningRoleArn: "STRING_VALUE", // required
+ *   preProvisioningHook: { // ProvisioningHook
+ *     payloadVersion: "STRING_VALUE",
+ *     targetArn: "STRING_VALUE", // required
+ *   },
+ *   tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ *   type: "FLEET_PROVISIONING" || "JITP",
+ * };
  * const command = new CreateProvisioningTemplateCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -27,6 +27,11 @@ 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 = { // CreateProvisioningTemplateVersionRequest
+ *   templateName: "STRING_VALUE", // required
+ *   templateBody: "STRING_VALUE", // required
+ *   setAsDefault: true || false,
+ * };
  * const command = new CreateProvisioningTemplateVersionCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -27,6 +27,17 @@ 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 = { // CreateRoleAliasRequest
+ *   roleAlias: "STRING_VALUE", // required
+ *   roleArn: "STRING_VALUE", // required
+ *   credentialDurationSeconds: Number("int"),
+ *   tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new CreateRoleAliasCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -28,6 +28,21 @@ 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 = { // CreateScheduledAuditRequest
+ *   frequency: "DAILY" || "WEEKLY" || "BIWEEKLY" || "MONTHLY", // required
+ *   dayOfMonth: "STRING_VALUE",
+ *   dayOfWeek: "SUN" || "MON" || "TUE" || "WED" || "THU" || "FRI" || "SAT",
+ *   targetCheckNames: [ // TargetAuditCheckNames // required
+ *     "STRING_VALUE",
+ *   ],
+ *   scheduledAuditName: "STRING_VALUE", // required
+ *   tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new CreateScheduledAuditCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -27,6 +27,73 @@ 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 = { // CreateSecurityProfileRequest
+ *   securityProfileName: "STRING_VALUE", // required
+ *   securityProfileDescription: "STRING_VALUE",
+ *   behaviors: [ // Behaviors
+ *     { // Behavior
+ *       name: "STRING_VALUE", // required
+ *       metric: "STRING_VALUE",
+ *       metricDimension: { // MetricDimension
+ *         dimensionName: "STRING_VALUE", // required
+ *         operator: "IN" || "NOT_IN",
+ *       },
+ *       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: { // MetricValue
+ *           count: Number("long"),
+ *           cidrs: [ // Cidrs
+ *             "STRING_VALUE",
+ *           ],
+ *           ports: [ // Ports
+ *             Number("int"),
+ *           ],
+ *           number: Number("double"),
+ *           numbers: [ // NumberList
+ *             Number("double"),
+ *           ],
+ *           strings: [ // StringList
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         durationSeconds: Number("int"),
+ *         consecutiveDatapointsToAlarm: Number("int"),
+ *         consecutiveDatapointsToClear: Number("int"),
+ *         statisticalThreshold: { // StatisticalThreshold
+ *           statistic: "STRING_VALUE",
+ *         },
+ *         mlDetectionConfig: { // MachineLearningDetectionConfig
+ *           confidenceLevel: "LOW" || "MEDIUM" || "HIGH", // required
+ *         },
+ *       },
+ *       suppressAlerts: true || false,
+ *     },
+ *   ],
+ *   alertTargets: { // AlertTargets
+ *     "<keys>": { // AlertTarget
+ *       alertTargetArn: "STRING_VALUE", // required
+ *       roleArn: "STRING_VALUE", // required
+ *     },
+ *   },
+ *   additionalMetricsToRetain: [ // AdditionalMetricsToRetainList
+ *     "STRING_VALUE",
+ *   ],
+ *   additionalMetricsToRetainV2: [ // AdditionalMetricsToRetainV2List
+ *     { // MetricToRetain
+ *       metric: "STRING_VALUE", // required
+ *       metricDimension: {
+ *         dimensionName: "STRING_VALUE", // required
+ *         operator: "IN" || "NOT_IN",
+ *       },
+ *     },
+ *   ],
+ *   tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new CreateSecurityProfileCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -29,6 +29,27 @@ 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 = { // CreateStreamRequest
+ *   streamId: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   files: [ // StreamFiles // required
+ *     { // StreamFile
+ *       fileId: Number("int"),
+ *       s3Location: { // S3Location
+ *         bucket: "STRING_VALUE",
+ *         key: "STRING_VALUE",
+ *         version: "STRING_VALUE",
+ *       },
+ *     },
+ *   ],
+ *   roleArn: "STRING_VALUE", // required
+ *   tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new CreateStreamCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -34,6 +34,17 @@ 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 = { // CreateThingRequest
+ *   thingName: "STRING_VALUE", // required
+ *   thingTypeName: "STRING_VALUE",
+ *   attributePayload: { // AttributePayload
+ *     attributes: { // Attributes
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     merge: true || false,
+ *   },
+ *   billingGroupName: "STRING_VALUE",
+ * };
  * const command = new CreateThingCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -31,6 +31,25 @@ 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 = { // CreateThingGroupRequest
+ *   thingGroupName: "STRING_VALUE", // required
+ *   parentGroupName: "STRING_VALUE",
+ *   thingGroupProperties: { // ThingGroupProperties
+ *     thingGroupDescription: "STRING_VALUE",
+ *     attributePayload: { // AttributePayload
+ *       attributes: { // Attributes
+ *         "<keys>": "STRING_VALUE",
+ *       },
+ *       merge: true || false,
+ *     },
+ *   },
+ *   tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new CreateThingGroupCommand(input);
  * const response = await client.send(command);
  * ```

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

@@ -27,6 +27,21 @@ 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 = { // CreateThingTypeRequest
+ *   thingTypeName: "STRING_VALUE", // required
+ *   thingTypeProperties: { // ThingTypeProperties
+ *     thingTypeDescription: "STRING_VALUE",
+ *     searchableAttributes: [ // SearchableAttributes
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new CreateThingTypeCommand(input);
  * const response = await client.send(command);
  * ```