@aws-sdk/client-iot 3.687.0 → 3.691.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.
- package/dist-types/models/models_0.d.ts +529 -529
- package/dist-types/models/models_1.d.ts +685 -685
- package/dist-types/models/models_2.d.ts +498 -498
- package/dist-types/ts3.4/models/models_0.d.ts +531 -529
- package/dist-types/ts3.4/models/models_1.d.ts +689 -687
- package/dist-types/ts3.4/models/models_2.d.ts +502 -500
- package/package.json +7 -7
|
@@ -17,7 +17,7 @@ export interface DeleteBillingGroupRequest {
|
|
|
17
17
|
* <code>VersionConflictException</code>.</p>
|
|
18
18
|
* @public
|
|
19
19
|
*/
|
|
20
|
-
expectedVersion?: number;
|
|
20
|
+
expectedVersion?: number | undefined;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
23
|
* @public
|
|
@@ -70,7 +70,7 @@ export interface DeleteCertificateRequest {
|
|
|
70
70
|
* thing.</p>
|
|
71
71
|
* @public
|
|
72
72
|
*/
|
|
73
|
-
forceDelete?: boolean;
|
|
73
|
+
forceDelete?: boolean | undefined;
|
|
74
74
|
}
|
|
75
75
|
/**
|
|
76
76
|
* @public
|
|
@@ -147,7 +147,7 @@ export interface DeleteDynamicThingGroupRequest {
|
|
|
147
147
|
* <p>The expected version of the dynamic thing group to delete.</p>
|
|
148
148
|
* @public
|
|
149
149
|
*/
|
|
150
|
-
expectedVersion?: number;
|
|
150
|
+
expectedVersion?: number | undefined;
|
|
151
151
|
}
|
|
152
152
|
/**
|
|
153
153
|
* @public
|
|
@@ -167,7 +167,7 @@ export interface DeleteFleetMetricRequest {
|
|
|
167
167
|
* <p>The expected version of the fleet metric to delete.</p>
|
|
168
168
|
* @public
|
|
169
169
|
*/
|
|
170
|
-
expectedVersion?: number;
|
|
170
|
+
expectedVersion?: number | undefined;
|
|
171
171
|
}
|
|
172
172
|
/**
|
|
173
173
|
* @public
|
|
@@ -193,7 +193,7 @@ export interface DeleteJobRequest {
|
|
|
193
193
|
* </note>
|
|
194
194
|
* @public
|
|
195
195
|
*/
|
|
196
|
-
force?: boolean;
|
|
196
|
+
force?: boolean | undefined;
|
|
197
197
|
/**
|
|
198
198
|
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
199
199
|
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
|
|
@@ -209,7 +209,7 @@ export interface DeleteJobRequest {
|
|
|
209
209
|
* </note>
|
|
210
210
|
* @public
|
|
211
211
|
*/
|
|
212
|
-
namespaceId?: string;
|
|
212
|
+
namespaceId?: string | undefined;
|
|
213
213
|
}
|
|
214
214
|
/**
|
|
215
215
|
* @public
|
|
@@ -244,7 +244,7 @@ export interface DeleteJobExecutionRequest {
|
|
|
244
244
|
* </note>
|
|
245
245
|
* @public
|
|
246
246
|
*/
|
|
247
|
-
force?: boolean;
|
|
247
|
+
force?: boolean | undefined;
|
|
248
248
|
/**
|
|
249
249
|
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
250
250
|
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
|
|
@@ -260,7 +260,7 @@ export interface DeleteJobExecutionRequest {
|
|
|
260
260
|
* </note>
|
|
261
261
|
* @public
|
|
262
262
|
*/
|
|
263
|
-
namespaceId?: string;
|
|
263
|
+
namespaceId?: string | undefined;
|
|
264
264
|
}
|
|
265
265
|
/**
|
|
266
266
|
* @public
|
|
@@ -301,13 +301,13 @@ export interface DeleteOTAUpdateRequest {
|
|
|
301
301
|
* Ignored if the stream specified in the OTAUpdate is supplied by the user.</p>
|
|
302
302
|
* @public
|
|
303
303
|
*/
|
|
304
|
-
deleteStream?: boolean;
|
|
304
|
+
deleteStream?: boolean | undefined;
|
|
305
305
|
/**
|
|
306
306
|
* <p>When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the
|
|
307
307
|
* job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.</p>
|
|
308
308
|
* @public
|
|
309
309
|
*/
|
|
310
|
-
forceDeleteAWSJob?: boolean;
|
|
310
|
+
forceDeleteAWSJob?: boolean | undefined;
|
|
311
311
|
}
|
|
312
312
|
/**
|
|
313
313
|
* @public
|
|
@@ -328,7 +328,7 @@ export interface DeletePackageRequest {
|
|
|
328
328
|
* Don't reuse this client token if a new idempotent request is required.</p>
|
|
329
329
|
* @public
|
|
330
330
|
*/
|
|
331
|
-
clientToken?: string;
|
|
331
|
+
clientToken?: string | undefined;
|
|
332
332
|
}
|
|
333
333
|
/**
|
|
334
334
|
* @public
|
|
@@ -354,7 +354,7 @@ export interface DeletePackageVersionRequest {
|
|
|
354
354
|
* Don't reuse this client token if a new idempotent request is required.</p>
|
|
355
355
|
* @public
|
|
356
356
|
*/
|
|
357
|
-
clientToken?: string;
|
|
357
|
+
clientToken?: string | undefined;
|
|
358
358
|
}
|
|
359
359
|
/**
|
|
360
360
|
* @public
|
|
@@ -480,7 +480,7 @@ export interface DeleteSecurityProfileRequest {
|
|
|
480
480
|
* version, a <code>VersionConflictException</code> is thrown.</p>
|
|
481
481
|
* @public
|
|
482
482
|
*/
|
|
483
|
-
expectedVersion?: number;
|
|
483
|
+
expectedVersion?: number | undefined;
|
|
484
484
|
}
|
|
485
485
|
/**
|
|
486
486
|
* @public
|
|
@@ -519,7 +519,7 @@ export interface DeleteThingRequest {
|
|
|
519
519
|
* <code>VersionConflictException</code>.</p>
|
|
520
520
|
* @public
|
|
521
521
|
*/
|
|
522
|
-
expectedVersion?: number;
|
|
522
|
+
expectedVersion?: number | undefined;
|
|
523
523
|
}
|
|
524
524
|
/**
|
|
525
525
|
* <p>The output of the DeleteThing operation.</p>
|
|
@@ -540,7 +540,7 @@ export interface DeleteThingGroupRequest {
|
|
|
540
540
|
* <p>The expected version of the thing group to delete.</p>
|
|
541
541
|
* @public
|
|
542
542
|
*/
|
|
543
|
-
expectedVersion?: number;
|
|
543
|
+
expectedVersion?: number | undefined;
|
|
544
544
|
}
|
|
545
545
|
/**
|
|
546
546
|
* @public
|
|
@@ -636,7 +636,7 @@ export interface DeprecateThingTypeRequest {
|
|
|
636
636
|
* associate it with things.</p>
|
|
637
637
|
* @public
|
|
638
638
|
*/
|
|
639
|
-
undoDeprecate?: boolean;
|
|
639
|
+
undoDeprecate?: boolean | undefined;
|
|
640
640
|
}
|
|
641
641
|
/**
|
|
642
642
|
* <p>The output for the DeprecateThingType operation.</p>
|
|
@@ -661,18 +661,18 @@ export interface DescribeAccountAuditConfigurationResponse {
|
|
|
661
661
|
* this parameter is required.</p>
|
|
662
662
|
* @public
|
|
663
663
|
*/
|
|
664
|
-
roleArn?: string;
|
|
664
|
+
roleArn?: string | undefined;
|
|
665
665
|
/**
|
|
666
666
|
* <p>Information about the targets to which audit notifications are sent for
|
|
667
667
|
* this account.</p>
|
|
668
668
|
* @public
|
|
669
669
|
*/
|
|
670
|
-
auditNotificationTargetConfigurations?: Partial<Record<AuditNotificationType, AuditNotificationTarget
|
|
670
|
+
auditNotificationTargetConfigurations?: Partial<Record<AuditNotificationType, AuditNotificationTarget>> | undefined;
|
|
671
671
|
/**
|
|
672
672
|
* <p>Which audit checks are enabled and disabled for this account.</p>
|
|
673
673
|
* @public
|
|
674
674
|
*/
|
|
675
|
-
auditCheckConfigurations?: Record<string, AuditCheckConfiguration
|
|
675
|
+
auditCheckConfigurations?: Record<string, AuditCheckConfiguration> | undefined;
|
|
676
676
|
}
|
|
677
677
|
/**
|
|
678
678
|
* @public
|
|
@@ -692,7 +692,7 @@ export interface DescribeAuditFindingResponse {
|
|
|
692
692
|
* <p>The findings (results) of the audit.</p>
|
|
693
693
|
* @public
|
|
694
694
|
*/
|
|
695
|
-
finding?: AuditFinding;
|
|
695
|
+
finding?: AuditFinding | undefined;
|
|
696
696
|
}
|
|
697
697
|
/**
|
|
698
698
|
* @public
|
|
@@ -713,22 +713,22 @@ export interface MitigationAction {
|
|
|
713
713
|
* <p>A user-friendly name for the mitigation action.</p>
|
|
714
714
|
* @public
|
|
715
715
|
*/
|
|
716
|
-
name?: string;
|
|
716
|
+
name?: string | undefined;
|
|
717
717
|
/**
|
|
718
718
|
* <p>A unique identifier for the mitigation action.</p>
|
|
719
719
|
* @public
|
|
720
720
|
*/
|
|
721
|
-
id?: string;
|
|
721
|
+
id?: string | undefined;
|
|
722
722
|
/**
|
|
723
723
|
* <p>The IAM role ARN used to apply this mitigation action.</p>
|
|
724
724
|
* @public
|
|
725
725
|
*/
|
|
726
|
-
roleArn?: string;
|
|
726
|
+
roleArn?: string | undefined;
|
|
727
727
|
/**
|
|
728
728
|
* <p>The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.</p>
|
|
729
729
|
* @public
|
|
730
730
|
*/
|
|
731
|
-
actionParams?: MitigationActionParams;
|
|
731
|
+
actionParams?: MitigationActionParams | undefined;
|
|
732
732
|
}
|
|
733
733
|
/**
|
|
734
734
|
* @public
|
|
@@ -738,37 +738,37 @@ export interface DescribeAuditMitigationActionsTaskResponse {
|
|
|
738
738
|
* <p>The current status of the task.</p>
|
|
739
739
|
* @public
|
|
740
740
|
*/
|
|
741
|
-
taskStatus?: AuditMitigationActionsTaskStatus;
|
|
741
|
+
taskStatus?: AuditMitigationActionsTaskStatus | undefined;
|
|
742
742
|
/**
|
|
743
743
|
* <p>The date and time when the task was started.</p>
|
|
744
744
|
* @public
|
|
745
745
|
*/
|
|
746
|
-
startTime?: Date;
|
|
746
|
+
startTime?: Date | undefined;
|
|
747
747
|
/**
|
|
748
748
|
* <p>The date and time when the task was completed or canceled.</p>
|
|
749
749
|
* @public
|
|
750
750
|
*/
|
|
751
|
-
endTime?: Date;
|
|
751
|
+
endTime?: Date | undefined;
|
|
752
752
|
/**
|
|
753
753
|
* <p>Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.</p>
|
|
754
754
|
* @public
|
|
755
755
|
*/
|
|
756
|
-
taskStatistics?: Record<string, TaskStatisticsForAuditCheck
|
|
756
|
+
taskStatistics?: Record<string, TaskStatisticsForAuditCheck> | undefined;
|
|
757
757
|
/**
|
|
758
758
|
* <p>Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.</p>
|
|
759
759
|
* @public
|
|
760
760
|
*/
|
|
761
|
-
target?: AuditMitigationActionsTaskTarget;
|
|
761
|
+
target?: AuditMitigationActionsTaskTarget | undefined;
|
|
762
762
|
/**
|
|
763
763
|
* <p>Specifies the mitigation actions that should be applied to specific audit checks.</p>
|
|
764
764
|
* @public
|
|
765
765
|
*/
|
|
766
|
-
auditCheckToActionsMapping?: Record<string, string[]
|
|
766
|
+
auditCheckToActionsMapping?: Record<string, string[]> | undefined;
|
|
767
767
|
/**
|
|
768
768
|
* <p>Specifies the mitigation actions and their parameters that are applied as part of this task.</p>
|
|
769
769
|
* @public
|
|
770
770
|
*/
|
|
771
|
-
actionsDefinition?: MitigationAction[];
|
|
771
|
+
actionsDefinition?: MitigationAction[] | undefined;
|
|
772
772
|
}
|
|
773
773
|
/**
|
|
774
774
|
* @public
|
|
@@ -799,33 +799,33 @@ export interface DescribeAuditSuppressionResponse {
|
|
|
799
799
|
* to select which checks are enabled.)</p>
|
|
800
800
|
* @public
|
|
801
801
|
*/
|
|
802
|
-
checkName?: string;
|
|
802
|
+
checkName?: string | undefined;
|
|
803
803
|
/**
|
|
804
804
|
* <p>Information that identifies the noncompliant resource.</p>
|
|
805
805
|
* @public
|
|
806
806
|
*/
|
|
807
|
-
resourceIdentifier?: ResourceIdentifier;
|
|
807
|
+
resourceIdentifier?: ResourceIdentifier | undefined;
|
|
808
808
|
/**
|
|
809
809
|
* <p>
|
|
810
810
|
* The epoch timestamp in seconds at which this suppression expires.
|
|
811
811
|
* </p>
|
|
812
812
|
* @public
|
|
813
813
|
*/
|
|
814
|
-
expirationDate?: Date;
|
|
814
|
+
expirationDate?: Date | undefined;
|
|
815
815
|
/**
|
|
816
816
|
* <p>
|
|
817
817
|
* Indicates whether a suppression should exist indefinitely or not.
|
|
818
818
|
* </p>
|
|
819
819
|
* @public
|
|
820
820
|
*/
|
|
821
|
-
suppressIndefinitely?: boolean;
|
|
821
|
+
suppressIndefinitely?: boolean | undefined;
|
|
822
822
|
/**
|
|
823
823
|
* <p>
|
|
824
824
|
* The description of the audit suppression.
|
|
825
825
|
* </p>
|
|
826
826
|
* @public
|
|
827
827
|
*/
|
|
828
|
-
description?: string;
|
|
828
|
+
description?: string | undefined;
|
|
829
829
|
}
|
|
830
830
|
/**
|
|
831
831
|
* @public
|
|
@@ -846,37 +846,37 @@ export interface TaskStatistics {
|
|
|
846
846
|
* <p>The number of checks in this audit.</p>
|
|
847
847
|
* @public
|
|
848
848
|
*/
|
|
849
|
-
totalChecks?: number;
|
|
849
|
+
totalChecks?: number | undefined;
|
|
850
850
|
/**
|
|
851
851
|
* <p>The number of checks in progress.</p>
|
|
852
852
|
* @public
|
|
853
853
|
*/
|
|
854
|
-
inProgressChecks?: number;
|
|
854
|
+
inProgressChecks?: number | undefined;
|
|
855
855
|
/**
|
|
856
856
|
* <p>The number of checks waiting for data collection.</p>
|
|
857
857
|
* @public
|
|
858
858
|
*/
|
|
859
|
-
waitingForDataCollectionChecks?: number;
|
|
859
|
+
waitingForDataCollectionChecks?: number | undefined;
|
|
860
860
|
/**
|
|
861
861
|
* <p>The number of checks that found compliant resources.</p>
|
|
862
862
|
* @public
|
|
863
863
|
*/
|
|
864
|
-
compliantChecks?: number;
|
|
864
|
+
compliantChecks?: number | undefined;
|
|
865
865
|
/**
|
|
866
866
|
* <p>The number of checks that found noncompliant resources.</p>
|
|
867
867
|
* @public
|
|
868
868
|
*/
|
|
869
|
-
nonCompliantChecks?: number;
|
|
869
|
+
nonCompliantChecks?: number | undefined;
|
|
870
870
|
/**
|
|
871
871
|
* <p>The number of checks.</p>
|
|
872
872
|
* @public
|
|
873
873
|
*/
|
|
874
|
-
failedChecks?: number;
|
|
874
|
+
failedChecks?: number | undefined;
|
|
875
875
|
/**
|
|
876
876
|
* <p>The number of checks that did not run because the audit was canceled.</p>
|
|
877
877
|
* @public
|
|
878
878
|
*/
|
|
879
|
-
canceledChecks?: number;
|
|
879
|
+
canceledChecks?: number | undefined;
|
|
880
880
|
}
|
|
881
881
|
/**
|
|
882
882
|
* @public
|
|
@@ -887,32 +887,32 @@ export interface DescribeAuditTaskResponse {
|
|
|
887
887
|
* "FAILED", or "CANCELED".</p>
|
|
888
888
|
* @public
|
|
889
889
|
*/
|
|
890
|
-
taskStatus?: AuditTaskStatus;
|
|
890
|
+
taskStatus?: AuditTaskStatus | undefined;
|
|
891
891
|
/**
|
|
892
892
|
* <p>The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".</p>
|
|
893
893
|
* @public
|
|
894
894
|
*/
|
|
895
|
-
taskType?: AuditTaskType;
|
|
895
|
+
taskType?: AuditTaskType | undefined;
|
|
896
896
|
/**
|
|
897
897
|
* <p>The time the audit started.</p>
|
|
898
898
|
* @public
|
|
899
899
|
*/
|
|
900
|
-
taskStartTime?: Date;
|
|
900
|
+
taskStartTime?: Date | undefined;
|
|
901
901
|
/**
|
|
902
902
|
* <p>Statistical information about the audit.</p>
|
|
903
903
|
* @public
|
|
904
904
|
*/
|
|
905
|
-
taskStatistics?: TaskStatistics;
|
|
905
|
+
taskStatistics?: TaskStatistics | undefined;
|
|
906
906
|
/**
|
|
907
907
|
* <p>The name of the scheduled audit (only if the audit was a scheduled audit).</p>
|
|
908
908
|
* @public
|
|
909
909
|
*/
|
|
910
|
-
scheduledAuditName?: string;
|
|
910
|
+
scheduledAuditName?: string | undefined;
|
|
911
911
|
/**
|
|
912
912
|
* <p>Detailed information about each check performed during this audit.</p>
|
|
913
913
|
* @public
|
|
914
914
|
*/
|
|
915
|
-
auditDetails?: Record<string, AuditCheckDetails
|
|
915
|
+
auditDetails?: Record<string, AuditCheckDetails> | undefined;
|
|
916
916
|
}
|
|
917
917
|
/**
|
|
918
918
|
* @public
|
|
@@ -932,7 +932,7 @@ export interface DescribeAuthorizerResponse {
|
|
|
932
932
|
* <p>The authorizer description.</p>
|
|
933
933
|
* @public
|
|
934
934
|
*/
|
|
935
|
-
authorizerDescription?: AuthorizerDescription;
|
|
935
|
+
authorizerDescription?: AuthorizerDescription | undefined;
|
|
936
936
|
}
|
|
937
937
|
/**
|
|
938
938
|
* @public
|
|
@@ -953,7 +953,7 @@ export interface BillingGroupMetadata {
|
|
|
953
953
|
* <p>The date the billing group was created.</p>
|
|
954
954
|
* @public
|
|
955
955
|
*/
|
|
956
|
-
creationDate?: Date;
|
|
956
|
+
creationDate?: Date | undefined;
|
|
957
957
|
}
|
|
958
958
|
/**
|
|
959
959
|
* @public
|
|
@@ -963,32 +963,32 @@ export interface DescribeBillingGroupResponse {
|
|
|
963
963
|
* <p>The name of the billing group.</p>
|
|
964
964
|
* @public
|
|
965
965
|
*/
|
|
966
|
-
billingGroupName?: string;
|
|
966
|
+
billingGroupName?: string | undefined;
|
|
967
967
|
/**
|
|
968
968
|
* <p>The ID of the billing group.</p>
|
|
969
969
|
* @public
|
|
970
970
|
*/
|
|
971
|
-
billingGroupId?: string;
|
|
971
|
+
billingGroupId?: string | undefined;
|
|
972
972
|
/**
|
|
973
973
|
* <p>The ARN of the billing group.</p>
|
|
974
974
|
* @public
|
|
975
975
|
*/
|
|
976
|
-
billingGroupArn?: string;
|
|
976
|
+
billingGroupArn?: string | undefined;
|
|
977
977
|
/**
|
|
978
978
|
* <p>The version of the billing group.</p>
|
|
979
979
|
* @public
|
|
980
980
|
*/
|
|
981
|
-
version?: number;
|
|
981
|
+
version?: number | undefined;
|
|
982
982
|
/**
|
|
983
983
|
* <p>The properties of the billing group.</p>
|
|
984
984
|
* @public
|
|
985
985
|
*/
|
|
986
|
-
billingGroupProperties?: BillingGroupProperties;
|
|
986
|
+
billingGroupProperties?: BillingGroupProperties | undefined;
|
|
987
987
|
/**
|
|
988
988
|
* <p>Additional information about the billing group.</p>
|
|
989
989
|
* @public
|
|
990
990
|
*/
|
|
991
|
-
billingGroupMetadata?: BillingGroupMetadata;
|
|
991
|
+
billingGroupMetadata?: BillingGroupMetadata | undefined;
|
|
992
992
|
}
|
|
993
993
|
/**
|
|
994
994
|
* <p>The input for the DescribeCACertificate operation.</p>
|
|
@@ -1034,12 +1034,12 @@ export interface CertificateValidity {
|
|
|
1034
1034
|
* <p>The certificate is not valid before this date.</p>
|
|
1035
1035
|
* @public
|
|
1036
1036
|
*/
|
|
1037
|
-
notBefore?: Date;
|
|
1037
|
+
notBefore?: Date | undefined;
|
|
1038
1038
|
/**
|
|
1039
1039
|
* <p>The certificate is not valid after this date.</p>
|
|
1040
1040
|
* @public
|
|
1041
1041
|
*/
|
|
1042
|
-
notAfter?: Date;
|
|
1042
|
+
notAfter?: Date | undefined;
|
|
1043
1043
|
}
|
|
1044
1044
|
/**
|
|
1045
1045
|
* <p>Describes a CA certificate.</p>
|
|
@@ -1050,65 +1050,65 @@ export interface CACertificateDescription {
|
|
|
1050
1050
|
* <p>The CA certificate ARN.</p>
|
|
1051
1051
|
* @public
|
|
1052
1052
|
*/
|
|
1053
|
-
certificateArn?: string;
|
|
1053
|
+
certificateArn?: string | undefined;
|
|
1054
1054
|
/**
|
|
1055
1055
|
* <p>The CA certificate ID.</p>
|
|
1056
1056
|
* @public
|
|
1057
1057
|
*/
|
|
1058
|
-
certificateId?: string;
|
|
1058
|
+
certificateId?: string | undefined;
|
|
1059
1059
|
/**
|
|
1060
1060
|
* <p>The status of a CA certificate.</p>
|
|
1061
1061
|
* @public
|
|
1062
1062
|
*/
|
|
1063
|
-
status?: CACertificateStatus;
|
|
1063
|
+
status?: CACertificateStatus | undefined;
|
|
1064
1064
|
/**
|
|
1065
1065
|
* <p>The CA certificate data, in PEM format.</p>
|
|
1066
1066
|
* @public
|
|
1067
1067
|
*/
|
|
1068
|
-
certificatePem?: string;
|
|
1068
|
+
certificatePem?: string | undefined;
|
|
1069
1069
|
/**
|
|
1070
1070
|
* <p>The owner of the CA certificate.</p>
|
|
1071
1071
|
* @public
|
|
1072
1072
|
*/
|
|
1073
|
-
ownedBy?: string;
|
|
1073
|
+
ownedBy?: string | undefined;
|
|
1074
1074
|
/**
|
|
1075
1075
|
* <p>The date the CA certificate was created.</p>
|
|
1076
1076
|
* @public
|
|
1077
1077
|
*/
|
|
1078
|
-
creationDate?: Date;
|
|
1078
|
+
creationDate?: Date | undefined;
|
|
1079
1079
|
/**
|
|
1080
1080
|
* <p>Whether the CA certificate configured for auto registration of device certificates.
|
|
1081
1081
|
* Valid values are "ENABLE" and "DISABLE"</p>
|
|
1082
1082
|
* @public
|
|
1083
1083
|
*/
|
|
1084
|
-
autoRegistrationStatus?: AutoRegistrationStatus;
|
|
1084
|
+
autoRegistrationStatus?: AutoRegistrationStatus | undefined;
|
|
1085
1085
|
/**
|
|
1086
1086
|
* <p>The date the CA certificate was last modified.</p>
|
|
1087
1087
|
* @public
|
|
1088
1088
|
*/
|
|
1089
|
-
lastModifiedDate?: Date;
|
|
1089
|
+
lastModifiedDate?: Date | undefined;
|
|
1090
1090
|
/**
|
|
1091
1091
|
* <p>The customer version of the CA certificate.</p>
|
|
1092
1092
|
* @public
|
|
1093
1093
|
*/
|
|
1094
|
-
customerVersion?: number;
|
|
1094
|
+
customerVersion?: number | undefined;
|
|
1095
1095
|
/**
|
|
1096
1096
|
* <p>The generation ID of the CA certificate.</p>
|
|
1097
1097
|
* @public
|
|
1098
1098
|
*/
|
|
1099
|
-
generationId?: string;
|
|
1099
|
+
generationId?: string | undefined;
|
|
1100
1100
|
/**
|
|
1101
1101
|
* <p>When the CA certificate is valid.</p>
|
|
1102
1102
|
* @public
|
|
1103
1103
|
*/
|
|
1104
|
-
validity?: CertificateValidity;
|
|
1104
|
+
validity?: CertificateValidity | undefined;
|
|
1105
1105
|
/**
|
|
1106
1106
|
* <p>The mode of the CA. </p>
|
|
1107
1107
|
* <p>All the device certificates that are registered using this CA will be registered
|
|
1108
1108
|
* in the same mode as the CA. For more information about certificate mode for device certificates, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode">certificate mode</a>.</p>
|
|
1109
1109
|
* @public
|
|
1110
1110
|
*/
|
|
1111
|
-
certificateMode?: CertificateMode;
|
|
1111
|
+
certificateMode?: CertificateMode | undefined;
|
|
1112
1112
|
}
|
|
1113
1113
|
/**
|
|
1114
1114
|
* <p>The registration configuration.</p>
|
|
@@ -1119,17 +1119,17 @@ export interface RegistrationConfig {
|
|
|
1119
1119
|
* <p>The template body.</p>
|
|
1120
1120
|
* @public
|
|
1121
1121
|
*/
|
|
1122
|
-
templateBody?: string;
|
|
1122
|
+
templateBody?: string | undefined;
|
|
1123
1123
|
/**
|
|
1124
1124
|
* <p>The ARN of the role.</p>
|
|
1125
1125
|
* @public
|
|
1126
1126
|
*/
|
|
1127
|
-
roleArn?: string;
|
|
1127
|
+
roleArn?: string | undefined;
|
|
1128
1128
|
/**
|
|
1129
1129
|
* <p>The name of the provisioning template.</p>
|
|
1130
1130
|
* @public
|
|
1131
1131
|
*/
|
|
1132
|
-
templateName?: string;
|
|
1132
|
+
templateName?: string | undefined;
|
|
1133
1133
|
}
|
|
1134
1134
|
/**
|
|
1135
1135
|
* <p>The output from the DescribeCACertificate operation.</p>
|
|
@@ -1140,12 +1140,12 @@ export interface DescribeCACertificateResponse {
|
|
|
1140
1140
|
* <p>The CA certificate description.</p>
|
|
1141
1141
|
* @public
|
|
1142
1142
|
*/
|
|
1143
|
-
certificateDescription?: CACertificateDescription;
|
|
1143
|
+
certificateDescription?: CACertificateDescription | undefined;
|
|
1144
1144
|
/**
|
|
1145
1145
|
* <p>Information about the registration configuration.</p>
|
|
1146
1146
|
* @public
|
|
1147
1147
|
*/
|
|
1148
|
-
registrationConfig?: RegistrationConfig;
|
|
1148
|
+
registrationConfig?: RegistrationConfig | undefined;
|
|
1149
1149
|
}
|
|
1150
1150
|
/**
|
|
1151
1151
|
* <p>The input for the DescribeCertificate operation.</p>
|
|
@@ -1184,27 +1184,27 @@ export interface TransferData {
|
|
|
1184
1184
|
* <p>The transfer message.</p>
|
|
1185
1185
|
* @public
|
|
1186
1186
|
*/
|
|
1187
|
-
transferMessage?: string;
|
|
1187
|
+
transferMessage?: string | undefined;
|
|
1188
1188
|
/**
|
|
1189
1189
|
* <p>The reason why the transfer was rejected.</p>
|
|
1190
1190
|
* @public
|
|
1191
1191
|
*/
|
|
1192
|
-
rejectReason?: string;
|
|
1192
|
+
rejectReason?: string | undefined;
|
|
1193
1193
|
/**
|
|
1194
1194
|
* <p>The date the transfer took place.</p>
|
|
1195
1195
|
* @public
|
|
1196
1196
|
*/
|
|
1197
|
-
transferDate?: Date;
|
|
1197
|
+
transferDate?: Date | undefined;
|
|
1198
1198
|
/**
|
|
1199
1199
|
* <p>The date the transfer was accepted.</p>
|
|
1200
1200
|
* @public
|
|
1201
1201
|
*/
|
|
1202
|
-
acceptDate?: Date;
|
|
1202
|
+
acceptDate?: Date | undefined;
|
|
1203
1203
|
/**
|
|
1204
1204
|
* <p>The date the transfer was rejected.</p>
|
|
1205
1205
|
* @public
|
|
1206
1206
|
*/
|
|
1207
|
-
rejectDate?: Date;
|
|
1207
|
+
rejectDate?: Date | undefined;
|
|
1208
1208
|
}
|
|
1209
1209
|
/**
|
|
1210
1210
|
* <p>Describes a certificate.</p>
|
|
@@ -1215,67 +1215,67 @@ export interface CertificateDescription {
|
|
|
1215
1215
|
* <p>The ARN of the certificate.</p>
|
|
1216
1216
|
* @public
|
|
1217
1217
|
*/
|
|
1218
|
-
certificateArn?: string;
|
|
1218
|
+
certificateArn?: string | undefined;
|
|
1219
1219
|
/**
|
|
1220
1220
|
* <p>The ID of the certificate.</p>
|
|
1221
1221
|
* @public
|
|
1222
1222
|
*/
|
|
1223
|
-
certificateId?: string;
|
|
1223
|
+
certificateId?: string | undefined;
|
|
1224
1224
|
/**
|
|
1225
1225
|
* <p>The certificate ID of the CA certificate used to sign this certificate.</p>
|
|
1226
1226
|
* @public
|
|
1227
1227
|
*/
|
|
1228
|
-
caCertificateId?: string;
|
|
1228
|
+
caCertificateId?: string | undefined;
|
|
1229
1229
|
/**
|
|
1230
1230
|
* <p>The status of the certificate.</p>
|
|
1231
1231
|
* @public
|
|
1232
1232
|
*/
|
|
1233
|
-
status?: CertificateStatus;
|
|
1233
|
+
status?: CertificateStatus | undefined;
|
|
1234
1234
|
/**
|
|
1235
1235
|
* <p>The certificate data, in PEM format.</p>
|
|
1236
1236
|
* @public
|
|
1237
1237
|
*/
|
|
1238
|
-
certificatePem?: string;
|
|
1238
|
+
certificatePem?: string | undefined;
|
|
1239
1239
|
/**
|
|
1240
1240
|
* <p>The ID of the Amazon Web Services account that owns the certificate.</p>
|
|
1241
1241
|
* @public
|
|
1242
1242
|
*/
|
|
1243
|
-
ownedBy?: string;
|
|
1243
|
+
ownedBy?: string | undefined;
|
|
1244
1244
|
/**
|
|
1245
1245
|
* <p>The ID of the Amazon Web Services account of the previous owner of the certificate.</p>
|
|
1246
1246
|
* @public
|
|
1247
1247
|
*/
|
|
1248
|
-
previousOwnedBy?: string;
|
|
1248
|
+
previousOwnedBy?: string | undefined;
|
|
1249
1249
|
/**
|
|
1250
1250
|
* <p>The date and time the certificate was created.</p>
|
|
1251
1251
|
* @public
|
|
1252
1252
|
*/
|
|
1253
|
-
creationDate?: Date;
|
|
1253
|
+
creationDate?: Date | undefined;
|
|
1254
1254
|
/**
|
|
1255
1255
|
* <p>The date and time the certificate was last modified.</p>
|
|
1256
1256
|
* @public
|
|
1257
1257
|
*/
|
|
1258
|
-
lastModifiedDate?: Date;
|
|
1258
|
+
lastModifiedDate?: Date | undefined;
|
|
1259
1259
|
/**
|
|
1260
1260
|
* <p>The customer version of the certificate.</p>
|
|
1261
1261
|
* @public
|
|
1262
1262
|
*/
|
|
1263
|
-
customerVersion?: number;
|
|
1263
|
+
customerVersion?: number | undefined;
|
|
1264
1264
|
/**
|
|
1265
1265
|
* <p>The transfer data.</p>
|
|
1266
1266
|
* @public
|
|
1267
1267
|
*/
|
|
1268
|
-
transferData?: TransferData;
|
|
1268
|
+
transferData?: TransferData | undefined;
|
|
1269
1269
|
/**
|
|
1270
1270
|
* <p>The generation ID of the certificate.</p>
|
|
1271
1271
|
* @public
|
|
1272
1272
|
*/
|
|
1273
|
-
generationId?: string;
|
|
1273
|
+
generationId?: string | undefined;
|
|
1274
1274
|
/**
|
|
1275
1275
|
* <p>When the certificate is valid.</p>
|
|
1276
1276
|
* @public
|
|
1277
1277
|
*/
|
|
1278
|
-
validity?: CertificateValidity;
|
|
1278
|
+
validity?: CertificateValidity | undefined;
|
|
1279
1279
|
/**
|
|
1280
1280
|
* <p>The mode of the certificate.</p>
|
|
1281
1281
|
* <p>
|
|
@@ -1291,7 +1291,7 @@ export interface CertificateDescription {
|
|
|
1291
1291
|
* <p>For more information about the value for SNI extension, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html">Transport security in IoT</a>.</p>
|
|
1292
1292
|
* @public
|
|
1293
1293
|
*/
|
|
1294
|
-
certificateMode?: CertificateMode;
|
|
1294
|
+
certificateMode?: CertificateMode | undefined;
|
|
1295
1295
|
}
|
|
1296
1296
|
/**
|
|
1297
1297
|
* <p>The output of the DescribeCertificate operation.</p>
|
|
@@ -1302,7 +1302,7 @@ export interface DescribeCertificateResponse {
|
|
|
1302
1302
|
* <p>The description of the certificate.</p>
|
|
1303
1303
|
* @public
|
|
1304
1304
|
*/
|
|
1305
|
-
certificateDescription?: CertificateDescription;
|
|
1305
|
+
certificateDescription?: CertificateDescription | undefined;
|
|
1306
1306
|
}
|
|
1307
1307
|
/**
|
|
1308
1308
|
* @public
|
|
@@ -1322,33 +1322,33 @@ export interface DescribeCertificateProviderResponse {
|
|
|
1322
1322
|
* <p>The name of the certificate provider.</p>
|
|
1323
1323
|
* @public
|
|
1324
1324
|
*/
|
|
1325
|
-
certificateProviderName?: string;
|
|
1325
|
+
certificateProviderName?: string | undefined;
|
|
1326
1326
|
/**
|
|
1327
1327
|
* <p>The ARN of the certificate provider.</p>
|
|
1328
1328
|
* @public
|
|
1329
1329
|
*/
|
|
1330
|
-
certificateProviderArn?: string;
|
|
1330
|
+
certificateProviderArn?: string | undefined;
|
|
1331
1331
|
/**
|
|
1332
1332
|
* <p>The Lambda function ARN that's associated with the certificate provider.</p>
|
|
1333
1333
|
* @public
|
|
1334
1334
|
*/
|
|
1335
|
-
lambdaFunctionArn?: string;
|
|
1335
|
+
lambdaFunctionArn?: string | undefined;
|
|
1336
1336
|
/**
|
|
1337
1337
|
* <p>A list of the operations that the certificate provider will use to generate certificates.
|
|
1338
1338
|
* Valid value: <code>CreateCertificateFromCsr</code>.</p>
|
|
1339
1339
|
* @public
|
|
1340
1340
|
*/
|
|
1341
|
-
accountDefaultForOperations?: CertificateProviderOperation[];
|
|
1341
|
+
accountDefaultForOperations?: CertificateProviderOperation[] | undefined;
|
|
1342
1342
|
/**
|
|
1343
1343
|
* <p>The date-time string that indicates when the certificate provider was created.</p>
|
|
1344
1344
|
* @public
|
|
1345
1345
|
*/
|
|
1346
|
-
creationDate?: Date;
|
|
1346
|
+
creationDate?: Date | undefined;
|
|
1347
1347
|
/**
|
|
1348
1348
|
* <p>The date-time string that indicates when the certificate provider was last updated.</p>
|
|
1349
1349
|
* @public
|
|
1350
1350
|
*/
|
|
1351
|
-
lastModifiedDate?: Date;
|
|
1351
|
+
lastModifiedDate?: Date | undefined;
|
|
1352
1352
|
}
|
|
1353
1353
|
/**
|
|
1354
1354
|
* @public
|
|
@@ -1372,14 +1372,14 @@ export interface DescribeCustomMetricResponse {
|
|
|
1372
1372
|
* </p>
|
|
1373
1373
|
* @public
|
|
1374
1374
|
*/
|
|
1375
|
-
metricName?: string;
|
|
1375
|
+
metricName?: string | undefined;
|
|
1376
1376
|
/**
|
|
1377
1377
|
* <p>
|
|
1378
1378
|
* The Amazon Resource Number (ARN) of the custom metric.
|
|
1379
1379
|
* </p>
|
|
1380
1380
|
* @public
|
|
1381
1381
|
*/
|
|
1382
|
-
metricArn?: string;
|
|
1382
|
+
metricArn?: string | undefined;
|
|
1383
1383
|
/**
|
|
1384
1384
|
* <p> The type of the custom metric. </p>
|
|
1385
1385
|
* <important>
|
|
@@ -1387,28 +1387,28 @@ export interface DescribeCustomMetricResponse {
|
|
|
1387
1387
|
* </important>
|
|
1388
1388
|
* @public
|
|
1389
1389
|
*/
|
|
1390
|
-
metricType?: CustomMetricType;
|
|
1390
|
+
metricType?: CustomMetricType | undefined;
|
|
1391
1391
|
/**
|
|
1392
1392
|
* <p>
|
|
1393
1393
|
* Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.
|
|
1394
1394
|
* </p>
|
|
1395
1395
|
* @public
|
|
1396
1396
|
*/
|
|
1397
|
-
displayName?: string;
|
|
1397
|
+
displayName?: string | undefined;
|
|
1398
1398
|
/**
|
|
1399
1399
|
* <p>
|
|
1400
1400
|
* The creation date of the custom metric in milliseconds since epoch.
|
|
1401
1401
|
* </p>
|
|
1402
1402
|
* @public
|
|
1403
1403
|
*/
|
|
1404
|
-
creationDate?: Date;
|
|
1404
|
+
creationDate?: Date | undefined;
|
|
1405
1405
|
/**
|
|
1406
1406
|
* <p>
|
|
1407
1407
|
* The time the custom metric was last modified in milliseconds since epoch.
|
|
1408
1408
|
* </p>
|
|
1409
1409
|
* @public
|
|
1410
1410
|
*/
|
|
1411
|
-
lastModifiedDate?: Date;
|
|
1411
|
+
lastModifiedDate?: Date | undefined;
|
|
1412
1412
|
}
|
|
1413
1413
|
/**
|
|
1414
1414
|
* @public
|
|
@@ -1423,7 +1423,7 @@ export interface DescribeDefaultAuthorizerResponse {
|
|
|
1423
1423
|
* <p>The default authorizer's description.</p>
|
|
1424
1424
|
* @public
|
|
1425
1425
|
*/
|
|
1426
|
-
authorizerDescription?: AuthorizerDescription;
|
|
1426
|
+
authorizerDescription?: AuthorizerDescription | undefined;
|
|
1427
1427
|
}
|
|
1428
1428
|
/**
|
|
1429
1429
|
* @public
|
|
@@ -1450,21 +1450,21 @@ export interface DetectMitigationActionsTaskTarget {
|
|
|
1450
1450
|
* </p>
|
|
1451
1451
|
* @public
|
|
1452
1452
|
*/
|
|
1453
|
-
violationIds?: string[];
|
|
1453
|
+
violationIds?: string[] | undefined;
|
|
1454
1454
|
/**
|
|
1455
1455
|
* <p>
|
|
1456
1456
|
* The name of the security profile.
|
|
1457
1457
|
* </p>
|
|
1458
1458
|
* @public
|
|
1459
1459
|
*/
|
|
1460
|
-
securityProfileName?: string;
|
|
1460
|
+
securityProfileName?: string | undefined;
|
|
1461
1461
|
/**
|
|
1462
1462
|
* <p>
|
|
1463
1463
|
* The name of the behavior.
|
|
1464
1464
|
* </p>
|
|
1465
1465
|
* @public
|
|
1466
1466
|
*/
|
|
1467
|
-
behaviorName?: string;
|
|
1467
|
+
behaviorName?: string | undefined;
|
|
1468
1468
|
}
|
|
1469
1469
|
/**
|
|
1470
1470
|
* <p>
|
|
@@ -1479,21 +1479,21 @@ export interface DetectMitigationActionsTaskStatistics {
|
|
|
1479
1479
|
* </p>
|
|
1480
1480
|
* @public
|
|
1481
1481
|
*/
|
|
1482
|
-
actionsExecuted?: number;
|
|
1482
|
+
actionsExecuted?: number | undefined;
|
|
1483
1483
|
/**
|
|
1484
1484
|
* <p>
|
|
1485
1485
|
* The actions that were skipped.
|
|
1486
1486
|
* </p>
|
|
1487
1487
|
* @public
|
|
1488
1488
|
*/
|
|
1489
|
-
actionsSkipped?: number;
|
|
1489
|
+
actionsSkipped?: number | undefined;
|
|
1490
1490
|
/**
|
|
1491
1491
|
* <p>
|
|
1492
1492
|
* The actions that failed.
|
|
1493
1493
|
* </p>
|
|
1494
1494
|
* @public
|
|
1495
1495
|
*/
|
|
1496
|
-
actionsFailed?: number;
|
|
1496
|
+
actionsFailed?: number | undefined;
|
|
1497
1497
|
}
|
|
1498
1498
|
/**
|
|
1499
1499
|
* @public
|
|
@@ -1544,70 +1544,70 @@ export interface DetectMitigationActionsTaskSummary {
|
|
|
1544
1544
|
* </p>
|
|
1545
1545
|
* @public
|
|
1546
1546
|
*/
|
|
1547
|
-
taskId?: string;
|
|
1547
|
+
taskId?: string | undefined;
|
|
1548
1548
|
/**
|
|
1549
1549
|
* <p>
|
|
1550
1550
|
* The status of the task.
|
|
1551
1551
|
* </p>
|
|
1552
1552
|
* @public
|
|
1553
1553
|
*/
|
|
1554
|
-
taskStatus?: DetectMitigationActionsTaskStatus;
|
|
1554
|
+
taskStatus?: DetectMitigationActionsTaskStatus | undefined;
|
|
1555
1555
|
/**
|
|
1556
1556
|
* <p>
|
|
1557
1557
|
* The date the task started.
|
|
1558
1558
|
* </p>
|
|
1559
1559
|
* @public
|
|
1560
1560
|
*/
|
|
1561
|
-
taskStartTime?: Date;
|
|
1561
|
+
taskStartTime?: Date | undefined;
|
|
1562
1562
|
/**
|
|
1563
1563
|
* <p>
|
|
1564
1564
|
* The date the task ended.
|
|
1565
1565
|
* </p>
|
|
1566
1566
|
* @public
|
|
1567
1567
|
*/
|
|
1568
|
-
taskEndTime?: Date;
|
|
1568
|
+
taskEndTime?: Date | undefined;
|
|
1569
1569
|
/**
|
|
1570
1570
|
* <p>
|
|
1571
1571
|
* Specifies the ML Detect findings to which the mitigation actions are applied.
|
|
1572
1572
|
* </p>
|
|
1573
1573
|
* @public
|
|
1574
1574
|
*/
|
|
1575
|
-
target?: DetectMitigationActionsTaskTarget;
|
|
1575
|
+
target?: DetectMitigationActionsTaskTarget | undefined;
|
|
1576
1576
|
/**
|
|
1577
1577
|
* <p>
|
|
1578
1578
|
* Specifies the time period of which violation events occurred between.
|
|
1579
1579
|
* </p>
|
|
1580
1580
|
* @public
|
|
1581
1581
|
*/
|
|
1582
|
-
violationEventOccurrenceRange?: ViolationEventOccurrenceRange;
|
|
1582
|
+
violationEventOccurrenceRange?: ViolationEventOccurrenceRange | undefined;
|
|
1583
1583
|
/**
|
|
1584
1584
|
* <p>
|
|
1585
1585
|
* Includes only active violations.
|
|
1586
1586
|
* </p>
|
|
1587
1587
|
* @public
|
|
1588
1588
|
*/
|
|
1589
|
-
onlyActiveViolationsIncluded?: boolean;
|
|
1589
|
+
onlyActiveViolationsIncluded?: boolean | undefined;
|
|
1590
1590
|
/**
|
|
1591
1591
|
* <p>
|
|
1592
1592
|
* Includes suppressed alerts.
|
|
1593
1593
|
* </p>
|
|
1594
1594
|
* @public
|
|
1595
1595
|
*/
|
|
1596
|
-
suppressedAlertsIncluded?: boolean;
|
|
1596
|
+
suppressedAlertsIncluded?: boolean | undefined;
|
|
1597
1597
|
/**
|
|
1598
1598
|
* <p>
|
|
1599
1599
|
* The definition of the actions.
|
|
1600
1600
|
* </p>
|
|
1601
1601
|
* @public
|
|
1602
1602
|
*/
|
|
1603
|
-
actionsDefinition?: MitigationAction[];
|
|
1603
|
+
actionsDefinition?: MitigationAction[] | undefined;
|
|
1604
1604
|
/**
|
|
1605
1605
|
* <p>
|
|
1606
1606
|
* The statistics of a mitigation action task.
|
|
1607
1607
|
* </p>
|
|
1608
1608
|
* @public
|
|
1609
1609
|
*/
|
|
1610
|
-
taskStatistics?: DetectMitigationActionsTaskStatistics;
|
|
1610
|
+
taskStatistics?: DetectMitigationActionsTaskStatistics | undefined;
|
|
1611
1611
|
}
|
|
1612
1612
|
/**
|
|
1613
1613
|
* @public
|
|
@@ -1619,7 +1619,7 @@ export interface DescribeDetectMitigationActionsTaskResponse {
|
|
|
1619
1619
|
* </p>
|
|
1620
1620
|
* @public
|
|
1621
1621
|
*/
|
|
1622
|
-
taskSummary?: DetectMitigationActionsTaskSummary;
|
|
1622
|
+
taskSummary?: DetectMitigationActionsTaskSummary | undefined;
|
|
1623
1623
|
}
|
|
1624
1624
|
/**
|
|
1625
1625
|
* @public
|
|
@@ -1639,7 +1639,7 @@ export interface DescribeDimensionResponse {
|
|
|
1639
1639
|
* <p>The unique identifier for the dimension.</p>
|
|
1640
1640
|
* @public
|
|
1641
1641
|
*/
|
|
1642
|
-
name?: string;
|
|
1642
|
+
name?: string | undefined;
|
|
1643
1643
|
/**
|
|
1644
1644
|
* <p>The Amazon Resource Name
|
|
1645
1645
|
* (ARN)
|
|
@@ -1647,27 +1647,27 @@ export interface DescribeDimensionResponse {
|
|
|
1647
1647
|
* the dimension.</p>
|
|
1648
1648
|
* @public
|
|
1649
1649
|
*/
|
|
1650
|
-
arn?: string;
|
|
1650
|
+
arn?: string | undefined;
|
|
1651
1651
|
/**
|
|
1652
1652
|
* <p>The type of the dimension.</p>
|
|
1653
1653
|
* @public
|
|
1654
1654
|
*/
|
|
1655
|
-
type?: DimensionType;
|
|
1655
|
+
type?: DimensionType | undefined;
|
|
1656
1656
|
/**
|
|
1657
1657
|
* <p>The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.</p>
|
|
1658
1658
|
* @public
|
|
1659
1659
|
*/
|
|
1660
|
-
stringValues?: string[];
|
|
1660
|
+
stringValues?: string[] | undefined;
|
|
1661
1661
|
/**
|
|
1662
1662
|
* <p>The date the dimension was created.</p>
|
|
1663
1663
|
* @public
|
|
1664
1664
|
*/
|
|
1665
|
-
creationDate?: Date;
|
|
1665
|
+
creationDate?: Date | undefined;
|
|
1666
1666
|
/**
|
|
1667
1667
|
* <p>The date the dimension was last modified.</p>
|
|
1668
1668
|
* @public
|
|
1669
1669
|
*/
|
|
1670
|
-
lastModifiedDate?: Date;
|
|
1670
|
+
lastModifiedDate?: Date | undefined;
|
|
1671
1671
|
}
|
|
1672
1672
|
/**
|
|
1673
1673
|
* @public
|
|
@@ -1725,17 +1725,17 @@ export interface ServerCertificateSummary {
|
|
|
1725
1725
|
* <p>The ARN of the server certificate.</p>
|
|
1726
1726
|
* @public
|
|
1727
1727
|
*/
|
|
1728
|
-
serverCertificateArn?: string;
|
|
1728
|
+
serverCertificateArn?: string | undefined;
|
|
1729
1729
|
/**
|
|
1730
1730
|
* <p>The status of the server certificate.</p>
|
|
1731
1731
|
* @public
|
|
1732
1732
|
*/
|
|
1733
|
-
serverCertificateStatus?: ServerCertificateStatus;
|
|
1733
|
+
serverCertificateStatus?: ServerCertificateStatus | undefined;
|
|
1734
1734
|
/**
|
|
1735
1735
|
* <p>Details that explain the status of the server certificate.</p>
|
|
1736
1736
|
* @public
|
|
1737
1737
|
*/
|
|
1738
|
-
serverCertificateStatusDetail?: string;
|
|
1738
|
+
serverCertificateStatusDetail?: string | undefined;
|
|
1739
1739
|
}
|
|
1740
1740
|
/**
|
|
1741
1741
|
* @public
|
|
@@ -1745,57 +1745,57 @@ export interface DescribeDomainConfigurationResponse {
|
|
|
1745
1745
|
* <p>The name of the domain configuration.</p>
|
|
1746
1746
|
* @public
|
|
1747
1747
|
*/
|
|
1748
|
-
domainConfigurationName?: string;
|
|
1748
|
+
domainConfigurationName?: string | undefined;
|
|
1749
1749
|
/**
|
|
1750
1750
|
* <p>The ARN of the domain configuration.</p>
|
|
1751
1751
|
* @public
|
|
1752
1752
|
*/
|
|
1753
|
-
domainConfigurationArn?: string;
|
|
1753
|
+
domainConfigurationArn?: string | undefined;
|
|
1754
1754
|
/**
|
|
1755
1755
|
* <p>The name of the domain.</p>
|
|
1756
1756
|
* @public
|
|
1757
1757
|
*/
|
|
1758
|
-
domainName?: string;
|
|
1758
|
+
domainName?: string | undefined;
|
|
1759
1759
|
/**
|
|
1760
1760
|
* <p>A list containing summary information about the server certificate included in the domain configuration.</p>
|
|
1761
1761
|
* @public
|
|
1762
1762
|
*/
|
|
1763
|
-
serverCertificates?: ServerCertificateSummary[];
|
|
1763
|
+
serverCertificates?: ServerCertificateSummary[] | undefined;
|
|
1764
1764
|
/**
|
|
1765
1765
|
* <p>An object that specifies the authorization service for a domain.</p>
|
|
1766
1766
|
* @public
|
|
1767
1767
|
*/
|
|
1768
|
-
authorizerConfig?: AuthorizerConfig;
|
|
1768
|
+
authorizerConfig?: AuthorizerConfig | undefined;
|
|
1769
1769
|
/**
|
|
1770
1770
|
* <p>A Boolean value that specifies the current state of the domain configuration.</p>
|
|
1771
1771
|
* @public
|
|
1772
1772
|
*/
|
|
1773
|
-
domainConfigurationStatus?: DomainConfigurationStatus;
|
|
1773
|
+
domainConfigurationStatus?: DomainConfigurationStatus | undefined;
|
|
1774
1774
|
/**
|
|
1775
1775
|
* <p>The type of service delivered by the endpoint.</p>
|
|
1776
1776
|
* @public
|
|
1777
1777
|
*/
|
|
1778
|
-
serviceType?: ServiceType;
|
|
1778
|
+
serviceType?: ServiceType | undefined;
|
|
1779
1779
|
/**
|
|
1780
1780
|
* <p>The type of the domain.</p>
|
|
1781
1781
|
* @public
|
|
1782
1782
|
*/
|
|
1783
|
-
domainType?: DomainType;
|
|
1783
|
+
domainType?: DomainType | undefined;
|
|
1784
1784
|
/**
|
|
1785
1785
|
* <p>The date and time the domain configuration's status was last changed.</p>
|
|
1786
1786
|
* @public
|
|
1787
1787
|
*/
|
|
1788
|
-
lastStatusChangeDate?: Date;
|
|
1788
|
+
lastStatusChangeDate?: Date | undefined;
|
|
1789
1789
|
/**
|
|
1790
1790
|
* <p>An object that specifies the TLS configuration for a domain.</p>
|
|
1791
1791
|
* @public
|
|
1792
1792
|
*/
|
|
1793
|
-
tlsConfig?: TlsConfig;
|
|
1793
|
+
tlsConfig?: TlsConfig | undefined;
|
|
1794
1794
|
/**
|
|
1795
1795
|
* <p>The server certificate configuration.</p>
|
|
1796
1796
|
* @public
|
|
1797
1797
|
*/
|
|
1798
|
-
serverCertificateConfig?: ServerCertificateConfig;
|
|
1798
|
+
serverCertificateConfig?: ServerCertificateConfig | undefined;
|
|
1799
1799
|
/**
|
|
1800
1800
|
* <p>An enumerated string that specifies the authentication type.</p>
|
|
1801
1801
|
* <ul>
|
|
@@ -1833,7 +1833,7 @@ export interface DescribeDomainConfigurationResponse {
|
|
|
1833
1833
|
* </ul>
|
|
1834
1834
|
* @public
|
|
1835
1835
|
*/
|
|
1836
|
-
authenticationType?: AuthenticationType;
|
|
1836
|
+
authenticationType?: AuthenticationType | undefined;
|
|
1837
1837
|
/**
|
|
1838
1838
|
* <p>An enumerated string that specifies the application-layer protocol.</p>
|
|
1839
1839
|
* <ul>
|
|
@@ -1863,12 +1863,12 @@ export interface DescribeDomainConfigurationResponse {
|
|
|
1863
1863
|
* </ul>
|
|
1864
1864
|
* @public
|
|
1865
1865
|
*/
|
|
1866
|
-
applicationProtocol?: ApplicationProtocol;
|
|
1866
|
+
applicationProtocol?: ApplicationProtocol | undefined;
|
|
1867
1867
|
/**
|
|
1868
1868
|
* <p>An object that specifies the client certificate configuration for a domain.</p>
|
|
1869
1869
|
* @public
|
|
1870
1870
|
*/
|
|
1871
|
-
clientCertificateConfig?: ClientCertificateConfig;
|
|
1871
|
+
clientCertificateConfig?: ClientCertificateConfig | undefined;
|
|
1872
1872
|
}
|
|
1873
1873
|
/**
|
|
1874
1874
|
* <p>The input for the DescribeEndpoint operation.</p>
|
|
@@ -1908,7 +1908,7 @@ export interface DescribeEndpointRequest {
|
|
|
1908
1908
|
* are more secure and are trusted by most popular browsers.</p>
|
|
1909
1909
|
* @public
|
|
1910
1910
|
*/
|
|
1911
|
-
endpointType?: string;
|
|
1911
|
+
endpointType?: string | undefined;
|
|
1912
1912
|
}
|
|
1913
1913
|
/**
|
|
1914
1914
|
* <p>The output from the DescribeEndpoint operation.</p>
|
|
@@ -1920,7 +1920,7 @@ export interface DescribeEndpointResponse {
|
|
|
1920
1920
|
* <i>identifier</i>.iot.<i>region</i>.amazonaws.com.</p>
|
|
1921
1921
|
* @public
|
|
1922
1922
|
*/
|
|
1923
|
-
endpointAddress?: string;
|
|
1923
|
+
endpointAddress?: string | undefined;
|
|
1924
1924
|
}
|
|
1925
1925
|
/**
|
|
1926
1926
|
* @public
|
|
@@ -1957,7 +1957,7 @@ export interface Configuration {
|
|
|
1957
1957
|
* <p>True to enable the configuration.</p>
|
|
1958
1958
|
* @public
|
|
1959
1959
|
*/
|
|
1960
|
-
Enabled?: boolean;
|
|
1960
|
+
Enabled?: boolean | undefined;
|
|
1961
1961
|
}
|
|
1962
1962
|
/**
|
|
1963
1963
|
* @public
|
|
@@ -1967,17 +1967,17 @@ export interface DescribeEventConfigurationsResponse {
|
|
|
1967
1967
|
* <p>The event configurations.</p>
|
|
1968
1968
|
* @public
|
|
1969
1969
|
*/
|
|
1970
|
-
eventConfigurations?: Partial<Record<EventType, Configuration
|
|
1970
|
+
eventConfigurations?: Partial<Record<EventType, Configuration>> | undefined;
|
|
1971
1971
|
/**
|
|
1972
1972
|
* <p>The creation date of the event configuration.</p>
|
|
1973
1973
|
* @public
|
|
1974
1974
|
*/
|
|
1975
|
-
creationDate?: Date;
|
|
1975
|
+
creationDate?: Date | undefined;
|
|
1976
1976
|
/**
|
|
1977
1977
|
* <p>The date the event configurations were last modified.</p>
|
|
1978
1978
|
* @public
|
|
1979
1979
|
*/
|
|
1980
|
-
lastModifiedDate?: Date;
|
|
1980
|
+
lastModifiedDate?: Date | undefined;
|
|
1981
1981
|
}
|
|
1982
1982
|
/**
|
|
1983
1983
|
* @public
|
|
@@ -1997,68 +1997,68 @@ export interface DescribeFleetMetricResponse {
|
|
|
1997
1997
|
* <p>The name of the fleet metric to describe.</p>
|
|
1998
1998
|
* @public
|
|
1999
1999
|
*/
|
|
2000
|
-
metricName?: string;
|
|
2000
|
+
metricName?: string | undefined;
|
|
2001
2001
|
/**
|
|
2002
2002
|
* <p>The search query string.</p>
|
|
2003
2003
|
* @public
|
|
2004
2004
|
*/
|
|
2005
|
-
queryString?: string;
|
|
2005
|
+
queryString?: string | undefined;
|
|
2006
2006
|
/**
|
|
2007
2007
|
* <p>The type of the aggregation query.</p>
|
|
2008
2008
|
* @public
|
|
2009
2009
|
*/
|
|
2010
|
-
aggregationType?: AggregationType;
|
|
2010
|
+
aggregationType?: AggregationType | undefined;
|
|
2011
2011
|
/**
|
|
2012
2012
|
* <p>The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.</p>
|
|
2013
2013
|
* @public
|
|
2014
2014
|
*/
|
|
2015
|
-
period?: number;
|
|
2015
|
+
period?: number | undefined;
|
|
2016
2016
|
/**
|
|
2017
2017
|
* <p>The field to aggregate.</p>
|
|
2018
2018
|
* @public
|
|
2019
2019
|
*/
|
|
2020
|
-
aggregationField?: string;
|
|
2020
|
+
aggregationField?: string | undefined;
|
|
2021
2021
|
/**
|
|
2022
2022
|
* <p>The fleet metric description.</p>
|
|
2023
2023
|
* @public
|
|
2024
2024
|
*/
|
|
2025
|
-
description?: string;
|
|
2025
|
+
description?: string | undefined;
|
|
2026
2026
|
/**
|
|
2027
2027
|
* <p>The query version.</p>
|
|
2028
2028
|
* @public
|
|
2029
2029
|
*/
|
|
2030
|
-
queryVersion?: string;
|
|
2030
|
+
queryVersion?: string | undefined;
|
|
2031
2031
|
/**
|
|
2032
2032
|
* <p>The name of the index to search.</p>
|
|
2033
2033
|
* @public
|
|
2034
2034
|
*/
|
|
2035
|
-
indexName?: string;
|
|
2035
|
+
indexName?: string | undefined;
|
|
2036
2036
|
/**
|
|
2037
2037
|
* <p>The date when the fleet metric is created.</p>
|
|
2038
2038
|
* @public
|
|
2039
2039
|
*/
|
|
2040
|
-
creationDate?: Date;
|
|
2040
|
+
creationDate?: Date | undefined;
|
|
2041
2041
|
/**
|
|
2042
2042
|
* <p>The date when the fleet metric is last modified.</p>
|
|
2043
2043
|
* @public
|
|
2044
2044
|
*/
|
|
2045
|
-
lastModifiedDate?: Date;
|
|
2045
|
+
lastModifiedDate?: Date | undefined;
|
|
2046
2046
|
/**
|
|
2047
2047
|
* <p>Used to support unit transformation such as milliseconds to seconds. The unit must be
|
|
2048
2048
|
* supported by <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">CW metric</a>.</p>
|
|
2049
2049
|
* @public
|
|
2050
2050
|
*/
|
|
2051
|
-
unit?: FleetMetricUnit;
|
|
2051
|
+
unit?: FleetMetricUnit | undefined;
|
|
2052
2052
|
/**
|
|
2053
2053
|
* <p>The version of the fleet metric.</p>
|
|
2054
2054
|
* @public
|
|
2055
2055
|
*/
|
|
2056
|
-
version?: number;
|
|
2056
|
+
version?: number | undefined;
|
|
2057
2057
|
/**
|
|
2058
2058
|
* <p>The ARN of the fleet metric to describe.</p>
|
|
2059
2059
|
* @public
|
|
2060
2060
|
*/
|
|
2061
|
-
metricArn?: string;
|
|
2061
|
+
metricArn?: string | undefined;
|
|
2062
2062
|
}
|
|
2063
2063
|
/**
|
|
2064
2064
|
* @public
|
|
@@ -2091,12 +2091,12 @@ export interface DescribeIndexResponse {
|
|
|
2091
2091
|
* <p>The index name.</p>
|
|
2092
2092
|
* @public
|
|
2093
2093
|
*/
|
|
2094
|
-
indexName?: string;
|
|
2094
|
+
indexName?: string | undefined;
|
|
2095
2095
|
/**
|
|
2096
2096
|
* <p>The index status.</p>
|
|
2097
2097
|
* @public
|
|
2098
2098
|
*/
|
|
2099
|
-
indexStatus?: IndexStatus;
|
|
2099
|
+
indexStatus?: IndexStatus | undefined;
|
|
2100
2100
|
/**
|
|
2101
2101
|
* <p>Contains a value that specifies the type of indexing performed. Valid values
|
|
2102
2102
|
* are:</p>
|
|
@@ -2122,7 +2122,7 @@ export interface DescribeIndexResponse {
|
|
|
2122
2122
|
* </ul>
|
|
2123
2123
|
* @public
|
|
2124
2124
|
*/
|
|
2125
|
-
schema?: string;
|
|
2125
|
+
schema?: string | undefined;
|
|
2126
2126
|
}
|
|
2127
2127
|
/**
|
|
2128
2128
|
* @public
|
|
@@ -2137,7 +2137,7 @@ export interface DescribeJobRequest {
|
|
|
2137
2137
|
* <p>A flag that provides a view of the job document before and after the substitution parameters have been resolved with their exact values.</p>
|
|
2138
2138
|
* @public
|
|
2139
2139
|
*/
|
|
2140
|
-
beforeSubstitution?: boolean;
|
|
2140
|
+
beforeSubstitution?: boolean | undefined;
|
|
2141
2141
|
}
|
|
2142
2142
|
/**
|
|
2143
2143
|
* <p>The job process details.</p>
|
|
@@ -2148,48 +2148,48 @@ export interface JobProcessDetails {
|
|
|
2148
2148
|
* <p>The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.</p>
|
|
2149
2149
|
* @public
|
|
2150
2150
|
*/
|
|
2151
|
-
processingTargets?: string[];
|
|
2151
|
+
processingTargets?: string[] | undefined;
|
|
2152
2152
|
/**
|
|
2153
2153
|
* <p>The number of things that cancelled the job.</p>
|
|
2154
2154
|
* @public
|
|
2155
2155
|
*/
|
|
2156
|
-
numberOfCanceledThings?: number;
|
|
2156
|
+
numberOfCanceledThings?: number | undefined;
|
|
2157
2157
|
/**
|
|
2158
2158
|
* <p>The number of things which successfully completed the job.</p>
|
|
2159
2159
|
* @public
|
|
2160
2160
|
*/
|
|
2161
|
-
numberOfSucceededThings?: number;
|
|
2161
|
+
numberOfSucceededThings?: number | undefined;
|
|
2162
2162
|
/**
|
|
2163
2163
|
* <p>The number of things that failed executing the job.</p>
|
|
2164
2164
|
* @public
|
|
2165
2165
|
*/
|
|
2166
|
-
numberOfFailedThings?: number;
|
|
2166
|
+
numberOfFailedThings?: number | undefined;
|
|
2167
2167
|
/**
|
|
2168
2168
|
* <p>The number of things that rejected the job.</p>
|
|
2169
2169
|
* @public
|
|
2170
2170
|
*/
|
|
2171
|
-
numberOfRejectedThings?: number;
|
|
2171
|
+
numberOfRejectedThings?: number | undefined;
|
|
2172
2172
|
/**
|
|
2173
2173
|
* <p>The number of things that are awaiting execution of the job.</p>
|
|
2174
2174
|
* @public
|
|
2175
2175
|
*/
|
|
2176
|
-
numberOfQueuedThings?: number;
|
|
2176
|
+
numberOfQueuedThings?: number | undefined;
|
|
2177
2177
|
/**
|
|
2178
2178
|
* <p>The number of things currently executing the job.</p>
|
|
2179
2179
|
* @public
|
|
2180
2180
|
*/
|
|
2181
|
-
numberOfInProgressThings?: number;
|
|
2181
|
+
numberOfInProgressThings?: number | undefined;
|
|
2182
2182
|
/**
|
|
2183
2183
|
* <p>The number of things that are no longer scheduled to execute the job because they have been deleted or
|
|
2184
2184
|
* have been removed from the group that was a target of the job.</p>
|
|
2185
2185
|
* @public
|
|
2186
2186
|
*/
|
|
2187
|
-
numberOfRemovedThings?: number;
|
|
2187
|
+
numberOfRemovedThings?: number | undefined;
|
|
2188
2188
|
/**
|
|
2189
2189
|
* <p>The number of things whose job execution status is <code>TIMED_OUT</code>.</p>
|
|
2190
2190
|
* @public
|
|
2191
2191
|
*/
|
|
2192
|
-
numberOfTimedOutThings?: number;
|
|
2192
|
+
numberOfTimedOutThings?: number | undefined;
|
|
2193
2193
|
}
|
|
2194
2194
|
/**
|
|
2195
2195
|
* <p>Displays the next seven maintenance window occurrences and their start times.</p>
|
|
@@ -2200,7 +2200,7 @@ export interface ScheduledJobRollout {
|
|
|
2200
2200
|
* <p>Displays the start times of the next seven maintenance window occurrences.</p>
|
|
2201
2201
|
* @public
|
|
2202
2202
|
*/
|
|
2203
|
-
startTime?: string;
|
|
2203
|
+
startTime?: string | undefined;
|
|
2204
2204
|
}
|
|
2205
2205
|
/**
|
|
2206
2206
|
* @public
|
|
@@ -2226,12 +2226,12 @@ export interface Job {
|
|
|
2226
2226
|
* <p>An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".</p>
|
|
2227
2227
|
* @public
|
|
2228
2228
|
*/
|
|
2229
|
-
jobArn?: string;
|
|
2229
|
+
jobArn?: string | undefined;
|
|
2230
2230
|
/**
|
|
2231
2231
|
* <p>The unique identifier you assigned to this job when it was created.</p>
|
|
2232
2232
|
* @public
|
|
2233
2233
|
*/
|
|
2234
|
-
jobId?: string;
|
|
2234
|
+
jobId?: string | undefined;
|
|
2235
2235
|
/**
|
|
2236
2236
|
* <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things
|
|
2237
2237
|
* specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
|
|
@@ -2245,74 +2245,74 @@ export interface Job {
|
|
|
2245
2245
|
* </note>
|
|
2246
2246
|
* @public
|
|
2247
2247
|
*/
|
|
2248
|
-
targetSelection?: TargetSelection;
|
|
2248
|
+
targetSelection?: TargetSelection | undefined;
|
|
2249
2249
|
/**
|
|
2250
2250
|
* <p>The status of the job, one of <code>IN_PROGRESS</code>, <code>CANCELED</code>,
|
|
2251
2251
|
* <code>DELETION_IN_PROGRESS</code> or <code>COMPLETED</code>. </p>
|
|
2252
2252
|
* @public
|
|
2253
2253
|
*/
|
|
2254
|
-
status?: JobStatus;
|
|
2254
|
+
status?: JobStatus | undefined;
|
|
2255
2255
|
/**
|
|
2256
2256
|
* <p>Will be <code>true</code> if the job was canceled with the optional <code>force</code> parameter set to
|
|
2257
2257
|
* <code>true</code>.</p>
|
|
2258
2258
|
* @public
|
|
2259
2259
|
*/
|
|
2260
|
-
forceCanceled?: boolean;
|
|
2260
|
+
forceCanceled?: boolean | undefined;
|
|
2261
2261
|
/**
|
|
2262
2262
|
* <p>If the job was updated, provides the reason code for the update.</p>
|
|
2263
2263
|
* @public
|
|
2264
2264
|
*/
|
|
2265
|
-
reasonCode?: string;
|
|
2265
|
+
reasonCode?: string | undefined;
|
|
2266
2266
|
/**
|
|
2267
2267
|
* <p>If the job was updated, describes the reason for the update.</p>
|
|
2268
2268
|
* @public
|
|
2269
2269
|
*/
|
|
2270
|
-
comment?: string;
|
|
2270
|
+
comment?: string | undefined;
|
|
2271
2271
|
/**
|
|
2272
2272
|
* <p>A list of IoT things and thing groups to which the job should be sent.</p>
|
|
2273
2273
|
* @public
|
|
2274
2274
|
*/
|
|
2275
|
-
targets?: string[];
|
|
2275
|
+
targets?: string[] | undefined;
|
|
2276
2276
|
/**
|
|
2277
2277
|
* <p>A short text description of the job.</p>
|
|
2278
2278
|
* @public
|
|
2279
2279
|
*/
|
|
2280
|
-
description?: string;
|
|
2280
|
+
description?: string | undefined;
|
|
2281
2281
|
/**
|
|
2282
2282
|
* <p>Configuration for pre-signed S3 URLs.</p>
|
|
2283
2283
|
* @public
|
|
2284
2284
|
*/
|
|
2285
|
-
presignedUrlConfig?: PresignedUrlConfig;
|
|
2285
|
+
presignedUrlConfig?: PresignedUrlConfig | undefined;
|
|
2286
2286
|
/**
|
|
2287
2287
|
* <p>Allows you to create a staged rollout of a job.</p>
|
|
2288
2288
|
* @public
|
|
2289
2289
|
*/
|
|
2290
|
-
jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
|
|
2290
|
+
jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig | undefined;
|
|
2291
2291
|
/**
|
|
2292
2292
|
* <p>Configuration for criteria to abort the job.</p>
|
|
2293
2293
|
* @public
|
|
2294
2294
|
*/
|
|
2295
|
-
abortConfig?: AbortConfig;
|
|
2295
|
+
abortConfig?: AbortConfig | undefined;
|
|
2296
2296
|
/**
|
|
2297
2297
|
* <p>The time, in seconds since the epoch, when the job was created.</p>
|
|
2298
2298
|
* @public
|
|
2299
2299
|
*/
|
|
2300
|
-
createdAt?: Date;
|
|
2300
|
+
createdAt?: Date | undefined;
|
|
2301
2301
|
/**
|
|
2302
2302
|
* <p>The time, in seconds since the epoch, when the job was last updated.</p>
|
|
2303
2303
|
* @public
|
|
2304
2304
|
*/
|
|
2305
|
-
lastUpdatedAt?: Date;
|
|
2305
|
+
lastUpdatedAt?: Date | undefined;
|
|
2306
2306
|
/**
|
|
2307
2307
|
* <p>The time, in seconds since the epoch, when the job was completed.</p>
|
|
2308
2308
|
* @public
|
|
2309
2309
|
*/
|
|
2310
|
-
completedAt?: Date;
|
|
2310
|
+
completedAt?: Date | undefined;
|
|
2311
2311
|
/**
|
|
2312
2312
|
* <p>Details about the job process.</p>
|
|
2313
2313
|
* @public
|
|
2314
2314
|
*/
|
|
2315
|
-
jobProcessDetails?: JobProcessDetails;
|
|
2315
|
+
jobProcessDetails?: JobProcessDetails | undefined;
|
|
2316
2316
|
/**
|
|
2317
2317
|
* <p>Specifies the amount of time each device has to finish its execution of the job. A timer
|
|
2318
2318
|
* is started when the job execution status is set to <code>IN_PROGRESS</code>. If the job
|
|
@@ -2320,7 +2320,7 @@ export interface Job {
|
|
|
2320
2320
|
* be automatically set to <code>TIMED_OUT</code>.</p>
|
|
2321
2321
|
* @public
|
|
2322
2322
|
*/
|
|
2323
|
-
timeoutConfig?: TimeoutConfig;
|
|
2323
|
+
timeoutConfig?: TimeoutConfig | undefined;
|
|
2324
2324
|
/**
|
|
2325
2325
|
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
2326
2326
|
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
|
|
@@ -2336,17 +2336,17 @@ export interface Job {
|
|
|
2336
2336
|
* </note>
|
|
2337
2337
|
* @public
|
|
2338
2338
|
*/
|
|
2339
|
-
namespaceId?: string;
|
|
2339
|
+
namespaceId?: string | undefined;
|
|
2340
2340
|
/**
|
|
2341
2341
|
* <p>The ARN of the job template used to create the job.</p>
|
|
2342
2342
|
* @public
|
|
2343
2343
|
*/
|
|
2344
|
-
jobTemplateArn?: string;
|
|
2344
|
+
jobTemplateArn?: string | undefined;
|
|
2345
2345
|
/**
|
|
2346
2346
|
* <p>The configuration for the criteria to retry the job.</p>
|
|
2347
2347
|
* @public
|
|
2348
2348
|
*/
|
|
2349
|
-
jobExecutionsRetryConfig?: JobExecutionsRetryConfig;
|
|
2349
|
+
jobExecutionsRetryConfig?: JobExecutionsRetryConfig | undefined;
|
|
2350
2350
|
/**
|
|
2351
2351
|
* <p>A key-value map that pairs the patterns that need to be replaced in a managed
|
|
2352
2352
|
* template job document schema. You can use the description of each key as a guidance
|
|
@@ -2359,25 +2359,25 @@ export interface Job {
|
|
|
2359
2359
|
* </note>
|
|
2360
2360
|
* @public
|
|
2361
2361
|
*/
|
|
2362
|
-
documentParameters?: Record<string, string
|
|
2362
|
+
documentParameters?: Record<string, string> | undefined;
|
|
2363
2363
|
/**
|
|
2364
2364
|
* <p>Indicates whether a job is concurrent. Will be true when a job is
|
|
2365
2365
|
* rolling out new job executions or canceling previously created executions,
|
|
2366
2366
|
* otherwise false.</p>
|
|
2367
2367
|
* @public
|
|
2368
2368
|
*/
|
|
2369
|
-
isConcurrent?: boolean;
|
|
2369
|
+
isConcurrent?: boolean | undefined;
|
|
2370
2370
|
/**
|
|
2371
2371
|
* <p>The configuration that allows you to schedule a job for a future date and time in
|
|
2372
2372
|
* addition to specifying the end behavior for each job execution.</p>
|
|
2373
2373
|
* @public
|
|
2374
2374
|
*/
|
|
2375
|
-
schedulingConfig?: SchedulingConfig;
|
|
2375
|
+
schedulingConfig?: SchedulingConfig | undefined;
|
|
2376
2376
|
/**
|
|
2377
2377
|
* <p>Displays the next seven maintenance window occurrences and their start times.</p>
|
|
2378
2378
|
* @public
|
|
2379
2379
|
*/
|
|
2380
|
-
scheduledJobRollouts?: ScheduledJobRollout[];
|
|
2380
|
+
scheduledJobRollouts?: ScheduledJobRollout[] | undefined;
|
|
2381
2381
|
/**
|
|
2382
2382
|
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
|
|
2383
2383
|
* job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. 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>.The package version must be in either the Published or Deprecated state when the job deploys. 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>
|
|
@@ -2386,7 +2386,7 @@ export interface Job {
|
|
|
2386
2386
|
* Up to 25 package version ARNs are allowed.</p>
|
|
2387
2387
|
* @public
|
|
2388
2388
|
*/
|
|
2389
|
-
destinationPackageVersions?: string[];
|
|
2389
|
+
destinationPackageVersions?: string[] | undefined;
|
|
2390
2390
|
}
|
|
2391
2391
|
/**
|
|
2392
2392
|
* @public
|
|
@@ -2396,12 +2396,12 @@ export interface DescribeJobResponse {
|
|
|
2396
2396
|
* <p>An S3 link to the job document.</p>
|
|
2397
2397
|
* @public
|
|
2398
2398
|
*/
|
|
2399
|
-
documentSource?: string;
|
|
2399
|
+
documentSource?: string | undefined;
|
|
2400
2400
|
/**
|
|
2401
2401
|
* <p>Information about the job.</p>
|
|
2402
2402
|
* @public
|
|
2403
2403
|
*/
|
|
2404
|
-
job?: Job;
|
|
2404
|
+
job?: Job | undefined;
|
|
2405
2405
|
}
|
|
2406
2406
|
/**
|
|
2407
2407
|
* @public
|
|
@@ -2422,7 +2422,7 @@ export interface DescribeJobExecutionRequest {
|
|
|
2422
2422
|
* on a particular device.</p>
|
|
2423
2423
|
* @public
|
|
2424
2424
|
*/
|
|
2425
|
-
executionNumber?: number;
|
|
2425
|
+
executionNumber?: number | undefined;
|
|
2426
2426
|
}
|
|
2427
2427
|
/**
|
|
2428
2428
|
* @public
|
|
@@ -2451,7 +2451,7 @@ export interface JobExecutionStatusDetails {
|
|
|
2451
2451
|
* <p>The job execution status.</p>
|
|
2452
2452
|
* @public
|
|
2453
2453
|
*/
|
|
2454
|
-
detailsMap?: Record<string, string
|
|
2454
|
+
detailsMap?: Record<string, string> | undefined;
|
|
2455
2455
|
}
|
|
2456
2456
|
/**
|
|
2457
2457
|
* <p>The job execution object represents the execution of a job on a particular device.</p>
|
|
@@ -2462,57 +2462,57 @@ export interface JobExecution {
|
|
|
2462
2462
|
* <p>The unique identifier you assigned to the job when it was created.</p>
|
|
2463
2463
|
* @public
|
|
2464
2464
|
*/
|
|
2465
|
-
jobId?: string;
|
|
2465
|
+
jobId?: string | undefined;
|
|
2466
2466
|
/**
|
|
2467
2467
|
* <p>The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT,
|
|
2468
2468
|
* CANCELED, or REJECTED).</p>
|
|
2469
2469
|
* @public
|
|
2470
2470
|
*/
|
|
2471
|
-
status?: JobExecutionStatus;
|
|
2471
|
+
status?: JobExecutionStatus | undefined;
|
|
2472
2472
|
/**
|
|
2473
2473
|
* <p>Will be <code>true</code> if the job execution was canceled with the optional <code>force</code>
|
|
2474
2474
|
* parameter set to <code>true</code>.</p>
|
|
2475
2475
|
* @public
|
|
2476
2476
|
*/
|
|
2477
|
-
forceCanceled?: boolean;
|
|
2477
|
+
forceCanceled?: boolean | undefined;
|
|
2478
2478
|
/**
|
|
2479
2479
|
* <p>A collection of name/value pairs that describe the status of the job execution.</p>
|
|
2480
2480
|
* @public
|
|
2481
2481
|
*/
|
|
2482
|
-
statusDetails?: JobExecutionStatusDetails;
|
|
2482
|
+
statusDetails?: JobExecutionStatusDetails | undefined;
|
|
2483
2483
|
/**
|
|
2484
2484
|
* <p>The ARN of the thing on which the job execution is running.</p>
|
|
2485
2485
|
* @public
|
|
2486
2486
|
*/
|
|
2487
|
-
thingArn?: string;
|
|
2487
|
+
thingArn?: string | undefined;
|
|
2488
2488
|
/**
|
|
2489
2489
|
* <p>The time, in seconds since the epoch, when the job execution was queued.</p>
|
|
2490
2490
|
* @public
|
|
2491
2491
|
*/
|
|
2492
|
-
queuedAt?: Date;
|
|
2492
|
+
queuedAt?: Date | undefined;
|
|
2493
2493
|
/**
|
|
2494
2494
|
* <p>The time, in seconds since the epoch, when the job execution started.</p>
|
|
2495
2495
|
* @public
|
|
2496
2496
|
*/
|
|
2497
|
-
startedAt?: Date;
|
|
2497
|
+
startedAt?: Date | undefined;
|
|
2498
2498
|
/**
|
|
2499
2499
|
* <p>The time, in seconds since the epoch, when the job execution was last updated.</p>
|
|
2500
2500
|
* @public
|
|
2501
2501
|
*/
|
|
2502
|
-
lastUpdatedAt?: Date;
|
|
2502
|
+
lastUpdatedAt?: Date | undefined;
|
|
2503
2503
|
/**
|
|
2504
2504
|
* <p>A string (consisting of the digits "0" through "9") which identifies this particular job execution on
|
|
2505
2505
|
* this particular device. It can be used in commands which return or update job execution information.
|
|
2506
2506
|
* </p>
|
|
2507
2507
|
* @public
|
|
2508
2508
|
*/
|
|
2509
|
-
executionNumber?: number;
|
|
2509
|
+
executionNumber?: number | undefined;
|
|
2510
2510
|
/**
|
|
2511
2511
|
* <p>The version of the job execution. Job execution versions are incremented each time they are updated
|
|
2512
2512
|
* by a device.</p>
|
|
2513
2513
|
* @public
|
|
2514
2514
|
*/
|
|
2515
|
-
versionNumber?: number;
|
|
2515
|
+
versionNumber?: number | undefined;
|
|
2516
2516
|
/**
|
|
2517
2517
|
* <p>The estimated number of seconds that remain before the job execution status will be
|
|
2518
2518
|
* changed to <code>TIMED_OUT</code>. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes).
|
|
@@ -2520,7 +2520,7 @@ export interface JobExecution {
|
|
|
2520
2520
|
* This value will not be included if the job execution has reached a terminal status.</p>
|
|
2521
2521
|
* @public
|
|
2522
2522
|
*/
|
|
2523
|
-
approximateSecondsBeforeTimedOut?: number;
|
|
2523
|
+
approximateSecondsBeforeTimedOut?: number | undefined;
|
|
2524
2524
|
}
|
|
2525
2525
|
/**
|
|
2526
2526
|
* @public
|
|
@@ -2530,7 +2530,7 @@ export interface DescribeJobExecutionResponse {
|
|
|
2530
2530
|
* <p>Information about the job execution.</p>
|
|
2531
2531
|
* @public
|
|
2532
2532
|
*/
|
|
2533
|
-
execution?: JobExecution;
|
|
2533
|
+
execution?: JobExecution | undefined;
|
|
2534
2534
|
}
|
|
2535
2535
|
/**
|
|
2536
2536
|
* @public
|
|
@@ -2550,47 +2550,47 @@ export interface DescribeJobTemplateResponse {
|
|
|
2550
2550
|
* <p>The ARN of the job template.</p>
|
|
2551
2551
|
* @public
|
|
2552
2552
|
*/
|
|
2553
|
-
jobTemplateArn?: string;
|
|
2553
|
+
jobTemplateArn?: string | undefined;
|
|
2554
2554
|
/**
|
|
2555
2555
|
* <p>The unique identifier of the job template.</p>
|
|
2556
2556
|
* @public
|
|
2557
2557
|
*/
|
|
2558
|
-
jobTemplateId?: string;
|
|
2558
|
+
jobTemplateId?: string | undefined;
|
|
2559
2559
|
/**
|
|
2560
2560
|
* <p>A description of the job template.</p>
|
|
2561
2561
|
* @public
|
|
2562
2562
|
*/
|
|
2563
|
-
description?: string;
|
|
2563
|
+
description?: string | undefined;
|
|
2564
2564
|
/**
|
|
2565
2565
|
* <p>An S3 link to the job document.</p>
|
|
2566
2566
|
* @public
|
|
2567
2567
|
*/
|
|
2568
|
-
documentSource?: string;
|
|
2568
|
+
documentSource?: string | undefined;
|
|
2569
2569
|
/**
|
|
2570
2570
|
* <p>The job document.</p>
|
|
2571
2571
|
* @public
|
|
2572
2572
|
*/
|
|
2573
|
-
document?: string;
|
|
2573
|
+
document?: string | undefined;
|
|
2574
2574
|
/**
|
|
2575
2575
|
* <p>The time, in seconds since the epoch, when the job template was created.</p>
|
|
2576
2576
|
* @public
|
|
2577
2577
|
*/
|
|
2578
|
-
createdAt?: Date;
|
|
2578
|
+
createdAt?: Date | undefined;
|
|
2579
2579
|
/**
|
|
2580
2580
|
* <p>Configuration for pre-signed S3 URLs.</p>
|
|
2581
2581
|
* @public
|
|
2582
2582
|
*/
|
|
2583
|
-
presignedUrlConfig?: PresignedUrlConfig;
|
|
2583
|
+
presignedUrlConfig?: PresignedUrlConfig | undefined;
|
|
2584
2584
|
/**
|
|
2585
2585
|
* <p>Allows you to create a staged rollout of a job.</p>
|
|
2586
2586
|
* @public
|
|
2587
2587
|
*/
|
|
2588
|
-
jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
|
|
2588
|
+
jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig | undefined;
|
|
2589
2589
|
/**
|
|
2590
2590
|
* <p>The criteria that determine when and how a job abort takes place.</p>
|
|
2591
2591
|
* @public
|
|
2592
2592
|
*/
|
|
2593
|
-
abortConfig?: AbortConfig;
|
|
2593
|
+
abortConfig?: AbortConfig | undefined;
|
|
2594
2594
|
/**
|
|
2595
2595
|
* <p>Specifies the amount of time each device has to finish its execution of the job. A timer
|
|
2596
2596
|
* is started when the job execution status is set to <code>IN_PROGRESS</code>. If the job
|
|
@@ -2598,18 +2598,18 @@ export interface DescribeJobTemplateResponse {
|
|
|
2598
2598
|
* be automatically set to <code>TIMED_OUT</code>.</p>
|
|
2599
2599
|
* @public
|
|
2600
2600
|
*/
|
|
2601
|
-
timeoutConfig?: TimeoutConfig;
|
|
2601
|
+
timeoutConfig?: TimeoutConfig | undefined;
|
|
2602
2602
|
/**
|
|
2603
2603
|
* <p>The configuration that determines how many retries are allowed for each failure type
|
|
2604
2604
|
* for a job.</p>
|
|
2605
2605
|
* @public
|
|
2606
2606
|
*/
|
|
2607
|
-
jobExecutionsRetryConfig?: JobExecutionsRetryConfig;
|
|
2607
|
+
jobExecutionsRetryConfig?: JobExecutionsRetryConfig | undefined;
|
|
2608
2608
|
/**
|
|
2609
2609
|
* <p>Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.</p>
|
|
2610
2610
|
* @public
|
|
2611
2611
|
*/
|
|
2612
|
-
maintenanceWindows?: MaintenanceWindow[];
|
|
2612
|
+
maintenanceWindows?: MaintenanceWindow[] | undefined;
|
|
2613
2613
|
/**
|
|
2614
2614
|
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
|
|
2615
2615
|
* job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. 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>
|
|
@@ -2618,7 +2618,7 @@ export interface DescribeJobTemplateResponse {
|
|
|
2618
2618
|
* Up to 25 package version ARNs are allowed.</p>
|
|
2619
2619
|
* @public
|
|
2620
2620
|
*/
|
|
2621
|
-
destinationPackageVersions?: string[];
|
|
2621
|
+
destinationPackageVersions?: string[] | undefined;
|
|
2622
2622
|
}
|
|
2623
2623
|
/**
|
|
2624
2624
|
* @public
|
|
@@ -2634,7 +2634,7 @@ export interface DescribeManagedJobTemplateRequest {
|
|
|
2634
2634
|
* pre-defined default version is returned.</p>
|
|
2635
2635
|
* @public
|
|
2636
2636
|
*/
|
|
2637
|
-
templateVersion?: string;
|
|
2637
|
+
templateVersion?: string | undefined;
|
|
2638
2638
|
}
|
|
2639
2639
|
/**
|
|
2640
2640
|
* <p>A map of key-value pairs containing the patterns that need to be replaced in a managed
|
|
@@ -2654,31 +2654,31 @@ export interface DocumentParameter {
|
|
|
2654
2654
|
* template job document schema.</p>
|
|
2655
2655
|
* @public
|
|
2656
2656
|
*/
|
|
2657
|
-
key?: string;
|
|
2657
|
+
key?: string | undefined;
|
|
2658
2658
|
/**
|
|
2659
2659
|
* <p>Description of the map field containing the patterns that need to be replaced in a
|
|
2660
2660
|
* managed template job document schema.</p>
|
|
2661
2661
|
* @public
|
|
2662
2662
|
*/
|
|
2663
|
-
description?: string;
|
|
2663
|
+
description?: string | undefined;
|
|
2664
2664
|
/**
|
|
2665
2665
|
* <p>A regular expression of the patterns that need to be replaced in a managed template
|
|
2666
2666
|
* job document schema.</p>
|
|
2667
2667
|
* @public
|
|
2668
2668
|
*/
|
|
2669
|
-
regex?: string;
|
|
2669
|
+
regex?: string | undefined;
|
|
2670
2670
|
/**
|
|
2671
2671
|
* <p>An example illustrating a pattern that need to be replaced in a managed template
|
|
2672
2672
|
* job document schema.</p>
|
|
2673
2673
|
* @public
|
|
2674
2674
|
*/
|
|
2675
|
-
example?: string;
|
|
2675
|
+
example?: string | undefined;
|
|
2676
2676
|
/**
|
|
2677
2677
|
* <p>Specifies whether a pattern that needs to be replaced in a managed template job document
|
|
2678
2678
|
* schema is optional or required.</p>
|
|
2679
2679
|
* @public
|
|
2680
2680
|
*/
|
|
2681
|
-
optional?: boolean;
|
|
2681
|
+
optional?: boolean | undefined;
|
|
2682
2682
|
}
|
|
2683
2683
|
/**
|
|
2684
2684
|
* @public
|
|
@@ -2688,27 +2688,27 @@ export interface DescribeManagedJobTemplateResponse {
|
|
|
2688
2688
|
* <p>The unique name of a managed template, such as <code>AWS-Reboot</code>.</p>
|
|
2689
2689
|
* @public
|
|
2690
2690
|
*/
|
|
2691
|
-
templateName?: string;
|
|
2691
|
+
templateName?: string | undefined;
|
|
2692
2692
|
/**
|
|
2693
2693
|
* <p>The unique Amazon Resource Name (ARN) of the managed template.</p>
|
|
2694
2694
|
* @public
|
|
2695
2695
|
*/
|
|
2696
|
-
templateArn?: string;
|
|
2696
|
+
templateArn?: string | undefined;
|
|
2697
2697
|
/**
|
|
2698
2698
|
* <p>The unique description of a managed template.</p>
|
|
2699
2699
|
* @public
|
|
2700
2700
|
*/
|
|
2701
|
-
description?: string;
|
|
2701
|
+
description?: string | undefined;
|
|
2702
2702
|
/**
|
|
2703
2703
|
* <p>The version for a managed template.</p>
|
|
2704
2704
|
* @public
|
|
2705
2705
|
*/
|
|
2706
|
-
templateVersion?: string;
|
|
2706
|
+
templateVersion?: string | undefined;
|
|
2707
2707
|
/**
|
|
2708
2708
|
* <p>A list of environments that are supported with the managed job template.</p>
|
|
2709
2709
|
* @public
|
|
2710
2710
|
*/
|
|
2711
|
-
environments?: string[];
|
|
2711
|
+
environments?: string[] | undefined;
|
|
2712
2712
|
/**
|
|
2713
2713
|
* <p>A map of key-value pairs that you can use as guidance to specify the inputs for creating
|
|
2714
2714
|
* a job from a managed template.</p>
|
|
@@ -2720,12 +2720,12 @@ export interface DescribeManagedJobTemplateResponse {
|
|
|
2720
2720
|
* </note>
|
|
2721
2721
|
* @public
|
|
2722
2722
|
*/
|
|
2723
|
-
documentParameters?: DocumentParameter[];
|
|
2723
|
+
documentParameters?: DocumentParameter[] | undefined;
|
|
2724
2724
|
/**
|
|
2725
2725
|
* <p>The document schema for a managed job template.</p>
|
|
2726
2726
|
* @public
|
|
2727
2727
|
*/
|
|
2728
|
-
document?: string;
|
|
2728
|
+
document?: string | undefined;
|
|
2729
2729
|
}
|
|
2730
2730
|
/**
|
|
2731
2731
|
* @public
|
|
@@ -2761,42 +2761,42 @@ export interface DescribeMitigationActionResponse {
|
|
|
2761
2761
|
* <p>The friendly name that uniquely identifies the mitigation action.</p>
|
|
2762
2762
|
* @public
|
|
2763
2763
|
*/
|
|
2764
|
-
actionName?: string;
|
|
2764
|
+
actionName?: string | undefined;
|
|
2765
2765
|
/**
|
|
2766
2766
|
* <p>The type of mitigation action.</p>
|
|
2767
2767
|
* @public
|
|
2768
2768
|
*/
|
|
2769
|
-
actionType?: MitigationActionType;
|
|
2769
|
+
actionType?: MitigationActionType | undefined;
|
|
2770
2770
|
/**
|
|
2771
2771
|
* <p>The ARN that identifies this migration action.</p>
|
|
2772
2772
|
* @public
|
|
2773
2773
|
*/
|
|
2774
|
-
actionArn?: string;
|
|
2774
|
+
actionArn?: string | undefined;
|
|
2775
2775
|
/**
|
|
2776
2776
|
* <p>A unique identifier for this action.</p>
|
|
2777
2777
|
* @public
|
|
2778
2778
|
*/
|
|
2779
|
-
actionId?: string;
|
|
2779
|
+
actionId?: string | undefined;
|
|
2780
2780
|
/**
|
|
2781
2781
|
* <p>The ARN of the IAM role used to apply this action.</p>
|
|
2782
2782
|
* @public
|
|
2783
2783
|
*/
|
|
2784
|
-
roleArn?: string;
|
|
2784
|
+
roleArn?: string | undefined;
|
|
2785
2785
|
/**
|
|
2786
2786
|
* <p>Parameters that control how the mitigation action is applied, specific to the type of mitigation action.</p>
|
|
2787
2787
|
* @public
|
|
2788
2788
|
*/
|
|
2789
|
-
actionParams?: MitigationActionParams;
|
|
2789
|
+
actionParams?: MitigationActionParams | undefined;
|
|
2790
2790
|
/**
|
|
2791
2791
|
* <p>The date and time when the mitigation action was added to your Amazon Web Services accounts.</p>
|
|
2792
2792
|
* @public
|
|
2793
2793
|
*/
|
|
2794
|
-
creationDate?: Date;
|
|
2794
|
+
creationDate?: Date | undefined;
|
|
2795
2795
|
/**
|
|
2796
2796
|
* <p>The date and time when the mitigation action was last changed.</p>
|
|
2797
2797
|
* @public
|
|
2798
2798
|
*/
|
|
2799
|
-
lastModifiedDate?: Date;
|
|
2799
|
+
lastModifiedDate?: Date | undefined;
|
|
2800
2800
|
}
|
|
2801
2801
|
/**
|
|
2802
2802
|
* @public
|
|
@@ -2816,53 +2816,53 @@ export interface DescribeProvisioningTemplateResponse {
|
|
|
2816
2816
|
* <p>The ARN of the provisioning template.</p>
|
|
2817
2817
|
* @public
|
|
2818
2818
|
*/
|
|
2819
|
-
templateArn?: string;
|
|
2819
|
+
templateArn?: string | undefined;
|
|
2820
2820
|
/**
|
|
2821
2821
|
* <p>The name of the provisioning template.</p>
|
|
2822
2822
|
* @public
|
|
2823
2823
|
*/
|
|
2824
|
-
templateName?: string;
|
|
2824
|
+
templateName?: string | undefined;
|
|
2825
2825
|
/**
|
|
2826
2826
|
* <p>The description of the provisioning template.</p>
|
|
2827
2827
|
* @public
|
|
2828
2828
|
*/
|
|
2829
|
-
description?: string;
|
|
2829
|
+
description?: string | undefined;
|
|
2830
2830
|
/**
|
|
2831
2831
|
* <p>The date when the provisioning template was created.</p>
|
|
2832
2832
|
* @public
|
|
2833
2833
|
*/
|
|
2834
|
-
creationDate?: Date;
|
|
2834
|
+
creationDate?: Date | undefined;
|
|
2835
2835
|
/**
|
|
2836
2836
|
* <p>The date when the provisioning template was last modified.</p>
|
|
2837
2837
|
* @public
|
|
2838
2838
|
*/
|
|
2839
|
-
lastModifiedDate?: Date;
|
|
2839
|
+
lastModifiedDate?: Date | undefined;
|
|
2840
2840
|
/**
|
|
2841
2841
|
* <p>The default fleet template version ID.</p>
|
|
2842
2842
|
* @public
|
|
2843
2843
|
*/
|
|
2844
|
-
defaultVersionId?: number;
|
|
2844
|
+
defaultVersionId?: number | undefined;
|
|
2845
2845
|
/**
|
|
2846
2846
|
* <p>The JSON formatted contents of the provisioning template.</p>
|
|
2847
2847
|
* @public
|
|
2848
2848
|
*/
|
|
2849
|
-
templateBody?: string;
|
|
2849
|
+
templateBody?: string | undefined;
|
|
2850
2850
|
/**
|
|
2851
2851
|
* <p>True if the provisioning template is enabled, otherwise false.</p>
|
|
2852
2852
|
* @public
|
|
2853
2853
|
*/
|
|
2854
|
-
enabled?: boolean;
|
|
2854
|
+
enabled?: boolean | undefined;
|
|
2855
2855
|
/**
|
|
2856
2856
|
* <p>The ARN of the role associated with the provisioning template. This IoT role grants
|
|
2857
2857
|
* permission to provision a device.</p>
|
|
2858
2858
|
* @public
|
|
2859
2859
|
*/
|
|
2860
|
-
provisioningRoleArn?: string;
|
|
2860
|
+
provisioningRoleArn?: string | undefined;
|
|
2861
2861
|
/**
|
|
2862
2862
|
* <p>Gets information about a pre-provisioned hook.</p>
|
|
2863
2863
|
* @public
|
|
2864
2864
|
*/
|
|
2865
|
-
preProvisioningHook?: ProvisioningHook;
|
|
2865
|
+
preProvisioningHook?: ProvisioningHook | undefined;
|
|
2866
2866
|
/**
|
|
2867
2867
|
* <p>The type you define in a provisioning template. You can create a template with only one type.
|
|
2868
2868
|
* You can't change the template type after its creation. The default value is <code>FLEET_PROVISIONING</code>.
|
|
@@ -2870,7 +2870,7 @@ export interface DescribeProvisioningTemplateResponse {
|
|
|
2870
2870
|
* </p>
|
|
2871
2871
|
* @public
|
|
2872
2872
|
*/
|
|
2873
|
-
type?: TemplateType;
|
|
2873
|
+
type?: TemplateType | undefined;
|
|
2874
2874
|
}
|
|
2875
2875
|
/**
|
|
2876
2876
|
* @public
|
|
@@ -2895,22 +2895,22 @@ export interface DescribeProvisioningTemplateVersionResponse {
|
|
|
2895
2895
|
* <p>The provisioning template version ID.</p>
|
|
2896
2896
|
* @public
|
|
2897
2897
|
*/
|
|
2898
|
-
versionId?: number;
|
|
2898
|
+
versionId?: number | undefined;
|
|
2899
2899
|
/**
|
|
2900
2900
|
* <p>The date when the provisioning template version was created.</p>
|
|
2901
2901
|
* @public
|
|
2902
2902
|
*/
|
|
2903
|
-
creationDate?: Date;
|
|
2903
|
+
creationDate?: Date | undefined;
|
|
2904
2904
|
/**
|
|
2905
2905
|
* <p>The JSON formatted contents of the provisioning template version.</p>
|
|
2906
2906
|
* @public
|
|
2907
2907
|
*/
|
|
2908
|
-
templateBody?: string;
|
|
2908
|
+
templateBody?: string | undefined;
|
|
2909
2909
|
/**
|
|
2910
2910
|
* <p>True if the provisioning template version is the default version.</p>
|
|
2911
2911
|
* @public
|
|
2912
2912
|
*/
|
|
2913
|
-
isDefaultVersion?: boolean;
|
|
2913
|
+
isDefaultVersion?: boolean | undefined;
|
|
2914
2914
|
}
|
|
2915
2915
|
/**
|
|
2916
2916
|
* @public
|
|
@@ -2931,37 +2931,37 @@ export interface RoleAliasDescription {
|
|
|
2931
2931
|
* <p>The role alias.</p>
|
|
2932
2932
|
* @public
|
|
2933
2933
|
*/
|
|
2934
|
-
roleAlias?: string;
|
|
2934
|
+
roleAlias?: string | undefined;
|
|
2935
2935
|
/**
|
|
2936
2936
|
* <p>The ARN of the role alias.</p>
|
|
2937
2937
|
* @public
|
|
2938
2938
|
*/
|
|
2939
|
-
roleAliasArn?: string;
|
|
2939
|
+
roleAliasArn?: string | undefined;
|
|
2940
2940
|
/**
|
|
2941
2941
|
* <p>The role ARN.</p>
|
|
2942
2942
|
* @public
|
|
2943
2943
|
*/
|
|
2944
|
-
roleArn?: string;
|
|
2944
|
+
roleArn?: string | undefined;
|
|
2945
2945
|
/**
|
|
2946
2946
|
* <p>The role alias owner.</p>
|
|
2947
2947
|
* @public
|
|
2948
2948
|
*/
|
|
2949
|
-
owner?: string;
|
|
2949
|
+
owner?: string | undefined;
|
|
2950
2950
|
/**
|
|
2951
2951
|
* <p>The number of seconds for which the credential is valid.</p>
|
|
2952
2952
|
* @public
|
|
2953
2953
|
*/
|
|
2954
|
-
credentialDurationSeconds?: number;
|
|
2954
|
+
credentialDurationSeconds?: number | undefined;
|
|
2955
2955
|
/**
|
|
2956
2956
|
* <p>The UNIX timestamp of when the role alias was created.</p>
|
|
2957
2957
|
* @public
|
|
2958
2958
|
*/
|
|
2959
|
-
creationDate?: Date;
|
|
2959
|
+
creationDate?: Date | undefined;
|
|
2960
2960
|
/**
|
|
2961
2961
|
* <p>The UNIX timestamp of when the role alias was last modified.</p>
|
|
2962
2962
|
* @public
|
|
2963
2963
|
*/
|
|
2964
|
-
lastModifiedDate?: Date;
|
|
2964
|
+
lastModifiedDate?: Date | undefined;
|
|
2965
2965
|
}
|
|
2966
2966
|
/**
|
|
2967
2967
|
* @public
|
|
@@ -2971,7 +2971,7 @@ export interface DescribeRoleAliasResponse {
|
|
|
2971
2971
|
* <p>The role alias description.</p>
|
|
2972
2972
|
* @public
|
|
2973
2973
|
*/
|
|
2974
|
-
roleAliasDescription?: RoleAliasDescription;
|
|
2974
|
+
roleAliasDescription?: RoleAliasDescription | undefined;
|
|
2975
2975
|
}
|
|
2976
2976
|
/**
|
|
2977
2977
|
* @public
|
|
@@ -2995,7 +2995,7 @@ export interface DescribeScheduledAuditResponse {
|
|
|
2995
2995
|
* system.</p>
|
|
2996
2996
|
* @public
|
|
2997
2997
|
*/
|
|
2998
|
-
frequency?: AuditFrequency;
|
|
2998
|
+
frequency?: AuditFrequency | undefined;
|
|
2999
2999
|
/**
|
|
3000
3000
|
* <p>The day of the month on which the scheduled audit takes place.
|
|
3001
3001
|
* This is
|
|
@@ -3006,7 +3006,7 @@ export interface DescribeScheduledAuditResponse {
|
|
|
3006
3006
|
* day of the month.</p>
|
|
3007
3007
|
* @public
|
|
3008
3008
|
*/
|
|
3009
|
-
dayOfMonth?: string;
|
|
3009
|
+
dayOfMonth?: string | undefined;
|
|
3010
3010
|
/**
|
|
3011
3011
|
* <p>The day of the week on which the scheduled audit takes
|
|
3012
3012
|
* place,
|
|
@@ -3014,7 +3014,7 @@ export interface DescribeScheduledAuditResponse {
|
|
|
3014
3014
|
* <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>.</p>
|
|
3015
3015
|
* @public
|
|
3016
3016
|
*/
|
|
3017
|
-
dayOfWeek?: DayOfWeek;
|
|
3017
|
+
dayOfWeek?: DayOfWeek | undefined;
|
|
3018
3018
|
/**
|
|
3019
3019
|
* <p>Which checks are performed during the scheduled audit. Checks must be
|
|
3020
3020
|
* enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
|
|
@@ -3022,17 +3022,17 @@ export interface DescribeScheduledAuditResponse {
|
|
|
3022
3022
|
* to select which checks are enabled.)</p>
|
|
3023
3023
|
* @public
|
|
3024
3024
|
*/
|
|
3025
|
-
targetCheckNames?: string[];
|
|
3025
|
+
targetCheckNames?: string[] | undefined;
|
|
3026
3026
|
/**
|
|
3027
3027
|
* <p>The name of the scheduled audit.</p>
|
|
3028
3028
|
* @public
|
|
3029
3029
|
*/
|
|
3030
|
-
scheduledAuditName?: string;
|
|
3030
|
+
scheduledAuditName?: string | undefined;
|
|
3031
3031
|
/**
|
|
3032
3032
|
* <p>The ARN of the scheduled audit.</p>
|
|
3033
3033
|
* @public
|
|
3034
3034
|
*/
|
|
3035
|
-
scheduledAuditArn?: string;
|
|
3035
|
+
scheduledAuditArn?: string | undefined;
|
|
3036
3036
|
}
|
|
3037
3037
|
/**
|
|
3038
3038
|
* @public
|
|
@@ -3053,28 +3053,28 @@ export interface DescribeSecurityProfileResponse {
|
|
|
3053
3053
|
* <p>The name of the security profile.</p>
|
|
3054
3054
|
* @public
|
|
3055
3055
|
*/
|
|
3056
|
-
securityProfileName?: string;
|
|
3056
|
+
securityProfileName?: string | undefined;
|
|
3057
3057
|
/**
|
|
3058
3058
|
* <p>The ARN of the security profile.</p>
|
|
3059
3059
|
* @public
|
|
3060
3060
|
*/
|
|
3061
|
-
securityProfileArn?: string;
|
|
3061
|
+
securityProfileArn?: string | undefined;
|
|
3062
3062
|
/**
|
|
3063
3063
|
* <p>A description of the security profile (associated with the security profile
|
|
3064
3064
|
* when it was created or updated).</p>
|
|
3065
3065
|
* @public
|
|
3066
3066
|
*/
|
|
3067
|
-
securityProfileDescription?: string;
|
|
3067
|
+
securityProfileDescription?: string | undefined;
|
|
3068
3068
|
/**
|
|
3069
3069
|
* <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
|
|
3070
3070
|
* @public
|
|
3071
3071
|
*/
|
|
3072
|
-
behaviors?: Behavior[];
|
|
3072
|
+
behaviors?: Behavior[] | undefined;
|
|
3073
3073
|
/**
|
|
3074
3074
|
* <p>Where the alerts are sent. (Alerts are always sent to the console.)</p>
|
|
3075
3075
|
* @public
|
|
3076
3076
|
*/
|
|
3077
|
-
alertTargets?: Partial<Record<AlertTargetType, AlertTarget
|
|
3077
|
+
alertTargets?: Partial<Record<AlertTargetType, AlertTarget>> | undefined;
|
|
3078
3078
|
/**
|
|
3079
3079
|
* @deprecated
|
|
3080
3080
|
*
|
|
@@ -3090,7 +3090,7 @@ export interface DescribeSecurityProfileResponse {
|
|
|
3090
3090
|
* also retained for any metric specified here.</p>
|
|
3091
3091
|
* @public
|
|
3092
3092
|
*/
|
|
3093
|
-
additionalMetricsToRetain?: string[];
|
|
3093
|
+
additionalMetricsToRetain?: string[] | undefined;
|
|
3094
3094
|
/**
|
|
3095
3095
|
* <p>A list of metrics whose data is retained (stored). By default, data is retained for any
|
|
3096
3096
|
* metric used in the profile's behaviors, but
|
|
@@ -3098,28 +3098,28 @@ export interface DescribeSecurityProfileResponse {
|
|
|
3098
3098
|
* also retained for any metric specified here.</p>
|
|
3099
3099
|
* @public
|
|
3100
3100
|
*/
|
|
3101
|
-
additionalMetricsToRetainV2?: MetricToRetain[];
|
|
3101
|
+
additionalMetricsToRetainV2?: MetricToRetain[] | undefined;
|
|
3102
3102
|
/**
|
|
3103
3103
|
* <p>The version of the security profile. A new version is generated whenever the
|
|
3104
3104
|
* security profile is updated.</p>
|
|
3105
3105
|
* @public
|
|
3106
3106
|
*/
|
|
3107
|
-
version?: number;
|
|
3107
|
+
version?: number | undefined;
|
|
3108
3108
|
/**
|
|
3109
3109
|
* <p>The time the security profile was created.</p>
|
|
3110
3110
|
* @public
|
|
3111
3111
|
*/
|
|
3112
|
-
creationDate?: Date;
|
|
3112
|
+
creationDate?: Date | undefined;
|
|
3113
3113
|
/**
|
|
3114
3114
|
* <p>The time the security profile was last modified.</p>
|
|
3115
3115
|
* @public
|
|
3116
3116
|
*/
|
|
3117
|
-
lastModifiedDate?: Date;
|
|
3117
|
+
lastModifiedDate?: Date | undefined;
|
|
3118
3118
|
/**
|
|
3119
3119
|
* <p>Specifies the MQTT topic and role ARN required for metric export.</p>
|
|
3120
3120
|
* @public
|
|
3121
3121
|
*/
|
|
3122
|
-
metricsExportConfig?: MetricsExportConfig;
|
|
3122
|
+
metricsExportConfig?: MetricsExportConfig | undefined;
|
|
3123
3123
|
}
|
|
3124
3124
|
/**
|
|
3125
3125
|
* @public
|
|
@@ -3140,42 +3140,42 @@ export interface StreamInfo {
|
|
|
3140
3140
|
* <p>The stream ID.</p>
|
|
3141
3141
|
* @public
|
|
3142
3142
|
*/
|
|
3143
|
-
streamId?: string;
|
|
3143
|
+
streamId?: string | undefined;
|
|
3144
3144
|
/**
|
|
3145
3145
|
* <p>The stream ARN.</p>
|
|
3146
3146
|
* @public
|
|
3147
3147
|
*/
|
|
3148
|
-
streamArn?: string;
|
|
3148
|
+
streamArn?: string | undefined;
|
|
3149
3149
|
/**
|
|
3150
3150
|
* <p>The stream version.</p>
|
|
3151
3151
|
* @public
|
|
3152
3152
|
*/
|
|
3153
|
-
streamVersion?: number;
|
|
3153
|
+
streamVersion?: number | undefined;
|
|
3154
3154
|
/**
|
|
3155
3155
|
* <p>The description of the stream.</p>
|
|
3156
3156
|
* @public
|
|
3157
3157
|
*/
|
|
3158
|
-
description?: string;
|
|
3158
|
+
description?: string | undefined;
|
|
3159
3159
|
/**
|
|
3160
3160
|
* <p>The files to stream.</p>
|
|
3161
3161
|
* @public
|
|
3162
3162
|
*/
|
|
3163
|
-
files?: StreamFile[];
|
|
3163
|
+
files?: StreamFile[] | undefined;
|
|
3164
3164
|
/**
|
|
3165
3165
|
* <p>The date when the stream was created.</p>
|
|
3166
3166
|
* @public
|
|
3167
3167
|
*/
|
|
3168
|
-
createdAt?: Date;
|
|
3168
|
+
createdAt?: Date | undefined;
|
|
3169
3169
|
/**
|
|
3170
3170
|
* <p>The date when the stream was last updated.</p>
|
|
3171
3171
|
* @public
|
|
3172
3172
|
*/
|
|
3173
|
-
lastUpdatedAt?: Date;
|
|
3173
|
+
lastUpdatedAt?: Date | undefined;
|
|
3174
3174
|
/**
|
|
3175
3175
|
* <p>An IAM role IoT assumes to access your S3 files.</p>
|
|
3176
3176
|
* @public
|
|
3177
3177
|
*/
|
|
3178
|
-
roleArn?: string;
|
|
3178
|
+
roleArn?: string | undefined;
|
|
3179
3179
|
}
|
|
3180
3180
|
/**
|
|
3181
3181
|
* @public
|
|
@@ -3185,7 +3185,7 @@ export interface DescribeStreamResponse {
|
|
|
3185
3185
|
* <p>Information about the stream.</p>
|
|
3186
3186
|
* @public
|
|
3187
3187
|
*/
|
|
3188
|
-
streamInfo?: StreamInfo;
|
|
3188
|
+
streamInfo?: StreamInfo | undefined;
|
|
3189
3189
|
}
|
|
3190
3190
|
/**
|
|
3191
3191
|
* <p>The input for the DescribeThing operation.</p>
|
|
@@ -3210,32 +3210,32 @@ export interface DescribeThingResponse {
|
|
|
3210
3210
|
* <p>This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.</p>
|
|
3211
3211
|
* @public
|
|
3212
3212
|
*/
|
|
3213
|
-
defaultClientId?: string;
|
|
3213
|
+
defaultClientId?: string | undefined;
|
|
3214
3214
|
/**
|
|
3215
3215
|
* <p>The name of the thing.</p>
|
|
3216
3216
|
* @public
|
|
3217
3217
|
*/
|
|
3218
|
-
thingName?: string;
|
|
3218
|
+
thingName?: string | undefined;
|
|
3219
3219
|
/**
|
|
3220
3220
|
* <p>The ID of the thing to describe.</p>
|
|
3221
3221
|
* @public
|
|
3222
3222
|
*/
|
|
3223
|
-
thingId?: string;
|
|
3223
|
+
thingId?: string | undefined;
|
|
3224
3224
|
/**
|
|
3225
3225
|
* <p>The ARN of the thing to describe.</p>
|
|
3226
3226
|
* @public
|
|
3227
3227
|
*/
|
|
3228
|
-
thingArn?: string;
|
|
3228
|
+
thingArn?: string | undefined;
|
|
3229
3229
|
/**
|
|
3230
3230
|
* <p>The thing type name.</p>
|
|
3231
3231
|
* @public
|
|
3232
3232
|
*/
|
|
3233
|
-
thingTypeName?: string;
|
|
3233
|
+
thingTypeName?: string | undefined;
|
|
3234
3234
|
/**
|
|
3235
3235
|
* <p>The thing attributes.</p>
|
|
3236
3236
|
* @public
|
|
3237
3237
|
*/
|
|
3238
|
-
attributes?: Record<string, string
|
|
3238
|
+
attributes?: Record<string, string> | undefined;
|
|
3239
3239
|
/**
|
|
3240
3240
|
* <p>The current version of the thing record in the registry.</p>
|
|
3241
3241
|
* <note>
|
|
@@ -3245,12 +3245,12 @@ export interface DescribeThingResponse {
|
|
|
3245
3245
|
* </note>
|
|
3246
3246
|
* @public
|
|
3247
3247
|
*/
|
|
3248
|
-
version?: number;
|
|
3248
|
+
version?: number | undefined;
|
|
3249
3249
|
/**
|
|
3250
3250
|
* <p>The name of the billing group the thing belongs to.</p>
|
|
3251
3251
|
* @public
|
|
3252
3252
|
*/
|
|
3253
|
-
billingGroupName?: string;
|
|
3253
|
+
billingGroupName?: string | undefined;
|
|
3254
3254
|
}
|
|
3255
3255
|
/**
|
|
3256
3256
|
* @public
|
|
@@ -3284,12 +3284,12 @@ export interface GroupNameAndArn {
|
|
|
3284
3284
|
* <p>The group name.</p>
|
|
3285
3285
|
* @public
|
|
3286
3286
|
*/
|
|
3287
|
-
groupName?: string;
|
|
3287
|
+
groupName?: string | undefined;
|
|
3288
3288
|
/**
|
|
3289
3289
|
* <p>The group ARN.</p>
|
|
3290
3290
|
* @public
|
|
3291
3291
|
*/
|
|
3292
|
-
groupArn?: string;
|
|
3292
|
+
groupArn?: string | undefined;
|
|
3293
3293
|
}
|
|
3294
3294
|
/**
|
|
3295
3295
|
* <p>Thing group metadata.</p>
|
|
@@ -3300,17 +3300,17 @@ export interface ThingGroupMetadata {
|
|
|
3300
3300
|
* <p>The parent thing group name.</p>
|
|
3301
3301
|
* @public
|
|
3302
3302
|
*/
|
|
3303
|
-
parentGroupName?: string;
|
|
3303
|
+
parentGroupName?: string | undefined;
|
|
3304
3304
|
/**
|
|
3305
3305
|
* <p>The root parent thing group.</p>
|
|
3306
3306
|
* @public
|
|
3307
3307
|
*/
|
|
3308
|
-
rootToParentThingGroups?: GroupNameAndArn[];
|
|
3308
|
+
rootToParentThingGroups?: GroupNameAndArn[] | undefined;
|
|
3309
3309
|
/**
|
|
3310
3310
|
* <p>The UNIX timestamp of when the thing group was created.</p>
|
|
3311
3311
|
* @public
|
|
3312
3312
|
*/
|
|
3313
|
-
creationDate?: Date;
|
|
3313
|
+
creationDate?: Date | undefined;
|
|
3314
3314
|
}
|
|
3315
3315
|
/**
|
|
3316
3316
|
* @public
|
|
@@ -3320,52 +3320,52 @@ export interface DescribeThingGroupResponse {
|
|
|
3320
3320
|
* <p>The name of the thing group.</p>
|
|
3321
3321
|
* @public
|
|
3322
3322
|
*/
|
|
3323
|
-
thingGroupName?: string;
|
|
3323
|
+
thingGroupName?: string | undefined;
|
|
3324
3324
|
/**
|
|
3325
3325
|
* <p>The thing group ID.</p>
|
|
3326
3326
|
* @public
|
|
3327
3327
|
*/
|
|
3328
|
-
thingGroupId?: string;
|
|
3328
|
+
thingGroupId?: string | undefined;
|
|
3329
3329
|
/**
|
|
3330
3330
|
* <p>The thing group ARN.</p>
|
|
3331
3331
|
* @public
|
|
3332
3332
|
*/
|
|
3333
|
-
thingGroupArn?: string;
|
|
3333
|
+
thingGroupArn?: string | undefined;
|
|
3334
3334
|
/**
|
|
3335
3335
|
* <p>The version of the thing group.</p>
|
|
3336
3336
|
* @public
|
|
3337
3337
|
*/
|
|
3338
|
-
version?: number;
|
|
3338
|
+
version?: number | undefined;
|
|
3339
3339
|
/**
|
|
3340
3340
|
* <p>The thing group properties.</p>
|
|
3341
3341
|
* @public
|
|
3342
3342
|
*/
|
|
3343
|
-
thingGroupProperties?: ThingGroupProperties;
|
|
3343
|
+
thingGroupProperties?: ThingGroupProperties | undefined;
|
|
3344
3344
|
/**
|
|
3345
3345
|
* <p>Thing group metadata.</p>
|
|
3346
3346
|
* @public
|
|
3347
3347
|
*/
|
|
3348
|
-
thingGroupMetadata?: ThingGroupMetadata;
|
|
3348
|
+
thingGroupMetadata?: ThingGroupMetadata | undefined;
|
|
3349
3349
|
/**
|
|
3350
3350
|
* <p>The dynamic thing group index name.</p>
|
|
3351
3351
|
* @public
|
|
3352
3352
|
*/
|
|
3353
|
-
indexName?: string;
|
|
3353
|
+
indexName?: string | undefined;
|
|
3354
3354
|
/**
|
|
3355
3355
|
* <p>The dynamic thing group search query string.</p>
|
|
3356
3356
|
* @public
|
|
3357
3357
|
*/
|
|
3358
|
-
queryString?: string;
|
|
3358
|
+
queryString?: string | undefined;
|
|
3359
3359
|
/**
|
|
3360
3360
|
* <p>The dynamic thing group query version.</p>
|
|
3361
3361
|
* @public
|
|
3362
3362
|
*/
|
|
3363
|
-
queryVersion?: string;
|
|
3363
|
+
queryVersion?: string | undefined;
|
|
3364
3364
|
/**
|
|
3365
3365
|
* <p>The dynamic thing group status.</p>
|
|
3366
3366
|
* @public
|
|
3367
3367
|
*/
|
|
3368
|
-
status?: DynamicGroupStatus;
|
|
3368
|
+
status?: DynamicGroupStatus | undefined;
|
|
3369
3369
|
}
|
|
3370
3370
|
/**
|
|
3371
3371
|
* @public
|
|
@@ -3400,62 +3400,62 @@ export interface DescribeThingRegistrationTaskResponse {
|
|
|
3400
3400
|
* <p>The task ID.</p>
|
|
3401
3401
|
* @public
|
|
3402
3402
|
*/
|
|
3403
|
-
taskId?: string;
|
|
3403
|
+
taskId?: string | undefined;
|
|
3404
3404
|
/**
|
|
3405
3405
|
* <p>The task creation date.</p>
|
|
3406
3406
|
* @public
|
|
3407
3407
|
*/
|
|
3408
|
-
creationDate?: Date;
|
|
3408
|
+
creationDate?: Date | undefined;
|
|
3409
3409
|
/**
|
|
3410
3410
|
* <p>The date when the task was last modified.</p>
|
|
3411
3411
|
* @public
|
|
3412
3412
|
*/
|
|
3413
|
-
lastModifiedDate?: Date;
|
|
3413
|
+
lastModifiedDate?: Date | undefined;
|
|
3414
3414
|
/**
|
|
3415
3415
|
* <p>The task's template.</p>
|
|
3416
3416
|
* @public
|
|
3417
3417
|
*/
|
|
3418
|
-
templateBody?: string;
|
|
3418
|
+
templateBody?: string | undefined;
|
|
3419
3419
|
/**
|
|
3420
3420
|
* <p>The S3 bucket that contains the input file.</p>
|
|
3421
3421
|
* @public
|
|
3422
3422
|
*/
|
|
3423
|
-
inputFileBucket?: string;
|
|
3423
|
+
inputFileBucket?: string | undefined;
|
|
3424
3424
|
/**
|
|
3425
3425
|
* <p>The input file key.</p>
|
|
3426
3426
|
* @public
|
|
3427
3427
|
*/
|
|
3428
|
-
inputFileKey?: string;
|
|
3428
|
+
inputFileKey?: string | undefined;
|
|
3429
3429
|
/**
|
|
3430
3430
|
* <p>The role ARN that grants access to the input file bucket.</p>
|
|
3431
3431
|
* @public
|
|
3432
3432
|
*/
|
|
3433
|
-
roleArn?: string;
|
|
3433
|
+
roleArn?: string | undefined;
|
|
3434
3434
|
/**
|
|
3435
3435
|
* <p>The status of the bulk thing provisioning task.</p>
|
|
3436
3436
|
* @public
|
|
3437
3437
|
*/
|
|
3438
|
-
status?: Status;
|
|
3438
|
+
status?: Status | undefined;
|
|
3439
3439
|
/**
|
|
3440
3440
|
* <p>The message.</p>
|
|
3441
3441
|
* @public
|
|
3442
3442
|
*/
|
|
3443
|
-
message?: string;
|
|
3443
|
+
message?: string | undefined;
|
|
3444
3444
|
/**
|
|
3445
3445
|
* <p>The number of things successfully provisioned.</p>
|
|
3446
3446
|
* @public
|
|
3447
3447
|
*/
|
|
3448
|
-
successCount?: number;
|
|
3448
|
+
successCount?: number | undefined;
|
|
3449
3449
|
/**
|
|
3450
3450
|
* <p>The number of things that failed to be provisioned.</p>
|
|
3451
3451
|
* @public
|
|
3452
3452
|
*/
|
|
3453
|
-
failureCount?: number;
|
|
3453
|
+
failureCount?: number | undefined;
|
|
3454
3454
|
/**
|
|
3455
3455
|
* <p>The progress of the bulk provisioning task expressed as a percentage.</p>
|
|
3456
3456
|
* @public
|
|
3457
3457
|
*/
|
|
3458
|
-
percentageProgress?: number;
|
|
3458
|
+
percentageProgress?: number | undefined;
|
|
3459
3459
|
}
|
|
3460
3460
|
/**
|
|
3461
3461
|
* <p>The input for the DescribeThingType operation.</p>
|
|
@@ -3480,17 +3480,17 @@ export interface ThingTypeMetadata {
|
|
|
3480
3480
|
* associated with this type.</p>
|
|
3481
3481
|
* @public
|
|
3482
3482
|
*/
|
|
3483
|
-
deprecated?: boolean;
|
|
3483
|
+
deprecated?: boolean | undefined;
|
|
3484
3484
|
/**
|
|
3485
3485
|
* <p>The date and time when the thing type was deprecated.</p>
|
|
3486
3486
|
* @public
|
|
3487
3487
|
*/
|
|
3488
|
-
deprecationDate?: Date;
|
|
3488
|
+
deprecationDate?: Date | undefined;
|
|
3489
3489
|
/**
|
|
3490
3490
|
* <p>The date and time when the thing type was created.</p>
|
|
3491
3491
|
* @public
|
|
3492
3492
|
*/
|
|
3493
|
-
creationDate?: Date;
|
|
3493
|
+
creationDate?: Date | undefined;
|
|
3494
3494
|
}
|
|
3495
3495
|
/**
|
|
3496
3496
|
* <p>The output for the DescribeThingType operation.</p>
|
|
@@ -3501,30 +3501,30 @@ export interface DescribeThingTypeResponse {
|
|
|
3501
3501
|
* <p>The name of the thing type.</p>
|
|
3502
3502
|
* @public
|
|
3503
3503
|
*/
|
|
3504
|
-
thingTypeName?: string;
|
|
3504
|
+
thingTypeName?: string | undefined;
|
|
3505
3505
|
/**
|
|
3506
3506
|
* <p>The thing type ID.</p>
|
|
3507
3507
|
* @public
|
|
3508
3508
|
*/
|
|
3509
|
-
thingTypeId?: string;
|
|
3509
|
+
thingTypeId?: string | undefined;
|
|
3510
3510
|
/**
|
|
3511
3511
|
* <p>The thing type ARN.</p>
|
|
3512
3512
|
* @public
|
|
3513
3513
|
*/
|
|
3514
|
-
thingTypeArn?: string;
|
|
3514
|
+
thingTypeArn?: string | undefined;
|
|
3515
3515
|
/**
|
|
3516
3516
|
* <p>The ThingTypeProperties contains information about the thing type including
|
|
3517
3517
|
* description, and a list of searchable thing attribute names.</p>
|
|
3518
3518
|
* @public
|
|
3519
3519
|
*/
|
|
3520
|
-
thingTypeProperties?: ThingTypeProperties;
|
|
3520
|
+
thingTypeProperties?: ThingTypeProperties | undefined;
|
|
3521
3521
|
/**
|
|
3522
3522
|
* <p>The ThingTypeMetadata contains additional information about the thing type
|
|
3523
3523
|
* including: creation date and time, a value indicating whether the thing type is
|
|
3524
3524
|
* deprecated, and a date and time when it was deprecated.</p>
|
|
3525
3525
|
* @public
|
|
3526
3526
|
*/
|
|
3527
|
-
thingTypeMetadata?: ThingTypeMetadata;
|
|
3527
|
+
thingTypeMetadata?: ThingTypeMetadata | undefined;
|
|
3528
3528
|
}
|
|
3529
3529
|
/**
|
|
3530
3530
|
* @public
|
|
@@ -3631,7 +3631,7 @@ export interface DisassociateSbomFromPackageVersionRequest {
|
|
|
3631
3631
|
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3632
3632
|
* @public
|
|
3633
3633
|
*/
|
|
3634
|
-
clientToken?: string;
|
|
3634
|
+
clientToken?: string | undefined;
|
|
3635
3635
|
}
|
|
3636
3636
|
/**
|
|
3637
3637
|
* @public
|
|
@@ -3659,21 +3659,21 @@ export interface GetBehaviorModelTrainingSummariesRequest {
|
|
|
3659
3659
|
* </p>
|
|
3660
3660
|
* @public
|
|
3661
3661
|
*/
|
|
3662
|
-
securityProfileName?: string;
|
|
3662
|
+
securityProfileName?: string | undefined;
|
|
3663
3663
|
/**
|
|
3664
3664
|
* <p>
|
|
3665
3665
|
* The maximum number of results to return at one time. The default is 10.
|
|
3666
3666
|
* </p>
|
|
3667
3667
|
* @public
|
|
3668
3668
|
*/
|
|
3669
|
-
maxResults?: number;
|
|
3669
|
+
maxResults?: number | undefined;
|
|
3670
3670
|
/**
|
|
3671
3671
|
* <p>
|
|
3672
3672
|
* The token for the next set of results.
|
|
3673
3673
|
* </p>
|
|
3674
3674
|
* @public
|
|
3675
3675
|
*/
|
|
3676
|
-
nextToken?: string;
|
|
3676
|
+
nextToken?: string | undefined;
|
|
3677
3677
|
}
|
|
3678
3678
|
/**
|
|
3679
3679
|
* @public
|
|
@@ -3701,42 +3701,42 @@ export interface BehaviorModelTrainingSummary {
|
|
|
3701
3701
|
* </p>
|
|
3702
3702
|
* @public
|
|
3703
3703
|
*/
|
|
3704
|
-
securityProfileName?: string;
|
|
3704
|
+
securityProfileName?: string | undefined;
|
|
3705
3705
|
/**
|
|
3706
3706
|
* <p>
|
|
3707
3707
|
* The name of the behavior.
|
|
3708
3708
|
* </p>
|
|
3709
3709
|
* @public
|
|
3710
3710
|
*/
|
|
3711
|
-
behaviorName?: string;
|
|
3711
|
+
behaviorName?: string | undefined;
|
|
3712
3712
|
/**
|
|
3713
3713
|
* <p>
|
|
3714
3714
|
* The date a training model started collecting data.
|
|
3715
3715
|
* </p>
|
|
3716
3716
|
* @public
|
|
3717
3717
|
*/
|
|
3718
|
-
trainingDataCollectionStartDate?: Date;
|
|
3718
|
+
trainingDataCollectionStartDate?: Date | undefined;
|
|
3719
3719
|
/**
|
|
3720
3720
|
* <p>
|
|
3721
3721
|
* The status of the behavior model.
|
|
3722
3722
|
* </p>
|
|
3723
3723
|
* @public
|
|
3724
3724
|
*/
|
|
3725
|
-
modelStatus?: ModelStatus;
|
|
3725
|
+
modelStatus?: ModelStatus | undefined;
|
|
3726
3726
|
/**
|
|
3727
3727
|
* <p>
|
|
3728
3728
|
* The percentage of datapoints collected.
|
|
3729
3729
|
* </p>
|
|
3730
3730
|
* @public
|
|
3731
3731
|
*/
|
|
3732
|
-
datapointsCollectionPercentage?: number;
|
|
3732
|
+
datapointsCollectionPercentage?: number | undefined;
|
|
3733
3733
|
/**
|
|
3734
3734
|
* <p>
|
|
3735
3735
|
* The date the model was last refreshed.
|
|
3736
3736
|
* </p>
|
|
3737
3737
|
* @public
|
|
3738
3738
|
*/
|
|
3739
|
-
lastModelRefreshDate?: Date;
|
|
3739
|
+
lastModelRefreshDate?: Date | undefined;
|
|
3740
3740
|
}
|
|
3741
3741
|
/**
|
|
3742
3742
|
* @public
|
|
@@ -3748,14 +3748,14 @@ export interface GetBehaviorModelTrainingSummariesResponse {
|
|
|
3748
3748
|
* </p>
|
|
3749
3749
|
* @public
|
|
3750
3750
|
*/
|
|
3751
|
-
summaries?: BehaviorModelTrainingSummary[];
|
|
3751
|
+
summaries?: BehaviorModelTrainingSummary[] | undefined;
|
|
3752
3752
|
/**
|
|
3753
3753
|
* <p>
|
|
3754
3754
|
* A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
|
|
3755
3755
|
* </p>
|
|
3756
3756
|
* @public
|
|
3757
3757
|
*/
|
|
3758
|
-
nextToken?: string;
|
|
3758
|
+
nextToken?: string | undefined;
|
|
3759
3759
|
}
|
|
3760
3760
|
/**
|
|
3761
3761
|
* <p>Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.</p>
|
|
@@ -3766,7 +3766,7 @@ export interface TermsAggregation {
|
|
|
3766
3766
|
* <p>The number of buckets to return in the response. Default to 10.</p>
|
|
3767
3767
|
* @public
|
|
3768
3768
|
*/
|
|
3769
|
-
maxBuckets?: number;
|
|
3769
|
+
maxBuckets?: number | undefined;
|
|
3770
3770
|
}
|
|
3771
3771
|
/**
|
|
3772
3772
|
* <p>The type of bucketed aggregation performed.</p>
|
|
@@ -3777,7 +3777,7 @@ export interface BucketsAggregationType {
|
|
|
3777
3777
|
* <p>Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.</p>
|
|
3778
3778
|
* @public
|
|
3779
3779
|
*/
|
|
3780
|
-
termsAggregation?: TermsAggregation;
|
|
3780
|
+
termsAggregation?: TermsAggregation | undefined;
|
|
3781
3781
|
}
|
|
3782
3782
|
/**
|
|
3783
3783
|
* @public
|
|
@@ -3787,7 +3787,7 @@ export interface GetBucketsAggregationRequest {
|
|
|
3787
3787
|
* <p>The name of the index to search.</p>
|
|
3788
3788
|
* @public
|
|
3789
3789
|
*/
|
|
3790
|
-
indexName?: string;
|
|
3790
|
+
indexName?: string | undefined;
|
|
3791
3791
|
/**
|
|
3792
3792
|
* <p>The search query string.</p>
|
|
3793
3793
|
* @public
|
|
@@ -3802,7 +3802,7 @@ export interface GetBucketsAggregationRequest {
|
|
|
3802
3802
|
* <p>The version of the query.</p>
|
|
3803
3803
|
* @public
|
|
3804
3804
|
*/
|
|
3805
|
-
queryVersion?: string;
|
|
3805
|
+
queryVersion?: string | undefined;
|
|
3806
3806
|
/**
|
|
3807
3807
|
* <p>The basic control of the response shape and the bucket aggregation type to perform. </p>
|
|
3808
3808
|
* @public
|
|
@@ -3818,12 +3818,12 @@ export interface Bucket {
|
|
|
3818
3818
|
* <p>The value counted for the particular bucket.</p>
|
|
3819
3819
|
* @public
|
|
3820
3820
|
*/
|
|
3821
|
-
keyValue?: string;
|
|
3821
|
+
keyValue?: string | undefined;
|
|
3822
3822
|
/**
|
|
3823
3823
|
* <p>The number of documents that have the value counted for the particular bucket.</p>
|
|
3824
3824
|
* @public
|
|
3825
3825
|
*/
|
|
3826
|
-
count?: number;
|
|
3826
|
+
count?: number | undefined;
|
|
3827
3827
|
}
|
|
3828
3828
|
/**
|
|
3829
3829
|
* @public
|
|
@@ -3833,7 +3833,7 @@ export interface GetBucketsAggregationResponse {
|
|
|
3833
3833
|
* <p>The total number of things that fit the query string criteria.</p>
|
|
3834
3834
|
* @public
|
|
3835
3835
|
*/
|
|
3836
|
-
totalCount?: number;
|
|
3836
|
+
totalCount?: number | undefined;
|
|
3837
3837
|
/**
|
|
3838
3838
|
* <p>The main part of the response with a list of buckets. Each bucket contains a <code>keyValue</code> and a <code>count</code>.</p>
|
|
3839
3839
|
* <p>
|
|
@@ -3842,7 +3842,7 @@ export interface GetBucketsAggregationResponse {
|
|
|
3842
3842
|
* <code>count</code>: The number of documents that have that value.</p>
|
|
3843
3843
|
* @public
|
|
3844
3844
|
*/
|
|
3845
|
-
buckets?: Bucket[];
|
|
3845
|
+
buckets?: Bucket[] | undefined;
|
|
3846
3846
|
}
|
|
3847
3847
|
/**
|
|
3848
3848
|
* @public
|
|
@@ -3852,7 +3852,7 @@ export interface GetCardinalityRequest {
|
|
|
3852
3852
|
* <p>The name of the index to search.</p>
|
|
3853
3853
|
* @public
|
|
3854
3854
|
*/
|
|
3855
|
-
indexName?: string;
|
|
3855
|
+
indexName?: string | undefined;
|
|
3856
3856
|
/**
|
|
3857
3857
|
* <p>The search query string.</p>
|
|
3858
3858
|
* @public
|
|
@@ -3862,12 +3862,12 @@ export interface GetCardinalityRequest {
|
|
|
3862
3862
|
* <p>The field to aggregate.</p>
|
|
3863
3863
|
* @public
|
|
3864
3864
|
*/
|
|
3865
|
-
aggregationField?: string;
|
|
3865
|
+
aggregationField?: string | undefined;
|
|
3866
3866
|
/**
|
|
3867
3867
|
* <p>The query version.</p>
|
|
3868
3868
|
* @public
|
|
3869
3869
|
*/
|
|
3870
|
-
queryVersion?: string;
|
|
3870
|
+
queryVersion?: string | undefined;
|
|
3871
3871
|
}
|
|
3872
3872
|
/**
|
|
3873
3873
|
* @public
|
|
@@ -3877,7 +3877,7 @@ export interface GetCardinalityResponse {
|
|
|
3877
3877
|
* <p>The approximate count of unique values that match the query.</p>
|
|
3878
3878
|
* @public
|
|
3879
3879
|
*/
|
|
3880
|
-
cardinality?: number;
|
|
3880
|
+
cardinality?: number | undefined;
|
|
3881
3881
|
}
|
|
3882
3882
|
/**
|
|
3883
3883
|
* @public
|
|
@@ -3887,17 +3887,17 @@ export interface GetEffectivePoliciesRequest {
|
|
|
3887
3887
|
* <p>The principal. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>), thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>) and CognitoId (<i>region</i>:<i>id</i>).</p>
|
|
3888
3888
|
* @public
|
|
3889
3889
|
*/
|
|
3890
|
-
principal?: string;
|
|
3890
|
+
principal?: string | undefined;
|
|
3891
3891
|
/**
|
|
3892
3892
|
* <p>The Cognito identity pool ID.</p>
|
|
3893
3893
|
* @public
|
|
3894
3894
|
*/
|
|
3895
|
-
cognitoIdentityPoolId?: string;
|
|
3895
|
+
cognitoIdentityPoolId?: string | undefined;
|
|
3896
3896
|
/**
|
|
3897
3897
|
* <p>The thing name.</p>
|
|
3898
3898
|
* @public
|
|
3899
3899
|
*/
|
|
3900
|
-
thingName?: string;
|
|
3900
|
+
thingName?: string | undefined;
|
|
3901
3901
|
}
|
|
3902
3902
|
/**
|
|
3903
3903
|
* <p>The policy that has the effect on the authorization results.</p>
|
|
@@ -3908,17 +3908,17 @@ export interface EffectivePolicy {
|
|
|
3908
3908
|
* <p>The policy name.</p>
|
|
3909
3909
|
* @public
|
|
3910
3910
|
*/
|
|
3911
|
-
policyName?: string;
|
|
3911
|
+
policyName?: string | undefined;
|
|
3912
3912
|
/**
|
|
3913
3913
|
* <p>The policy ARN.</p>
|
|
3914
3914
|
* @public
|
|
3915
3915
|
*/
|
|
3916
|
-
policyArn?: string;
|
|
3916
|
+
policyArn?: string | undefined;
|
|
3917
3917
|
/**
|
|
3918
3918
|
* <p>The IAM policy document.</p>
|
|
3919
3919
|
* @public
|
|
3920
3920
|
*/
|
|
3921
|
-
policyDocument?: string;
|
|
3921
|
+
policyDocument?: string | undefined;
|
|
3922
3922
|
}
|
|
3923
3923
|
/**
|
|
3924
3924
|
* @public
|
|
@@ -3928,7 +3928,7 @@ export interface GetEffectivePoliciesResponse {
|
|
|
3928
3928
|
* <p>The effective policies.</p>
|
|
3929
3929
|
* @public
|
|
3930
3930
|
*/
|
|
3931
|
-
effectivePolicies?: EffectivePolicy[];
|
|
3931
|
+
effectivePolicies?: EffectivePolicy[] | undefined;
|
|
3932
3932
|
}
|
|
3933
3933
|
/**
|
|
3934
3934
|
* @public
|
|
@@ -3957,12 +3957,12 @@ export interface Field {
|
|
|
3957
3957
|
* <p>The name of the field.</p>
|
|
3958
3958
|
* @public
|
|
3959
3959
|
*/
|
|
3960
|
-
name?: string;
|
|
3960
|
+
name?: string | undefined;
|
|
3961
3961
|
/**
|
|
3962
3962
|
* <p>The data type of the field.</p>
|
|
3963
3963
|
* @public
|
|
3964
3964
|
*/
|
|
3965
|
-
type?: FieldType;
|
|
3965
|
+
type?: FieldType | undefined;
|
|
3966
3966
|
}
|
|
3967
3967
|
/**
|
|
3968
3968
|
* @public
|
|
@@ -3994,14 +3994,14 @@ export interface ThingGroupIndexingConfiguration {
|
|
|
3994
3994
|
* </note>
|
|
3995
3995
|
* @public
|
|
3996
3996
|
*/
|
|
3997
|
-
managedFields?: Field[];
|
|
3997
|
+
managedFields?: Field[] | undefined;
|
|
3998
3998
|
/**
|
|
3999
3999
|
* <p>A list of thing group fields to index. This list cannot contain any managed fields. Use
|
|
4000
4000
|
* the GetIndexingConfiguration API to get a list of managed fields.</p>
|
|
4001
4001
|
* <p>Contains custom field names and their data type.</p>
|
|
4002
4002
|
* @public
|
|
4003
4003
|
*/
|
|
4004
|
-
customFields?: Field[];
|
|
4004
|
+
customFields?: Field[] | undefined;
|
|
4005
4005
|
}
|
|
4006
4006
|
/**
|
|
4007
4007
|
* @public
|
|
@@ -4039,13 +4039,13 @@ export interface GeoLocationTarget {
|
|
|
4039
4039
|
* named shadow, you must select the named shadow using the <code>namedShadow</code> filter.</p>
|
|
4040
4040
|
* @public
|
|
4041
4041
|
*/
|
|
4042
|
-
name?: string;
|
|
4042
|
+
name?: string | undefined;
|
|
4043
4043
|
/**
|
|
4044
4044
|
* <p>The <code>order</code> of the geolocation target field. This field is optional. The
|
|
4045
4045
|
* default value is <code>LatLon</code>.</p>
|
|
4046
4046
|
* @public
|
|
4047
4047
|
*/
|
|
4048
|
-
order?: TargetFieldOrder;
|
|
4048
|
+
order?: TargetFieldOrder | undefined;
|
|
4049
4049
|
}
|
|
4050
4050
|
/**
|
|
4051
4051
|
* <p>Provides additional selections for named shadows and geolocation data. </p>
|
|
@@ -4076,14 +4076,14 @@ export interface IndexingFilter {
|
|
|
4076
4076
|
* </p>
|
|
4077
4077
|
* @public
|
|
4078
4078
|
*/
|
|
4079
|
-
namedShadowNames?: string[];
|
|
4079
|
+
namedShadowNames?: string[] | undefined;
|
|
4080
4080
|
/**
|
|
4081
4081
|
* <p>The list of geolocation targets that you select to index. The default maximum number of
|
|
4082
4082
|
* geolocation targets for indexing is <code>1</code>. To increase the limit, see <a href="https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits">Amazon Web Services IoT Device
|
|
4083
4083
|
* Management Quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
4084
4084
|
* @public
|
|
4085
4085
|
*/
|
|
4086
|
-
geoLocations?: GeoLocationTarget[];
|
|
4086
|
+
geoLocations?: GeoLocationTarget[] | undefined;
|
|
4087
4087
|
}
|
|
4088
4088
|
/**
|
|
4089
4089
|
* @public
|
|
@@ -4158,7 +4158,7 @@ export interface ThingIndexingConfiguration {
|
|
|
4158
4158
|
* </ul>
|
|
4159
4159
|
* @public
|
|
4160
4160
|
*/
|
|
4161
|
-
thingConnectivityIndexingMode?: ThingConnectivityIndexingMode;
|
|
4161
|
+
thingConnectivityIndexingMode?: ThingConnectivityIndexingMode | undefined;
|
|
4162
4162
|
/**
|
|
4163
4163
|
* <p>Device Defender indexing mode. Valid values are:</p>
|
|
4164
4164
|
* <ul>
|
|
@@ -4175,7 +4175,7 @@ export interface ThingIndexingConfiguration {
|
|
|
4175
4175
|
* </p>
|
|
4176
4176
|
* @public
|
|
4177
4177
|
*/
|
|
4178
|
-
deviceDefenderIndexingMode?: DeviceDefenderIndexingMode;
|
|
4178
|
+
deviceDefenderIndexingMode?: DeviceDefenderIndexingMode | undefined;
|
|
4179
4179
|
/**
|
|
4180
4180
|
* <p>Named shadow indexing mode. Valid values are:</p>
|
|
4181
4181
|
* <ul>
|
|
@@ -4192,7 +4192,7 @@ export interface ThingIndexingConfiguration {
|
|
|
4192
4192
|
* </p>
|
|
4193
4193
|
* @public
|
|
4194
4194
|
*/
|
|
4195
|
-
namedShadowIndexingMode?: NamedShadowIndexingMode;
|
|
4195
|
+
namedShadowIndexingMode?: NamedShadowIndexingMode | undefined;
|
|
4196
4196
|
/**
|
|
4197
4197
|
* <p>Contains fields that are indexed and whose types are already known by the Fleet Indexing
|
|
4198
4198
|
* service. This is an optional field. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field">Managed fields</a> in the <i>Amazon Web Services IoT Core Developer Guide</i>.</p>
|
|
@@ -4201,12 +4201,12 @@ export interface ThingIndexingConfiguration {
|
|
|
4201
4201
|
* </note>
|
|
4202
4202
|
* @public
|
|
4203
4203
|
*/
|
|
4204
|
-
managedFields?: Field[];
|
|
4204
|
+
managedFields?: Field[] | undefined;
|
|
4205
4205
|
/**
|
|
4206
4206
|
* <p>Contains custom field names and their data type.</p>
|
|
4207
4207
|
* @public
|
|
4208
4208
|
*/
|
|
4209
|
-
customFields?: Field[];
|
|
4209
|
+
customFields?: Field[] | undefined;
|
|
4210
4210
|
/**
|
|
4211
4211
|
* <p>Provides additional selections for named shadows and geolocation data. </p>
|
|
4212
4212
|
* <p>To add named shadows to your fleet indexing configuration, set <code>namedShadowIndexingMode</code> to
|
|
@@ -4227,7 +4227,7 @@ export interface ThingIndexingConfiguration {
|
|
|
4227
4227
|
* </ul>
|
|
4228
4228
|
* @public
|
|
4229
4229
|
*/
|
|
4230
|
-
filter?: IndexingFilter;
|
|
4230
|
+
filter?: IndexingFilter | undefined;
|
|
4231
4231
|
}
|
|
4232
4232
|
/**
|
|
4233
4233
|
* @public
|
|
@@ -4237,12 +4237,12 @@ export interface GetIndexingConfigurationResponse {
|
|
|
4237
4237
|
* <p>Thing indexing configuration.</p>
|
|
4238
4238
|
* @public
|
|
4239
4239
|
*/
|
|
4240
|
-
thingIndexingConfiguration?: ThingIndexingConfiguration;
|
|
4240
|
+
thingIndexingConfiguration?: ThingIndexingConfiguration | undefined;
|
|
4241
4241
|
/**
|
|
4242
4242
|
* <p>The index configuration.</p>
|
|
4243
4243
|
* @public
|
|
4244
4244
|
*/
|
|
4245
|
-
thingGroupIndexingConfiguration?: ThingGroupIndexingConfiguration;
|
|
4245
|
+
thingGroupIndexingConfiguration?: ThingGroupIndexingConfiguration | undefined;
|
|
4246
4246
|
}
|
|
4247
4247
|
/**
|
|
4248
4248
|
* @public
|
|
@@ -4257,7 +4257,7 @@ export interface GetJobDocumentRequest {
|
|
|
4257
4257
|
* <p>A flag that provides a view of the job document before and after the substitution parameters have been resolved with their exact values.</p>
|
|
4258
4258
|
* @public
|
|
4259
4259
|
*/
|
|
4260
|
-
beforeSubstitution?: boolean;
|
|
4260
|
+
beforeSubstitution?: boolean | undefined;
|
|
4261
4261
|
}
|
|
4262
4262
|
/**
|
|
4263
4263
|
* @public
|
|
@@ -4267,7 +4267,7 @@ export interface GetJobDocumentResponse {
|
|
|
4267
4267
|
* <p>The job document content.</p>
|
|
4268
4268
|
* @public
|
|
4269
4269
|
*/
|
|
4270
|
-
document?: string;
|
|
4270
|
+
document?: string | undefined;
|
|
4271
4271
|
}
|
|
4272
4272
|
/**
|
|
4273
4273
|
* <p>The input for the GetLoggingOptions operation.</p>
|
|
@@ -4284,12 +4284,12 @@ export interface GetLoggingOptionsResponse {
|
|
|
4284
4284
|
* <p>The ARN of the IAM role that grants access.</p>
|
|
4285
4285
|
* @public
|
|
4286
4286
|
*/
|
|
4287
|
-
roleArn?: string;
|
|
4287
|
+
roleArn?: string | undefined;
|
|
4288
4288
|
/**
|
|
4289
4289
|
* <p>The logging level.</p>
|
|
4290
4290
|
* @public
|
|
4291
4291
|
*/
|
|
4292
|
-
logLevel?: LogLevel;
|
|
4292
|
+
logLevel?: LogLevel | undefined;
|
|
4293
4293
|
}
|
|
4294
4294
|
/**
|
|
4295
4295
|
* @public
|
|
@@ -4310,12 +4310,12 @@ export interface ErrorInfo {
|
|
|
4310
4310
|
* <p>The error code.</p>
|
|
4311
4311
|
* @public
|
|
4312
4312
|
*/
|
|
4313
|
-
code?: string;
|
|
4313
|
+
code?: string | undefined;
|
|
4314
4314
|
/**
|
|
4315
4315
|
* <p>The error message.</p>
|
|
4316
4316
|
* @public
|
|
4317
4317
|
*/
|
|
4318
|
-
message?: string;
|
|
4318
|
+
message?: string | undefined;
|
|
4319
4319
|
}
|
|
4320
4320
|
/**
|
|
4321
4321
|
* <p>Information about an OTA update.</p>
|
|
@@ -4326,49 +4326,49 @@ export interface OTAUpdateInfo {
|
|
|
4326
4326
|
* <p>The OTA update ID.</p>
|
|
4327
4327
|
* @public
|
|
4328
4328
|
*/
|
|
4329
|
-
otaUpdateId?: string;
|
|
4329
|
+
otaUpdateId?: string | undefined;
|
|
4330
4330
|
/**
|
|
4331
4331
|
* <p>The OTA update ARN.</p>
|
|
4332
4332
|
* @public
|
|
4333
4333
|
*/
|
|
4334
|
-
otaUpdateArn?: string;
|
|
4334
|
+
otaUpdateArn?: string | undefined;
|
|
4335
4335
|
/**
|
|
4336
4336
|
* <p>The date when the OTA update was created.</p>
|
|
4337
4337
|
* @public
|
|
4338
4338
|
*/
|
|
4339
|
-
creationDate?: Date;
|
|
4339
|
+
creationDate?: Date | undefined;
|
|
4340
4340
|
/**
|
|
4341
4341
|
* <p>The date when the OTA update was last updated.</p>
|
|
4342
4342
|
* @public
|
|
4343
4343
|
*/
|
|
4344
|
-
lastModifiedDate?: Date;
|
|
4344
|
+
lastModifiedDate?: Date | undefined;
|
|
4345
4345
|
/**
|
|
4346
4346
|
* <p>A description of the OTA update.</p>
|
|
4347
4347
|
* @public
|
|
4348
4348
|
*/
|
|
4349
|
-
description?: string;
|
|
4349
|
+
description?: string | undefined;
|
|
4350
4350
|
/**
|
|
4351
4351
|
* <p>The targets of the OTA update.</p>
|
|
4352
4352
|
* @public
|
|
4353
4353
|
*/
|
|
4354
|
-
targets?: string[];
|
|
4354
|
+
targets?: string[] | undefined;
|
|
4355
4355
|
/**
|
|
4356
4356
|
* <p>The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both
|
|
4357
4357
|
* HTTP and MQTT are specified, the target device can choose the protocol.</p>
|
|
4358
4358
|
* @public
|
|
4359
4359
|
*/
|
|
4360
|
-
protocols?: Protocol[];
|
|
4360
|
+
protocols?: Protocol[] | undefined;
|
|
4361
4361
|
/**
|
|
4362
4362
|
* <p>Configuration for the rollout of OTA updates.</p>
|
|
4363
4363
|
* @public
|
|
4364
4364
|
*/
|
|
4365
|
-
awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig;
|
|
4365
|
+
awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig | undefined;
|
|
4366
4366
|
/**
|
|
4367
4367
|
* <p>Configuration information for pre-signed URLs. Valid when <code>protocols</code>
|
|
4368
4368
|
* contains HTTP.</p>
|
|
4369
4369
|
* @public
|
|
4370
4370
|
*/
|
|
4371
|
-
awsJobPresignedUrlConfig?: AwsJobPresignedUrlConfig;
|
|
4371
|
+
awsJobPresignedUrlConfig?: AwsJobPresignedUrlConfig | undefined;
|
|
4372
4372
|
/**
|
|
4373
4373
|
* <p>Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those
|
|
4374
4374
|
* things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also
|
|
@@ -4377,37 +4377,37 @@ export interface OTAUpdateInfo {
|
|
|
4377
4377
|
* the group. </p>
|
|
4378
4378
|
* @public
|
|
4379
4379
|
*/
|
|
4380
|
-
targetSelection?: TargetSelection;
|
|
4380
|
+
targetSelection?: TargetSelection | undefined;
|
|
4381
4381
|
/**
|
|
4382
4382
|
* <p>A list of files associated with the OTA update.</p>
|
|
4383
4383
|
* @public
|
|
4384
4384
|
*/
|
|
4385
|
-
otaUpdateFiles?: OTAUpdateFile[];
|
|
4385
|
+
otaUpdateFiles?: OTAUpdateFile[] | undefined;
|
|
4386
4386
|
/**
|
|
4387
4387
|
* <p>The status of the OTA update.</p>
|
|
4388
4388
|
* @public
|
|
4389
4389
|
*/
|
|
4390
|
-
otaUpdateStatus?: OTAUpdateStatus;
|
|
4390
|
+
otaUpdateStatus?: OTAUpdateStatus | undefined;
|
|
4391
4391
|
/**
|
|
4392
4392
|
* <p>The IoT job ID associated with the OTA update.</p>
|
|
4393
4393
|
* @public
|
|
4394
4394
|
*/
|
|
4395
|
-
awsIotJobId?: string;
|
|
4395
|
+
awsIotJobId?: string | undefined;
|
|
4396
4396
|
/**
|
|
4397
4397
|
* <p>The IoT job ARN associated with the OTA update.</p>
|
|
4398
4398
|
* @public
|
|
4399
4399
|
*/
|
|
4400
|
-
awsIotJobArn?: string;
|
|
4400
|
+
awsIotJobArn?: string | undefined;
|
|
4401
4401
|
/**
|
|
4402
4402
|
* <p>Error information associated with the OTA update.</p>
|
|
4403
4403
|
* @public
|
|
4404
4404
|
*/
|
|
4405
|
-
errorInfo?: ErrorInfo;
|
|
4405
|
+
errorInfo?: ErrorInfo | undefined;
|
|
4406
4406
|
/**
|
|
4407
4407
|
* <p>A collection of name/value pairs</p>
|
|
4408
4408
|
* @public
|
|
4409
4409
|
*/
|
|
4410
|
-
additionalParameters?: Record<string, string
|
|
4410
|
+
additionalParameters?: Record<string, string> | undefined;
|
|
4411
4411
|
}
|
|
4412
4412
|
/**
|
|
4413
4413
|
* @public
|
|
@@ -4417,7 +4417,7 @@ export interface GetOTAUpdateResponse {
|
|
|
4417
4417
|
* <p>The OTA update info.</p>
|
|
4418
4418
|
* @public
|
|
4419
4419
|
*/
|
|
4420
|
-
otaUpdateInfo?: OTAUpdateInfo;
|
|
4420
|
+
otaUpdateInfo?: OTAUpdateInfo | undefined;
|
|
4421
4421
|
}
|
|
4422
4422
|
/**
|
|
4423
4423
|
* @public
|
|
@@ -4437,32 +4437,32 @@ export interface GetPackageResponse {
|
|
|
4437
4437
|
* <p>The name of the software package.</p>
|
|
4438
4438
|
* @public
|
|
4439
4439
|
*/
|
|
4440
|
-
packageName?: string;
|
|
4440
|
+
packageName?: string | undefined;
|
|
4441
4441
|
/**
|
|
4442
4442
|
* <p>The ARN for the package.</p>
|
|
4443
4443
|
* @public
|
|
4444
4444
|
*/
|
|
4445
|
-
packageArn?: string;
|
|
4445
|
+
packageArn?: string | undefined;
|
|
4446
4446
|
/**
|
|
4447
4447
|
* <p>The package description.</p>
|
|
4448
4448
|
* @public
|
|
4449
4449
|
*/
|
|
4450
|
-
description?: string;
|
|
4450
|
+
description?: string | undefined;
|
|
4451
4451
|
/**
|
|
4452
4452
|
* <p>The name of the default package version.</p>
|
|
4453
4453
|
* @public
|
|
4454
4454
|
*/
|
|
4455
|
-
defaultVersionName?: string;
|
|
4455
|
+
defaultVersionName?: string | undefined;
|
|
4456
4456
|
/**
|
|
4457
4457
|
* <p>The date the package was created.</p>
|
|
4458
4458
|
* @public
|
|
4459
4459
|
*/
|
|
4460
|
-
creationDate?: Date;
|
|
4460
|
+
creationDate?: Date | undefined;
|
|
4461
4461
|
/**
|
|
4462
4462
|
* <p>The date when the package was last updated.</p>
|
|
4463
4463
|
* @public
|
|
4464
4464
|
*/
|
|
4465
|
-
lastModifiedDate?: Date;
|
|
4465
|
+
lastModifiedDate?: Date | undefined;
|
|
4466
4466
|
}
|
|
4467
4467
|
/**
|
|
4468
4468
|
* @public
|
|
@@ -4481,13 +4481,13 @@ export interface VersionUpdateByJobsConfig {
|
|
|
4481
4481
|
* <p>Indicates whether the Job is enabled or not.</p>
|
|
4482
4482
|
* @public
|
|
4483
4483
|
*/
|
|
4484
|
-
enabled?: boolean;
|
|
4484
|
+
enabled?: boolean | undefined;
|
|
4485
4485
|
/**
|
|
4486
4486
|
* <p>The Amazon Resource Name (ARN) of the role that grants permission to the IoT
|
|
4487
4487
|
* jobs service to update the reserved named shadow when the job successfully completes.</p>
|
|
4488
4488
|
* @public
|
|
4489
4489
|
*/
|
|
4490
|
-
roleArn?: string;
|
|
4490
|
+
roleArn?: string | undefined;
|
|
4491
4491
|
}
|
|
4492
4492
|
/**
|
|
4493
4493
|
* @public
|
|
@@ -4497,7 +4497,7 @@ export interface GetPackageConfigurationResponse {
|
|
|
4497
4497
|
* <p>The version that is associated to a specific job.</p>
|
|
4498
4498
|
* @public
|
|
4499
4499
|
*/
|
|
4500
|
-
versionUpdateByJobsConfig?: VersionUpdateByJobsConfig;
|
|
4500
|
+
versionUpdateByJobsConfig?: VersionUpdateByJobsConfig | undefined;
|
|
4501
4501
|
}
|
|
4502
4502
|
/**
|
|
4503
4503
|
* @public
|
|
@@ -4522,69 +4522,69 @@ export interface GetPackageVersionResponse {
|
|
|
4522
4522
|
* <p>The ARN for the package version.</p>
|
|
4523
4523
|
* @public
|
|
4524
4524
|
*/
|
|
4525
|
-
packageVersionArn?: string;
|
|
4525
|
+
packageVersionArn?: string | undefined;
|
|
4526
4526
|
/**
|
|
4527
4527
|
* <p>The name of the software package.</p>
|
|
4528
4528
|
* @public
|
|
4529
4529
|
*/
|
|
4530
|
-
packageName?: string;
|
|
4530
|
+
packageName?: string | undefined;
|
|
4531
4531
|
/**
|
|
4532
4532
|
* <p>The name of the package version.</p>
|
|
4533
4533
|
* @public
|
|
4534
4534
|
*/
|
|
4535
|
-
versionName?: string;
|
|
4535
|
+
versionName?: string | undefined;
|
|
4536
4536
|
/**
|
|
4537
4537
|
* <p>The package version description.</p>
|
|
4538
4538
|
* @public
|
|
4539
4539
|
*/
|
|
4540
|
-
description?: string;
|
|
4540
|
+
description?: string | undefined;
|
|
4541
4541
|
/**
|
|
4542
4542
|
* <p>Metadata that were added to the package version that can be used to define a package version’s configuration.</p>
|
|
4543
4543
|
* @public
|
|
4544
4544
|
*/
|
|
4545
|
-
attributes?: Record<string, string
|
|
4545
|
+
attributes?: Record<string, string> | undefined;
|
|
4546
4546
|
/**
|
|
4547
4547
|
* <p>The various components that make up a software package version.</p>
|
|
4548
4548
|
* @public
|
|
4549
4549
|
*/
|
|
4550
|
-
artifact?: PackageVersionArtifact;
|
|
4550
|
+
artifact?: PackageVersionArtifact | undefined;
|
|
4551
4551
|
/**
|
|
4552
4552
|
* <p>The status associated to 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>
|
|
4553
4553
|
* @public
|
|
4554
4554
|
*/
|
|
4555
|
-
status?: PackageVersionStatus;
|
|
4555
|
+
status?: PackageVersionStatus | undefined;
|
|
4556
4556
|
/**
|
|
4557
4557
|
* <p>Error reason for a package version failure during creation or update.</p>
|
|
4558
4558
|
* @public
|
|
4559
4559
|
*/
|
|
4560
|
-
errorReason?: string;
|
|
4560
|
+
errorReason?: string | undefined;
|
|
4561
4561
|
/**
|
|
4562
4562
|
* <p>The date when the package version was created.</p>
|
|
4563
4563
|
* @public
|
|
4564
4564
|
*/
|
|
4565
|
-
creationDate?: Date;
|
|
4565
|
+
creationDate?: Date | undefined;
|
|
4566
4566
|
/**
|
|
4567
4567
|
* <p>The date when the package version was last updated.</p>
|
|
4568
4568
|
* @public
|
|
4569
4569
|
*/
|
|
4570
|
-
lastModifiedDate?: Date;
|
|
4570
|
+
lastModifiedDate?: Date | undefined;
|
|
4571
4571
|
/**
|
|
4572
4572
|
* <p>The software bill of materials for a software package version.</p>
|
|
4573
4573
|
* @public
|
|
4574
4574
|
*/
|
|
4575
|
-
sbom?: Sbom;
|
|
4575
|
+
sbom?: Sbom | undefined;
|
|
4576
4576
|
/**
|
|
4577
4577
|
* <p>The status of the validation for a new software bill of materials added to a software
|
|
4578
4578
|
* package version.</p>
|
|
4579
4579
|
* @public
|
|
4580
4580
|
*/
|
|
4581
|
-
sbomValidationStatus?: SbomValidationStatus;
|
|
4581
|
+
sbomValidationStatus?: SbomValidationStatus | undefined;
|
|
4582
4582
|
/**
|
|
4583
4583
|
* <p>The inline job document associated with a software package version used for a quick job
|
|
4584
4584
|
* deployment.</p>
|
|
4585
4585
|
* @public
|
|
4586
4586
|
*/
|
|
4587
|
-
recipe?: string;
|
|
4587
|
+
recipe?: string | undefined;
|
|
4588
4588
|
}
|
|
4589
4589
|
/**
|
|
4590
4590
|
* @public
|
|
@@ -4594,7 +4594,7 @@ export interface GetPercentilesRequest {
|
|
|
4594
4594
|
* <p>The name of the index to search.</p>
|
|
4595
4595
|
* @public
|
|
4596
4596
|
*/
|
|
4597
|
-
indexName?: string;
|
|
4597
|
+
indexName?: string | undefined;
|
|
4598
4598
|
/**
|
|
4599
4599
|
* <p>The search query string.</p>
|
|
4600
4600
|
* @public
|
|
@@ -4604,17 +4604,17 @@ export interface GetPercentilesRequest {
|
|
|
4604
4604
|
* <p>The field to aggregate.</p>
|
|
4605
4605
|
* @public
|
|
4606
4606
|
*/
|
|
4607
|
-
aggregationField?: string;
|
|
4607
|
+
aggregationField?: string | undefined;
|
|
4608
4608
|
/**
|
|
4609
4609
|
* <p>The query version.</p>
|
|
4610
4610
|
* @public
|
|
4611
4611
|
*/
|
|
4612
|
-
queryVersion?: string;
|
|
4612
|
+
queryVersion?: string | undefined;
|
|
4613
4613
|
/**
|
|
4614
4614
|
* <p>The percentile groups returned.</p>
|
|
4615
4615
|
* @public
|
|
4616
4616
|
*/
|
|
4617
|
-
percents?: number[];
|
|
4617
|
+
percents?: number[] | undefined;
|
|
4618
4618
|
}
|
|
4619
4619
|
/**
|
|
4620
4620
|
* <p>Describes the percentile and percentile value.</p>
|
|
@@ -4625,12 +4625,12 @@ export interface PercentPair {
|
|
|
4625
4625
|
* <p>The percentile.</p>
|
|
4626
4626
|
* @public
|
|
4627
4627
|
*/
|
|
4628
|
-
percent?: number;
|
|
4628
|
+
percent?: number | undefined;
|
|
4629
4629
|
/**
|
|
4630
4630
|
* <p>The value of the percentile.</p>
|
|
4631
4631
|
* @public
|
|
4632
4632
|
*/
|
|
4633
|
-
value?: number;
|
|
4633
|
+
value?: number | undefined;
|
|
4634
4634
|
}
|
|
4635
4635
|
/**
|
|
4636
4636
|
* @public
|
|
@@ -4640,7 +4640,7 @@ export interface GetPercentilesResponse {
|
|
|
4640
4640
|
* <p>The percentile values of the aggregated fields.</p>
|
|
4641
4641
|
* @public
|
|
4642
4642
|
*/
|
|
4643
|
-
percentiles?: PercentPair[];
|
|
4643
|
+
percentiles?: PercentPair[] | undefined;
|
|
4644
4644
|
}
|
|
4645
4645
|
/**
|
|
4646
4646
|
* <p>The input for the GetPolicy operation.</p>
|
|
@@ -4662,37 +4662,37 @@ export interface GetPolicyResponse {
|
|
|
4662
4662
|
* <p>The policy name.</p>
|
|
4663
4663
|
* @public
|
|
4664
4664
|
*/
|
|
4665
|
-
policyName?: string;
|
|
4665
|
+
policyName?: string | undefined;
|
|
4666
4666
|
/**
|
|
4667
4667
|
* <p>The policy ARN.</p>
|
|
4668
4668
|
* @public
|
|
4669
4669
|
*/
|
|
4670
|
-
policyArn?: string;
|
|
4670
|
+
policyArn?: string | undefined;
|
|
4671
4671
|
/**
|
|
4672
4672
|
* <p>The JSON document that describes the policy.</p>
|
|
4673
4673
|
* @public
|
|
4674
4674
|
*/
|
|
4675
|
-
policyDocument?: string;
|
|
4675
|
+
policyDocument?: string | undefined;
|
|
4676
4676
|
/**
|
|
4677
4677
|
* <p>The default policy version ID.</p>
|
|
4678
4678
|
* @public
|
|
4679
4679
|
*/
|
|
4680
|
-
defaultVersionId?: string;
|
|
4680
|
+
defaultVersionId?: string | undefined;
|
|
4681
4681
|
/**
|
|
4682
4682
|
* <p>The date the policy was created.</p>
|
|
4683
4683
|
* @public
|
|
4684
4684
|
*/
|
|
4685
|
-
creationDate?: Date;
|
|
4685
|
+
creationDate?: Date | undefined;
|
|
4686
4686
|
/**
|
|
4687
4687
|
* <p>The date the policy was last modified.</p>
|
|
4688
4688
|
* @public
|
|
4689
4689
|
*/
|
|
4690
|
-
lastModifiedDate?: Date;
|
|
4690
|
+
lastModifiedDate?: Date | undefined;
|
|
4691
4691
|
/**
|
|
4692
4692
|
* <p>The generation ID of the policy.</p>
|
|
4693
4693
|
* @public
|
|
4694
4694
|
*/
|
|
4695
|
-
generationId?: string;
|
|
4695
|
+
generationId?: string | undefined;
|
|
4696
4696
|
}
|
|
4697
4697
|
/**
|
|
4698
4698
|
* <p>The input for the GetPolicyVersion operation.</p>
|
|
@@ -4719,42 +4719,42 @@ export interface GetPolicyVersionResponse {
|
|
|
4719
4719
|
* <p>The policy ARN.</p>
|
|
4720
4720
|
* @public
|
|
4721
4721
|
*/
|
|
4722
|
-
policyArn?: string;
|
|
4722
|
+
policyArn?: string | undefined;
|
|
4723
4723
|
/**
|
|
4724
4724
|
* <p>The policy name.</p>
|
|
4725
4725
|
* @public
|
|
4726
4726
|
*/
|
|
4727
|
-
policyName?: string;
|
|
4727
|
+
policyName?: string | undefined;
|
|
4728
4728
|
/**
|
|
4729
4729
|
* <p>The JSON document that describes the policy.</p>
|
|
4730
4730
|
* @public
|
|
4731
4731
|
*/
|
|
4732
|
-
policyDocument?: string;
|
|
4732
|
+
policyDocument?: string | undefined;
|
|
4733
4733
|
/**
|
|
4734
4734
|
* <p>The policy version ID.</p>
|
|
4735
4735
|
* @public
|
|
4736
4736
|
*/
|
|
4737
|
-
policyVersionId?: string;
|
|
4737
|
+
policyVersionId?: string | undefined;
|
|
4738
4738
|
/**
|
|
4739
4739
|
* <p>Specifies whether the policy version is the default.</p>
|
|
4740
4740
|
* @public
|
|
4741
4741
|
*/
|
|
4742
|
-
isDefaultVersion?: boolean;
|
|
4742
|
+
isDefaultVersion?: boolean | undefined;
|
|
4743
4743
|
/**
|
|
4744
4744
|
* <p>The date the policy was created.</p>
|
|
4745
4745
|
* @public
|
|
4746
4746
|
*/
|
|
4747
|
-
creationDate?: Date;
|
|
4747
|
+
creationDate?: Date | undefined;
|
|
4748
4748
|
/**
|
|
4749
4749
|
* <p>The date the policy was last modified.</p>
|
|
4750
4750
|
* @public
|
|
4751
4751
|
*/
|
|
4752
|
-
lastModifiedDate?: Date;
|
|
4752
|
+
lastModifiedDate?: Date | undefined;
|
|
4753
4753
|
/**
|
|
4754
4754
|
* <p>The generation ID of the policy version.</p>
|
|
4755
4755
|
* @public
|
|
4756
4756
|
*/
|
|
4757
|
-
generationId?: string;
|
|
4757
|
+
generationId?: string | undefined;
|
|
4758
4758
|
}
|
|
4759
4759
|
/**
|
|
4760
4760
|
* <p>The input to the GetRegistrationCode operation.</p>
|
|
@@ -4771,7 +4771,7 @@ export interface GetRegistrationCodeResponse {
|
|
|
4771
4771
|
* <p>The CA certificate registration code.</p>
|
|
4772
4772
|
* @public
|
|
4773
4773
|
*/
|
|
4774
|
-
registrationCode?: string;
|
|
4774
|
+
registrationCode?: string | undefined;
|
|
4775
4775
|
}
|
|
4776
4776
|
/**
|
|
4777
4777
|
* @public
|
|
@@ -4781,7 +4781,7 @@ export interface GetStatisticsRequest {
|
|
|
4781
4781
|
* <p>The name of the index to search. The default value is <code>AWS_Things</code>.</p>
|
|
4782
4782
|
* @public
|
|
4783
4783
|
*/
|
|
4784
|
-
indexName?: string;
|
|
4784
|
+
indexName?: string | undefined;
|
|
4785
4785
|
/**
|
|
4786
4786
|
* <p>The query used to search. You can specify "*" for the query string to get the count of all
|
|
4787
4787
|
* indexed things in your Amazon Web Services account.</p>
|
|
@@ -4792,12 +4792,12 @@ export interface GetStatisticsRequest {
|
|
|
4792
4792
|
* <p>The aggregation field name.</p>
|
|
4793
4793
|
* @public
|
|
4794
4794
|
*/
|
|
4795
|
-
aggregationField?: string;
|
|
4795
|
+
aggregationField?: string | undefined;
|
|
4796
4796
|
/**
|
|
4797
4797
|
* <p>The version of the query used to search.</p>
|
|
4798
4798
|
* @public
|
|
4799
4799
|
*/
|
|
4800
|
-
queryVersion?: string;
|
|
4800
|
+
queryVersion?: string | undefined;
|
|
4801
4801
|
}
|
|
4802
4802
|
/**
|
|
4803
4803
|
* <p>A map of key-value pairs for all supported statistics. For issues with missing or unexpected values for this API,
|
|
@@ -4810,42 +4810,42 @@ export interface Statistics {
|
|
|
4810
4810
|
* <p>The count of things that match the query string criteria and contain a valid aggregation field value.</p>
|
|
4811
4811
|
* @public
|
|
4812
4812
|
*/
|
|
4813
|
-
count?: number;
|
|
4813
|
+
count?: number | undefined;
|
|
4814
4814
|
/**
|
|
4815
4815
|
* <p>The average of the aggregated field values.</p>
|
|
4816
4816
|
* @public
|
|
4817
4817
|
*/
|
|
4818
|
-
average?: number;
|
|
4818
|
+
average?: number | undefined;
|
|
4819
4819
|
/**
|
|
4820
4820
|
* <p>The sum of the aggregated field values.</p>
|
|
4821
4821
|
* @public
|
|
4822
4822
|
*/
|
|
4823
|
-
sum?: number;
|
|
4823
|
+
sum?: number | undefined;
|
|
4824
4824
|
/**
|
|
4825
4825
|
* <p>The minimum aggregated field value.</p>
|
|
4826
4826
|
* @public
|
|
4827
4827
|
*/
|
|
4828
|
-
minimum?: number;
|
|
4828
|
+
minimum?: number | undefined;
|
|
4829
4829
|
/**
|
|
4830
4830
|
* <p>The maximum aggregated field value.</p>
|
|
4831
4831
|
* @public
|
|
4832
4832
|
*/
|
|
4833
|
-
maximum?: number;
|
|
4833
|
+
maximum?: number | undefined;
|
|
4834
4834
|
/**
|
|
4835
4835
|
* <p>The sum of the squares of the aggregated field values.</p>
|
|
4836
4836
|
* @public
|
|
4837
4837
|
*/
|
|
4838
|
-
sumOfSquares?: number;
|
|
4838
|
+
sumOfSquares?: number | undefined;
|
|
4839
4839
|
/**
|
|
4840
4840
|
* <p>The variance of the aggregated field values.</p>
|
|
4841
4841
|
* @public
|
|
4842
4842
|
*/
|
|
4843
|
-
variance?: number;
|
|
4843
|
+
variance?: number | undefined;
|
|
4844
4844
|
/**
|
|
4845
4845
|
* <p>The standard deviation of the aggregated field values.</p>
|
|
4846
4846
|
* @public
|
|
4847
4847
|
*/
|
|
4848
|
-
stdDeviation?: number;
|
|
4848
|
+
stdDeviation?: number | undefined;
|
|
4849
4849
|
}
|
|
4850
4850
|
/**
|
|
4851
4851
|
* @public
|
|
@@ -4856,7 +4856,7 @@ export interface GetStatisticsResponse {
|
|
|
4856
4856
|
* field.</p>
|
|
4857
4857
|
* @public
|
|
4858
4858
|
*/
|
|
4859
|
-
statistics?: Statistics;
|
|
4859
|
+
statistics?: Statistics | undefined;
|
|
4860
4860
|
}
|
|
4861
4861
|
/**
|
|
4862
4862
|
* <p>The input for the GetTopicRule operation.</p>
|
|
@@ -4878,43 +4878,43 @@ export interface TopicRule {
|
|
|
4878
4878
|
* <p>The name of the rule.</p>
|
|
4879
4879
|
* @public
|
|
4880
4880
|
*/
|
|
4881
|
-
ruleName?: string;
|
|
4881
|
+
ruleName?: string | undefined;
|
|
4882
4882
|
/**
|
|
4883
4883
|
* <p>The SQL statement used to query the topic. When using a SQL query with multiple
|
|
4884
4884
|
* lines, be sure to escape the newline characters.</p>
|
|
4885
4885
|
* @public
|
|
4886
4886
|
*/
|
|
4887
|
-
sql?: string;
|
|
4887
|
+
sql?: string | undefined;
|
|
4888
4888
|
/**
|
|
4889
4889
|
* <p>The description of the rule.</p>
|
|
4890
4890
|
* @public
|
|
4891
4891
|
*/
|
|
4892
|
-
description?: string;
|
|
4892
|
+
description?: string | undefined;
|
|
4893
4893
|
/**
|
|
4894
4894
|
* <p>The date and time the rule was created.</p>
|
|
4895
4895
|
* @public
|
|
4896
4896
|
*/
|
|
4897
|
-
createdAt?: Date;
|
|
4897
|
+
createdAt?: Date | undefined;
|
|
4898
4898
|
/**
|
|
4899
4899
|
* <p>The actions associated with the rule.</p>
|
|
4900
4900
|
* @public
|
|
4901
4901
|
*/
|
|
4902
|
-
actions?: Action[];
|
|
4902
|
+
actions?: Action[] | undefined;
|
|
4903
4903
|
/**
|
|
4904
4904
|
* <p>Specifies whether the rule is disabled.</p>
|
|
4905
4905
|
* @public
|
|
4906
4906
|
*/
|
|
4907
|
-
ruleDisabled?: boolean;
|
|
4907
|
+
ruleDisabled?: boolean | undefined;
|
|
4908
4908
|
/**
|
|
4909
4909
|
* <p>The version of the SQL rules engine to use when evaluating the rule.</p>
|
|
4910
4910
|
* @public
|
|
4911
4911
|
*/
|
|
4912
|
-
awsIotSqlVersion?: string;
|
|
4912
|
+
awsIotSqlVersion?: string | undefined;
|
|
4913
4913
|
/**
|
|
4914
4914
|
* <p>The action to perform when an error occurs.</p>
|
|
4915
4915
|
* @public
|
|
4916
4916
|
*/
|
|
4917
|
-
errorAction?: Action;
|
|
4917
|
+
errorAction?: Action | undefined;
|
|
4918
4918
|
}
|
|
4919
4919
|
/**
|
|
4920
4920
|
* <p>The output from the GetTopicRule operation.</p>
|
|
@@ -4925,12 +4925,12 @@ export interface GetTopicRuleResponse {
|
|
|
4925
4925
|
* <p>The rule ARN.</p>
|
|
4926
4926
|
* @public
|
|
4927
4927
|
*/
|
|
4928
|
-
ruleArn?: string;
|
|
4928
|
+
ruleArn?: string | undefined;
|
|
4929
4929
|
/**
|
|
4930
4930
|
* <p>The rule.</p>
|
|
4931
4931
|
* @public
|
|
4932
4932
|
*/
|
|
4933
|
-
rule?: TopicRule;
|
|
4933
|
+
rule?: TopicRule | undefined;
|
|
4934
4934
|
}
|
|
4935
4935
|
/**
|
|
4936
4936
|
* @public
|
|
@@ -4950,7 +4950,7 @@ export interface GetTopicRuleDestinationResponse {
|
|
|
4950
4950
|
* <p>The topic rule destination.</p>
|
|
4951
4951
|
* @public
|
|
4952
4952
|
*/
|
|
4953
|
-
topicRuleDestination?: TopicRuleDestination;
|
|
4953
|
+
topicRuleDestination?: TopicRuleDestination | undefined;
|
|
4954
4954
|
}
|
|
4955
4955
|
/**
|
|
4956
4956
|
* @public
|
|
@@ -4965,17 +4965,17 @@ export interface GetV2LoggingOptionsResponse {
|
|
|
4965
4965
|
* <p>The IAM role ARN IoT uses to write to your CloudWatch logs.</p>
|
|
4966
4966
|
* @public
|
|
4967
4967
|
*/
|
|
4968
|
-
roleArn?: string;
|
|
4968
|
+
roleArn?: string | undefined;
|
|
4969
4969
|
/**
|
|
4970
4970
|
* <p>The default log level.</p>
|
|
4971
4971
|
* @public
|
|
4972
4972
|
*/
|
|
4973
|
-
defaultLogLevel?: LogLevel;
|
|
4973
|
+
defaultLogLevel?: LogLevel | undefined;
|
|
4974
4974
|
/**
|
|
4975
4975
|
* <p>Disables all logs.</p>
|
|
4976
4976
|
* @public
|
|
4977
4977
|
*/
|
|
4978
|
-
disableAllLogs?: boolean;
|
|
4978
|
+
disableAllLogs?: boolean | undefined;
|
|
4979
4979
|
}
|
|
4980
4980
|
/**
|
|
4981
4981
|
* <p>The resource is not configured.</p>
|
|
@@ -5010,41 +5010,41 @@ export interface ListActiveViolationsRequest {
|
|
|
5010
5010
|
* <p>The name of the thing whose active violations are listed.</p>
|
|
5011
5011
|
* @public
|
|
5012
5012
|
*/
|
|
5013
|
-
thingName?: string;
|
|
5013
|
+
thingName?: string | undefined;
|
|
5014
5014
|
/**
|
|
5015
5015
|
* <p>The name of the Device Defender security profile for which violations are listed.</p>
|
|
5016
5016
|
* @public
|
|
5017
5017
|
*/
|
|
5018
|
-
securityProfileName?: string;
|
|
5018
|
+
securityProfileName?: string | undefined;
|
|
5019
5019
|
/**
|
|
5020
5020
|
* <p>
|
|
5021
5021
|
* The criteria for a behavior.
|
|
5022
5022
|
* </p>
|
|
5023
5023
|
* @public
|
|
5024
5024
|
*/
|
|
5025
|
-
behaviorCriteriaType?: BehaviorCriteriaType;
|
|
5025
|
+
behaviorCriteriaType?: BehaviorCriteriaType | undefined;
|
|
5026
5026
|
/**
|
|
5027
5027
|
* <p>
|
|
5028
5028
|
* A list of all suppressed alerts.
|
|
5029
5029
|
* </p>
|
|
5030
5030
|
* @public
|
|
5031
5031
|
*/
|
|
5032
|
-
listSuppressedAlerts?: boolean;
|
|
5032
|
+
listSuppressedAlerts?: boolean | undefined;
|
|
5033
5033
|
/**
|
|
5034
5034
|
* <p>The verification state of the violation (detect alarm).</p>
|
|
5035
5035
|
* @public
|
|
5036
5036
|
*/
|
|
5037
|
-
verificationState?: VerificationState;
|
|
5037
|
+
verificationState?: VerificationState | undefined;
|
|
5038
5038
|
/**
|
|
5039
5039
|
* <p>The token for the next set of results.</p>
|
|
5040
5040
|
* @public
|
|
5041
5041
|
*/
|
|
5042
|
-
nextToken?: string;
|
|
5042
|
+
nextToken?: string | undefined;
|
|
5043
5043
|
/**
|
|
5044
5044
|
* <p>The maximum number of results to return at one time.</p>
|
|
5045
5045
|
* @public
|
|
5046
5046
|
*/
|
|
5047
|
-
maxResults?: number;
|
|
5047
|
+
maxResults?: number | undefined;
|
|
5048
5048
|
}
|
|
5049
5049
|
/**
|
|
5050
5050
|
* @public
|
|
@@ -5054,13 +5054,13 @@ export interface ListActiveViolationsResponse {
|
|
|
5054
5054
|
* <p>The list of active violations.</p>
|
|
5055
5055
|
* @public
|
|
5056
5056
|
*/
|
|
5057
|
-
activeViolations?: ActiveViolation[];
|
|
5057
|
+
activeViolations?: ActiveViolation[] | undefined;
|
|
5058
5058
|
/**
|
|
5059
5059
|
* <p>A token that can be used to retrieve the next set of results,
|
|
5060
5060
|
* or <code>null</code> if there are no additional results.</p>
|
|
5061
5061
|
* @public
|
|
5062
5062
|
*/
|
|
5063
|
-
nextToken?: string;
|
|
5063
|
+
nextToken?: string | undefined;
|
|
5064
5064
|
}
|
|
5065
5065
|
/**
|
|
5066
5066
|
* @public
|
|
@@ -5075,17 +5075,17 @@ export interface ListAttachedPoliciesRequest {
|
|
|
5075
5075
|
* <p>When true, recursively list attached policies.</p>
|
|
5076
5076
|
* @public
|
|
5077
5077
|
*/
|
|
5078
|
-
recursive?: boolean;
|
|
5078
|
+
recursive?: boolean | undefined;
|
|
5079
5079
|
/**
|
|
5080
5080
|
* <p>The token to retrieve the next set of results.</p>
|
|
5081
5081
|
* @public
|
|
5082
5082
|
*/
|
|
5083
|
-
marker?: string;
|
|
5083
|
+
marker?: string | undefined;
|
|
5084
5084
|
/**
|
|
5085
5085
|
* <p>The maximum number of results to be returned per request.</p>
|
|
5086
5086
|
* @public
|
|
5087
5087
|
*/
|
|
5088
|
-
pageSize?: number;
|
|
5088
|
+
pageSize?: number | undefined;
|
|
5089
5089
|
}
|
|
5090
5090
|
/**
|
|
5091
5091
|
* @public
|
|
@@ -5095,13 +5095,13 @@ export interface ListAttachedPoliciesResponse {
|
|
|
5095
5095
|
* <p>The policies.</p>
|
|
5096
5096
|
* @public
|
|
5097
5097
|
*/
|
|
5098
|
-
policies?: Policy[];
|
|
5098
|
+
policies?: Policy[] | undefined;
|
|
5099
5099
|
/**
|
|
5100
5100
|
* <p>The token to retrieve the next set of results, or ``null`` if there are no more
|
|
5101
5101
|
* results.</p>
|
|
5102
5102
|
* @public
|
|
5103
5103
|
*/
|
|
5104
|
-
nextMarker?: string;
|
|
5104
|
+
nextMarker?: string | undefined;
|
|
5105
5105
|
}
|
|
5106
5106
|
/**
|
|
5107
5107
|
* @public
|
|
@@ -5112,46 +5112,46 @@ export interface ListAuditFindingsRequest {
|
|
|
5112
5112
|
* specify either the taskId or the startTime and endTime, but not both.</p>
|
|
5113
5113
|
* @public
|
|
5114
5114
|
*/
|
|
5115
|
-
taskId?: string;
|
|
5115
|
+
taskId?: string | undefined;
|
|
5116
5116
|
/**
|
|
5117
5117
|
* <p>A filter to limit results to the findings for the specified audit check.</p>
|
|
5118
5118
|
* @public
|
|
5119
5119
|
*/
|
|
5120
|
-
checkName?: string;
|
|
5120
|
+
checkName?: string | undefined;
|
|
5121
5121
|
/**
|
|
5122
5122
|
* <p>Information identifying the noncompliant resource.</p>
|
|
5123
5123
|
* @public
|
|
5124
5124
|
*/
|
|
5125
|
-
resourceIdentifier?: ResourceIdentifier;
|
|
5125
|
+
resourceIdentifier?: ResourceIdentifier | undefined;
|
|
5126
5126
|
/**
|
|
5127
5127
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
5128
5128
|
* @public
|
|
5129
5129
|
*/
|
|
5130
|
-
maxResults?: number;
|
|
5130
|
+
maxResults?: number | undefined;
|
|
5131
5131
|
/**
|
|
5132
5132
|
* <p>The token for the next set of results.</p>
|
|
5133
5133
|
* @public
|
|
5134
5134
|
*/
|
|
5135
|
-
nextToken?: string;
|
|
5135
|
+
nextToken?: string | undefined;
|
|
5136
5136
|
/**
|
|
5137
5137
|
* <p>A filter to limit results to those found after the specified time. You must
|
|
5138
5138
|
* specify either the startTime and endTime or the taskId, but not both.</p>
|
|
5139
5139
|
* @public
|
|
5140
5140
|
*/
|
|
5141
|
-
startTime?: Date;
|
|
5141
|
+
startTime?: Date | undefined;
|
|
5142
5142
|
/**
|
|
5143
5143
|
* <p>A filter to limit results to those found before the specified time. You must
|
|
5144
5144
|
* specify either the startTime and endTime or the taskId, but not both.</p>
|
|
5145
5145
|
* @public
|
|
5146
5146
|
*/
|
|
5147
|
-
endTime?: Date;
|
|
5147
|
+
endTime?: Date | undefined;
|
|
5148
5148
|
/**
|
|
5149
5149
|
* <p>
|
|
5150
5150
|
* Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn't provided, the response will list both suppressed and unsuppressed findings.
|
|
5151
5151
|
* </p>
|
|
5152
5152
|
* @public
|
|
5153
5153
|
*/
|
|
5154
|
-
listSuppressedFindings?: boolean;
|
|
5154
|
+
listSuppressedFindings?: boolean | undefined;
|
|
5155
5155
|
}
|
|
5156
5156
|
/**
|
|
5157
5157
|
* @public
|
|
@@ -5161,13 +5161,13 @@ export interface ListAuditFindingsResponse {
|
|
|
5161
5161
|
* <p>The findings (results) of the audit.</p>
|
|
5162
5162
|
* @public
|
|
5163
5163
|
*/
|
|
5164
|
-
findings?: AuditFinding[];
|
|
5164
|
+
findings?: AuditFinding[] | undefined;
|
|
5165
5165
|
/**
|
|
5166
5166
|
* <p>A token that can be used to retrieve the next set of results, or <code>null</code>
|
|
5167
5167
|
* if there are no additional results.</p>
|
|
5168
5168
|
* @public
|
|
5169
5169
|
*/
|
|
5170
|
-
nextToken?: string;
|
|
5170
|
+
nextToken?: string | undefined;
|
|
5171
5171
|
}
|
|
5172
5172
|
/**
|
|
5173
5173
|
* @public
|
|
@@ -5182,7 +5182,7 @@ export interface ListAuditMitigationActionsExecutionsRequest {
|
|
|
5182
5182
|
* <p>Specify this filter to limit results to those with a specific status.</p>
|
|
5183
5183
|
* @public
|
|
5184
5184
|
*/
|
|
5185
|
-
actionStatus?: AuditMitigationActionsExecutionStatus;
|
|
5185
|
+
actionStatus?: AuditMitigationActionsExecutionStatus | undefined;
|
|
5186
5186
|
/**
|
|
5187
5187
|
* <p>Specify this filter to limit results to those that were applied to a specific audit finding.</p>
|
|
5188
5188
|
* @public
|
|
@@ -5192,12 +5192,12 @@ export interface ListAuditMitigationActionsExecutionsRequest {
|
|
|
5192
5192
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
5193
5193
|
* @public
|
|
5194
5194
|
*/
|
|
5195
|
-
maxResults?: number;
|
|
5195
|
+
maxResults?: number | undefined;
|
|
5196
5196
|
/**
|
|
5197
5197
|
* <p>The token for the next set of results.</p>
|
|
5198
5198
|
* @public
|
|
5199
5199
|
*/
|
|
5200
|
-
nextToken?: string;
|
|
5200
|
+
nextToken?: string | undefined;
|
|
5201
5201
|
}
|
|
5202
5202
|
/**
|
|
5203
5203
|
* @public
|
|
@@ -5207,12 +5207,12 @@ export interface ListAuditMitigationActionsExecutionsResponse {
|
|
|
5207
5207
|
* <p>A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.</p>
|
|
5208
5208
|
* @public
|
|
5209
5209
|
*/
|
|
5210
|
-
actionsExecutions?: AuditMitigationActionExecutionMetadata[];
|
|
5210
|
+
actionsExecutions?: AuditMitigationActionExecutionMetadata[] | undefined;
|
|
5211
5211
|
/**
|
|
5212
5212
|
* <p>The token for the next set of results.</p>
|
|
5213
5213
|
* @public
|
|
5214
5214
|
*/
|
|
5215
|
-
nextToken?: string;
|
|
5215
|
+
nextToken?: string | undefined;
|
|
5216
5216
|
}
|
|
5217
5217
|
/**
|
|
5218
5218
|
* @public
|
|
@@ -5222,27 +5222,27 @@ export interface ListAuditMitigationActionsTasksRequest {
|
|
|
5222
5222
|
* <p>Specify this filter to limit results to tasks that were applied to results for a specific audit.</p>
|
|
5223
5223
|
* @public
|
|
5224
5224
|
*/
|
|
5225
|
-
auditTaskId?: string;
|
|
5225
|
+
auditTaskId?: string | undefined;
|
|
5226
5226
|
/**
|
|
5227
5227
|
* <p>Specify this filter to limit results to tasks that were applied to a specific audit finding.</p>
|
|
5228
5228
|
* @public
|
|
5229
5229
|
*/
|
|
5230
|
-
findingId?: string;
|
|
5230
|
+
findingId?: string | undefined;
|
|
5231
5231
|
/**
|
|
5232
5232
|
* <p>Specify this filter to limit results to tasks that are in a specific state.</p>
|
|
5233
5233
|
* @public
|
|
5234
5234
|
*/
|
|
5235
|
-
taskStatus?: AuditMitigationActionsTaskStatus;
|
|
5235
|
+
taskStatus?: AuditMitigationActionsTaskStatus | undefined;
|
|
5236
5236
|
/**
|
|
5237
5237
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
5238
5238
|
* @public
|
|
5239
5239
|
*/
|
|
5240
|
-
maxResults?: number;
|
|
5240
|
+
maxResults?: number | undefined;
|
|
5241
5241
|
/**
|
|
5242
5242
|
* <p>The token for the next set of results.</p>
|
|
5243
5243
|
* @public
|
|
5244
5244
|
*/
|
|
5245
|
-
nextToken?: string;
|
|
5245
|
+
nextToken?: string | undefined;
|
|
5246
5246
|
/**
|
|
5247
5247
|
* <p>Specify this filter to limit results to tasks that began on or after a specific date and time.</p>
|
|
5248
5248
|
* @public
|
|
@@ -5262,12 +5262,12 @@ export interface ListAuditMitigationActionsTasksResponse {
|
|
|
5262
5262
|
* <p>The collection of audit mitigation tasks that matched the filter criteria.</p>
|
|
5263
5263
|
* @public
|
|
5264
5264
|
*/
|
|
5265
|
-
tasks?: AuditMitigationActionsTaskMetadata[];
|
|
5265
|
+
tasks?: AuditMitigationActionsTaskMetadata[] | undefined;
|
|
5266
5266
|
/**
|
|
5267
5267
|
* <p>The token for the next set of results.</p>
|
|
5268
5268
|
* @public
|
|
5269
5269
|
*/
|
|
5270
|
-
nextToken?: string;
|
|
5270
|
+
nextToken?: string | undefined;
|
|
5271
5271
|
}
|
|
5272
5272
|
/**
|
|
5273
5273
|
* @public
|
|
@@ -5280,33 +5280,33 @@ export interface ListAuditSuppressionsRequest {
|
|
|
5280
5280
|
* to select which checks are enabled.)</p>
|
|
5281
5281
|
* @public
|
|
5282
5282
|
*/
|
|
5283
|
-
checkName?: string;
|
|
5283
|
+
checkName?: string | undefined;
|
|
5284
5284
|
/**
|
|
5285
5285
|
* <p>Information that identifies the noncompliant resource.</p>
|
|
5286
5286
|
* @public
|
|
5287
5287
|
*/
|
|
5288
|
-
resourceIdentifier?: ResourceIdentifier;
|
|
5288
|
+
resourceIdentifier?: ResourceIdentifier | undefined;
|
|
5289
5289
|
/**
|
|
5290
5290
|
* <p>
|
|
5291
5291
|
* Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn't provided, <code>ascendingOrder=true</code>.
|
|
5292
5292
|
* </p>
|
|
5293
5293
|
* @public
|
|
5294
5294
|
*/
|
|
5295
|
-
ascendingOrder?: boolean;
|
|
5295
|
+
ascendingOrder?: boolean | undefined;
|
|
5296
5296
|
/**
|
|
5297
5297
|
* <p>
|
|
5298
5298
|
* The token for the next set of results.
|
|
5299
5299
|
* </p>
|
|
5300
5300
|
* @public
|
|
5301
5301
|
*/
|
|
5302
|
-
nextToken?: string;
|
|
5302
|
+
nextToken?: string | undefined;
|
|
5303
5303
|
/**
|
|
5304
5304
|
* <p>
|
|
5305
5305
|
* The maximum number of results to return at one time. The default is 25.
|
|
5306
5306
|
* </p>
|
|
5307
5307
|
* @public
|
|
5308
5308
|
*/
|
|
5309
|
-
maxResults?: number;
|
|
5309
|
+
maxResults?: number | undefined;
|
|
5310
5310
|
}
|
|
5311
5311
|
/**
|
|
5312
5312
|
* @public
|
|
@@ -5318,14 +5318,14 @@ export interface ListAuditSuppressionsResponse {
|
|
|
5318
5318
|
* </p>
|
|
5319
5319
|
* @public
|
|
5320
5320
|
*/
|
|
5321
|
-
suppressions?: AuditSuppression[];
|
|
5321
|
+
suppressions?: AuditSuppression[] | undefined;
|
|
5322
5322
|
/**
|
|
5323
5323
|
* <p>
|
|
5324
5324
|
* A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
|
|
5325
5325
|
* </p>
|
|
5326
5326
|
* @public
|
|
5327
5327
|
*/
|
|
5328
|
-
nextToken?: string;
|
|
5328
|
+
nextToken?: string | undefined;
|
|
5329
5329
|
}
|
|
5330
5330
|
/**
|
|
5331
5331
|
* @public
|
|
@@ -5348,23 +5348,23 @@ export interface ListAuditTasksRequest {
|
|
|
5348
5348
|
* "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".</p>
|
|
5349
5349
|
* @public
|
|
5350
5350
|
*/
|
|
5351
|
-
taskType?: AuditTaskType;
|
|
5351
|
+
taskType?: AuditTaskType | undefined;
|
|
5352
5352
|
/**
|
|
5353
5353
|
* <p>A filter to limit the output to audits with the specified completion
|
|
5354
5354
|
* status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".</p>
|
|
5355
5355
|
* @public
|
|
5356
5356
|
*/
|
|
5357
|
-
taskStatus?: AuditTaskStatus;
|
|
5357
|
+
taskStatus?: AuditTaskStatus | undefined;
|
|
5358
5358
|
/**
|
|
5359
5359
|
* <p>The token for the next set of results.</p>
|
|
5360
5360
|
* @public
|
|
5361
5361
|
*/
|
|
5362
|
-
nextToken?: string;
|
|
5362
|
+
nextToken?: string | undefined;
|
|
5363
5363
|
/**
|
|
5364
5364
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
5365
5365
|
* @public
|
|
5366
5366
|
*/
|
|
5367
|
-
maxResults?: number;
|
|
5367
|
+
maxResults?: number | undefined;
|
|
5368
5368
|
}
|
|
5369
5369
|
/**
|
|
5370
5370
|
* @public
|
|
@@ -5374,13 +5374,13 @@ export interface ListAuditTasksResponse {
|
|
|
5374
5374
|
* <p>The audits that were performed during the specified time period.</p>
|
|
5375
5375
|
* @public
|
|
5376
5376
|
*/
|
|
5377
|
-
tasks?: AuditTaskMetadata[];
|
|
5377
|
+
tasks?: AuditTaskMetadata[] | undefined;
|
|
5378
5378
|
/**
|
|
5379
5379
|
* <p>A token that can be used to retrieve the next set of results, or <code>null</code>
|
|
5380
5380
|
* if there are no additional results.</p>
|
|
5381
5381
|
* @public
|
|
5382
5382
|
*/
|
|
5383
|
-
nextToken?: string;
|
|
5383
|
+
nextToken?: string | undefined;
|
|
5384
5384
|
}
|
|
5385
5385
|
/**
|
|
5386
5386
|
* @public
|
|
@@ -5390,22 +5390,22 @@ export interface ListAuthorizersRequest {
|
|
|
5390
5390
|
* <p>The maximum number of results to return at one time.</p>
|
|
5391
5391
|
* @public
|
|
5392
5392
|
*/
|
|
5393
|
-
pageSize?: number;
|
|
5393
|
+
pageSize?: number | undefined;
|
|
5394
5394
|
/**
|
|
5395
5395
|
* <p>A marker used to get the next set of results.</p>
|
|
5396
5396
|
* @public
|
|
5397
5397
|
*/
|
|
5398
|
-
marker?: string;
|
|
5398
|
+
marker?: string | undefined;
|
|
5399
5399
|
/**
|
|
5400
5400
|
* <p>Return the list of authorizers in ascending alphabetical order.</p>
|
|
5401
5401
|
* @public
|
|
5402
5402
|
*/
|
|
5403
|
-
ascendingOrder?: boolean;
|
|
5403
|
+
ascendingOrder?: boolean | undefined;
|
|
5404
5404
|
/**
|
|
5405
5405
|
* <p>The status of the list authorizers request.</p>
|
|
5406
5406
|
* @public
|
|
5407
5407
|
*/
|
|
5408
|
-
status?: AuthorizerStatus;
|
|
5408
|
+
status?: AuthorizerStatus | undefined;
|
|
5409
5409
|
}
|
|
5410
5410
|
/**
|
|
5411
5411
|
* @public
|
|
@@ -5415,12 +5415,12 @@ export interface ListAuthorizersResponse {
|
|
|
5415
5415
|
* <p>The authorizers.</p>
|
|
5416
5416
|
* @public
|
|
5417
5417
|
*/
|
|
5418
|
-
authorizers?: AuthorizerSummary[];
|
|
5418
|
+
authorizers?: AuthorizerSummary[] | undefined;
|
|
5419
5419
|
/**
|
|
5420
5420
|
* <p>A marker used to get the next set of results.</p>
|
|
5421
5421
|
* @public
|
|
5422
5422
|
*/
|
|
5423
|
-
nextMarker?: string;
|
|
5423
|
+
nextMarker?: string | undefined;
|
|
5424
5424
|
}
|
|
5425
5425
|
/**
|
|
5426
5426
|
* @public
|
|
@@ -5432,17 +5432,17 @@ export interface ListBillingGroupsRequest {
|
|
|
5432
5432
|
* the first set of results.</p>
|
|
5433
5433
|
* @public
|
|
5434
5434
|
*/
|
|
5435
|
-
nextToken?: string;
|
|
5435
|
+
nextToken?: string | undefined;
|
|
5436
5436
|
/**
|
|
5437
5437
|
* <p>The maximum number of results to return per request.</p>
|
|
5438
5438
|
* @public
|
|
5439
5439
|
*/
|
|
5440
|
-
maxResults?: number;
|
|
5440
|
+
maxResults?: number | undefined;
|
|
5441
5441
|
/**
|
|
5442
5442
|
* <p>Limit the results to billing groups whose names have the given prefix.</p>
|
|
5443
5443
|
* @public
|
|
5444
5444
|
*/
|
|
5445
|
-
namePrefixFilter?: string;
|
|
5445
|
+
namePrefixFilter?: string | undefined;
|
|
5446
5446
|
}
|
|
5447
5447
|
/**
|
|
5448
5448
|
* @public
|
|
@@ -5452,12 +5452,12 @@ export interface ListBillingGroupsResponse {
|
|
|
5452
5452
|
* <p>The list of billing groups.</p>
|
|
5453
5453
|
* @public
|
|
5454
5454
|
*/
|
|
5455
|
-
billingGroups?: GroupNameAndArn[];
|
|
5455
|
+
billingGroups?: GroupNameAndArn[] | undefined;
|
|
5456
5456
|
/**
|
|
5457
5457
|
* <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
|
|
5458
5458
|
* @public
|
|
5459
5459
|
*/
|
|
5460
|
-
nextToken?: string;
|
|
5460
|
+
nextToken?: string | undefined;
|
|
5461
5461
|
}
|
|
5462
5462
|
/**
|
|
5463
5463
|
* <p>Input for the ListCACertificates operation.</p>
|
|
@@ -5468,22 +5468,22 @@ export interface ListCACertificatesRequest {
|
|
|
5468
5468
|
* <p>The result page size.</p>
|
|
5469
5469
|
* @public
|
|
5470
5470
|
*/
|
|
5471
|
-
pageSize?: number;
|
|
5471
|
+
pageSize?: number | undefined;
|
|
5472
5472
|
/**
|
|
5473
5473
|
* <p>The marker for the next set of results.</p>
|
|
5474
5474
|
* @public
|
|
5475
5475
|
*/
|
|
5476
|
-
marker?: string;
|
|
5476
|
+
marker?: string | undefined;
|
|
5477
5477
|
/**
|
|
5478
5478
|
* <p>Determines the order of the results.</p>
|
|
5479
5479
|
* @public
|
|
5480
5480
|
*/
|
|
5481
|
-
ascendingOrder?: boolean;
|
|
5481
|
+
ascendingOrder?: boolean | undefined;
|
|
5482
5482
|
/**
|
|
5483
5483
|
* <p>The name of the provisioning template.</p>
|
|
5484
5484
|
* @public
|
|
5485
5485
|
*/
|
|
5486
|
-
templateName?: string;
|
|
5486
|
+
templateName?: string | undefined;
|
|
5487
5487
|
}
|
|
5488
5488
|
/**
|
|
5489
5489
|
* <p>A CA certificate.</p>
|
|
@@ -5494,23 +5494,23 @@ export interface CACertificate {
|
|
|
5494
5494
|
* <p>The ARN of the CA certificate.</p>
|
|
5495
5495
|
* @public
|
|
5496
5496
|
*/
|
|
5497
|
-
certificateArn?: string;
|
|
5497
|
+
certificateArn?: string | undefined;
|
|
5498
5498
|
/**
|
|
5499
5499
|
* <p>The ID of the CA certificate.</p>
|
|
5500
5500
|
* @public
|
|
5501
5501
|
*/
|
|
5502
|
-
certificateId?: string;
|
|
5502
|
+
certificateId?: string | undefined;
|
|
5503
5503
|
/**
|
|
5504
5504
|
* <p>The status of the CA certificate.</p>
|
|
5505
5505
|
* <p>The status value REGISTER_INACTIVE is deprecated and should not be used.</p>
|
|
5506
5506
|
* @public
|
|
5507
5507
|
*/
|
|
5508
|
-
status?: CACertificateStatus;
|
|
5508
|
+
status?: CACertificateStatus | undefined;
|
|
5509
5509
|
/**
|
|
5510
5510
|
* <p>The date the CA certificate was created.</p>
|
|
5511
5511
|
* @public
|
|
5512
5512
|
*/
|
|
5513
|
-
creationDate?: Date;
|
|
5513
|
+
creationDate?: Date | undefined;
|
|
5514
5514
|
}
|
|
5515
5515
|
/**
|
|
5516
5516
|
* <p>The output from the ListCACertificates operation.</p>
|
|
@@ -5521,12 +5521,12 @@ export interface ListCACertificatesResponse {
|
|
|
5521
5521
|
* <p>The CA certificates registered in your Amazon Web Services account.</p>
|
|
5522
5522
|
* @public
|
|
5523
5523
|
*/
|
|
5524
|
-
certificates?: CACertificate[];
|
|
5524
|
+
certificates?: CACertificate[] | undefined;
|
|
5525
5525
|
/**
|
|
5526
5526
|
* <p>The current position within the list of CA certificates.</p>
|
|
5527
5527
|
* @public
|
|
5528
5528
|
*/
|
|
5529
|
-
nextMarker?: string;
|
|
5529
|
+
nextMarker?: string | undefined;
|
|
5530
5530
|
}
|
|
5531
5531
|
/**
|
|
5532
5532
|
* @public
|
|
@@ -5536,12 +5536,12 @@ export interface ListCertificateProvidersRequest {
|
|
|
5536
5536
|
* <p>The token for the next set of results, or <code>null</code> if there are no more results.</p>
|
|
5537
5537
|
* @public
|
|
5538
5538
|
*/
|
|
5539
|
-
nextToken?: string;
|
|
5539
|
+
nextToken?: string | undefined;
|
|
5540
5540
|
/**
|
|
5541
5541
|
* <p>Returns the list of certificate providers in ascending alphabetical order.</p>
|
|
5542
5542
|
* @public
|
|
5543
5543
|
*/
|
|
5544
|
-
ascendingOrder?: boolean;
|
|
5544
|
+
ascendingOrder?: boolean | undefined;
|
|
5545
5545
|
}
|
|
5546
5546
|
/**
|
|
5547
5547
|
* <p>The certificate provider summary.</p>
|
|
@@ -5552,12 +5552,12 @@ export interface CertificateProviderSummary {
|
|
|
5552
5552
|
* <p>The name of the certificate provider.</p>
|
|
5553
5553
|
* @public
|
|
5554
5554
|
*/
|
|
5555
|
-
certificateProviderName?: string;
|
|
5555
|
+
certificateProviderName?: string | undefined;
|
|
5556
5556
|
/**
|
|
5557
5557
|
* <p>The ARN of the certificate provider.</p>
|
|
5558
5558
|
* @public
|
|
5559
5559
|
*/
|
|
5560
|
-
certificateProviderArn?: string;
|
|
5560
|
+
certificateProviderArn?: string | undefined;
|
|
5561
5561
|
}
|
|
5562
5562
|
/**
|
|
5563
5563
|
* @public
|
|
@@ -5567,12 +5567,12 @@ export interface ListCertificateProvidersResponse {
|
|
|
5567
5567
|
* <p>The list of certificate providers in your Amazon Web Services account.</p>
|
|
5568
5568
|
* @public
|
|
5569
5569
|
*/
|
|
5570
|
-
certificateProviders?: CertificateProviderSummary[];
|
|
5570
|
+
certificateProviders?: CertificateProviderSummary[] | undefined;
|
|
5571
5571
|
/**
|
|
5572
5572
|
* <p>The token for the next set of results, or <code>null</code> if there are no more results.</p>
|
|
5573
5573
|
* @public
|
|
5574
5574
|
*/
|
|
5575
|
-
nextToken?: string;
|
|
5575
|
+
nextToken?: string | undefined;
|
|
5576
5576
|
}
|
|
5577
5577
|
/**
|
|
5578
5578
|
* <p>The input for the ListCertificates operation.</p>
|
|
@@ -5583,18 +5583,18 @@ export interface ListCertificatesRequest {
|
|
|
5583
5583
|
* <p>The result page size.</p>
|
|
5584
5584
|
* @public
|
|
5585
5585
|
*/
|
|
5586
|
-
pageSize?: number;
|
|
5586
|
+
pageSize?: number | undefined;
|
|
5587
5587
|
/**
|
|
5588
5588
|
* <p>The marker for the next set of results.</p>
|
|
5589
5589
|
* @public
|
|
5590
5590
|
*/
|
|
5591
|
-
marker?: string;
|
|
5591
|
+
marker?: string | undefined;
|
|
5592
5592
|
/**
|
|
5593
5593
|
* <p>Specifies the order for results. If True, the results are returned in ascending
|
|
5594
5594
|
* order, based on the creation date.</p>
|
|
5595
5595
|
* @public
|
|
5596
5596
|
*/
|
|
5597
|
-
ascendingOrder?: boolean;
|
|
5597
|
+
ascendingOrder?: boolean | undefined;
|
|
5598
5598
|
}
|
|
5599
5599
|
/**
|
|
5600
5600
|
* <p>Information about a certificate.</p>
|
|
@@ -5605,19 +5605,19 @@ export interface Certificate {
|
|
|
5605
5605
|
* <p>The ARN of the certificate.</p>
|
|
5606
5606
|
* @public
|
|
5607
5607
|
*/
|
|
5608
|
-
certificateArn?: string;
|
|
5608
|
+
certificateArn?: string | undefined;
|
|
5609
5609
|
/**
|
|
5610
5610
|
* <p>The ID of the certificate. (The last part of the certificate ARN contains the
|
|
5611
5611
|
* certificate ID.)</p>
|
|
5612
5612
|
* @public
|
|
5613
5613
|
*/
|
|
5614
|
-
certificateId?: string;
|
|
5614
|
+
certificateId?: string | undefined;
|
|
5615
5615
|
/**
|
|
5616
5616
|
* <p>The status of the certificate.</p>
|
|
5617
5617
|
* <p>The status value REGISTER_INACTIVE is deprecated and should not be used.</p>
|
|
5618
5618
|
* @public
|
|
5619
5619
|
*/
|
|
5620
|
-
status?: CertificateStatus;
|
|
5620
|
+
status?: CertificateStatus | undefined;
|
|
5621
5621
|
/**
|
|
5622
5622
|
* <p>The mode of the certificate.</p>
|
|
5623
5623
|
* <p>
|
|
@@ -5632,12 +5632,12 @@ export interface Certificate {
|
|
|
5632
5632
|
* in <code>SNI_ONLY</code> mode must send the SNI extension when connecting to Amazon Web Services IoT Core. </p>
|
|
5633
5633
|
* @public
|
|
5634
5634
|
*/
|
|
5635
|
-
certificateMode?: CertificateMode;
|
|
5635
|
+
certificateMode?: CertificateMode | undefined;
|
|
5636
5636
|
/**
|
|
5637
5637
|
* <p>The date and time the certificate was created.</p>
|
|
5638
5638
|
* @public
|
|
5639
5639
|
*/
|
|
5640
|
-
creationDate?: Date;
|
|
5640
|
+
creationDate?: Date | undefined;
|
|
5641
5641
|
}
|
|
5642
5642
|
/**
|
|
5643
5643
|
* <p>The output of the ListCertificates operation.</p>
|
|
@@ -5648,13 +5648,13 @@ export interface ListCertificatesResponse {
|
|
|
5648
5648
|
* <p>The descriptions of the certificates.</p>
|
|
5649
5649
|
* @public
|
|
5650
5650
|
*/
|
|
5651
|
-
certificates?: Certificate[];
|
|
5651
|
+
certificates?: Certificate[] | undefined;
|
|
5652
5652
|
/**
|
|
5653
5653
|
* <p>The marker for the next set of results, or null if there are no additional
|
|
5654
5654
|
* results.</p>
|
|
5655
5655
|
* @public
|
|
5656
5656
|
*/
|
|
5657
|
-
nextMarker?: string;
|
|
5657
|
+
nextMarker?: string | undefined;
|
|
5658
5658
|
}
|
|
5659
5659
|
/**
|
|
5660
5660
|
* <p>The input to the ListCertificatesByCA operation.</p>
|
|
@@ -5671,18 +5671,18 @@ export interface ListCertificatesByCARequest {
|
|
|
5671
5671
|
* <p>The result page size.</p>
|
|
5672
5672
|
* @public
|
|
5673
5673
|
*/
|
|
5674
|
-
pageSize?: number;
|
|
5674
|
+
pageSize?: number | undefined;
|
|
5675
5675
|
/**
|
|
5676
5676
|
* <p>The marker for the next set of results.</p>
|
|
5677
5677
|
* @public
|
|
5678
5678
|
*/
|
|
5679
|
-
marker?: string;
|
|
5679
|
+
marker?: string | undefined;
|
|
5680
5680
|
/**
|
|
5681
5681
|
* <p>Specifies the order for results. If True, the results are returned in ascending
|
|
5682
5682
|
* order, based on the creation date.</p>
|
|
5683
5683
|
* @public
|
|
5684
5684
|
*/
|
|
5685
|
-
ascendingOrder?: boolean;
|
|
5685
|
+
ascendingOrder?: boolean | undefined;
|
|
5686
5686
|
}
|
|
5687
5687
|
/**
|
|
5688
5688
|
* <p>The output of the ListCertificatesByCA operation.</p>
|
|
@@ -5693,13 +5693,13 @@ export interface ListCertificatesByCAResponse {
|
|
|
5693
5693
|
* <p>The device certificates signed by the specified CA certificate.</p>
|
|
5694
5694
|
* @public
|
|
5695
5695
|
*/
|
|
5696
|
-
certificates?: Certificate[];
|
|
5696
|
+
certificates?: Certificate[] | undefined;
|
|
5697
5697
|
/**
|
|
5698
5698
|
* <p>The marker for the next set of results, or null if there are no additional
|
|
5699
5699
|
* results.</p>
|
|
5700
5700
|
* @public
|
|
5701
5701
|
*/
|
|
5702
|
-
nextMarker?: string;
|
|
5702
|
+
nextMarker?: string | undefined;
|
|
5703
5703
|
}
|
|
5704
5704
|
/**
|
|
5705
5705
|
* @public
|
|
@@ -5711,14 +5711,14 @@ export interface ListCustomMetricsRequest {
|
|
|
5711
5711
|
* </p>
|
|
5712
5712
|
* @public
|
|
5713
5713
|
*/
|
|
5714
|
-
nextToken?: string;
|
|
5714
|
+
nextToken?: string | undefined;
|
|
5715
5715
|
/**
|
|
5716
5716
|
* <p>
|
|
5717
5717
|
* The maximum number of results to return at one time. The default is 25.
|
|
5718
5718
|
* </p>
|
|
5719
5719
|
* @public
|
|
5720
5720
|
*/
|
|
5721
|
-
maxResults?: number;
|
|
5721
|
+
maxResults?: number | undefined;
|
|
5722
5722
|
}
|
|
5723
5723
|
/**
|
|
5724
5724
|
* @public
|
|
@@ -5730,7 +5730,7 @@ export interface ListCustomMetricsResponse {
|
|
|
5730
5730
|
* </p>
|
|
5731
5731
|
* @public
|
|
5732
5732
|
*/
|
|
5733
|
-
metricNames?: string[];
|
|
5733
|
+
metricNames?: string[] | undefined;
|
|
5734
5734
|
/**
|
|
5735
5735
|
* <p>
|
|
5736
5736
|
* A token that can be used to retrieve the next set of results,
|
|
@@ -5738,7 +5738,7 @@ export interface ListCustomMetricsResponse {
|
|
|
5738
5738
|
* </p>
|
|
5739
5739
|
* @public
|
|
5740
5740
|
*/
|
|
5741
|
-
nextToken?: string;
|
|
5741
|
+
nextToken?: string | undefined;
|
|
5742
5742
|
}
|
|
5743
5743
|
/**
|
|
5744
5744
|
* @public
|
|
@@ -5750,21 +5750,21 @@ export interface ListDetectMitigationActionsExecutionsRequest {
|
|
|
5750
5750
|
* </p>
|
|
5751
5751
|
* @public
|
|
5752
5752
|
*/
|
|
5753
|
-
taskId?: string;
|
|
5753
|
+
taskId?: string | undefined;
|
|
5754
5754
|
/**
|
|
5755
5755
|
* <p>
|
|
5756
5756
|
* The unique identifier of the violation.
|
|
5757
5757
|
* </p>
|
|
5758
5758
|
* @public
|
|
5759
5759
|
*/
|
|
5760
|
-
violationId?: string;
|
|
5760
|
+
violationId?: string | undefined;
|
|
5761
5761
|
/**
|
|
5762
5762
|
* <p>
|
|
5763
5763
|
* The name of the thing whose mitigation actions are listed.
|
|
5764
5764
|
* </p>
|
|
5765
5765
|
* @public
|
|
5766
5766
|
*/
|
|
5767
|
-
thingName?: string;
|
|
5767
|
+
thingName?: string | undefined;
|
|
5768
5768
|
/**
|
|
5769
5769
|
* <p>
|
|
5770
5770
|
* A filter to limit results to those found after the specified time. You must
|
|
@@ -5772,28 +5772,28 @@ export interface ListDetectMitigationActionsExecutionsRequest {
|
|
|
5772
5772
|
* </p>
|
|
5773
5773
|
* @public
|
|
5774
5774
|
*/
|
|
5775
|
-
startTime?: Date;
|
|
5775
|
+
startTime?: Date | undefined;
|
|
5776
5776
|
/**
|
|
5777
5777
|
* <p>
|
|
5778
5778
|
* The end of the time period for which ML Detect mitigation actions executions are returned.
|
|
5779
5779
|
* </p>
|
|
5780
5780
|
* @public
|
|
5781
5781
|
*/
|
|
5782
|
-
endTime?: Date;
|
|
5782
|
+
endTime?: Date | undefined;
|
|
5783
5783
|
/**
|
|
5784
5784
|
* <p>
|
|
5785
5785
|
* The maximum number of results to return at one time. The default is 25.
|
|
5786
5786
|
* </p>
|
|
5787
5787
|
* @public
|
|
5788
5788
|
*/
|
|
5789
|
-
maxResults?: number;
|
|
5789
|
+
maxResults?: number | undefined;
|
|
5790
5790
|
/**
|
|
5791
5791
|
* <p>
|
|
5792
5792
|
* The token for the next set of results.
|
|
5793
5793
|
* </p>
|
|
5794
5794
|
* @public
|
|
5795
5795
|
*/
|
|
5796
|
-
nextToken?: string;
|
|
5796
|
+
nextToken?: string | undefined;
|
|
5797
5797
|
}
|
|
5798
5798
|
/**
|
|
5799
5799
|
* @public
|
|
@@ -5822,63 +5822,63 @@ export interface DetectMitigationActionExecution {
|
|
|
5822
5822
|
* </p>
|
|
5823
5823
|
* @public
|
|
5824
5824
|
*/
|
|
5825
|
-
taskId?: string;
|
|
5825
|
+
taskId?: string | undefined;
|
|
5826
5826
|
/**
|
|
5827
5827
|
* <p>
|
|
5828
5828
|
* The unique identifier of the violation.
|
|
5829
5829
|
* </p>
|
|
5830
5830
|
* @public
|
|
5831
5831
|
*/
|
|
5832
|
-
violationId?: string;
|
|
5832
|
+
violationId?: string | undefined;
|
|
5833
5833
|
/**
|
|
5834
5834
|
* <p>
|
|
5835
5835
|
* The friendly name that uniquely identifies the mitigation action.
|
|
5836
5836
|
* </p>
|
|
5837
5837
|
* @public
|
|
5838
5838
|
*/
|
|
5839
|
-
actionName?: string;
|
|
5839
|
+
actionName?: string | undefined;
|
|
5840
5840
|
/**
|
|
5841
5841
|
* <p>
|
|
5842
5842
|
* The name of the thing.
|
|
5843
5843
|
* </p>
|
|
5844
5844
|
* @public
|
|
5845
5845
|
*/
|
|
5846
|
-
thingName?: string;
|
|
5846
|
+
thingName?: string | undefined;
|
|
5847
5847
|
/**
|
|
5848
5848
|
* <p>
|
|
5849
5849
|
* The date a mitigation action was started.
|
|
5850
5850
|
* </p>
|
|
5851
5851
|
* @public
|
|
5852
5852
|
*/
|
|
5853
|
-
executionStartDate?: Date;
|
|
5853
|
+
executionStartDate?: Date | undefined;
|
|
5854
5854
|
/**
|
|
5855
5855
|
* <p>
|
|
5856
5856
|
* The date a mitigation action ended.
|
|
5857
5857
|
* </p>
|
|
5858
5858
|
* @public
|
|
5859
5859
|
*/
|
|
5860
|
-
executionEndDate?: Date;
|
|
5860
|
+
executionEndDate?: Date | undefined;
|
|
5861
5861
|
/**
|
|
5862
5862
|
* <p>
|
|
5863
5863
|
* The status of a mitigation action.
|
|
5864
5864
|
* </p>
|
|
5865
5865
|
* @public
|
|
5866
5866
|
*/
|
|
5867
|
-
status?: DetectMitigationActionExecutionStatus;
|
|
5867
|
+
status?: DetectMitigationActionExecutionStatus | undefined;
|
|
5868
5868
|
/**
|
|
5869
5869
|
* <p>
|
|
5870
5870
|
* The error code of a mitigation action.
|
|
5871
5871
|
* </p>
|
|
5872
5872
|
* @public
|
|
5873
5873
|
*/
|
|
5874
|
-
errorCode?: string;
|
|
5874
|
+
errorCode?: string | undefined;
|
|
5875
5875
|
/**
|
|
5876
5876
|
* <p>
|
|
5877
5877
|
* The message of a mitigation action.
|
|
5878
5878
|
* </p>
|
|
5879
5879
|
* @public
|
|
5880
5880
|
*/
|
|
5881
|
-
message?: string;
|
|
5881
|
+
message?: string | undefined;
|
|
5882
5882
|
}
|
|
5883
5883
|
/**
|
|
5884
5884
|
* @public
|
|
@@ -5890,14 +5890,14 @@ export interface ListDetectMitigationActionsExecutionsResponse {
|
|
|
5890
5890
|
* </p>
|
|
5891
5891
|
* @public
|
|
5892
5892
|
*/
|
|
5893
|
-
actionsExecutions?: DetectMitigationActionExecution[];
|
|
5893
|
+
actionsExecutions?: DetectMitigationActionExecution[] | undefined;
|
|
5894
5894
|
/**
|
|
5895
5895
|
* <p>
|
|
5896
5896
|
* A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
|
|
5897
5897
|
* </p>
|
|
5898
5898
|
* @public
|
|
5899
5899
|
*/
|
|
5900
|
-
nextToken?: string;
|
|
5900
|
+
nextToken?: string | undefined;
|
|
5901
5901
|
}
|
|
5902
5902
|
/**
|
|
5903
5903
|
* @public
|
|
@@ -5907,14 +5907,14 @@ export interface ListDetectMitigationActionsTasksRequest {
|
|
|
5907
5907
|
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
5908
5908
|
* @public
|
|
5909
5909
|
*/
|
|
5910
|
-
maxResults?: number;
|
|
5910
|
+
maxResults?: number | undefined;
|
|
5911
5911
|
/**
|
|
5912
5912
|
* <p>
|
|
5913
5913
|
* The token for the next set of results.
|
|
5914
5914
|
* </p>
|
|
5915
5915
|
* @public
|
|
5916
5916
|
*/
|
|
5917
|
-
nextToken?: string;
|
|
5917
|
+
nextToken?: string | undefined;
|
|
5918
5918
|
/**
|
|
5919
5919
|
* <p>
|
|
5920
5920
|
* A filter to limit results to those found after the specified time. You must
|
|
@@ -5941,14 +5941,14 @@ export interface ListDetectMitigationActionsTasksResponse {
|
|
|
5941
5941
|
* </p>
|
|
5942
5942
|
* @public
|
|
5943
5943
|
*/
|
|
5944
|
-
tasks?: DetectMitigationActionsTaskSummary[];
|
|
5944
|
+
tasks?: DetectMitigationActionsTaskSummary[] | undefined;
|
|
5945
5945
|
/**
|
|
5946
5946
|
* <p>
|
|
5947
5947
|
* A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
|
|
5948
5948
|
* </p>
|
|
5949
5949
|
* @public
|
|
5950
5950
|
*/
|
|
5951
|
-
nextToken?: string;
|
|
5951
|
+
nextToken?: string | undefined;
|
|
5952
5952
|
}
|
|
5953
5953
|
/**
|
|
5954
5954
|
* @public
|
|
@@ -5958,12 +5958,12 @@ export interface ListDimensionsRequest {
|
|
|
5958
5958
|
* <p>The token for the next set of results.</p>
|
|
5959
5959
|
* @public
|
|
5960
5960
|
*/
|
|
5961
|
-
nextToken?: string;
|
|
5961
|
+
nextToken?: string | undefined;
|
|
5962
5962
|
/**
|
|
5963
5963
|
* <p>The maximum number of results to retrieve at one time.</p>
|
|
5964
5964
|
* @public
|
|
5965
5965
|
*/
|
|
5966
|
-
maxResults?: number;
|
|
5966
|
+
maxResults?: number | undefined;
|
|
5967
5967
|
}
|
|
5968
5968
|
/**
|
|
5969
5969
|
* @public
|
|
@@ -5973,12 +5973,12 @@ export interface ListDimensionsResponse {
|
|
|
5973
5973
|
* <p>A list of the names of the defined dimensions. Use <code>DescribeDimension</code> to get details for a dimension.</p>
|
|
5974
5974
|
* @public
|
|
5975
5975
|
*/
|
|
5976
|
-
dimensionNames?: string[];
|
|
5976
|
+
dimensionNames?: string[] | undefined;
|
|
5977
5977
|
/**
|
|
5978
5978
|
* <p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>
|
|
5979
5979
|
* @public
|
|
5980
5980
|
*/
|
|
5981
|
-
nextToken?: string;
|
|
5981
|
+
nextToken?: string | undefined;
|
|
5982
5982
|
}
|
|
5983
5983
|
/**
|
|
5984
5984
|
* @public
|
|
@@ -5988,17 +5988,17 @@ export interface ListDomainConfigurationsRequest {
|
|
|
5988
5988
|
* <p>The marker for the next set of results.</p>
|
|
5989
5989
|
* @public
|
|
5990
5990
|
*/
|
|
5991
|
-
marker?: string;
|
|
5991
|
+
marker?: string | undefined;
|
|
5992
5992
|
/**
|
|
5993
5993
|
* <p>The result page size.</p>
|
|
5994
5994
|
* @public
|
|
5995
5995
|
*/
|
|
5996
|
-
pageSize?: number;
|
|
5996
|
+
pageSize?: number | undefined;
|
|
5997
5997
|
/**
|
|
5998
5998
|
* <p>The type of service delivered by the endpoint.</p>
|
|
5999
5999
|
* @public
|
|
6000
6000
|
*/
|
|
6001
|
-
serviceType?: ServiceType;
|
|
6001
|
+
serviceType?: ServiceType | undefined;
|
|
6002
6002
|
}
|
|
6003
6003
|
/**
|
|
6004
6004
|
* <p>The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain.
|
|
@@ -6022,17 +6022,17 @@ export interface DomainConfigurationSummary {
|
|
|
6022
6022
|
* <p>The name of the domain configuration. This value must be unique to a region.</p>
|
|
6023
6023
|
* @public
|
|
6024
6024
|
*/
|
|
6025
|
-
domainConfigurationName?: string;
|
|
6025
|
+
domainConfigurationName?: string | undefined;
|
|
6026
6026
|
/**
|
|
6027
6027
|
* <p>The ARN of the domain configuration.</p>
|
|
6028
6028
|
* @public
|
|
6029
6029
|
*/
|
|
6030
|
-
domainConfigurationArn?: string;
|
|
6030
|
+
domainConfigurationArn?: string | undefined;
|
|
6031
6031
|
/**
|
|
6032
6032
|
* <p>The type of service delivered by the endpoint.</p>
|
|
6033
6033
|
* @public
|
|
6034
6034
|
*/
|
|
6035
|
-
serviceType?: ServiceType;
|
|
6035
|
+
serviceType?: ServiceType | undefined;
|
|
6036
6036
|
}
|
|
6037
6037
|
/**
|
|
6038
6038
|
* @public
|
|
@@ -6042,12 +6042,12 @@ export interface ListDomainConfigurationsResponse {
|
|
|
6042
6042
|
* <p>A list of objects that contain summary information about the user's domain configurations.</p>
|
|
6043
6043
|
* @public
|
|
6044
6044
|
*/
|
|
6045
|
-
domainConfigurations?: DomainConfigurationSummary[];
|
|
6045
|
+
domainConfigurations?: DomainConfigurationSummary[] | undefined;
|
|
6046
6046
|
/**
|
|
6047
6047
|
* <p>The marker for the next set of results.</p>
|
|
6048
6048
|
* @public
|
|
6049
6049
|
*/
|
|
6050
|
-
nextMarker?: string;
|
|
6050
|
+
nextMarker?: string | undefined;
|
|
6051
6051
|
}
|
|
6052
6052
|
/**
|
|
6053
6053
|
* @public
|
|
@@ -6058,12 +6058,12 @@ export interface ListFleetMetricsRequest {
|
|
|
6058
6058
|
* otherwise <code>null</code> to receive the first set of results.</p>
|
|
6059
6059
|
* @public
|
|
6060
6060
|
*/
|
|
6061
|
-
nextToken?: string;
|
|
6061
|
+
nextToken?: string | undefined;
|
|
6062
6062
|
/**
|
|
6063
6063
|
* <p>The maximum number of results to return in this operation.</p>
|
|
6064
6064
|
* @public
|
|
6065
6065
|
*/
|
|
6066
|
-
maxResults?: number;
|
|
6066
|
+
maxResults?: number | undefined;
|
|
6067
6067
|
}
|
|
6068
6068
|
/**
|
|
6069
6069
|
* <p>The name and ARN of a fleet metric.</p>
|
|
@@ -6074,12 +6074,12 @@ export interface FleetMetricNameAndArn {
|
|
|
6074
6074
|
* <p>The fleet metric name.</p>
|
|
6075
6075
|
* @public
|
|
6076
6076
|
*/
|
|
6077
|
-
metricName?: string;
|
|
6077
|
+
metricName?: string | undefined;
|
|
6078
6078
|
/**
|
|
6079
6079
|
* <p>The fleet metric ARN.</p>
|
|
6080
6080
|
* @public
|
|
6081
6081
|
*/
|
|
6082
|
-
metricArn?: string;
|
|
6082
|
+
metricArn?: string | undefined;
|
|
6083
6083
|
}
|
|
6084
6084
|
/**
|
|
6085
6085
|
* @public
|
|
@@ -6089,13 +6089,13 @@ export interface ListFleetMetricsResponse {
|
|
|
6089
6089
|
* <p>The list of fleet metrics objects.</p>
|
|
6090
6090
|
* @public
|
|
6091
6091
|
*/
|
|
6092
|
-
fleetMetrics?: FleetMetricNameAndArn[];
|
|
6092
|
+
fleetMetrics?: FleetMetricNameAndArn[] | undefined;
|
|
6093
6093
|
/**
|
|
6094
6094
|
* <p>The token for the next set of results. Will not be returned if the operation has returned
|
|
6095
6095
|
* all results.</p>
|
|
6096
6096
|
* @public
|
|
6097
6097
|
*/
|
|
6098
|
-
nextToken?: string;
|
|
6098
|
+
nextToken?: string | undefined;
|
|
6099
6099
|
}
|
|
6100
6100
|
/**
|
|
6101
6101
|
* @public
|
|
@@ -6106,12 +6106,12 @@ export interface ListIndicesRequest {
|
|
|
6106
6106
|
* results.</p>
|
|
6107
6107
|
* @public
|
|
6108
6108
|
*/
|
|
6109
|
-
nextToken?: string;
|
|
6109
|
+
nextToken?: string | undefined;
|
|
6110
6110
|
/**
|
|
6111
6111
|
* <p>The maximum number of results to return at one time.</p>
|
|
6112
6112
|
* @public
|
|
6113
6113
|
*/
|
|
6114
|
-
maxResults?: number;
|
|
6114
|
+
maxResults?: number | undefined;
|
|
6115
6115
|
}
|
|
6116
6116
|
/**
|
|
6117
6117
|
* @public
|
|
@@ -6121,13 +6121,13 @@ export interface ListIndicesResponse {
|
|
|
6121
6121
|
* <p>The index names.</p>
|
|
6122
6122
|
* @public
|
|
6123
6123
|
*/
|
|
6124
|
-
indexNames?: string[];
|
|
6124
|
+
indexNames?: string[] | undefined;
|
|
6125
6125
|
/**
|
|
6126
6126
|
* <p>The token used to get the next set of results, or <code>null</code> if there are no additional
|
|
6127
6127
|
* results.</p>
|
|
6128
6128
|
* @public
|
|
6129
6129
|
*/
|
|
6130
|
-
nextToken?: string;
|
|
6130
|
+
nextToken?: string | undefined;
|
|
6131
6131
|
}
|
|
6132
6132
|
/**
|
|
6133
6133
|
* @public
|
|
@@ -6142,17 +6142,17 @@ export interface ListJobExecutionsForJobRequest {
|
|
|
6142
6142
|
* <p>The status of the job.</p>
|
|
6143
6143
|
* @public
|
|
6144
6144
|
*/
|
|
6145
|
-
status?: JobExecutionStatus;
|
|
6145
|
+
status?: JobExecutionStatus | undefined;
|
|
6146
6146
|
/**
|
|
6147
6147
|
* <p>The maximum number of results to be returned per request.</p>
|
|
6148
6148
|
* @public
|
|
6149
6149
|
*/
|
|
6150
|
-
maxResults?: number;
|
|
6150
|
+
maxResults?: number | undefined;
|
|
6151
6151
|
/**
|
|
6152
6152
|
* <p>The token to retrieve the next set of results.</p>
|
|
6153
6153
|
* @public
|
|
6154
6154
|
*/
|
|
6155
|
-
nextToken?: string;
|
|
6155
|
+
nextToken?: string | undefined;
|
|
6156
6156
|
}
|
|
6157
6157
|
/**
|
|
6158
6158
|
* <p>The job execution summary.</p>
|
|
@@ -6163,35 +6163,35 @@ export interface JobExecutionSummary {
|
|
|
6163
6163
|
* <p>The status of the job execution.</p>
|
|
6164
6164
|
* @public
|
|
6165
6165
|
*/
|
|
6166
|
-
status?: JobExecutionStatus;
|
|
6166
|
+
status?: JobExecutionStatus | undefined;
|
|
6167
6167
|
/**
|
|
6168
6168
|
* <p>The time, in seconds since the epoch, when the job execution was queued.</p>
|
|
6169
6169
|
* @public
|
|
6170
6170
|
*/
|
|
6171
|
-
queuedAt?: Date;
|
|
6171
|
+
queuedAt?: Date | undefined;
|
|
6172
6172
|
/**
|
|
6173
6173
|
* <p>The time, in seconds since the epoch, when the job execution started.</p>
|
|
6174
6174
|
* @public
|
|
6175
6175
|
*/
|
|
6176
|
-
startedAt?: Date;
|
|
6176
|
+
startedAt?: Date | undefined;
|
|
6177
6177
|
/**
|
|
6178
6178
|
* <p>The time, in seconds since the epoch, when the job execution was last updated.</p>
|
|
6179
6179
|
* @public
|
|
6180
6180
|
*/
|
|
6181
|
-
lastUpdatedAt?: Date;
|
|
6181
|
+
lastUpdatedAt?: Date | undefined;
|
|
6182
6182
|
/**
|
|
6183
6183
|
* <p>A string (consisting of the digits "0" through "9") which identifies this particular job execution on
|
|
6184
6184
|
* this particular device. It can be used later in commands which return or update job execution
|
|
6185
6185
|
* information.</p>
|
|
6186
6186
|
* @public
|
|
6187
6187
|
*/
|
|
6188
|
-
executionNumber?: number;
|
|
6188
|
+
executionNumber?: number | undefined;
|
|
6189
6189
|
/**
|
|
6190
6190
|
* <p>The number that indicates how many retry attempts have been completed for this
|
|
6191
6191
|
* job on this device.</p>
|
|
6192
6192
|
* @public
|
|
6193
6193
|
*/
|
|
6194
|
-
retryAttempt?: number;
|
|
6194
|
+
retryAttempt?: number | undefined;
|
|
6195
6195
|
}
|
|
6196
6196
|
/**
|
|
6197
6197
|
* <p>Contains a summary of information about job executions for a specific job.</p>
|
|
@@ -6202,12 +6202,12 @@ export interface JobExecutionSummaryForJob {
|
|
|
6202
6202
|
* <p>The ARN of the thing on which the job execution is running.</p>
|
|
6203
6203
|
* @public
|
|
6204
6204
|
*/
|
|
6205
|
-
thingArn?: string;
|
|
6205
|
+
thingArn?: string | undefined;
|
|
6206
6206
|
/**
|
|
6207
6207
|
* <p>Contains a subset of information about a job execution.</p>
|
|
6208
6208
|
* @public
|
|
6209
6209
|
*/
|
|
6210
|
-
jobExecutionSummary?: JobExecutionSummary;
|
|
6210
|
+
jobExecutionSummary?: JobExecutionSummary | undefined;
|
|
6211
6211
|
}
|
|
6212
6212
|
/**
|
|
6213
6213
|
* @public
|
|
@@ -6217,13 +6217,13 @@ export interface ListJobExecutionsForJobResponse {
|
|
|
6217
6217
|
* <p>A list of job execution summaries.</p>
|
|
6218
6218
|
* @public
|
|
6219
6219
|
*/
|
|
6220
|
-
executionSummaries?: JobExecutionSummaryForJob[];
|
|
6220
|
+
executionSummaries?: JobExecutionSummaryForJob[] | undefined;
|
|
6221
6221
|
/**
|
|
6222
6222
|
* <p>The token for the next set of results, or <b>null</b> if there are no
|
|
6223
6223
|
* additional results.</p>
|
|
6224
6224
|
* @public
|
|
6225
6225
|
*/
|
|
6226
|
-
nextToken?: string;
|
|
6226
|
+
nextToken?: string | undefined;
|
|
6227
6227
|
}
|
|
6228
6228
|
/**
|
|
6229
6229
|
* @public
|
|
@@ -6238,7 +6238,7 @@ export interface ListJobExecutionsForThingRequest {
|
|
|
6238
6238
|
* <p>An optional filter that lets you search for jobs that have the specified status.</p>
|
|
6239
6239
|
* @public
|
|
6240
6240
|
*/
|
|
6241
|
-
status?: JobExecutionStatus;
|
|
6241
|
+
status?: JobExecutionStatus | undefined;
|
|
6242
6242
|
/**
|
|
6243
6243
|
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
6244
6244
|
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
|
|
@@ -6254,22 +6254,22 @@ export interface ListJobExecutionsForThingRequest {
|
|
|
6254
6254
|
* </note>
|
|
6255
6255
|
* @public
|
|
6256
6256
|
*/
|
|
6257
|
-
namespaceId?: string;
|
|
6257
|
+
namespaceId?: string | undefined;
|
|
6258
6258
|
/**
|
|
6259
6259
|
* <p>The maximum number of results to be returned per request.</p>
|
|
6260
6260
|
* @public
|
|
6261
6261
|
*/
|
|
6262
|
-
maxResults?: number;
|
|
6262
|
+
maxResults?: number | undefined;
|
|
6263
6263
|
/**
|
|
6264
6264
|
* <p>The token to retrieve the next set of results.</p>
|
|
6265
6265
|
* @public
|
|
6266
6266
|
*/
|
|
6267
|
-
nextToken?: string;
|
|
6267
|
+
nextToken?: string | undefined;
|
|
6268
6268
|
/**
|
|
6269
6269
|
* <p>The unique identifier you assigned to this job when it was created.</p>
|
|
6270
6270
|
* @public
|
|
6271
6271
|
*/
|
|
6272
|
-
jobId?: string;
|
|
6272
|
+
jobId?: string | undefined;
|
|
6273
6273
|
}
|
|
6274
6274
|
/**
|
|
6275
6275
|
* <p>The job execution summary for a thing.</p>
|
|
@@ -6280,12 +6280,12 @@ export interface JobExecutionSummaryForThing {
|
|
|
6280
6280
|
* <p>The unique identifier you assigned to this job when it was created.</p>
|
|
6281
6281
|
* @public
|
|
6282
6282
|
*/
|
|
6283
|
-
jobId?: string;
|
|
6283
|
+
jobId?: string | undefined;
|
|
6284
6284
|
/**
|
|
6285
6285
|
* <p>Contains a subset of information about a job execution.</p>
|
|
6286
6286
|
* @public
|
|
6287
6287
|
*/
|
|
6288
|
-
jobExecutionSummary?: JobExecutionSummary;
|
|
6288
|
+
jobExecutionSummary?: JobExecutionSummary | undefined;
|
|
6289
6289
|
}
|
|
6290
6290
|
/**
|
|
6291
6291
|
* @public
|
|
@@ -6295,13 +6295,13 @@ export interface ListJobExecutionsForThingResponse {
|
|
|
6295
6295
|
* <p>A list of job execution summaries.</p>
|
|
6296
6296
|
* @public
|
|
6297
6297
|
*/
|
|
6298
|
-
executionSummaries?: JobExecutionSummaryForThing[];
|
|
6298
|
+
executionSummaries?: JobExecutionSummaryForThing[] | undefined;
|
|
6299
6299
|
/**
|
|
6300
6300
|
* <p>The token for the next set of results, or <b>null</b> if there are no
|
|
6301
6301
|
* additional results.</p>
|
|
6302
6302
|
* @public
|
|
6303
6303
|
*/
|
|
6304
|
-
nextToken?: string;
|
|
6304
|
+
nextToken?: string | undefined;
|
|
6305
6305
|
}
|
|
6306
6306
|
/**
|
|
6307
6307
|
* @public
|
|
@@ -6311,7 +6311,7 @@ export interface ListJobsRequest {
|
|
|
6311
6311
|
* <p>An optional filter that lets you search for jobs that have the specified status.</p>
|
|
6312
6312
|
* @public
|
|
6313
6313
|
*/
|
|
6314
|
-
status?: JobStatus;
|
|
6314
|
+
status?: JobStatus | undefined;
|
|
6315
6315
|
/**
|
|
6316
6316
|
* <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things
|
|
6317
6317
|
* specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
|
|
@@ -6324,27 +6324,27 @@ export interface ListJobsRequest {
|
|
|
6324
6324
|
* </note>
|
|
6325
6325
|
* @public
|
|
6326
6326
|
*/
|
|
6327
|
-
targetSelection?: TargetSelection;
|
|
6327
|
+
targetSelection?: TargetSelection | undefined;
|
|
6328
6328
|
/**
|
|
6329
6329
|
* <p>The maximum number of results to return per request.</p>
|
|
6330
6330
|
* @public
|
|
6331
6331
|
*/
|
|
6332
|
-
maxResults?: number;
|
|
6332
|
+
maxResults?: number | undefined;
|
|
6333
6333
|
/**
|
|
6334
6334
|
* <p>The token to retrieve the next set of results.</p>
|
|
6335
6335
|
* @public
|
|
6336
6336
|
*/
|
|
6337
|
-
nextToken?: string;
|
|
6337
|
+
nextToken?: string | undefined;
|
|
6338
6338
|
/**
|
|
6339
6339
|
* <p>A filter that limits the returned jobs to those for the specified group.</p>
|
|
6340
6340
|
* @public
|
|
6341
6341
|
*/
|
|
6342
|
-
thingGroupName?: string;
|
|
6342
|
+
thingGroupName?: string | undefined;
|
|
6343
6343
|
/**
|
|
6344
6344
|
* <p>A filter that limits the returned jobs to those for the specified group.</p>
|
|
6345
6345
|
* @public
|
|
6346
6346
|
*/
|
|
6347
|
-
thingGroupId?: string;
|
|
6347
|
+
thingGroupId?: string | undefined;
|
|
6348
6348
|
/**
|
|
6349
6349
|
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
6350
6350
|
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
|
|
@@ -6359,7 +6359,7 @@ export interface ListJobsRequest {
|
|
|
6359
6359
|
* </note>
|
|
6360
6360
|
* @public
|
|
6361
6361
|
*/
|
|
6362
|
-
namespaceId?: string;
|
|
6362
|
+
namespaceId?: string | undefined;
|
|
6363
6363
|
}
|
|
6364
6364
|
/**
|
|
6365
6365
|
* <p>The job summary.</p>
|
|
@@ -6370,17 +6370,17 @@ export interface JobSummary {
|
|
|
6370
6370
|
* <p>The job ARN.</p>
|
|
6371
6371
|
* @public
|
|
6372
6372
|
*/
|
|
6373
|
-
jobArn?: string;
|
|
6373
|
+
jobArn?: string | undefined;
|
|
6374
6374
|
/**
|
|
6375
6375
|
* <p>The unique identifier you assigned to this job when it was created.</p>
|
|
6376
6376
|
* @public
|
|
6377
6377
|
*/
|
|
6378
|
-
jobId?: string;
|
|
6378
|
+
jobId?: string | undefined;
|
|
6379
6379
|
/**
|
|
6380
6380
|
* <p>The ID of the thing group.</p>
|
|
6381
6381
|
* @public
|
|
6382
6382
|
*/
|
|
6383
|
-
thingGroupId?: string;
|
|
6383
|
+
thingGroupId?: string | undefined;
|
|
6384
6384
|
/**
|
|
6385
6385
|
* <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things
|
|
6386
6386
|
* specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
|
|
@@ -6393,34 +6393,34 @@ export interface JobSummary {
|
|
|
6393
6393
|
* </note>
|
|
6394
6394
|
* @public
|
|
6395
6395
|
*/
|
|
6396
|
-
targetSelection?: TargetSelection;
|
|
6396
|
+
targetSelection?: TargetSelection | undefined;
|
|
6397
6397
|
/**
|
|
6398
6398
|
* <p>The job summary status.</p>
|
|
6399
6399
|
* @public
|
|
6400
6400
|
*/
|
|
6401
|
-
status?: JobStatus;
|
|
6401
|
+
status?: JobStatus | undefined;
|
|
6402
6402
|
/**
|
|
6403
6403
|
* <p>The time, in seconds since the epoch, when the job was created.</p>
|
|
6404
6404
|
* @public
|
|
6405
6405
|
*/
|
|
6406
|
-
createdAt?: Date;
|
|
6406
|
+
createdAt?: Date | undefined;
|
|
6407
6407
|
/**
|
|
6408
6408
|
* <p>The time, in seconds since the epoch, when the job was last updated.</p>
|
|
6409
6409
|
* @public
|
|
6410
6410
|
*/
|
|
6411
|
-
lastUpdatedAt?: Date;
|
|
6411
|
+
lastUpdatedAt?: Date | undefined;
|
|
6412
6412
|
/**
|
|
6413
6413
|
* <p>The time, in seconds since the epoch, when the job completed.</p>
|
|
6414
6414
|
* @public
|
|
6415
6415
|
*/
|
|
6416
|
-
completedAt?: Date;
|
|
6416
|
+
completedAt?: Date | undefined;
|
|
6417
6417
|
/**
|
|
6418
6418
|
* <p>Indicates whether a job is concurrent. Will be true when a job is
|
|
6419
6419
|
* rolling out new job executions or canceling previously created executions,
|
|
6420
6420
|
* otherwise false.</p>
|
|
6421
6421
|
* @public
|
|
6422
6422
|
*/
|
|
6423
|
-
isConcurrent?: boolean;
|
|
6423
|
+
isConcurrent?: boolean | undefined;
|
|
6424
6424
|
}
|
|
6425
6425
|
/**
|
|
6426
6426
|
* @public
|
|
@@ -6430,13 +6430,13 @@ export interface ListJobsResponse {
|
|
|
6430
6430
|
* <p>A list of jobs.</p>
|
|
6431
6431
|
* @public
|
|
6432
6432
|
*/
|
|
6433
|
-
jobs?: JobSummary[];
|
|
6433
|
+
jobs?: JobSummary[] | undefined;
|
|
6434
6434
|
/**
|
|
6435
6435
|
* <p>The token for the next set of results, or <b>null</b> if there are no
|
|
6436
6436
|
* additional results.</p>
|
|
6437
6437
|
* @public
|
|
6438
6438
|
*/
|
|
6439
|
-
nextToken?: string;
|
|
6439
|
+
nextToken?: string | undefined;
|
|
6440
6440
|
}
|
|
6441
6441
|
/**
|
|
6442
6442
|
* @public
|
|
@@ -6446,12 +6446,12 @@ export interface ListJobTemplatesRequest {
|
|
|
6446
6446
|
* <p>The maximum number of results to return in the list.</p>
|
|
6447
6447
|
* @public
|
|
6448
6448
|
*/
|
|
6449
|
-
maxResults?: number;
|
|
6449
|
+
maxResults?: number | undefined;
|
|
6450
6450
|
/**
|
|
6451
6451
|
* <p>The token to use to return the next set of results in the list.</p>
|
|
6452
6452
|
* @public
|
|
6453
6453
|
*/
|
|
6454
|
-
nextToken?: string;
|
|
6454
|
+
nextToken?: string | undefined;
|
|
6455
6455
|
}
|
|
6456
6456
|
/**
|
|
6457
6457
|
* <p>An object that contains information about the job template.</p>
|
|
@@ -6462,22 +6462,22 @@ export interface JobTemplateSummary {
|
|
|
6462
6462
|
* <p>The ARN of the job template.</p>
|
|
6463
6463
|
* @public
|
|
6464
6464
|
*/
|
|
6465
|
-
jobTemplateArn?: string;
|
|
6465
|
+
jobTemplateArn?: string | undefined;
|
|
6466
6466
|
/**
|
|
6467
6467
|
* <p>The unique identifier of the job template.</p>
|
|
6468
6468
|
* @public
|
|
6469
6469
|
*/
|
|
6470
|
-
jobTemplateId?: string;
|
|
6470
|
+
jobTemplateId?: string | undefined;
|
|
6471
6471
|
/**
|
|
6472
6472
|
* <p>A description of the job template.</p>
|
|
6473
6473
|
* @public
|
|
6474
6474
|
*/
|
|
6475
|
-
description?: string;
|
|
6475
|
+
description?: string | undefined;
|
|
6476
6476
|
/**
|
|
6477
6477
|
* <p>The time, in seconds since the epoch, when the job template was created.</p>
|
|
6478
6478
|
* @public
|
|
6479
6479
|
*/
|
|
6480
|
-
createdAt?: Date;
|
|
6480
|
+
createdAt?: Date | undefined;
|
|
6481
6481
|
}
|
|
6482
6482
|
/**
|
|
6483
6483
|
* @public
|
|
@@ -6487,13 +6487,13 @@ export interface ListJobTemplatesResponse {
|
|
|
6487
6487
|
* <p>A list of objects that contain information about the job templates.</p>
|
|
6488
6488
|
* @public
|
|
6489
6489
|
*/
|
|
6490
|
-
jobTemplates?: JobTemplateSummary[];
|
|
6490
|
+
jobTemplates?: JobTemplateSummary[] | undefined;
|
|
6491
6491
|
/**
|
|
6492
6492
|
* <p>The token for the next set of results, or <b>null</b> if there are no
|
|
6493
6493
|
* additional results.</p>
|
|
6494
6494
|
* @public
|
|
6495
6495
|
*/
|
|
6496
|
-
nextToken?: string;
|
|
6496
|
+
nextToken?: string | undefined;
|
|
6497
6497
|
}
|
|
6498
6498
|
/**
|
|
6499
6499
|
* @public
|
|
@@ -6504,17 +6504,17 @@ export interface ListManagedJobTemplatesRequest {
|
|
|
6504
6504
|
* managed job templates that have the specified template name will be returned.</p>
|
|
6505
6505
|
* @public
|
|
6506
6506
|
*/
|
|
6507
|
-
templateName?: string;
|
|
6507
|
+
templateName?: string | undefined;
|
|
6508
6508
|
/**
|
|
6509
6509
|
* <p>Maximum number of entries that can be returned.</p>
|
|
6510
6510
|
* @public
|
|
6511
6511
|
*/
|
|
6512
|
-
maxResults?: number;
|
|
6512
|
+
maxResults?: number | undefined;
|
|
6513
6513
|
/**
|
|
6514
6514
|
* <p>The token to retrieve the next set of results.</p>
|
|
6515
6515
|
* @public
|
|
6516
6516
|
*/
|
|
6517
|
-
nextToken?: string;
|
|
6517
|
+
nextToken?: string | undefined;
|
|
6518
6518
|
}
|
|
6519
6519
|
/**
|
|
6520
6520
|
* <p>An object that contains information about the managed template.</p>
|
|
@@ -6525,27 +6525,27 @@ export interface ManagedJobTemplateSummary {
|
|
|
6525
6525
|
* <p>The Amazon Resource Name (ARN) for a managed template.</p>
|
|
6526
6526
|
* @public
|
|
6527
6527
|
*/
|
|
6528
|
-
templateArn?: string;
|
|
6528
|
+
templateArn?: string | undefined;
|
|
6529
6529
|
/**
|
|
6530
6530
|
* <p>The unique Name for a managed template.</p>
|
|
6531
6531
|
* @public
|
|
6532
6532
|
*/
|
|
6533
|
-
templateName?: string;
|
|
6533
|
+
templateName?: string | undefined;
|
|
6534
6534
|
/**
|
|
6535
6535
|
* <p>The description for a managed template.</p>
|
|
6536
6536
|
* @public
|
|
6537
6537
|
*/
|
|
6538
|
-
description?: string;
|
|
6538
|
+
description?: string | undefined;
|
|
6539
6539
|
/**
|
|
6540
6540
|
* <p>A list of environments that are supported with the managed job template.</p>
|
|
6541
6541
|
* @public
|
|
6542
6542
|
*/
|
|
6543
|
-
environments?: string[];
|
|
6543
|
+
environments?: string[] | undefined;
|
|
6544
6544
|
/**
|
|
6545
6545
|
* <p>The version for a managed template.</p>
|
|
6546
6546
|
* @public
|
|
6547
6547
|
*/
|
|
6548
|
-
templateVersion?: string;
|
|
6548
|
+
templateVersion?: string | undefined;
|
|
6549
6549
|
}
|
|
6550
6550
|
/**
|
|
6551
6551
|
* @internal
|