@aws-sdk/client-iot 3.345.0 → 3.347.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/README.md +96 -0
- package/dist-cjs/IoT.js +24 -0
- package/dist-cjs/commands/CreatePackageCommand.js +47 -0
- package/dist-cjs/commands/CreatePackageVersionCommand.js +47 -0
- package/dist-cjs/commands/DeletePackageCommand.js +46 -0
- package/dist-cjs/commands/DeletePackageVersionCommand.js +46 -0
- package/dist-cjs/commands/GetPackageCommand.js +47 -0
- package/dist-cjs/commands/GetPackageConfigurationCommand.js +46 -0
- package/dist-cjs/commands/GetPackageVersionCommand.js +47 -0
- package/dist-cjs/commands/ListPackageVersionsCommand.js +46 -0
- package/dist-cjs/commands/ListPackagesCommand.js +46 -0
- package/dist-cjs/commands/UpdatePackageCommand.js +47 -0
- package/dist-cjs/commands/UpdatePackageConfigurationCommand.js +46 -0
- package/dist-cjs/commands/UpdatePackageVersionCommand.js +47 -0
- package/dist-cjs/commands/index.js +12 -0
- package/dist-cjs/models/models_0.js +68 -1
- package/dist-cjs/models/models_1.js +13 -14
- package/dist-cjs/models/models_2.js +17 -1
- package/dist-cjs/pagination/ListPackageVersionsPaginator.js +29 -0
- package/dist-cjs/pagination/ListPackagesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +897 -46
- package/dist-es/IoT.js +24 -0
- package/dist-es/commands/CreatePackageCommand.js +43 -0
- package/dist-es/commands/CreatePackageVersionCommand.js +43 -0
- package/dist-es/commands/DeletePackageCommand.js +42 -0
- package/dist-es/commands/DeletePackageVersionCommand.js +42 -0
- package/dist-es/commands/GetPackageCommand.js +43 -0
- package/dist-es/commands/GetPackageConfigurationCommand.js +42 -0
- package/dist-es/commands/GetPackageVersionCommand.js +43 -0
- package/dist-es/commands/ListPackageVersionsCommand.js +42 -0
- package/dist-es/commands/ListPackagesCommand.js +42 -0
- package/dist-es/commands/UpdatePackageCommand.js +43 -0
- package/dist-es/commands/UpdatePackageConfigurationCommand.js +42 -0
- package/dist-es/commands/UpdatePackageVersionCommand.js +43 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/models/models_0.js +60 -0
- package/dist-es/models/models_1.js +10 -12
- package/dist-es/models/models_2.js +14 -0
- package/dist-es/pagination/ListPackageVersionsPaginator.js +25 -0
- package/dist-es/pagination/ListPackagesPaginator.js +25 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +862 -35
- package/dist-types/IoT.d.ts +84 -0
- package/dist-types/IoTClient.d.ts +14 -2
- package/dist-types/commands/CreateCertificateFromCsrCommand.d.ts +1 -1
- package/dist-types/commands/CreateJobCommand.d.ts +3 -0
- package/dist-types/commands/CreateJobTemplateCommand.d.ts +3 -0
- package/dist-types/commands/CreatePackageCommand.d.ts +97 -0
- package/dist-types/commands/CreatePackageVersionCommand.d.ts +107 -0
- package/dist-types/commands/DeleteFleetMetricCommand.d.ts +1 -1
- package/dist-types/commands/DeleteJobCommand.d.ts +1 -1
- package/dist-types/commands/DeleteJobExecutionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteJobTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMitigationActionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteOTAUpdateCommand.d.ts +1 -1
- package/dist-types/commands/DeletePackageCommand.d.ts +85 -0
- package/dist-types/commands/DeletePackageVersionCommand.d.ts +85 -0
- package/dist-types/commands/DescribeJobCommand.d.ts +3 -0
- package/dist-types/commands/DescribeJobTemplateCommand.d.ts +3 -0
- package/dist-types/commands/GetPackageCommand.d.ts +92 -0
- package/dist-types/commands/GetPackageConfigurationCommand.d.ts +82 -0
- package/dist-types/commands/GetPackageVersionCommand.d.ts +98 -0
- package/dist-types/commands/ListPackageVersionsCommand.d.ts +96 -0
- package/dist-types/commands/ListPackagesCommand.d.ts +93 -0
- package/dist-types/commands/ListPolicyVersionsCommand.d.ts +2 -1
- package/dist-types/commands/ListPrincipalPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListPrincipalThingsCommand.d.ts +1 -1
- package/dist-types/commands/ListProvisioningTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListProvisioningTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListRelatedResourcesForAuditFindingCommand.d.ts +1 -1
- package/dist-types/commands/ListRoleAliasesCommand.d.ts +1 -1
- package/dist-types/commands/ListScheduledAuditsCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityProfilesCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityProfilesForTargetCommand.d.ts +1 -2
- package/dist-types/commands/UpdatePackageCommand.d.ts +89 -0
- package/dist-types/commands/UpdatePackageConfigurationCommand.d.ts +86 -0
- package/dist-types/commands/UpdatePackageVersionCommand.d.ts +92 -0
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/models/models_0.d.ts +184 -134
- package/dist-types/models/models_1.d.ts +416 -405
- package/dist-types/models/models_2.d.ts +529 -2
- package/dist-types/pagination/ListPackageVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPackagesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +108 -0
- package/dist-types/ts3.4/IoT.d.ts +204 -0
- package/dist-types/ts3.4/IoTClient.d.ts +72 -0
- package/dist-types/ts3.4/commands/CreatePackageCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreatePackageVersionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteFleetMetricCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteJobExecutionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteJobTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMitigationActionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteOTAUpdateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePackageCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeletePackageVersionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetPackageCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetPackageConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetPackageVersionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListPackageVersionsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListPackagesCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListPolicyVersionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListPrincipalPoliciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPrincipalThingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListProvisioningTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListProvisioningTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRelatedResourcesForAuditFindingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRoleAliasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListScheduledAuditsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSecurityProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSecurityProfilesForTargetCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdatePackageCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdatePackageConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdatePackageVersionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +12 -0
- package/dist-types/ts3.4/models/models_0.d.ts +71 -29
- package/dist-types/ts3.4/models/models_1.d.ts +114 -121
- package/dist-types/ts3.4/models/models_2.d.ts +152 -2
- package/dist-types/ts3.4/pagination/ListPackageVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPackagesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +144 -0
- package/package.json +28 -28
|
@@ -1,6 +1,187 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { IoTServiceException as __BaseException } from "./IoTServiceException";
|
|
3
|
-
import { AbortConfig, Action, ActiveViolation, AggregationType, AlertTarget, AuditCheckConfiguration, AuditCheckDetails, AuditFinding, AuditFrequency, AuditMitigationActionExecutionMetadata, AuditMitigationActionsExecutionStatus, AuditMitigationActionsTaskMetadata, AuditMitigationActionsTaskStatus, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditSuppression, AuditTaskMetadata, AuditTaskStatus, AuditTaskType, AuthorizerConfig, AuthorizerDescription, AuthorizerStatus, AuthorizerSummary, AutoRegistrationStatus, AwsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig, Behavior, BillingGroupProperties, CustomMetricType, DayOfWeek, DimensionType, DimensionValueOperator, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MaintenanceWindow, MetricToRetain, MetricValue, MitigationActionParams, OTAUpdateFile, OTAUpdateStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook,
|
|
3
|
+
import { AbortConfig, Action, ActiveViolation, AggregationType, AlertTarget, AuditCheckConfiguration, AuditCheckDetails, AuditFinding, AuditFrequency, AuditMitigationActionExecutionMetadata, AuditMitigationActionsExecutionStatus, AuditMitigationActionsTaskMetadata, AuditMitigationActionsTaskStatus, AuditMitigationActionsTaskTarget, AuditNotificationTarget, AuditSuppression, AuditTaskMetadata, AuditTaskStatus, AuditTaskType, AuthorizerConfig, AuthorizerDescription, AuthorizerStatus, AuthorizerSummary, AutoRegistrationStatus, AwsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig, Behavior, BillingGroupProperties, CustomMetricType, DayOfWeek, DimensionType, DimensionValueOperator, FleetMetricUnit, JobExecutionsRetryConfig, JobExecutionsRolloutConfig, LogLevel, MaintenanceWindow, MetricToRetain, MetricValue, MitigationActionParams, OTAUpdateFile, OTAUpdateStatus, PackageVersionStatus, Policy, PresignedUrlConfig, Protocol, ProvisioningHook, ResourceIdentifier, SchedulingConfig, ServiceType, StreamFile, TargetSelection, TaskStatisticsForAuditCheck, TemplateType, ThingGroupProperties, ThingTypeProperties, TimeoutConfig, TlsConfig, TopicRuleDestination, VerificationState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface DeleteFleetMetricRequest {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The name of the fleet metric to delete.</p>
|
|
10
|
+
*/
|
|
11
|
+
metricName: string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The expected version of the fleet metric to delete.</p>
|
|
14
|
+
*/
|
|
15
|
+
expectedVersion?: number;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export interface DeleteJobRequest {
|
|
21
|
+
/**
|
|
22
|
+
* <p>The ID of the job to be deleted.</p>
|
|
23
|
+
* <p>After a job deletion is completed, you may reuse this jobId when you create a new job.
|
|
24
|
+
* However, this is not recommended, and you must ensure that your devices are not using the
|
|
25
|
+
* jobId to refer to the deleted job.</p>
|
|
26
|
+
*/
|
|
27
|
+
jobId: string | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* <p>(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can
|
|
30
|
+
* only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception
|
|
31
|
+
* will occur. The default is false.</p>
|
|
32
|
+
* <note>
|
|
33
|
+
* <p>Deleting a job which is "IN_PROGRESS", will cause a device which is executing
|
|
34
|
+
* the job to be unable to access job information or update the job execution status.
|
|
35
|
+
* Use caution and ensure that each device executing a job which is deleted is able to recover to
|
|
36
|
+
* a valid state.</p>
|
|
37
|
+
* </note>
|
|
38
|
+
*/
|
|
39
|
+
force?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
42
|
+
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
|
|
43
|
+
* contain the value in the following format.</p>
|
|
44
|
+
* <p>
|
|
45
|
+
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
46
|
+
* </p>
|
|
47
|
+
* <note>
|
|
48
|
+
* <p>The <code>namespaceId</code> feature is in public preview.</p>
|
|
49
|
+
* </note>
|
|
50
|
+
*/
|
|
51
|
+
namespaceId?: string;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
export interface DeleteJobExecutionRequest {
|
|
57
|
+
/**
|
|
58
|
+
* <p>The ID of the job whose execution on a particular device will be deleted.</p>
|
|
59
|
+
*/
|
|
60
|
+
jobId: string | undefined;
|
|
61
|
+
/**
|
|
62
|
+
* <p>The name of the thing whose job execution will be deleted.</p>
|
|
63
|
+
*/
|
|
64
|
+
thingName: string | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* <p>The ID of the job execution to be deleted. The <code>executionNumber</code> refers to the
|
|
67
|
+
* execution of a particular job on a particular device.</p>
|
|
68
|
+
* <p>Note that once a job execution is deleted, the <code>executionNumber</code> may be reused
|
|
69
|
+
* by IoT, so be sure you get and use the correct value here.</p>
|
|
70
|
+
*/
|
|
71
|
+
executionNumber: number | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* <p>(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise,
|
|
74
|
+
* you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED",
|
|
75
|
+
* "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.</p>
|
|
76
|
+
* <note>
|
|
77
|
+
* <p>Deleting a job execution which is "IN_PROGRESS", will cause the device
|
|
78
|
+
* to be unable to access job information or update the job execution status.
|
|
79
|
+
* Use caution and ensure that the device is able to recover to a valid state.</p>
|
|
80
|
+
* </note>
|
|
81
|
+
*/
|
|
82
|
+
force?: boolean;
|
|
83
|
+
/**
|
|
84
|
+
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
85
|
+
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that
|
|
86
|
+
* contain the value in the following format.</p>
|
|
87
|
+
* <p>
|
|
88
|
+
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
89
|
+
* </p>
|
|
90
|
+
* <note>
|
|
91
|
+
* <p>The <code>namespaceId</code> feature is in public preview.</p>
|
|
92
|
+
* </note>
|
|
93
|
+
*/
|
|
94
|
+
namespaceId?: string;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export interface DeleteJobTemplateRequest {
|
|
100
|
+
/**
|
|
101
|
+
* <p>The unique identifier of the job template to delete.</p>
|
|
102
|
+
*/
|
|
103
|
+
jobTemplateId: string | undefined;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
export interface DeleteMitigationActionRequest {
|
|
109
|
+
/**
|
|
110
|
+
* <p>The name of the mitigation action that you want to delete.</p>
|
|
111
|
+
*/
|
|
112
|
+
actionName: string | undefined;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
export interface DeleteMitigationActionResponse {
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
export interface DeleteOTAUpdateRequest {
|
|
123
|
+
/**
|
|
124
|
+
* <p>The ID of the OTA update to delete.</p>
|
|
125
|
+
*/
|
|
126
|
+
otaUpdateId: string | undefined;
|
|
127
|
+
/**
|
|
128
|
+
* <p>When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted.
|
|
129
|
+
* Ignored if the stream specified in the OTAUpdate is supplied by the user.</p>
|
|
130
|
+
*/
|
|
131
|
+
deleteStream?: boolean;
|
|
132
|
+
/**
|
|
133
|
+
* <p>When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the
|
|
134
|
+
* job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.</p>
|
|
135
|
+
*/
|
|
136
|
+
forceDeleteAWSJob?: boolean;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
141
|
+
export interface DeleteOTAUpdateResponse {
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
export interface DeletePackageRequest {
|
|
147
|
+
/**
|
|
148
|
+
* <p>The name of the target package.</p>
|
|
149
|
+
*/
|
|
150
|
+
packageName: string | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
|
|
153
|
+
* Don't reuse this client token if a new idempotent request is required.</p>
|
|
154
|
+
*/
|
|
155
|
+
clientToken?: string;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
export interface DeletePackageResponse {
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
export interface DeletePackageVersionRequest {
|
|
166
|
+
/**
|
|
167
|
+
* <p>The name of the associated package.</p>
|
|
168
|
+
*/
|
|
169
|
+
packageName: string | undefined;
|
|
170
|
+
/**
|
|
171
|
+
* <p>The name of the target package version.</p>
|
|
172
|
+
*/
|
|
173
|
+
versionName: string | undefined;
|
|
174
|
+
/**
|
|
175
|
+
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
|
|
176
|
+
* Don't reuse this client token if a new idempotent request is required.</p>
|
|
177
|
+
*/
|
|
178
|
+
clientToken?: string;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* @public
|
|
182
|
+
*/
|
|
183
|
+
export interface DeletePackageVersionResponse {
|
|
184
|
+
}
|
|
4
185
|
/**
|
|
5
186
|
* @public
|
|
6
187
|
* <p>The input for the DeletePolicy operation.</p>
|
|
@@ -1666,6 +1847,13 @@ export interface Job {
|
|
|
1666
1847
|
* <p>Displays the next seven maintenance window occurrences and their start times.</p>
|
|
1667
1848
|
*/
|
|
1668
1849
|
scheduledJobRollouts?: ScheduledJobRollout[];
|
|
1850
|
+
/**
|
|
1851
|
+
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. </p>
|
|
1852
|
+
* <p>
|
|
1853
|
+
* <b>Note:</b>The following Length Constraints relates to a single string.
|
|
1854
|
+
* Up to five strings are allowed.</p>
|
|
1855
|
+
*/
|
|
1856
|
+
destinationPackageVersions?: string[];
|
|
1669
1857
|
}
|
|
1670
1858
|
/**
|
|
1671
1859
|
* @public
|
|
@@ -1858,6 +2046,13 @@ export interface DescribeJobTemplateResponse {
|
|
|
1858
2046
|
* <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>
|
|
1859
2047
|
*/
|
|
1860
2048
|
maintenanceWindows?: MaintenanceWindow[];
|
|
2049
|
+
/**
|
|
2050
|
+
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. </p>
|
|
2051
|
+
* <p>
|
|
2052
|
+
* <b>Note:</b>The following Length Constraints relates to a single string.
|
|
2053
|
+
* Up to five strings are allowed.</p>
|
|
2054
|
+
*/
|
|
2055
|
+
destinationPackageVersions?: string[];
|
|
1861
2056
|
}
|
|
1862
2057
|
/**
|
|
1863
2058
|
* @public
|
|
@@ -1952,19 +2147,6 @@ export interface DescribeManagedJobTemplateResponse {
|
|
|
1952
2147
|
*/
|
|
1953
2148
|
document?: string;
|
|
1954
2149
|
}
|
|
1955
|
-
/**
|
|
1956
|
-
* @public
|
|
1957
|
-
* <p>Internal error from the service that indicates an unexpected error or that the service
|
|
1958
|
-
* is unavailable.</p>
|
|
1959
|
-
*/
|
|
1960
|
-
export declare class InternalServerException extends __BaseException {
|
|
1961
|
-
readonly name: "InternalServerException";
|
|
1962
|
-
readonly $fault: "server";
|
|
1963
|
-
/**
|
|
1964
|
-
* @internal
|
|
1965
|
-
*/
|
|
1966
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
1967
|
-
}
|
|
1968
2150
|
/**
|
|
1969
2151
|
* @public
|
|
1970
2152
|
*/
|
|
@@ -3354,6 +3536,130 @@ export interface GetOTAUpdateResponse {
|
|
|
3354
3536
|
*/
|
|
3355
3537
|
otaUpdateInfo?: OTAUpdateInfo;
|
|
3356
3538
|
}
|
|
3539
|
+
/**
|
|
3540
|
+
* @public
|
|
3541
|
+
*/
|
|
3542
|
+
export interface GetPackageRequest {
|
|
3543
|
+
/**
|
|
3544
|
+
* <p>The name of the target package.</p>
|
|
3545
|
+
*/
|
|
3546
|
+
packageName: string | undefined;
|
|
3547
|
+
}
|
|
3548
|
+
/**
|
|
3549
|
+
* @public
|
|
3550
|
+
*/
|
|
3551
|
+
export interface GetPackageResponse {
|
|
3552
|
+
/**
|
|
3553
|
+
* <p>The name of the package.</p>
|
|
3554
|
+
*/
|
|
3555
|
+
packageName?: string;
|
|
3556
|
+
/**
|
|
3557
|
+
* <p>The ARN for the package.</p>
|
|
3558
|
+
*/
|
|
3559
|
+
packageArn?: string;
|
|
3560
|
+
/**
|
|
3561
|
+
* <p>The package description.</p>
|
|
3562
|
+
*/
|
|
3563
|
+
description?: string;
|
|
3564
|
+
/**
|
|
3565
|
+
* <p>The name of the default package version.</p>
|
|
3566
|
+
*/
|
|
3567
|
+
defaultVersionName?: string;
|
|
3568
|
+
/**
|
|
3569
|
+
* <p>The date the package was created.</p>
|
|
3570
|
+
*/
|
|
3571
|
+
creationDate?: Date;
|
|
3572
|
+
/**
|
|
3573
|
+
* <p>The date when the package was last updated.</p>
|
|
3574
|
+
*/
|
|
3575
|
+
lastModifiedDate?: Date;
|
|
3576
|
+
}
|
|
3577
|
+
/**
|
|
3578
|
+
* @public
|
|
3579
|
+
*/
|
|
3580
|
+
export interface GetPackageConfigurationRequest {
|
|
3581
|
+
}
|
|
3582
|
+
/**
|
|
3583
|
+
* @public
|
|
3584
|
+
* <p>Configuration to manage IoT Job's package version reporting. If configured, Jobs updates the thing's reserved named shadow with the package version information up on successful job completion.</p>
|
|
3585
|
+
* <p>
|
|
3586
|
+
* <b>Note:</b> For each job, the destinationPackageVersions attribute has to be set with the correct data for Jobs to report to the thing shadow.
|
|
3587
|
+
* </p>
|
|
3588
|
+
*/
|
|
3589
|
+
export interface VersionUpdateByJobsConfig {
|
|
3590
|
+
/**
|
|
3591
|
+
* <p>Indicates whether the Job is enabled or not.</p>
|
|
3592
|
+
*/
|
|
3593
|
+
enabled?: boolean;
|
|
3594
|
+
/**
|
|
3595
|
+
* <p>The Amazon Resource Name (ARN) of the role that grants permission to the IoT
|
|
3596
|
+
* jobs service to update the reserved named shadow when the job successfully completes.</p>
|
|
3597
|
+
*/
|
|
3598
|
+
roleArn?: string;
|
|
3599
|
+
}
|
|
3600
|
+
/**
|
|
3601
|
+
* @public
|
|
3602
|
+
*/
|
|
3603
|
+
export interface GetPackageConfigurationResponse {
|
|
3604
|
+
/**
|
|
3605
|
+
* <p>The version that is associated to a specific job.</p>
|
|
3606
|
+
*/
|
|
3607
|
+
versionUpdateByJobsConfig?: VersionUpdateByJobsConfig;
|
|
3608
|
+
}
|
|
3609
|
+
/**
|
|
3610
|
+
* @public
|
|
3611
|
+
*/
|
|
3612
|
+
export interface GetPackageVersionRequest {
|
|
3613
|
+
/**
|
|
3614
|
+
* <p>The name of the associated package.</p>
|
|
3615
|
+
*/
|
|
3616
|
+
packageName: string | undefined;
|
|
3617
|
+
/**
|
|
3618
|
+
* <p>The name of the target package version.</p>
|
|
3619
|
+
*/
|
|
3620
|
+
versionName: string | undefined;
|
|
3621
|
+
}
|
|
3622
|
+
/**
|
|
3623
|
+
* @public
|
|
3624
|
+
*/
|
|
3625
|
+
export interface GetPackageVersionResponse {
|
|
3626
|
+
/**
|
|
3627
|
+
* <p>The ARN for the package version.</p>
|
|
3628
|
+
*/
|
|
3629
|
+
packageVersionArn?: string;
|
|
3630
|
+
/**
|
|
3631
|
+
* <p>The name of the package.</p>
|
|
3632
|
+
*/
|
|
3633
|
+
packageName?: string;
|
|
3634
|
+
/**
|
|
3635
|
+
* <p>The name of the package version.</p>
|
|
3636
|
+
*/
|
|
3637
|
+
versionName?: string;
|
|
3638
|
+
/**
|
|
3639
|
+
* <p>The package version description.</p>
|
|
3640
|
+
*/
|
|
3641
|
+
description?: string;
|
|
3642
|
+
/**
|
|
3643
|
+
* <p>Metadata that were added to the package version that can be used to define a package version’s configuration.</p>
|
|
3644
|
+
*/
|
|
3645
|
+
attributes?: Record<string, string>;
|
|
3646
|
+
/**
|
|
3647
|
+
* <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>
|
|
3648
|
+
*/
|
|
3649
|
+
status?: PackageVersionStatus | string;
|
|
3650
|
+
/**
|
|
3651
|
+
* <p>Error reason for a package version failure during creation or update.</p>
|
|
3652
|
+
*/
|
|
3653
|
+
errorReason?: string;
|
|
3654
|
+
/**
|
|
3655
|
+
* <p>The date when the package version was created.</p>
|
|
3656
|
+
*/
|
|
3657
|
+
creationDate?: Date;
|
|
3658
|
+
/**
|
|
3659
|
+
* <p>The date when the package version was last updated.</p>
|
|
3660
|
+
*/
|
|
3661
|
+
lastModifiedDate?: Date;
|
|
3662
|
+
}
|
|
3357
3663
|
/**
|
|
3358
3664
|
* @public
|
|
3359
3665
|
*/
|
|
@@ -5246,123 +5552,117 @@ export interface ListOutgoingCertificatesResponse {
|
|
|
5246
5552
|
}
|
|
5247
5553
|
/**
|
|
5248
5554
|
* @public
|
|
5249
|
-
* <p>The input for the ListPolicies operation.</p>
|
|
5250
5555
|
*/
|
|
5251
|
-
export interface
|
|
5556
|
+
export interface ListPackagesRequest {
|
|
5252
5557
|
/**
|
|
5253
|
-
* <p>The
|
|
5558
|
+
* <p>The maximum number of results returned at one time.</p>
|
|
5254
5559
|
*/
|
|
5255
|
-
|
|
5560
|
+
maxResults?: number;
|
|
5256
5561
|
/**
|
|
5257
|
-
* <p>The
|
|
5562
|
+
* <p>The token for the next set of results.</p>
|
|
5258
5563
|
*/
|
|
5259
|
-
|
|
5564
|
+
nextToken?: string;
|
|
5565
|
+
}
|
|
5566
|
+
/**
|
|
5567
|
+
* @public
|
|
5568
|
+
* <p>A summary of information about a software package.</p>
|
|
5569
|
+
*/
|
|
5570
|
+
export interface PackageSummary {
|
|
5260
5571
|
/**
|
|
5261
|
-
* <p>
|
|
5262
|
-
* creation order.</p>
|
|
5572
|
+
* <p>The name for the target package.</p>
|
|
5263
5573
|
*/
|
|
5264
|
-
|
|
5574
|
+
packageName?: string;
|
|
5575
|
+
/**
|
|
5576
|
+
* <p>The name of the default package version.</p>
|
|
5577
|
+
*/
|
|
5578
|
+
defaultVersionName?: string;
|
|
5579
|
+
/**
|
|
5580
|
+
* <p>The date that the package was created.</p>
|
|
5581
|
+
*/
|
|
5582
|
+
creationDate?: Date;
|
|
5583
|
+
/**
|
|
5584
|
+
* <p>The date that the package was last updated.</p>
|
|
5585
|
+
*/
|
|
5586
|
+
lastModifiedDate?: Date;
|
|
5265
5587
|
}
|
|
5266
5588
|
/**
|
|
5267
5589
|
* @public
|
|
5268
|
-
* <p>The output from the ListPolicies operation.</p>
|
|
5269
5590
|
*/
|
|
5270
|
-
export interface
|
|
5591
|
+
export interface ListPackagesResponse {
|
|
5271
5592
|
/**
|
|
5272
|
-
* <p>The
|
|
5593
|
+
* <p>The software package summary.</p>
|
|
5273
5594
|
*/
|
|
5274
|
-
|
|
5595
|
+
packageSummaries?: PackageSummary[];
|
|
5275
5596
|
/**
|
|
5276
|
-
* <p>The
|
|
5277
|
-
* results.</p>
|
|
5597
|
+
* <p>The token for the next set of results.</p>
|
|
5278
5598
|
*/
|
|
5279
|
-
|
|
5599
|
+
nextToken?: string;
|
|
5280
5600
|
}
|
|
5281
5601
|
/**
|
|
5282
5602
|
* @public
|
|
5283
|
-
* <p>The input for the ListPolicyPrincipals operation.</p>
|
|
5284
5603
|
*/
|
|
5285
|
-
export interface
|
|
5604
|
+
export interface ListPackageVersionsRequest {
|
|
5286
5605
|
/**
|
|
5287
|
-
* <p>The
|
|
5606
|
+
* <p>The name of the target package.</p>
|
|
5288
5607
|
*/
|
|
5289
|
-
|
|
5608
|
+
packageName: string | undefined;
|
|
5290
5609
|
/**
|
|
5291
|
-
* <p>The
|
|
5610
|
+
* <p>The status of the package version. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
|
|
5292
5611
|
*/
|
|
5293
|
-
|
|
5612
|
+
status?: PackageVersionStatus | string;
|
|
5294
5613
|
/**
|
|
5295
|
-
* <p>The
|
|
5614
|
+
* <p>The maximum number of results to return at one time.</p>
|
|
5296
5615
|
*/
|
|
5297
|
-
|
|
5616
|
+
maxResults?: number;
|
|
5298
5617
|
/**
|
|
5299
|
-
* <p>
|
|
5300
|
-
* creation order.</p>
|
|
5618
|
+
* <p>The token for the next set of results.</p>
|
|
5301
5619
|
*/
|
|
5302
|
-
|
|
5620
|
+
nextToken?: string;
|
|
5303
5621
|
}
|
|
5304
5622
|
/**
|
|
5305
5623
|
* @public
|
|
5306
|
-
* <p>
|
|
5624
|
+
* <p>A summary of information about a package version.</p>
|
|
5307
5625
|
*/
|
|
5308
|
-
export interface
|
|
5309
|
-
/**
|
|
5310
|
-
* <p>The descriptions of the principals.</p>
|
|
5311
|
-
*/
|
|
5312
|
-
principals?: string[];
|
|
5626
|
+
export interface PackageVersionSummary {
|
|
5313
5627
|
/**
|
|
5314
|
-
* <p>The
|
|
5315
|
-
* results.</p>
|
|
5628
|
+
* <p>The name of the associated software package.</p>
|
|
5316
5629
|
*/
|
|
5317
|
-
|
|
5318
|
-
}
|
|
5319
|
-
/**
|
|
5320
|
-
* @public
|
|
5321
|
-
* <p>The input for the ListPolicyVersions operation.</p>
|
|
5322
|
-
*/
|
|
5323
|
-
export interface ListPolicyVersionsRequest {
|
|
5630
|
+
packageName?: string;
|
|
5324
5631
|
/**
|
|
5325
|
-
* <p>The
|
|
5632
|
+
* <p>The name of the target package version.</p>
|
|
5326
5633
|
*/
|
|
5327
|
-
|
|
5328
|
-
}
|
|
5329
|
-
/**
|
|
5330
|
-
* @public
|
|
5331
|
-
* <p>Describes a policy version.</p>
|
|
5332
|
-
*/
|
|
5333
|
-
export interface PolicyVersion {
|
|
5634
|
+
versionName?: string;
|
|
5334
5635
|
/**
|
|
5335
|
-
* <p>The
|
|
5636
|
+
* <p>The status of the package version. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
|
|
5336
5637
|
*/
|
|
5337
|
-
|
|
5638
|
+
status?: PackageVersionStatus | string;
|
|
5338
5639
|
/**
|
|
5339
|
-
* <p>
|
|
5640
|
+
* <p>The date that the package version was created.</p>
|
|
5340
5641
|
*/
|
|
5341
|
-
|
|
5642
|
+
creationDate?: Date;
|
|
5342
5643
|
/**
|
|
5343
|
-
* <p>The date
|
|
5644
|
+
* <p>The date that the package version was last updated.</p>
|
|
5344
5645
|
*/
|
|
5345
|
-
|
|
5646
|
+
lastModifiedDate?: Date;
|
|
5346
5647
|
}
|
|
5347
5648
|
/**
|
|
5348
5649
|
* @public
|
|
5349
|
-
* <p>The output from the ListPolicyVersions operation.</p>
|
|
5350
5650
|
*/
|
|
5351
|
-
export interface
|
|
5651
|
+
export interface ListPackageVersionsResponse {
|
|
5352
5652
|
/**
|
|
5353
|
-
* <p>
|
|
5653
|
+
* <p>Lists the package versions associated to the package.</p>
|
|
5354
5654
|
*/
|
|
5355
|
-
|
|
5655
|
+
packageVersionSummaries?: PackageVersionSummary[];
|
|
5656
|
+
/**
|
|
5657
|
+
* <p>The token for the next set of results.</p>
|
|
5658
|
+
*/
|
|
5659
|
+
nextToken?: string;
|
|
5356
5660
|
}
|
|
5357
5661
|
/**
|
|
5358
5662
|
* @public
|
|
5359
|
-
* <p>The input for the
|
|
5663
|
+
* <p>The input for the ListPolicies operation.</p>
|
|
5360
5664
|
*/
|
|
5361
|
-
export interface
|
|
5362
|
-
/**
|
|
5363
|
-
* <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>
|
|
5364
|
-
*/
|
|
5365
|
-
principal: string | undefined;
|
|
5665
|
+
export interface ListPoliciesRequest {
|
|
5366
5666
|
/**
|
|
5367
5667
|
* <p>The marker for the next set of results.</p>
|
|
5368
5668
|
*/
|
|
@@ -5372,18 +5672,18 @@ export interface ListPrincipalPoliciesRequest {
|
|
|
5372
5672
|
*/
|
|
5373
5673
|
pageSize?: number;
|
|
5374
5674
|
/**
|
|
5375
|
-
* <p>Specifies the order for results. If true, results are returned in ascending
|
|
5376
|
-
* order.</p>
|
|
5675
|
+
* <p>Specifies the order for results. If true, the results are returned in ascending
|
|
5676
|
+
* creation order.</p>
|
|
5377
5677
|
*/
|
|
5378
5678
|
ascendingOrder?: boolean;
|
|
5379
5679
|
}
|
|
5380
5680
|
/**
|
|
5381
5681
|
* @public
|
|
5382
|
-
* <p>The output from the
|
|
5682
|
+
* <p>The output from the ListPolicies operation.</p>
|
|
5383
5683
|
*/
|
|
5384
|
-
export interface
|
|
5684
|
+
export interface ListPoliciesResponse {
|
|
5385
5685
|
/**
|
|
5386
|
-
* <p>The policies.</p>
|
|
5686
|
+
* <p>The descriptions of the policies.</p>
|
|
5387
5687
|
*/
|
|
5388
5688
|
policies?: Policy[];
|
|
5389
5689
|
/**
|
|
@@ -5394,364 +5694,75 @@ export interface ListPrincipalPoliciesResponse {
|
|
|
5394
5694
|
}
|
|
5395
5695
|
/**
|
|
5396
5696
|
* @public
|
|
5397
|
-
* <p>The input for the
|
|
5398
|
-
*/
|
|
5399
|
-
export interface ListPrincipalThingsRequest {
|
|
5400
|
-
/**
|
|
5401
|
-
* <p>To retrieve the next set of results, the <code>nextToken</code>
|
|
5402
|
-
* value from a previous response; otherwise <b>null</b> to receive
|
|
5403
|
-
* the first set of results.</p>
|
|
5404
|
-
*/
|
|
5405
|
-
nextToken?: string;
|
|
5406
|
-
/**
|
|
5407
|
-
* <p>The maximum number of results to return in this operation.</p>
|
|
5408
|
-
*/
|
|
5409
|
-
maxResults?: number;
|
|
5410
|
-
/**
|
|
5411
|
-
* <p>The principal.</p>
|
|
5412
|
-
*/
|
|
5413
|
-
principal: string | undefined;
|
|
5414
|
-
}
|
|
5415
|
-
/**
|
|
5416
|
-
* @public
|
|
5417
|
-
* <p>The output from the ListPrincipalThings operation.</p>
|
|
5418
|
-
*/
|
|
5419
|
-
export interface ListPrincipalThingsResponse {
|
|
5420
|
-
/**
|
|
5421
|
-
* <p>The things.</p>
|
|
5422
|
-
*/
|
|
5423
|
-
things?: string[];
|
|
5424
|
-
/**
|
|
5425
|
-
* <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
|
|
5426
|
-
*/
|
|
5427
|
-
nextToken?: string;
|
|
5428
|
-
}
|
|
5429
|
-
/**
|
|
5430
|
-
* @public
|
|
5431
|
-
*/
|
|
5432
|
-
export interface ListProvisioningTemplatesRequest {
|
|
5433
|
-
/**
|
|
5434
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
5435
|
-
*/
|
|
5436
|
-
maxResults?: number;
|
|
5437
|
-
/**
|
|
5438
|
-
* <p>A token to retrieve the next set of results.</p>
|
|
5439
|
-
*/
|
|
5440
|
-
nextToken?: string;
|
|
5441
|
-
}
|
|
5442
|
-
/**
|
|
5443
|
-
* @public
|
|
5444
|
-
* <p>A summary of information about a provisioning template.</p>
|
|
5445
|
-
*/
|
|
5446
|
-
export interface ProvisioningTemplateSummary {
|
|
5447
|
-
/**
|
|
5448
|
-
* <p>The ARN of the provisioning template.</p>
|
|
5449
|
-
*/
|
|
5450
|
-
templateArn?: string;
|
|
5451
|
-
/**
|
|
5452
|
-
* <p>The name of the provisioning template.</p>
|
|
5453
|
-
*/
|
|
5454
|
-
templateName?: string;
|
|
5455
|
-
/**
|
|
5456
|
-
* <p>The description of the provisioning template.</p>
|
|
5457
|
-
*/
|
|
5458
|
-
description?: string;
|
|
5459
|
-
/**
|
|
5460
|
-
* <p>The date when the provisioning template summary was created.</p>
|
|
5461
|
-
*/
|
|
5462
|
-
creationDate?: Date;
|
|
5463
|
-
/**
|
|
5464
|
-
* <p>The date when the provisioning template summary was last modified.</p>
|
|
5465
|
-
*/
|
|
5466
|
-
lastModifiedDate?: Date;
|
|
5467
|
-
/**
|
|
5468
|
-
* <p>True if the fleet provision template is enabled, otherwise false.</p>
|
|
5469
|
-
*/
|
|
5470
|
-
enabled?: boolean;
|
|
5471
|
-
/**
|
|
5472
|
-
* <p>The type you define in a provisioning template. You can create a template with only one type.
|
|
5473
|
-
* You can't change the template type after its creation. The default value is <code>FLEET_PROVISIONING</code>.
|
|
5474
|
-
* For more information about provisioning template, see: <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html">Provisioning template</a>.
|
|
5475
|
-
* </p>
|
|
5476
|
-
*/
|
|
5477
|
-
type?: TemplateType | string;
|
|
5478
|
-
}
|
|
5479
|
-
/**
|
|
5480
|
-
* @public
|
|
5481
|
-
*/
|
|
5482
|
-
export interface ListProvisioningTemplatesResponse {
|
|
5483
|
-
/**
|
|
5484
|
-
* <p>A list of provisioning templates</p>
|
|
5485
|
-
*/
|
|
5486
|
-
templates?: ProvisioningTemplateSummary[];
|
|
5487
|
-
/**
|
|
5488
|
-
* <p>A token to retrieve the next set of results.</p>
|
|
5489
|
-
*/
|
|
5490
|
-
nextToken?: string;
|
|
5491
|
-
}
|
|
5492
|
-
/**
|
|
5493
|
-
* @public
|
|
5494
|
-
*/
|
|
5495
|
-
export interface ListProvisioningTemplateVersionsRequest {
|
|
5496
|
-
/**
|
|
5497
|
-
* <p>The name of the provisioning template.</p>
|
|
5498
|
-
*/
|
|
5499
|
-
templateName: string | undefined;
|
|
5500
|
-
/**
|
|
5501
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
5502
|
-
*/
|
|
5503
|
-
maxResults?: number;
|
|
5504
|
-
/**
|
|
5505
|
-
* <p>A token to retrieve the next set of results.</p>
|
|
5506
|
-
*/
|
|
5507
|
-
nextToken?: string;
|
|
5508
|
-
}
|
|
5509
|
-
/**
|
|
5510
|
-
* @public
|
|
5511
|
-
* <p>A summary of information about a fleet provision template version.</p>
|
|
5512
|
-
*/
|
|
5513
|
-
export interface ProvisioningTemplateVersionSummary {
|
|
5514
|
-
/**
|
|
5515
|
-
* <p>The ID of the fleet provisioning template version.</p>
|
|
5516
|
-
*/
|
|
5517
|
-
versionId?: number;
|
|
5518
|
-
/**
|
|
5519
|
-
* <p>The date when the provisioning template version was created</p>
|
|
5520
|
-
*/
|
|
5521
|
-
creationDate?: Date;
|
|
5522
|
-
/**
|
|
5523
|
-
* <p>True if the provisioning template version is the default version, otherwise
|
|
5524
|
-
* false.</p>
|
|
5525
|
-
*/
|
|
5526
|
-
isDefaultVersion?: boolean;
|
|
5527
|
-
}
|
|
5528
|
-
/**
|
|
5529
|
-
* @public
|
|
5530
|
-
*/
|
|
5531
|
-
export interface ListProvisioningTemplateVersionsResponse {
|
|
5532
|
-
/**
|
|
5533
|
-
* <p>The list of provisioning template versions.</p>
|
|
5534
|
-
*/
|
|
5535
|
-
versions?: ProvisioningTemplateVersionSummary[];
|
|
5536
|
-
/**
|
|
5537
|
-
* <p>A token to retrieve the next set of results.</p>
|
|
5538
|
-
*/
|
|
5539
|
-
nextToken?: string;
|
|
5540
|
-
}
|
|
5541
|
-
/**
|
|
5542
|
-
* @public
|
|
5543
|
-
*/
|
|
5544
|
-
export interface ListRelatedResourcesForAuditFindingRequest {
|
|
5545
|
-
/**
|
|
5546
|
-
* <p>The finding Id.</p>
|
|
5547
|
-
*/
|
|
5548
|
-
findingId: string | undefined;
|
|
5549
|
-
/**
|
|
5550
|
-
* <p>A token that can be used to retrieve the next set of results,
|
|
5551
|
-
* or <code>null</code> if there are no additional results.</p>
|
|
5552
|
-
*/
|
|
5553
|
-
nextToken?: string;
|
|
5554
|
-
/**
|
|
5555
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
5556
|
-
*/
|
|
5557
|
-
maxResults?: number;
|
|
5558
|
-
}
|
|
5559
|
-
/**
|
|
5560
|
-
* @public
|
|
5697
|
+
* <p>The input for the ListPolicyPrincipals operation.</p>
|
|
5561
5698
|
*/
|
|
5562
|
-
export interface
|
|
5699
|
+
export interface ListPolicyPrincipalsRequest {
|
|
5563
5700
|
/**
|
|
5564
|
-
* <p>The
|
|
5701
|
+
* <p>The policy name.</p>
|
|
5565
5702
|
*/
|
|
5566
|
-
|
|
5703
|
+
policyName: string | undefined;
|
|
5567
5704
|
/**
|
|
5568
|
-
* <p>
|
|
5569
|
-
* or <code>null</code> for the first API call.</p>
|
|
5705
|
+
* <p>The marker for the next set of results.</p>
|
|
5570
5706
|
*/
|
|
5571
|
-
|
|
5572
|
-
}
|
|
5573
|
-
/**
|
|
5574
|
-
* @public
|
|
5575
|
-
*/
|
|
5576
|
-
export interface ListRoleAliasesRequest {
|
|
5707
|
+
marker?: string;
|
|
5577
5708
|
/**
|
|
5578
|
-
* <p>The
|
|
5709
|
+
* <p>The result page size.</p>
|
|
5579
5710
|
*/
|
|
5580
5711
|
pageSize?: number;
|
|
5581
5712
|
/**
|
|
5582
|
-
* <p>
|
|
5583
|
-
|
|
5584
|
-
marker?: string;
|
|
5585
|
-
/**
|
|
5586
|
-
* <p>Return the list of role aliases in ascending alphabetical order.</p>
|
|
5713
|
+
* <p>Specifies the order for results. If true, the results are returned in ascending
|
|
5714
|
+
* creation order.</p>
|
|
5587
5715
|
*/
|
|
5588
5716
|
ascendingOrder?: boolean;
|
|
5589
5717
|
}
|
|
5590
5718
|
/**
|
|
5591
5719
|
* @public
|
|
5720
|
+
* <p>The output from the ListPolicyPrincipals operation.</p>
|
|
5592
5721
|
*/
|
|
5593
|
-
export interface
|
|
5722
|
+
export interface ListPolicyPrincipalsResponse {
|
|
5594
5723
|
/**
|
|
5595
|
-
* <p>The
|
|
5724
|
+
* <p>The descriptions of the principals.</p>
|
|
5596
5725
|
*/
|
|
5597
|
-
|
|
5726
|
+
principals?: string[];
|
|
5598
5727
|
/**
|
|
5599
|
-
* <p>
|
|
5728
|
+
* <p>The marker for the next set of results, or null if there are no additional
|
|
5729
|
+
* results.</p>
|
|
5600
5730
|
*/
|
|
5601
5731
|
nextMarker?: string;
|
|
5602
5732
|
}
|
|
5603
5733
|
/**
|
|
5604
5734
|
* @public
|
|
5735
|
+
* <p>The input for the ListPolicyVersions operation.</p>
|
|
5605
5736
|
*/
|
|
5606
|
-
export interface
|
|
5607
|
-
/**
|
|
5608
|
-
* <p>The token for the next set of results.</p>
|
|
5609
|
-
*/
|
|
5610
|
-
nextToken?: string;
|
|
5611
|
-
/**
|
|
5612
|
-
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
5613
|
-
*/
|
|
5614
|
-
maxResults?: number;
|
|
5615
|
-
}
|
|
5616
|
-
/**
|
|
5617
|
-
* @public
|
|
5618
|
-
* <p>Information about the scheduled audit.</p>
|
|
5619
|
-
*/
|
|
5620
|
-
export interface ScheduledAuditMetadata {
|
|
5621
|
-
/**
|
|
5622
|
-
* <p>The name of the scheduled audit.</p>
|
|
5623
|
-
*/
|
|
5624
|
-
scheduledAuditName?: string;
|
|
5625
|
-
/**
|
|
5626
|
-
* <p>The ARN of the scheduled audit.</p>
|
|
5627
|
-
*/
|
|
5628
|
-
scheduledAuditArn?: string;
|
|
5629
|
-
/**
|
|
5630
|
-
* <p>How often the scheduled audit occurs.</p>
|
|
5631
|
-
*/
|
|
5632
|
-
frequency?: AuditFrequency | string;
|
|
5633
|
-
/**
|
|
5634
|
-
* <p>The day of the month on which the scheduled audit is run (if the
|
|
5635
|
-
* <code>frequency</code> is "MONTHLY").
|
|
5636
|
-
* If days 29-31 are specified, and the month does not have that many
|
|
5637
|
-
* days, the audit takes place on the "LAST" day of the month.</p>
|
|
5638
|
-
*/
|
|
5639
|
-
dayOfMonth?: string;
|
|
5640
|
-
/**
|
|
5641
|
-
* <p>The day of the week on which the scheduled audit is run (if the
|
|
5642
|
-
* <code>frequency</code> is "WEEKLY" or "BIWEEKLY").</p>
|
|
5643
|
-
*/
|
|
5644
|
-
dayOfWeek?: DayOfWeek | string;
|
|
5645
|
-
}
|
|
5646
|
-
/**
|
|
5647
|
-
* @public
|
|
5648
|
-
*/
|
|
5649
|
-
export interface ListScheduledAuditsResponse {
|
|
5650
|
-
/**
|
|
5651
|
-
* <p>The list of scheduled audits.</p>
|
|
5652
|
-
*/
|
|
5653
|
-
scheduledAudits?: ScheduledAuditMetadata[];
|
|
5654
|
-
/**
|
|
5655
|
-
* <p>A token that can be used to retrieve the next set of results,
|
|
5656
|
-
* or <code>null</code> if there are no additional results.</p>
|
|
5657
|
-
*/
|
|
5658
|
-
nextToken?: string;
|
|
5659
|
-
}
|
|
5660
|
-
/**
|
|
5661
|
-
* @public
|
|
5662
|
-
*/
|
|
5663
|
-
export interface ListSecurityProfilesRequest {
|
|
5664
|
-
/**
|
|
5665
|
-
* <p>The token for the next set of results.</p>
|
|
5666
|
-
*/
|
|
5667
|
-
nextToken?: string;
|
|
5668
|
-
/**
|
|
5669
|
-
* <p>The maximum number of results to return at one time.</p>
|
|
5670
|
-
*/
|
|
5671
|
-
maxResults?: number;
|
|
5672
|
-
/**
|
|
5673
|
-
* <p>A filter to limit results to the security profiles that use the defined dimension.
|
|
5674
|
-
* Cannot be used with <code>metricName</code>
|
|
5675
|
-
* </p>
|
|
5676
|
-
*/
|
|
5677
|
-
dimensionName?: string;
|
|
5678
|
-
/**
|
|
5679
|
-
* <p> The name of the custom metric.
|
|
5680
|
-
* Cannot be used with <code>dimensionName</code>. </p>
|
|
5681
|
-
*/
|
|
5682
|
-
metricName?: string;
|
|
5683
|
-
}
|
|
5684
|
-
/**
|
|
5685
|
-
* @public
|
|
5686
|
-
* <p>Identifying information for a Device Defender security profile.</p>
|
|
5687
|
-
*/
|
|
5688
|
-
export interface SecurityProfileIdentifier {
|
|
5689
|
-
/**
|
|
5690
|
-
* <p>The name you've given to the security profile.</p>
|
|
5691
|
-
*/
|
|
5692
|
-
name: string | undefined;
|
|
5693
|
-
/**
|
|
5694
|
-
* <p>The ARN of the security profile.</p>
|
|
5695
|
-
*/
|
|
5696
|
-
arn: string | undefined;
|
|
5697
|
-
}
|
|
5698
|
-
/**
|
|
5699
|
-
* @public
|
|
5700
|
-
*/
|
|
5701
|
-
export interface ListSecurityProfilesResponse {
|
|
5702
|
-
/**
|
|
5703
|
-
* <p>A list of security profile identifiers (names and ARNs).</p>
|
|
5704
|
-
*/
|
|
5705
|
-
securityProfileIdentifiers?: SecurityProfileIdentifier[];
|
|
5737
|
+
export interface ListPolicyVersionsRequest {
|
|
5706
5738
|
/**
|
|
5707
|
-
* <p>
|
|
5708
|
-
* additional results.</p>
|
|
5739
|
+
* <p>The policy name.</p>
|
|
5709
5740
|
*/
|
|
5710
|
-
|
|
5741
|
+
policyName: string | undefined;
|
|
5711
5742
|
}
|
|
5712
5743
|
/**
|
|
5713
5744
|
* @public
|
|
5745
|
+
* <p>Describes a policy version.</p>
|
|
5714
5746
|
*/
|
|
5715
|
-
export interface
|
|
5716
|
-
/**
|
|
5717
|
-
* <p>The token for the next set of results.</p>
|
|
5718
|
-
*/
|
|
5719
|
-
nextToken?: string;
|
|
5747
|
+
export interface PolicyVersion {
|
|
5720
5748
|
/**
|
|
5721
|
-
* <p>The
|
|
5749
|
+
* <p>The policy version ID.</p>
|
|
5722
5750
|
*/
|
|
5723
|
-
|
|
5751
|
+
versionId?: string;
|
|
5724
5752
|
/**
|
|
5725
|
-
* <p>
|
|
5753
|
+
* <p>Specifies whether the policy version is the default.</p>
|
|
5726
5754
|
*/
|
|
5727
|
-
|
|
5755
|
+
isDefaultVersion?: boolean;
|
|
5728
5756
|
/**
|
|
5729
|
-
* <p>The
|
|
5757
|
+
* <p>The date and time the policy was created.</p>
|
|
5730
5758
|
*/
|
|
5731
|
-
|
|
5759
|
+
createDate?: Date;
|
|
5732
5760
|
}
|
|
5733
5761
|
/**
|
|
5734
|
-
* @
|
|
5735
|
-
* <p>A target to which an alert is sent when a security profile behavior is
|
|
5736
|
-
* violated.</p>
|
|
5762
|
+
* @internal
|
|
5737
5763
|
*/
|
|
5738
|
-
export
|
|
5739
|
-
/**
|
|
5740
|
-
* <p>The ARN of the security profile.</p>
|
|
5741
|
-
*/
|
|
5742
|
-
arn: string | undefined;
|
|
5743
|
-
}
|
|
5764
|
+
export declare const GetPackageResponseFilterSensitiveLog: (obj: GetPackageResponse) => any;
|
|
5744
5765
|
/**
|
|
5745
|
-
* @
|
|
5746
|
-
* <p>Information about a security profile and the target associated with it.</p>
|
|
5766
|
+
* @internal
|
|
5747
5767
|
*/
|
|
5748
|
-
export
|
|
5749
|
-
/**
|
|
5750
|
-
* <p>Information that identifies the security profile.</p>
|
|
5751
|
-
*/
|
|
5752
|
-
securityProfileIdentifier?: SecurityProfileIdentifier;
|
|
5753
|
-
/**
|
|
5754
|
-
* <p>Information about the target (thing group) associated with the security profile.</p>
|
|
5755
|
-
*/
|
|
5756
|
-
target?: SecurityProfileTarget;
|
|
5757
|
-
}
|
|
5768
|
+
export declare const GetPackageVersionResponseFilterSensitiveLog: (obj: GetPackageVersionResponse) => any;
|