@aws-sdk/client-iot 3.428.0 → 3.430.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -34,12 +34,12 @@ export interface AbortCriteria {
34
34
  * @public
35
35
  * <p>The type of job execution failures that can initiate a job abort.</p>
36
36
  */
37
- failureType: JobExecutionFailureType | string | undefined;
37
+ failureType: JobExecutionFailureType | undefined;
38
38
  /**
39
39
  * @public
40
40
  * <p>The type of job action to take to initiate the job abort.</p>
41
41
  */
42
- action: AbortAction | string | undefined;
42
+ action: AbortAction | undefined;
43
43
  /**
44
44
  * @public
45
45
  * <p>The minimum percentage of job execution failures that must occur to initiate the job abort.</p>
@@ -315,7 +315,7 @@ export interface DynamoDBAction {
315
315
  * @public
316
316
  * <p>The hash key type. Valid values are "STRING" or "NUMBER"</p>
317
317
  */
318
- hashKeyType?: DynamoKeyType | string;
318
+ hashKeyType?: DynamoKeyType;
319
319
  /**
320
320
  * @public
321
321
  * <p>The range key name.</p>
@@ -330,7 +330,7 @@ export interface DynamoDBAction {
330
330
  * @public
331
331
  * <p>The range key type. Valid values are "STRING" or "NUMBER"</p>
332
332
  */
333
- rangeKeyType?: DynamoKeyType | string;
333
+ rangeKeyType?: DynamoKeyType;
334
334
  /**
335
335
  * @public
336
336
  * <p>The action payload. This name can be customized.</p>
@@ -1115,7 +1115,7 @@ export interface S3Action {
1115
1115
  * <p>The Amazon S3 canned ACL that controls access to the object identified by the object
1116
1116
  * key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl">S3 canned ACLs</a>.</p>
1117
1117
  */
1118
- cannedAcl?: CannedAccessControlList | string;
1118
+ cannedAcl?: CannedAccessControlList;
1119
1119
  }
1120
1120
  /**
1121
1121
  * @public
@@ -1171,7 +1171,7 @@ export interface SnsAction {
1171
1171
  * if the payload should be parsed and relevant platform-specific bits of the payload should
1172
1172
  * be extracted. To read more about SNS message formats, see <a href="https://docs.aws.amazon.com/sns/latest/dg/json-formats.html">https://docs.aws.amazon.com/sns/latest/dg/json-formats.html</a> refer to their official documentation.</p>
1173
1173
  */
1174
- messageFormat?: MessageFormat | string;
1174
+ messageFormat?: MessageFormat;
1175
1175
  }
1176
1176
  /**
1177
1177
  * @public
@@ -1495,7 +1495,7 @@ export interface MachineLearningDetectionConfig {
1495
1495
  * The sensitivity of anomalous behavior evaluation. Can be <code>Low</code>, <code>Medium</code>, or <code>High</code>.
1496
1496
  * </p>
1497
1497
  */
1498
- confidenceLevel: ConfidenceLevel | string | undefined;
1498
+ confidenceLevel: ConfidenceLevel | undefined;
1499
1499
  }
1500
1500
  /**
1501
1501
  * @public
@@ -1594,7 +1594,7 @@ export interface BehaviorCriteria {
1594
1594
  * </li>
1595
1595
  * </ul>
1596
1596
  */
1597
- comparisonOperator?: ComparisonOperator | string;
1597
+ comparisonOperator?: ComparisonOperator;
1598
1598
  /**
1599
1599
  * @public
1600
1600
  * <p>The value to be compared with the <code>metric</code>.</p>
@@ -1664,7 +1664,7 @@ export interface MetricDimension {
1664
1664
  * @public
1665
1665
  * <p>Defines how the <code>dimensionValues</code> of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the <code>IN</code> operator, a message will be counted only if its topic matches one of the topic filters. With <code>NOT_IN</code> operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is <code>null</code>), it will be interpreted as <code>IN</code>.</p>
1666
1666
  */
1667
- operator?: DimensionValueOperator | string;
1667
+ operator?: DimensionValueOperator;
1668
1668
  }
1669
1669
  /**
1670
1670
  * @public
@@ -1731,7 +1731,7 @@ export interface ViolationEventAdditionalInfo {
1731
1731
  * The sensitivity of anomalous behavior evaluation. Can be <code>Low</code>, <code>Medium</code>, or <code>High</code>.
1732
1732
  * </p>
1733
1733
  */
1734
- confidenceLevel?: ConfidenceLevel | string;
1734
+ confidenceLevel?: ConfidenceLevel;
1735
1735
  }
1736
1736
  /**
1737
1737
  * @public
@@ -1774,7 +1774,7 @@ export interface ActiveViolation {
1774
1774
  * @public
1775
1775
  * <p>The verification state of the violation (detect alarm).</p>
1776
1776
  */
1777
- verificationState?: VerificationState | string;
1777
+ verificationState?: VerificationState;
1778
1778
  /**
1779
1779
  * @public
1780
1780
  * <p>The description of the verification state of the violation.</p>
@@ -1916,7 +1916,7 @@ export interface AggregationType {
1916
1916
  * @public
1917
1917
  * <p>The name of the aggregation type.</p>
1918
1918
  */
1919
- name: AggregationTypeName | string | undefined;
1919
+ name: AggregationTypeName | undefined;
1920
1920
  /**
1921
1921
  * @public
1922
1922
  * <p>A list of the values of aggregation types.</p>
@@ -2193,7 +2193,7 @@ export interface AuditCheckDetails {
2193
2193
  * <p>The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION",
2194
2194
  * "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".</p>
2195
2195
  */
2196
- checkRunStatus?: AuditCheckRunStatus | string;
2196
+ checkRunStatus?: AuditCheckRunStatus;
2197
2197
  /**
2198
2198
  * @public
2199
2199
  * <p>True if the check is complete and found all resources compliant.</p>
@@ -2349,7 +2349,7 @@ export interface NonCompliantResource {
2349
2349
  * @public
2350
2350
  * <p>The type of the noncompliant resource.</p>
2351
2351
  */
2352
- resourceType?: ResourceType | string;
2352
+ resourceType?: ResourceType;
2353
2353
  /**
2354
2354
  * @public
2355
2355
  * <p>Information that identifies the noncompliant resource.</p>
@@ -2370,7 +2370,7 @@ export interface RelatedResource {
2370
2370
  * @public
2371
2371
  * <p>The type of resource.</p>
2372
2372
  */
2373
- resourceType?: ResourceType | string;
2373
+ resourceType?: ResourceType;
2374
2374
  /**
2375
2375
  * @public
2376
2376
  * <p>Information that identifies the resource.</p>
@@ -2431,7 +2431,7 @@ export interface AuditFinding {
2431
2431
  * @public
2432
2432
  * <p>The severity of the result (finding).</p>
2433
2433
  */
2434
- severity?: AuditFindingSeverity | string;
2434
+ severity?: AuditFindingSeverity;
2435
2435
  /**
2436
2436
  * @public
2437
2437
  * <p>The resource that was found to be noncompliant with the
@@ -2520,7 +2520,7 @@ export interface AuditMitigationActionExecutionMetadata {
2520
2520
  * @public
2521
2521
  * <p>The current status of the task being executed.</p>
2522
2522
  */
2523
- status?: AuditMitigationActionsExecutionStatus | string;
2523
+ status?: AuditMitigationActionsExecutionStatus;
2524
2524
  /**
2525
2525
  * @public
2526
2526
  * <p>The date and time when the task was started.</p>
@@ -2575,7 +2575,7 @@ export interface AuditMitigationActionsTaskMetadata {
2575
2575
  * @public
2576
2576
  * <p>The current state of the audit mitigation actions task.</p>
2577
2577
  */
2578
- taskStatus?: AuditMitigationActionsTaskStatus | string;
2578
+ taskStatus?: AuditMitigationActionsTaskStatus;
2579
2579
  }
2580
2580
  /**
2581
2581
  * @public
@@ -2742,12 +2742,12 @@ export interface AuditTaskMetadata {
2742
2742
  * <p>The status of this audit. One of "IN_PROGRESS", "COMPLETED",
2743
2743
  * "FAILED", or "CANCELED".</p>
2744
2744
  */
2745
- taskStatus?: AuditTaskStatus | string;
2745
+ taskStatus?: AuditTaskStatus;
2746
2746
  /**
2747
2747
  * @public
2748
2748
  * <p>The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".</p>
2749
2749
  */
2750
- taskType?: AuditTaskType | string;
2750
+ taskType?: AuditTaskType;
2751
2751
  }
2752
2752
  /**
2753
2753
  * @public
@@ -2771,7 +2771,7 @@ export interface AuthInfo {
2771
2771
  * @public
2772
2772
  * <p>The type of action for which the principal is being authorized.</p>
2773
2773
  */
2774
- actionType?: ActionType | string;
2774
+ actionType?: ActionType;
2775
2775
  /**
2776
2776
  * @public
2777
2777
  * <p>The resources for which the principal is being authorized to perform the specified
@@ -2842,7 +2842,7 @@ export interface AuthorizerDescription {
2842
2842
  * @public
2843
2843
  * <p>The status of the authorizer.</p>
2844
2844
  */
2845
- status?: AuthorizerStatus | string;
2845
+ status?: AuthorizerStatus;
2846
2846
  /**
2847
2847
  * @public
2848
2848
  * <p>The UNIX timestamp of when the authorizer was created.</p>
@@ -2950,7 +2950,7 @@ export interface AuthResult {
2950
2950
  * account when determining the authorization decision. An explicit deny statement can
2951
2951
  * override multiple allow statements.</p>
2952
2952
  */
2953
- authDecision?: AuthDecision | string;
2953
+ authDecision?: AuthDecision;
2954
2954
  /**
2955
2955
  * @public
2956
2956
  * <p>Contains any missing context values found while evaluating policy.</p>
@@ -3305,7 +3305,7 @@ export interface CreateAuthorizerRequest {
3305
3305
  * @public
3306
3306
  * <p>The status of the create authorizer request.</p>
3307
3307
  */
3308
- status?: AuthorizerStatus | string;
3308
+ status?: AuthorizerStatus;
3309
3309
  /**
3310
3310
  * @public
3311
3311
  * <p>Metadata which can be used to manage the custom authorizer.</p>
@@ -3479,7 +3479,7 @@ export interface CreateCustomMetricRequest {
3479
3479
  * single value.</p>
3480
3480
  * </important>
3481
3481
  */
3482
- metricType: CustomMetricType | string | undefined;
3482
+ metricType: CustomMetricType | undefined;
3483
3483
  /**
3484
3484
  * @public
3485
3485
  * <p>
@@ -3542,7 +3542,7 @@ export interface CreateDimensionRequest {
3542
3542
  * <p>Specifies the type of dimension. Supported types: <code>TOPIC_FILTER.</code>
3543
3543
  * </p>
3544
3544
  */
3545
- type: DimensionType | string | undefined;
3545
+ type: DimensionType | undefined;
3546
3546
  /**
3547
3547
  * @public
3548
3548
  * <p>Specifies the value or list of values for the dimension. For <code>TOPIC_FILTER</code> dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").</p>
@@ -3654,7 +3654,7 @@ export interface CreateDomainConfigurationRequest {
3654
3654
  * <p>Amazon Web Services IoT Core currently supports only the <code>DATA</code> service type.</p>
3655
3655
  * </note>
3656
3656
  */
3657
- serviceType?: ServiceType | string;
3657
+ serviceType?: ServiceType;
3658
3658
  /**
3659
3659
  * @public
3660
3660
  * <p>Metadata which can be used to manage the domain configuration.</p>
@@ -3880,7 +3880,7 @@ export interface CreateFleetMetricRequest {
3880
3880
  * <p>Used to support unit transformation such as milliseconds to seconds. The unit must be
3881
3881
  * supported by <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">CW metric</a>. Default to null.</p>
3882
3882
  */
3883
- unit?: FleetMetricUnit | string;
3883
+ unit?: FleetMetricUnit;
3884
3884
  /**
3885
3885
  * @public
3886
3886
  * <p>Metadata, which can be used to manage the fleet metric.</p>
@@ -3949,7 +3949,7 @@ export interface RetryCriteria {
3949
3949
  * @public
3950
3950
  * <p>The type of job execution failures that can initiate a job retry.</p>
3951
3951
  */
3952
- failureType: RetryableFailureType | string | undefined;
3952
+ failureType: RetryableFailureType | undefined;
3953
3953
  /**
3954
3954
  * @public
3955
3955
  * <p>The number of retries allowed for a failure type for the job.</p>
@@ -4113,7 +4113,7 @@ export interface SchedulingConfig {
4113
4113
  * <code>endTime</code>. If <code>endTime</code> is not selected when creating the job,
4114
4114
  * then <code>endBehavior</code> does not apply.</p>
4115
4115
  */
4116
- endBehavior?: JobEndBehavior | string;
4116
+ endBehavior?: JobEndBehavior;
4117
4117
  /**
4118
4118
  * @public
4119
4119
  * <p>An optional configuration within the <code>SchedulingConfig</code> to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.</p>
@@ -4200,7 +4200,7 @@ export interface CreateJobRequest {
4200
4200
  * been created.</p>
4201
4201
  * </note>
4202
4202
  */
4203
- targetSelection?: TargetSelection | string;
4203
+ targetSelection?: TargetSelection;
4204
4204
  /**
4205
4205
  * @public
4206
4206
  * <p>Allows you to create a staged rollout of the job.</p>
@@ -4490,7 +4490,7 @@ export interface EnableIoTLoggingParams {
4490
4490
  * @public
4491
4491
  * <p>Specifies the type of information to be logged.</p>
4492
4492
  */
4493
- logLevel: LogLevel | string | undefined;
4493
+ logLevel: LogLevel | undefined;
4494
4494
  }
4495
4495
  /**
4496
4496
  * @public
@@ -4523,7 +4523,7 @@ export interface ReplaceDefaultPolicyVersionParams {
4523
4523
  * @public
4524
4524
  * <p>The name of the template to be applied. The only supported value is <code>BLANK_POLICY</code>.</p>
4525
4525
  */
4526
- templateName: PolicyTemplateName | string | undefined;
4526
+ templateName: PolicyTemplateName | undefined;
4527
4527
  }
4528
4528
  /**
4529
4529
  * @public
@@ -4545,7 +4545,7 @@ export interface UpdateCACertificateParams {
4545
4545
  * @public
4546
4546
  * <p>The action that you want to apply to the CA certificate. The only supported value is <code>DEACTIVATE</code>.</p>
4547
4547
  */
4548
- action: CACertificateUpdateAction | string | undefined;
4548
+ action: CACertificateUpdateAction | undefined;
4549
4549
  }
4550
4550
  /**
4551
4551
  * @public
@@ -4567,7 +4567,7 @@ export interface UpdateDeviceCertificateParams {
4567
4567
  * @public
4568
4568
  * <p>The action that you want to apply to the device certificate. The only supported value is <code>DEACTIVATE</code>.</p>
4569
4569
  */
4570
- action: DeviceCertificateUpdateAction | string | undefined;
4570
+ action: DeviceCertificateUpdateAction | undefined;
4571
4571
  }
4572
4572
  /**
4573
4573
  * @public
@@ -4679,12 +4679,12 @@ export interface AwsJobAbortCriteria {
4679
4679
  * @public
4680
4680
  * <p>The type of job execution failures that can initiate a job abort.</p>
4681
4681
  */
4682
- failureType: AwsJobAbortCriteriaFailureType | string | undefined;
4682
+ failureType: AwsJobAbortCriteriaFailureType | undefined;
4683
4683
  /**
4684
4684
  * @public
4685
4685
  * <p>The type of job action to take to initiate the job abort.</p>
4686
4686
  */
4687
- action: AwsJobAbortCriteriaAbortAction | string | undefined;
4687
+ action: AwsJobAbortCriteriaAbortAction | undefined;
4688
4688
  /**
4689
4689
  * @public
4690
4690
  * <p>The minimum percentage of job execution failures that must occur to initiate the job abort.</p>
@@ -5069,7 +5069,7 @@ export interface CreateOTAUpdateRequest {
5069
5069
  * <p>The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both
5070
5070
  * HTTP and MQTT are specified, the target device can choose the protocol.</p>
5071
5071
  */
5072
- protocols?: (Protocol | string)[];
5072
+ protocols?: Protocol[];
5073
5073
  /**
5074
5074
  * @public
5075
5075
  * <p>Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things
@@ -5078,7 +5078,7 @@ export interface CreateOTAUpdateRequest {
5078
5078
  * added to a target group, even after the update was completed by all things originally in the group. Valid
5079
5079
  * values: CONTINUOUS | SNAPSHOT.</p>
5080
5080
  */
5081
- targetSelection?: TargetSelection | string;
5081
+ targetSelection?: TargetSelection;
5082
5082
  /**
5083
5083
  * @public
5084
5084
  * <p>Configuration for the rollout of OTA updates.</p>
@@ -5169,7 +5169,7 @@ export interface CreateOTAUpdateResponse {
5169
5169
  * @public
5170
5170
  * <p>The OTA update status.</p>
5171
5171
  */
5172
- otaUpdateStatus?: OTAUpdateStatus | string;
5172
+ otaUpdateStatus?: OTAUpdateStatus;
5173
5173
  }
5174
5174
  /**
5175
5175
  * @public
@@ -5337,7 +5337,7 @@ export interface CreatePackageVersionResponse {
5337
5337
  * @public
5338
5338
  * <p>The status of the package version. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
5339
5339
  */
5340
- status?: PackageVersionStatus | string;
5340
+ status?: PackageVersionStatus;
5341
5341
  /**
5342
5342
  * @public
5343
5343
  * <p>Error reason for a package version failure during creation or update.</p>
@@ -5597,7 +5597,7 @@ export interface CreateProvisioningTemplateRequest {
5597
5597
  * For more information about provisioning template, see: <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html">Provisioning template</a>.
5598
5598
  * </p>
5599
5599
  */
5600
- type?: TemplateType | string;
5600
+ type?: TemplateType;
5601
5601
  }
5602
5602
  /**
5603
5603
  * @public
@@ -5744,7 +5744,7 @@ export interface CreateScheduledAuditRequest {
5744
5744
  * <code>WEEKLY</code>, <code>BIWEEKLY</code> or <code>MONTHLY</code>. The start time of each audit is
5745
5745
  * determined by the system.</p>
5746
5746
  */
5747
- frequency: AuditFrequency | string | undefined;
5747
+ frequency: AuditFrequency | undefined;
5748
5748
  /**
5749
5749
  * @public
5750
5750
  * <p>The day of the month on which the scheduled audit takes place.
@@ -5766,7 +5766,7 @@ export interface CreateScheduledAuditRequest {
5766
5766
  * <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>. This field is required if the <code>frequency</code>
5767
5767
  * parameter is set to <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p>
5768
5768
  */
5769
- dayOfWeek?: DayOfWeek | string;
5769
+ dayOfWeek?: DayOfWeek;
5770
5770
  /**
5771
5771
  * @public
5772
5772
  * <p>Which checks are performed during the scheduled audit. Checks must be enabled
@@ -5820,7 +5820,7 @@ export interface CreateSecurityProfileRequest {
5820
5820
  * <p>Specifies the destinations to which alerts are sent. (Alerts are always sent to the
5821
5821
  * console.) Alerts are generated when a device (thing) violates a behavior.</p>
5822
5822
  */
5823
- alertTargets?: Record<string, AlertTarget>;
5823
+ alertTargets?: Record<AlertTargetType, AlertTarget>;
5824
5824
  /**
5825
5825
  * @public
5826
5826
  * @deprecated
@@ -6327,7 +6327,7 @@ export interface TopicRuleDestination {
6327
6327
  * </dd>
6328
6328
  * </dl>
6329
6329
  */
6330
- status?: TopicRuleDestinationStatus | string;
6330
+ status?: TopicRuleDestinationStatus;
6331
6331
  /**
6332
6332
  * @public
6333
6333
  * <p>The date and time when the topic rule destination was created.</p>