UNPKG

373 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class Iot extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: Iot.Types.ClientConfiguration)
13 config: Config & Iot.Types.ClientConfiguration;
14 /**
15 * Accepts a pending certificate transfer. The default state of the certificate is INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
16 */
17 acceptCertificateTransfer(params: Iot.Types.AcceptCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
18 /**
19 * Accepts a pending certificate transfer. The default state of the certificate is INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
20 */
21 acceptCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
22 /**
23 * Adds a thing to a billing group.
24 */
25 addThingToBillingGroup(params: Iot.Types.AddThingToBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.AddThingToBillingGroupResponse) => void): Request<Iot.Types.AddThingToBillingGroupResponse, AWSError>;
26 /**
27 * Adds a thing to a billing group.
28 */
29 addThingToBillingGroup(callback?: (err: AWSError, data: Iot.Types.AddThingToBillingGroupResponse) => void): Request<Iot.Types.AddThingToBillingGroupResponse, AWSError>;
30 /**
31 * Adds a thing to a thing group.
32 */
33 addThingToThingGroup(params: Iot.Types.AddThingToThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.AddThingToThingGroupResponse) => void): Request<Iot.Types.AddThingToThingGroupResponse, AWSError>;
34 /**
35 * Adds a thing to a thing group.
36 */
37 addThingToThingGroup(callback?: (err: AWSError, data: Iot.Types.AddThingToThingGroupResponse) => void): Request<Iot.Types.AddThingToThingGroupResponse, AWSError>;
38 /**
39 * Associates a group with a continuous job. The following criteria must be met: The job must have been created with the targetSelection field set to "CONTINUOUS". The job status must currently be "IN_PROGRESS". The total number of targets associated with a job must not exceed 100.
40 */
41 associateTargetsWithJob(params: Iot.Types.AssociateTargetsWithJobRequest, callback?: (err: AWSError, data: Iot.Types.AssociateTargetsWithJobResponse) => void): Request<Iot.Types.AssociateTargetsWithJobResponse, AWSError>;
42 /**
43 * Associates a group with a continuous job. The following criteria must be met: The job must have been created with the targetSelection field set to "CONTINUOUS". The job status must currently be "IN_PROGRESS". The total number of targets associated with a job must not exceed 100.
44 */
45 associateTargetsWithJob(callback?: (err: AWSError, data: Iot.Types.AssociateTargetsWithJobResponse) => void): Request<Iot.Types.AssociateTargetsWithJobResponse, AWSError>;
46 /**
47 * Attaches a policy to the specified target.
48 */
49 attachPolicy(params: Iot.Types.AttachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
50 /**
51 * Attaches a policy to the specified target.
52 */
53 attachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
54 /**
55 * Attaches the specified policy to the specified principal (certificate or other credential). Note: This API is deprecated. Please use AttachPolicy instead.
56 */
57 attachPrincipalPolicy(params: Iot.Types.AttachPrincipalPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
58 /**
59 * Attaches the specified policy to the specified principal (certificate or other credential). Note: This API is deprecated. Please use AttachPolicy instead.
60 */
61 attachPrincipalPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
62 /**
63 * Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
64 */
65 attachSecurityProfile(params: Iot.Types.AttachSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.AttachSecurityProfileResponse) => void): Request<Iot.Types.AttachSecurityProfileResponse, AWSError>;
66 /**
67 * Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
68 */
69 attachSecurityProfile(callback?: (err: AWSError, data: Iot.Types.AttachSecurityProfileResponse) => void): Request<Iot.Types.AttachSecurityProfileResponse, AWSError>;
70 /**
71 * Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
72 */
73 attachThingPrincipal(params: Iot.Types.AttachThingPrincipalRequest, callback?: (err: AWSError, data: Iot.Types.AttachThingPrincipalResponse) => void): Request<Iot.Types.AttachThingPrincipalResponse, AWSError>;
74 /**
75 * Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
76 */
77 attachThingPrincipal(callback?: (err: AWSError, data: Iot.Types.AttachThingPrincipalResponse) => void): Request<Iot.Types.AttachThingPrincipalResponse, AWSError>;
78 /**
79 * Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
80 */
81 cancelAuditMitigationActionsTask(params: Iot.Types.CancelAuditMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.CancelAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelAuditMitigationActionsTaskResponse, AWSError>;
82 /**
83 * Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
84 */
85 cancelAuditMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.CancelAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelAuditMitigationActionsTaskResponse, AWSError>;
86 /**
87 * Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.
88 */
89 cancelAuditTask(params: Iot.Types.CancelAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.CancelAuditTaskResponse) => void): Request<Iot.Types.CancelAuditTaskResponse, AWSError>;
90 /**
91 * Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.
92 */
93 cancelAuditTask(callback?: (err: AWSError, data: Iot.Types.CancelAuditTaskResponse) => void): Request<Iot.Types.CancelAuditTaskResponse, AWSError>;
94 /**
95 * Cancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled. After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
96 */
97 cancelCertificateTransfer(params: Iot.Types.CancelCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
98 /**
99 * Cancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled. After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
100 */
101 cancelCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
102 /**
103 * Cancels a job.
104 */
105 cancelJob(params: Iot.Types.CancelJobRequest, callback?: (err: AWSError, data: Iot.Types.CancelJobResponse) => void): Request<Iot.Types.CancelJobResponse, AWSError>;
106 /**
107 * Cancels a job.
108 */
109 cancelJob(callback?: (err: AWSError, data: Iot.Types.CancelJobResponse) => void): Request<Iot.Types.CancelJobResponse, AWSError>;
110 /**
111 * Cancels the execution of a job for a given thing.
112 */
113 cancelJobExecution(params: Iot.Types.CancelJobExecutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
114 /**
115 * Cancels the execution of a job for a given thing.
116 */
117 cancelJobExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
118 /**
119 * Clears the default authorizer.
120 */
121 clearDefaultAuthorizer(params: Iot.Types.ClearDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.ClearDefaultAuthorizerResponse) => void): Request<Iot.Types.ClearDefaultAuthorizerResponse, AWSError>;
122 /**
123 * Clears the default authorizer.
124 */
125 clearDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.ClearDefaultAuthorizerResponse) => void): Request<Iot.Types.ClearDefaultAuthorizerResponse, AWSError>;
126 /**
127 * Confirms a topic rule destination. When you create a rule requiring a destination, AWS IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.
128 */
129 confirmTopicRuleDestination(params: Iot.Types.ConfirmTopicRuleDestinationRequest, callback?: (err: AWSError, data: Iot.Types.ConfirmTopicRuleDestinationResponse) => void): Request<Iot.Types.ConfirmTopicRuleDestinationResponse, AWSError>;
130 /**
131 * Confirms a topic rule destination. When you create a rule requiring a destination, AWS IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.
132 */
133 confirmTopicRuleDestination(callback?: (err: AWSError, data: Iot.Types.ConfirmTopicRuleDestinationResponse) => void): Request<Iot.Types.ConfirmTopicRuleDestinationResponse, AWSError>;
134 /**
135 * Creates an authorizer.
136 */
137 createAuthorizer(params: Iot.Types.CreateAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.CreateAuthorizerResponse) => void): Request<Iot.Types.CreateAuthorizerResponse, AWSError>;
138 /**
139 * Creates an authorizer.
140 */
141 createAuthorizer(callback?: (err: AWSError, data: Iot.Types.CreateAuthorizerResponse) => void): Request<Iot.Types.CreateAuthorizerResponse, AWSError>;
142 /**
143 * Creates a billing group.
144 */
145 createBillingGroup(params: Iot.Types.CreateBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateBillingGroupResponse) => void): Request<Iot.Types.CreateBillingGroupResponse, AWSError>;
146 /**
147 * Creates a billing group.
148 */
149 createBillingGroup(callback?: (err: AWSError, data: Iot.Types.CreateBillingGroupResponse) => void): Request<Iot.Types.CreateBillingGroupResponse, AWSError>;
150 /**
151 * Creates an X.509 certificate using the specified certificate signing request. Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. Note: Reusing the same certificate signing request (CSR) results in a distinct certificate. You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. Assuming a set of CSRs are located inside of the directory my-csr-directory: On Linux and OS X, the command is: $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR. The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process: $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: &gt; ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: &gt; forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
152 */
153 createCertificateFromCsr(params: Iot.Types.CreateCertificateFromCsrRequest, callback?: (err: AWSError, data: Iot.Types.CreateCertificateFromCsrResponse) => void): Request<Iot.Types.CreateCertificateFromCsrResponse, AWSError>;
154 /**
155 * Creates an X.509 certificate using the specified certificate signing request. Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. Note: Reusing the same certificate signing request (CSR) results in a distinct certificate. You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. Assuming a set of CSRs are located inside of the directory my-csr-directory: On Linux and OS X, the command is: $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR. The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process: $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: &gt; ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: &gt; forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
156 */
157 createCertificateFromCsr(callback?: (err: AWSError, data: Iot.Types.CreateCertificateFromCsrResponse) => void): Request<Iot.Types.CreateCertificateFromCsrResponse, AWSError>;
158 /**
159 * Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
160 */
161 createDimension(params: Iot.Types.CreateDimensionRequest, callback?: (err: AWSError, data: Iot.Types.CreateDimensionResponse) => void): Request<Iot.Types.CreateDimensionResponse, AWSError>;
162 /**
163 * Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
164 */
165 createDimension(callback?: (err: AWSError, data: Iot.Types.CreateDimensionResponse) => void): Request<Iot.Types.CreateDimensionResponse, AWSError>;
166 /**
167 * Creates a domain configuration. The domain configuration feature is in public preview and is subject to change.
168 */
169 createDomainConfiguration(params: Iot.Types.CreateDomainConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.CreateDomainConfigurationResponse) => void): Request<Iot.Types.CreateDomainConfigurationResponse, AWSError>;
170 /**
171 * Creates a domain configuration. The domain configuration feature is in public preview and is subject to change.
172 */
173 createDomainConfiguration(callback?: (err: AWSError, data: Iot.Types.CreateDomainConfigurationResponse) => void): Request<Iot.Types.CreateDomainConfigurationResponse, AWSError>;
174 /**
175 * Creates a dynamic thing group.
176 */
177 createDynamicThingGroup(params: Iot.Types.CreateDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateDynamicThingGroupResponse) => void): Request<Iot.Types.CreateDynamicThingGroupResponse, AWSError>;
178 /**
179 * Creates a dynamic thing group.
180 */
181 createDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.CreateDynamicThingGroupResponse) => void): Request<Iot.Types.CreateDynamicThingGroupResponse, AWSError>;
182 /**
183 * Creates a job.
184 */
185 createJob(params: Iot.Types.CreateJobRequest, callback?: (err: AWSError, data: Iot.Types.CreateJobResponse) => void): Request<Iot.Types.CreateJobResponse, AWSError>;
186 /**
187 * Creates a job.
188 */
189 createJob(callback?: (err: AWSError, data: Iot.Types.CreateJobResponse) => void): Request<Iot.Types.CreateJobResponse, AWSError>;
190 /**
191 * Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API. Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
192 */
193 createKeysAndCertificate(params: Iot.Types.CreateKeysAndCertificateRequest, callback?: (err: AWSError, data: Iot.Types.CreateKeysAndCertificateResponse) => void): Request<Iot.Types.CreateKeysAndCertificateResponse, AWSError>;
194 /**
195 * Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API. Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
196 */
197 createKeysAndCertificate(callback?: (err: AWSError, data: Iot.Types.CreateKeysAndCertificateResponse) => void): Request<Iot.Types.CreateKeysAndCertificateResponse, AWSError>;
198 /**
199 * Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change.
200 */
201 createMitigationAction(params: Iot.Types.CreateMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.CreateMitigationActionResponse) => void): Request<Iot.Types.CreateMitigationActionResponse, AWSError>;
202 /**
203 * Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change.
204 */
205 createMitigationAction(callback?: (err: AWSError, data: Iot.Types.CreateMitigationActionResponse) => void): Request<Iot.Types.CreateMitigationActionResponse, AWSError>;
206 /**
207 * Creates an AWS IoT OTAUpdate on a target group of things or groups.
208 */
209 createOTAUpdate(params: Iot.Types.CreateOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.CreateOTAUpdateResponse) => void): Request<Iot.Types.CreateOTAUpdateResponse, AWSError>;
210 /**
211 * Creates an AWS IoT OTAUpdate on a target group of things or groups.
212 */
213 createOTAUpdate(callback?: (err: AWSError, data: Iot.Types.CreateOTAUpdateResponse) => void): Request<Iot.Types.CreateOTAUpdateResponse, AWSError>;
214 /**
215 * Creates an AWS IoT policy. The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
216 */
217 createPolicy(params: Iot.Types.CreatePolicyRequest, callback?: (err: AWSError, data: Iot.Types.CreatePolicyResponse) => void): Request<Iot.Types.CreatePolicyResponse, AWSError>;
218 /**
219 * Creates an AWS IoT policy. The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
220 */
221 createPolicy(callback?: (err: AWSError, data: Iot.Types.CreatePolicyResponse) => void): Request<Iot.Types.CreatePolicyResponse, AWSError>;
222 /**
223 * Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one. Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
224 */
225 createPolicyVersion(params: Iot.Types.CreatePolicyVersionRequest, callback?: (err: AWSError, data: Iot.Types.CreatePolicyVersionResponse) => void): Request<Iot.Types.CreatePolicyVersionResponse, AWSError>;
226 /**
227 * Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one. Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
228 */
229 createPolicyVersion(callback?: (err: AWSError, data: Iot.Types.CreatePolicyVersionResponse) => void): Request<Iot.Types.CreatePolicyVersionResponse, AWSError>;
230 /**
231 * Creates a provisioning claim.
232 */
233 createProvisioningClaim(params: Iot.Types.CreateProvisioningClaimRequest, callback?: (err: AWSError, data: Iot.Types.CreateProvisioningClaimResponse) => void): Request<Iot.Types.CreateProvisioningClaimResponse, AWSError>;
234 /**
235 * Creates a provisioning claim.
236 */
237 createProvisioningClaim(callback?: (err: AWSError, data: Iot.Types.CreateProvisioningClaimResponse) => void): Request<Iot.Types.CreateProvisioningClaimResponse, AWSError>;
238 /**
239 * Creates a fleet provisioning template.
240 */
241 createProvisioningTemplate(params: Iot.Types.CreateProvisioningTemplateRequest, callback?: (err: AWSError, data: Iot.Types.CreateProvisioningTemplateResponse) => void): Request<Iot.Types.CreateProvisioningTemplateResponse, AWSError>;
242 /**
243 * Creates a fleet provisioning template.
244 */
245 createProvisioningTemplate(callback?: (err: AWSError, data: Iot.Types.CreateProvisioningTemplateResponse) => void): Request<Iot.Types.CreateProvisioningTemplateResponse, AWSError>;
246 /**
247 * Creates a new version of a fleet provisioning template.
248 */
249 createProvisioningTemplateVersion(params: Iot.Types.CreateProvisioningTemplateVersionRequest, callback?: (err: AWSError, data: Iot.Types.CreateProvisioningTemplateVersionResponse) => void): Request<Iot.Types.CreateProvisioningTemplateVersionResponse, AWSError>;
250 /**
251 * Creates a new version of a fleet provisioning template.
252 */
253 createProvisioningTemplateVersion(callback?: (err: AWSError, data: Iot.Types.CreateProvisioningTemplateVersionResponse) => void): Request<Iot.Types.CreateProvisioningTemplateVersionResponse, AWSError>;
254 /**
255 * Creates a role alias.
256 */
257 createRoleAlias(params: Iot.Types.CreateRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.CreateRoleAliasResponse) => void): Request<Iot.Types.CreateRoleAliasResponse, AWSError>;
258 /**
259 * Creates a role alias.
260 */
261 createRoleAlias(callback?: (err: AWSError, data: Iot.Types.CreateRoleAliasResponse) => void): Request<Iot.Types.CreateRoleAliasResponse, AWSError>;
262 /**
263 * Creates a scheduled audit that is run at a specified time interval.
264 */
265 createScheduledAudit(params: Iot.Types.CreateScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.CreateScheduledAuditResponse) => void): Request<Iot.Types.CreateScheduledAuditResponse, AWSError>;
266 /**
267 * Creates a scheduled audit that is run at a specified time interval.
268 */
269 createScheduledAudit(callback?: (err: AWSError, data: Iot.Types.CreateScheduledAuditResponse) => void): Request<Iot.Types.CreateScheduledAuditResponse, AWSError>;
270 /**
271 * Creates a Device Defender security profile.
272 */
273 createSecurityProfile(params: Iot.Types.CreateSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.CreateSecurityProfileResponse) => void): Request<Iot.Types.CreateSecurityProfileResponse, AWSError>;
274 /**
275 * Creates a Device Defender security profile.
276 */
277 createSecurityProfile(callback?: (err: AWSError, data: Iot.Types.CreateSecurityProfileResponse) => void): Request<Iot.Types.CreateSecurityProfileResponse, AWSError>;
278 /**
279 * Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.
280 */
281 createStream(params: Iot.Types.CreateStreamRequest, callback?: (err: AWSError, data: Iot.Types.CreateStreamResponse) => void): Request<Iot.Types.CreateStreamResponse, AWSError>;
282 /**
283 * Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.
284 */
285 createStream(callback?: (err: AWSError, data: Iot.Types.CreateStreamResponse) => void): Request<Iot.Types.CreateStreamResponse, AWSError>;
286 /**
287 * Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown. This is a control plane operation. See Authorization for information about authorizing control plane actions.
288 */
289 createThing(params: Iot.Types.CreateThingRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingResponse) => void): Request<Iot.Types.CreateThingResponse, AWSError>;
290 /**
291 * Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown. This is a control plane operation. See Authorization for information about authorizing control plane actions.
292 */
293 createThing(callback?: (err: AWSError, data: Iot.Types.CreateThingResponse) => void): Request<Iot.Types.CreateThingResponse, AWSError>;
294 /**
295 * Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions.
296 */
297 createThingGroup(params: Iot.Types.CreateThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingGroupResponse) => void): Request<Iot.Types.CreateThingGroupResponse, AWSError>;
298 /**
299 * Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions.
300 */
301 createThingGroup(callback?: (err: AWSError, data: Iot.Types.CreateThingGroupResponse) => void): Request<Iot.Types.CreateThingGroupResponse, AWSError>;
302 /**
303 * Creates a new thing type.
304 */
305 createThingType(params: Iot.Types.CreateThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingTypeResponse) => void): Request<Iot.Types.CreateThingTypeResponse, AWSError>;
306 /**
307 * Creates a new thing type.
308 */
309 createThingType(callback?: (err: AWSError, data: Iot.Types.CreateThingTypeResponse) => void): Request<Iot.Types.CreateThingTypeResponse, AWSError>;
310 /**
311 * Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
312 */
313 createTopicRule(params: Iot.Types.CreateTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
314 /**
315 * Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
316 */
317 createTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
318 /**
319 * Creates a topic rule destination. The destination must be confirmed prior to use.
320 */
321 createTopicRuleDestination(params: Iot.Types.CreateTopicRuleDestinationRequest, callback?: (err: AWSError, data: Iot.Types.CreateTopicRuleDestinationResponse) => void): Request<Iot.Types.CreateTopicRuleDestinationResponse, AWSError>;
322 /**
323 * Creates a topic rule destination. The destination must be confirmed prior to use.
324 */
325 createTopicRuleDestination(callback?: (err: AWSError, data: Iot.Types.CreateTopicRuleDestinationResponse) => void): Request<Iot.Types.CreateTopicRuleDestinationResponse, AWSError>;
326 /**
327 * Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.
328 */
329 deleteAccountAuditConfiguration(params: Iot.Types.DeleteAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DeleteAccountAuditConfigurationResponse) => void): Request<Iot.Types.DeleteAccountAuditConfigurationResponse, AWSError>;
330 /**
331 * Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.
332 */
333 deleteAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.DeleteAccountAuditConfigurationResponse) => void): Request<Iot.Types.DeleteAccountAuditConfigurationResponse, AWSError>;
334 /**
335 * Deletes an authorizer.
336 */
337 deleteAuthorizer(params: Iot.Types.DeleteAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DeleteAuthorizerResponse) => void): Request<Iot.Types.DeleteAuthorizerResponse, AWSError>;
338 /**
339 * Deletes an authorizer.
340 */
341 deleteAuthorizer(callback?: (err: AWSError, data: Iot.Types.DeleteAuthorizerResponse) => void): Request<Iot.Types.DeleteAuthorizerResponse, AWSError>;
342 /**
343 * Deletes the billing group.
344 */
345 deleteBillingGroup(params: Iot.Types.DeleteBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteBillingGroupResponse) => void): Request<Iot.Types.DeleteBillingGroupResponse, AWSError>;
346 /**
347 * Deletes the billing group.
348 */
349 deleteBillingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteBillingGroupResponse) => void): Request<Iot.Types.DeleteBillingGroupResponse, AWSError>;
350 /**
351 * Deletes a registered CA certificate.
352 */
353 deleteCACertificate(params: Iot.Types.DeleteCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.DeleteCACertificateResponse) => void): Request<Iot.Types.DeleteCACertificateResponse, AWSError>;
354 /**
355 * Deletes a registered CA certificate.
356 */
357 deleteCACertificate(callback?: (err: AWSError, data: Iot.Types.DeleteCACertificateResponse) => void): Request<Iot.Types.DeleteCACertificateResponse, AWSError>;
358 /**
359 * Deletes the specified certificate. A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
360 */
361 deleteCertificate(params: Iot.Types.DeleteCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
362 /**
363 * Deletes the specified certificate. A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
364 */
365 deleteCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
366 /**
367 * Removes the specified dimension from your AWS account.
368 */
369 deleteDimension(params: Iot.Types.DeleteDimensionRequest, callback?: (err: AWSError, data: Iot.Types.DeleteDimensionResponse) => void): Request<Iot.Types.DeleteDimensionResponse, AWSError>;
370 /**
371 * Removes the specified dimension from your AWS account.
372 */
373 deleteDimension(callback?: (err: AWSError, data: Iot.Types.DeleteDimensionResponse) => void): Request<Iot.Types.DeleteDimensionResponse, AWSError>;
374 /**
375 * Deletes the specified domain configuration. The domain configuration feature is in public preview and is subject to change.
376 */
377 deleteDomainConfiguration(params: Iot.Types.DeleteDomainConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DeleteDomainConfigurationResponse) => void): Request<Iot.Types.DeleteDomainConfigurationResponse, AWSError>;
378 /**
379 * Deletes the specified domain configuration. The domain configuration feature is in public preview and is subject to change.
380 */
381 deleteDomainConfiguration(callback?: (err: AWSError, data: Iot.Types.DeleteDomainConfigurationResponse) => void): Request<Iot.Types.DeleteDomainConfigurationResponse, AWSError>;
382 /**
383 * Deletes a dynamic thing group.
384 */
385 deleteDynamicThingGroup(params: Iot.Types.DeleteDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteDynamicThingGroupResponse) => void): Request<Iot.Types.DeleteDynamicThingGroupResponse, AWSError>;
386 /**
387 * Deletes a dynamic thing group.
388 */
389 deleteDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteDynamicThingGroupResponse) => void): Request<Iot.Types.DeleteDynamicThingGroupResponse, AWSError>;
390 /**
391 * Deletes a job and its related job executions. Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error. Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.
392 */
393 deleteJob(params: Iot.Types.DeleteJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
394 /**
395 * Deletes a job and its related job executions. Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error. Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.
396 */
397 deleteJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
398 /**
399 * Deletes a job execution.
400 */
401 deleteJobExecution(params: Iot.Types.DeleteJobExecutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
402 /**
403 * Deletes a job execution.
404 */
405 deleteJobExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
406 /**
407 * Deletes a defined mitigation action from your AWS account.
408 */
409 deleteMitigationAction(params: Iot.Types.DeleteMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.DeleteMitigationActionResponse) => void): Request<Iot.Types.DeleteMitigationActionResponse, AWSError>;
410 /**
411 * Deletes a defined mitigation action from your AWS account.
412 */
413 deleteMitigationAction(callback?: (err: AWSError, data: Iot.Types.DeleteMitigationActionResponse) => void): Request<Iot.Types.DeleteMitigationActionResponse, AWSError>;
414 /**
415 * Delete an OTA update.
416 */
417 deleteOTAUpdate(params: Iot.Types.DeleteOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.DeleteOTAUpdateResponse) => void): Request<Iot.Types.DeleteOTAUpdateResponse, AWSError>;
418 /**
419 * Delete an OTA update.
420 */
421 deleteOTAUpdate(callback?: (err: AWSError, data: Iot.Types.DeleteOTAUpdateResponse) => void): Request<Iot.Types.DeleteOTAUpdateResponse, AWSError>;
422 /**
423 * Deletes the specified policy. A policy cannot be deleted if it has non-default versions or it is attached to any certificate. To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy. When a policy is deleted using DeletePolicy, its default version is deleted with it.
424 */
425 deletePolicy(params: Iot.Types.DeletePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
426 /**
427 * Deletes the specified policy. A policy cannot be deleted if it has non-default versions or it is attached to any certificate. To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy. When a policy is deleted using DeletePolicy, its default version is deleted with it.
428 */
429 deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
430 /**
431 * Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
432 */
433 deletePolicyVersion(params: Iot.Types.DeletePolicyVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
434 /**
435 * Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
436 */
437 deletePolicyVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
438 /**
439 * Deletes a fleet provisioning template.
440 */
441 deleteProvisioningTemplate(params: Iot.Types.DeleteProvisioningTemplateRequest, callback?: (err: AWSError, data: Iot.Types.DeleteProvisioningTemplateResponse) => void): Request<Iot.Types.DeleteProvisioningTemplateResponse, AWSError>;
442 /**
443 * Deletes a fleet provisioning template.
444 */
445 deleteProvisioningTemplate(callback?: (err: AWSError, data: Iot.Types.DeleteProvisioningTemplateResponse) => void): Request<Iot.Types.DeleteProvisioningTemplateResponse, AWSError>;
446 /**
447 * Deletes a fleet provisioning template version.
448 */
449 deleteProvisioningTemplateVersion(params: Iot.Types.DeleteProvisioningTemplateVersionRequest, callback?: (err: AWSError, data: Iot.Types.DeleteProvisioningTemplateVersionResponse) => void): Request<Iot.Types.DeleteProvisioningTemplateVersionResponse, AWSError>;
450 /**
451 * Deletes a fleet provisioning template version.
452 */
453 deleteProvisioningTemplateVersion(callback?: (err: AWSError, data: Iot.Types.DeleteProvisioningTemplateVersionResponse) => void): Request<Iot.Types.DeleteProvisioningTemplateVersionResponse, AWSError>;
454 /**
455 * Deletes a CA certificate registration code.
456 */
457 deleteRegistrationCode(params: Iot.Types.DeleteRegistrationCodeRequest, callback?: (err: AWSError, data: Iot.Types.DeleteRegistrationCodeResponse) => void): Request<Iot.Types.DeleteRegistrationCodeResponse, AWSError>;
458 /**
459 * Deletes a CA certificate registration code.
460 */
461 deleteRegistrationCode(callback?: (err: AWSError, data: Iot.Types.DeleteRegistrationCodeResponse) => void): Request<Iot.Types.DeleteRegistrationCodeResponse, AWSError>;
462 /**
463 * Deletes a role alias
464 */
465 deleteRoleAlias(params: Iot.Types.DeleteRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.DeleteRoleAliasResponse) => void): Request<Iot.Types.DeleteRoleAliasResponse, AWSError>;
466 /**
467 * Deletes a role alias
468 */
469 deleteRoleAlias(callback?: (err: AWSError, data: Iot.Types.DeleteRoleAliasResponse) => void): Request<Iot.Types.DeleteRoleAliasResponse, AWSError>;
470 /**
471 * Deletes a scheduled audit.
472 */
473 deleteScheduledAudit(params: Iot.Types.DeleteScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.DeleteScheduledAuditResponse) => void): Request<Iot.Types.DeleteScheduledAuditResponse, AWSError>;
474 /**
475 * Deletes a scheduled audit.
476 */
477 deleteScheduledAudit(callback?: (err: AWSError, data: Iot.Types.DeleteScheduledAuditResponse) => void): Request<Iot.Types.DeleteScheduledAuditResponse, AWSError>;
478 /**
479 * Deletes a Device Defender security profile.
480 */
481 deleteSecurityProfile(params: Iot.Types.DeleteSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DeleteSecurityProfileResponse) => void): Request<Iot.Types.DeleteSecurityProfileResponse, AWSError>;
482 /**
483 * Deletes a Device Defender security profile.
484 */
485 deleteSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DeleteSecurityProfileResponse) => void): Request<Iot.Types.DeleteSecurityProfileResponse, AWSError>;
486 /**
487 * Deletes a stream.
488 */
489 deleteStream(params: Iot.Types.DeleteStreamRequest, callback?: (err: AWSError, data: Iot.Types.DeleteStreamResponse) => void): Request<Iot.Types.DeleteStreamResponse, AWSError>;
490 /**
491 * Deletes a stream.
492 */
493 deleteStream(callback?: (err: AWSError, data: Iot.Types.DeleteStreamResponse) => void): Request<Iot.Types.DeleteStreamResponse, AWSError>;
494 /**
495 * Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
496 */
497 deleteThing(params: Iot.Types.DeleteThingRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingResponse) => void): Request<Iot.Types.DeleteThingResponse, AWSError>;
498 /**
499 * Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
500 */
501 deleteThing(callback?: (err: AWSError, data: Iot.Types.DeleteThingResponse) => void): Request<Iot.Types.DeleteThingResponse, AWSError>;
502 /**
503 * Deletes a thing group.
504 */
505 deleteThingGroup(params: Iot.Types.DeleteThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingGroupResponse) => void): Request<Iot.Types.DeleteThingGroupResponse, AWSError>;
506 /**
507 * Deletes a thing group.
508 */
509 deleteThingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteThingGroupResponse) => void): Request<Iot.Types.DeleteThingGroupResponse, AWSError>;
510 /**
511 * Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.
512 */
513 deleteThingType(params: Iot.Types.DeleteThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingTypeResponse) => void): Request<Iot.Types.DeleteThingTypeResponse, AWSError>;
514 /**
515 * Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.
516 */
517 deleteThingType(callback?: (err: AWSError, data: Iot.Types.DeleteThingTypeResponse) => void): Request<Iot.Types.DeleteThingTypeResponse, AWSError>;
518 /**
519 * Deletes the rule.
520 */
521 deleteTopicRule(params: Iot.Types.DeleteTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
522 /**
523 * Deletes the rule.
524 */
525 deleteTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
526 /**
527 * Deletes a topic rule destination.
528 */
529 deleteTopicRuleDestination(params: Iot.Types.DeleteTopicRuleDestinationRequest, callback?: (err: AWSError, data: Iot.Types.DeleteTopicRuleDestinationResponse) => void): Request<Iot.Types.DeleteTopicRuleDestinationResponse, AWSError>;
530 /**
531 * Deletes a topic rule destination.
532 */
533 deleteTopicRuleDestination(callback?: (err: AWSError, data: Iot.Types.DeleteTopicRuleDestinationResponse) => void): Request<Iot.Types.DeleteTopicRuleDestinationResponse, AWSError>;
534 /**
535 * Deletes a logging level.
536 */
537 deleteV2LoggingLevel(params: Iot.Types.DeleteV2LoggingLevelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
538 /**
539 * Deletes a logging level.
540 */
541 deleteV2LoggingLevel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
542 /**
543 * Deprecates a thing type. You can not associate new things with deprecated thing type.
544 */
545 deprecateThingType(params: Iot.Types.DeprecateThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DeprecateThingTypeResponse) => void): Request<Iot.Types.DeprecateThingTypeResponse, AWSError>;
546 /**
547 * Deprecates a thing type. You can not associate new things with deprecated thing type.
548 */
549 deprecateThingType(callback?: (err: AWSError, data: Iot.Types.DeprecateThingTypeResponse) => void): Request<Iot.Types.DeprecateThingTypeResponse, AWSError>;
550 /**
551 * Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
552 */
553 describeAccountAuditConfiguration(params: Iot.Types.DescribeAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAccountAuditConfigurationResponse) => void): Request<Iot.Types.DescribeAccountAuditConfigurationResponse, AWSError>;
554 /**
555 * Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
556 */
557 describeAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.DescribeAccountAuditConfigurationResponse) => void): Request<Iot.Types.DescribeAccountAuditConfigurationResponse, AWSError>;
558 /**
559 * Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.
560 */
561 describeAuditFinding(params: Iot.Types.DescribeAuditFindingRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuditFindingResponse) => void): Request<Iot.Types.DescribeAuditFindingResponse, AWSError>;
562 /**
563 * Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.
564 */
565 describeAuditFinding(callback?: (err: AWSError, data: Iot.Types.DescribeAuditFindingResponse) => void): Request<Iot.Types.DescribeAuditFindingResponse, AWSError>;
566 /**
567 * Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.
568 */
569 describeAuditMitigationActionsTask(params: Iot.Types.DescribeAuditMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.DescribeAuditMitigationActionsTaskResponse, AWSError>;
570 /**
571 * Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.
572 */
573 describeAuditMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.DescribeAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.DescribeAuditMitigationActionsTaskResponse, AWSError>;
574 /**
575 * Gets information about a Device Defender audit.
576 */
577 describeAuditTask(params: Iot.Types.DescribeAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuditTaskResponse) => void): Request<Iot.Types.DescribeAuditTaskResponse, AWSError>;
578 /**
579 * Gets information about a Device Defender audit.
580 */
581 describeAuditTask(callback?: (err: AWSError, data: Iot.Types.DescribeAuditTaskResponse) => void): Request<Iot.Types.DescribeAuditTaskResponse, AWSError>;
582 /**
583 * Describes an authorizer.
584 */
585 describeAuthorizer(params: Iot.Types.DescribeAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuthorizerResponse) => void): Request<Iot.Types.DescribeAuthorizerResponse, AWSError>;
586 /**
587 * Describes an authorizer.
588 */
589 describeAuthorizer(callback?: (err: AWSError, data: Iot.Types.DescribeAuthorizerResponse) => void): Request<Iot.Types.DescribeAuthorizerResponse, AWSError>;
590 /**
591 * Returns information about a billing group.
592 */
593 describeBillingGroup(params: Iot.Types.DescribeBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DescribeBillingGroupResponse) => void): Request<Iot.Types.DescribeBillingGroupResponse, AWSError>;
594 /**
595 * Returns information about a billing group.
596 */
597 describeBillingGroup(callback?: (err: AWSError, data: Iot.Types.DescribeBillingGroupResponse) => void): Request<Iot.Types.DescribeBillingGroupResponse, AWSError>;
598 /**
599 * Describes a registered CA certificate.
600 */
601 describeCACertificate(params: Iot.Types.DescribeCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.DescribeCACertificateResponse) => void): Request<Iot.Types.DescribeCACertificateResponse, AWSError>;
602 /**
603 * Describes a registered CA certificate.
604 */
605 describeCACertificate(callback?: (err: AWSError, data: Iot.Types.DescribeCACertificateResponse) => void): Request<Iot.Types.DescribeCACertificateResponse, AWSError>;
606 /**
607 * Gets information about the specified certificate.
608 */
609 describeCertificate(params: Iot.Types.DescribeCertificateRequest, callback?: (err: AWSError, data: Iot.Types.DescribeCertificateResponse) => void): Request<Iot.Types.DescribeCertificateResponse, AWSError>;
610 /**
611 * Gets information about the specified certificate.
612 */
613 describeCertificate(callback?: (err: AWSError, data: Iot.Types.DescribeCertificateResponse) => void): Request<Iot.Types.DescribeCertificateResponse, AWSError>;
614 /**
615 * Describes the default authorizer.
616 */
617 describeDefaultAuthorizer(params: Iot.Types.DescribeDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DescribeDefaultAuthorizerResponse) => void): Request<Iot.Types.DescribeDefaultAuthorizerResponse, AWSError>;
618 /**
619 * Describes the default authorizer.
620 */
621 describeDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.DescribeDefaultAuthorizerResponse) => void): Request<Iot.Types.DescribeDefaultAuthorizerResponse, AWSError>;
622 /**
623 * Provides details about a dimension that is defined in your AWS account.
624 */
625 describeDimension(params: Iot.Types.DescribeDimensionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeDimensionResponse) => void): Request<Iot.Types.DescribeDimensionResponse, AWSError>;
626 /**
627 * Provides details about a dimension that is defined in your AWS account.
628 */
629 describeDimension(callback?: (err: AWSError, data: Iot.Types.DescribeDimensionResponse) => void): Request<Iot.Types.DescribeDimensionResponse, AWSError>;
630 /**
631 * Gets summary information about a domain configuration. The domain configuration feature is in public preview and is subject to change.
632 */
633 describeDomainConfiguration(params: Iot.Types.DescribeDomainConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DescribeDomainConfigurationResponse) => void): Request<Iot.Types.DescribeDomainConfigurationResponse, AWSError>;
634 /**
635 * Gets summary information about a domain configuration. The domain configuration feature is in public preview and is subject to change.
636 */
637 describeDomainConfiguration(callback?: (err: AWSError, data: Iot.Types.DescribeDomainConfigurationResponse) => void): Request<Iot.Types.DescribeDomainConfigurationResponse, AWSError>;
638 /**
639 * Returns a unique endpoint specific to the AWS account making the call.
640 */
641 describeEndpoint(params: Iot.Types.DescribeEndpointRequest, callback?: (err: AWSError, data: Iot.Types.DescribeEndpointResponse) => void): Request<Iot.Types.DescribeEndpointResponse, AWSError>;
642 /**
643 * Returns a unique endpoint specific to the AWS account making the call.
644 */
645 describeEndpoint(callback?: (err: AWSError, data: Iot.Types.DescribeEndpointResponse) => void): Request<Iot.Types.DescribeEndpointResponse, AWSError>;
646 /**
647 * Describes event configurations.
648 */
649 describeEventConfigurations(params: Iot.Types.DescribeEventConfigurationsRequest, callback?: (err: AWSError, data: Iot.Types.DescribeEventConfigurationsResponse) => void): Request<Iot.Types.DescribeEventConfigurationsResponse, AWSError>;
650 /**
651 * Describes event configurations.
652 */
653 describeEventConfigurations(callback?: (err: AWSError, data: Iot.Types.DescribeEventConfigurationsResponse) => void): Request<Iot.Types.DescribeEventConfigurationsResponse, AWSError>;
654 /**
655 * Describes a search index.
656 */
657 describeIndex(params: Iot.Types.DescribeIndexRequest, callback?: (err: AWSError, data: Iot.Types.DescribeIndexResponse) => void): Request<Iot.Types.DescribeIndexResponse, AWSError>;
658 /**
659 * Describes a search index.
660 */
661 describeIndex(callback?: (err: AWSError, data: Iot.Types.DescribeIndexResponse) => void): Request<Iot.Types.DescribeIndexResponse, AWSError>;
662 /**
663 * Describes a job.
664 */
665 describeJob(params: Iot.Types.DescribeJobRequest, callback?: (err: AWSError, data: Iot.Types.DescribeJobResponse) => void): Request<Iot.Types.DescribeJobResponse, AWSError>;
666 /**
667 * Describes a job.
668 */
669 describeJob(callback?: (err: AWSError, data: Iot.Types.DescribeJobResponse) => void): Request<Iot.Types.DescribeJobResponse, AWSError>;
670 /**
671 * Describes a job execution.
672 */
673 describeJobExecution(params: Iot.Types.DescribeJobExecutionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeJobExecutionResponse) => void): Request<Iot.Types.DescribeJobExecutionResponse, AWSError>;
674 /**
675 * Describes a job execution.
676 */
677 describeJobExecution(callback?: (err: AWSError, data: Iot.Types.DescribeJobExecutionResponse) => void): Request<Iot.Types.DescribeJobExecutionResponse, AWSError>;
678 /**
679 * Gets information about a mitigation action.
680 */
681 describeMitigationAction(params: Iot.Types.DescribeMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeMitigationActionResponse) => void): Request<Iot.Types.DescribeMitigationActionResponse, AWSError>;
682 /**
683 * Gets information about a mitigation action.
684 */
685 describeMitigationAction(callback?: (err: AWSError, data: Iot.Types.DescribeMitigationActionResponse) => void): Request<Iot.Types.DescribeMitigationActionResponse, AWSError>;
686 /**
687 * Returns information about a fleet provisioning template.
688 */
689 describeProvisioningTemplate(params: Iot.Types.DescribeProvisioningTemplateRequest, callback?: (err: AWSError, data: Iot.Types.DescribeProvisioningTemplateResponse) => void): Request<Iot.Types.DescribeProvisioningTemplateResponse, AWSError>;
690 /**
691 * Returns information about a fleet provisioning template.
692 */
693 describeProvisioningTemplate(callback?: (err: AWSError, data: Iot.Types.DescribeProvisioningTemplateResponse) => void): Request<Iot.Types.DescribeProvisioningTemplateResponse, AWSError>;
694 /**
695 * Returns information about a fleet provisioning template version.
696 */
697 describeProvisioningTemplateVersion(params: Iot.Types.DescribeProvisioningTemplateVersionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeProvisioningTemplateVersionResponse) => void): Request<Iot.Types.DescribeProvisioningTemplateVersionResponse, AWSError>;
698 /**
699 * Returns information about a fleet provisioning template version.
700 */
701 describeProvisioningTemplateVersion(callback?: (err: AWSError, data: Iot.Types.DescribeProvisioningTemplateVersionResponse) => void): Request<Iot.Types.DescribeProvisioningTemplateVersionResponse, AWSError>;
702 /**
703 * Describes a role alias.
704 */
705 describeRoleAlias(params: Iot.Types.DescribeRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.DescribeRoleAliasResponse) => void): Request<Iot.Types.DescribeRoleAliasResponse, AWSError>;
706 /**
707 * Describes a role alias.
708 */
709 describeRoleAlias(callback?: (err: AWSError, data: Iot.Types.DescribeRoleAliasResponse) => void): Request<Iot.Types.DescribeRoleAliasResponse, AWSError>;
710 /**
711 * Gets information about a scheduled audit.
712 */
713 describeScheduledAudit(params: Iot.Types.DescribeScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.DescribeScheduledAuditResponse) => void): Request<Iot.Types.DescribeScheduledAuditResponse, AWSError>;
714 /**
715 * Gets information about a scheduled audit.
716 */
717 describeScheduledAudit(callback?: (err: AWSError, data: Iot.Types.DescribeScheduledAuditResponse) => void): Request<Iot.Types.DescribeScheduledAuditResponse, AWSError>;
718 /**
719 * Gets information about a Device Defender security profile.
720 */
721 describeSecurityProfile(params: Iot.Types.DescribeSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DescribeSecurityProfileResponse) => void): Request<Iot.Types.DescribeSecurityProfileResponse, AWSError>;
722 /**
723 * Gets information about a Device Defender security profile.
724 */
725 describeSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DescribeSecurityProfileResponse) => void): Request<Iot.Types.DescribeSecurityProfileResponse, AWSError>;
726 /**
727 * Gets information about a stream.
728 */
729 describeStream(params: Iot.Types.DescribeStreamRequest, callback?: (err: AWSError, data: Iot.Types.DescribeStreamResponse) => void): Request<Iot.Types.DescribeStreamResponse, AWSError>;
730 /**
731 * Gets information about a stream.
732 */
733 describeStream(callback?: (err: AWSError, data: Iot.Types.DescribeStreamResponse) => void): Request<Iot.Types.DescribeStreamResponse, AWSError>;
734 /**
735 * Gets information about the specified thing.
736 */
737 describeThing(params: Iot.Types.DescribeThingRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingResponse) => void): Request<Iot.Types.DescribeThingResponse, AWSError>;
738 /**
739 * Gets information about the specified thing.
740 */
741 describeThing(callback?: (err: AWSError, data: Iot.Types.DescribeThingResponse) => void): Request<Iot.Types.DescribeThingResponse, AWSError>;
742 /**
743 * Describe a thing group.
744 */
745 describeThingGroup(params: Iot.Types.DescribeThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingGroupResponse) => void): Request<Iot.Types.DescribeThingGroupResponse, AWSError>;
746 /**
747 * Describe a thing group.
748 */
749 describeThingGroup(callback?: (err: AWSError, data: Iot.Types.DescribeThingGroupResponse) => void): Request<Iot.Types.DescribeThingGroupResponse, AWSError>;
750 /**
751 * Describes a bulk thing provisioning task.
752 */
753 describeThingRegistrationTask(params: Iot.Types.DescribeThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingRegistrationTaskResponse) => void): Request<Iot.Types.DescribeThingRegistrationTaskResponse, AWSError>;
754 /**
755 * Describes a bulk thing provisioning task.
756 */
757 describeThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.DescribeThingRegistrationTaskResponse) => void): Request<Iot.Types.DescribeThingRegistrationTaskResponse, AWSError>;
758 /**
759 * Gets information about the specified thing type.
760 */
761 describeThingType(params: Iot.Types.DescribeThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingTypeResponse) => void): Request<Iot.Types.DescribeThingTypeResponse, AWSError>;
762 /**
763 * Gets information about the specified thing type.
764 */
765 describeThingType(callback?: (err: AWSError, data: Iot.Types.DescribeThingTypeResponse) => void): Request<Iot.Types.DescribeThingTypeResponse, AWSError>;
766 /**
767 * Detaches a policy from the specified target.
768 */
769 detachPolicy(params: Iot.Types.DetachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
770 /**
771 * Detaches a policy from the specified target.
772 */
773 detachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
774 /**
775 * Removes the specified policy from the specified certificate. Note: This API is deprecated. Please use DetachPolicy instead.
776 */
777 detachPrincipalPolicy(params: Iot.Types.DetachPrincipalPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
778 /**
779 * Removes the specified policy from the specified certificate. Note: This API is deprecated. Please use DetachPolicy instead.
780 */
781 detachPrincipalPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
782 /**
783 * Disassociates a Device Defender security profile from a thing group or from this account.
784 */
785 detachSecurityProfile(params: Iot.Types.DetachSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DetachSecurityProfileResponse) => void): Request<Iot.Types.DetachSecurityProfileResponse, AWSError>;
786 /**
787 * Disassociates a Device Defender security profile from a thing group or from this account.
788 */
789 detachSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DetachSecurityProfileResponse) => void): Request<Iot.Types.DetachSecurityProfileResponse, AWSError>;
790 /**
791 * Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. This call is asynchronous. It might take several seconds for the detachment to propagate.
792 */
793 detachThingPrincipal(params: Iot.Types.DetachThingPrincipalRequest, callback?: (err: AWSError, data: Iot.Types.DetachThingPrincipalResponse) => void): Request<Iot.Types.DetachThingPrincipalResponse, AWSError>;
794 /**
795 * Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. This call is asynchronous. It might take several seconds for the detachment to propagate.
796 */
797 detachThingPrincipal(callback?: (err: AWSError, data: Iot.Types.DetachThingPrincipalResponse) => void): Request<Iot.Types.DetachThingPrincipalResponse, AWSError>;
798 /**
799 * Disables the rule.
800 */
801 disableTopicRule(params: Iot.Types.DisableTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
802 /**
803 * Disables the rule.
804 */
805 disableTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
806 /**
807 * Enables the rule.
808 */
809 enableTopicRule(params: Iot.Types.EnableTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
810 /**
811 * Enables the rule.
812 */
813 enableTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
814 /**
815 * Returns the approximate count of unique values that match the query.
816 */
817 getCardinality(params: Iot.Types.GetCardinalityRequest, callback?: (err: AWSError, data: Iot.Types.GetCardinalityResponse) => void): Request<Iot.Types.GetCardinalityResponse, AWSError>;
818 /**
819 * Returns the approximate count of unique values that match the query.
820 */
821 getCardinality(callback?: (err: AWSError, data: Iot.Types.GetCardinalityResponse) => void): Request<Iot.Types.GetCardinalityResponse, AWSError>;
822 /**
823 * Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.
824 */
825 getEffectivePolicies(params: Iot.Types.GetEffectivePoliciesRequest, callback?: (err: AWSError, data: Iot.Types.GetEffectivePoliciesResponse) => void): Request<Iot.Types.GetEffectivePoliciesResponse, AWSError>;
826 /**
827 * Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.
828 */
829 getEffectivePolicies(callback?: (err: AWSError, data: Iot.Types.GetEffectivePoliciesResponse) => void): Request<Iot.Types.GetEffectivePoliciesResponse, AWSError>;
830 /**
831 * Gets the indexing configuration.
832 */
833 getIndexingConfiguration(params: Iot.Types.GetIndexingConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.GetIndexingConfigurationResponse) => void): Request<Iot.Types.GetIndexingConfigurationResponse, AWSError>;
834 /**
835 * Gets the indexing configuration.
836 */
837 getIndexingConfiguration(callback?: (err: AWSError, data: Iot.Types.GetIndexingConfigurationResponse) => void): Request<Iot.Types.GetIndexingConfigurationResponse, AWSError>;
838 /**
839 * Gets a job document.
840 */
841 getJobDocument(params: Iot.Types.GetJobDocumentRequest, callback?: (err: AWSError, data: Iot.Types.GetJobDocumentResponse) => void): Request<Iot.Types.GetJobDocumentResponse, AWSError>;
842 /**
843 * Gets a job document.
844 */
845 getJobDocument(callback?: (err: AWSError, data: Iot.Types.GetJobDocumentResponse) => void): Request<Iot.Types.GetJobDocumentResponse, AWSError>;
846 /**
847 * Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
848 */
849 getLoggingOptions(params: Iot.Types.GetLoggingOptionsRequest, callback?: (err: AWSError, data: Iot.Types.GetLoggingOptionsResponse) => void): Request<Iot.Types.GetLoggingOptionsResponse, AWSError>;
850 /**
851 * Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
852 */
853 getLoggingOptions(callback?: (err: AWSError, data: Iot.Types.GetLoggingOptionsResponse) => void): Request<Iot.Types.GetLoggingOptionsResponse, AWSError>;
854 /**
855 * Gets an OTA update.
856 */
857 getOTAUpdate(params: Iot.Types.GetOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.GetOTAUpdateResponse) => void): Request<Iot.Types.GetOTAUpdateResponse, AWSError>;
858 /**
859 * Gets an OTA update.
860 */
861 getOTAUpdate(callback?: (err: AWSError, data: Iot.Types.GetOTAUpdateResponse) => void): Request<Iot.Types.GetOTAUpdateResponse, AWSError>;
862 /**
863 * Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.
864 */
865 getPercentiles(params: Iot.Types.GetPercentilesRequest, callback?: (err: AWSError, data: Iot.Types.GetPercentilesResponse) => void): Request<Iot.Types.GetPercentilesResponse, AWSError>;
866 /**
867 * Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.
868 */
869 getPercentiles(callback?: (err: AWSError, data: Iot.Types.GetPercentilesResponse) => void): Request<Iot.Types.GetPercentilesResponse, AWSError>;
870 /**
871 * Gets information about the specified policy with the policy document of the default version.
872 */
873 getPolicy(params: Iot.Types.GetPolicyRequest, callback?: (err: AWSError, data: Iot.Types.GetPolicyResponse) => void): Request<Iot.Types.GetPolicyResponse, AWSError>;
874 /**
875 * Gets information about the specified policy with the policy document of the default version.
876 */
877 getPolicy(callback?: (err: AWSError, data: Iot.Types.GetPolicyResponse) => void): Request<Iot.Types.GetPolicyResponse, AWSError>;
878 /**
879 * Gets information about the specified policy version.
880 */
881 getPolicyVersion(params: Iot.Types.GetPolicyVersionRequest, callback?: (err: AWSError, data: Iot.Types.GetPolicyVersionResponse) => void): Request<Iot.Types.GetPolicyVersionResponse, AWSError>;
882 /**
883 * Gets information about the specified policy version.
884 */
885 getPolicyVersion(callback?: (err: AWSError, data: Iot.Types.GetPolicyVersionResponse) => void): Request<Iot.Types.GetPolicyVersionResponse, AWSError>;
886 /**
887 * Gets a registration code used to register a CA certificate with AWS IoT.
888 */
889 getRegistrationCode(params: Iot.Types.GetRegistrationCodeRequest, callback?: (err: AWSError, data: Iot.Types.GetRegistrationCodeResponse) => void): Request<Iot.Types.GetRegistrationCodeResponse, AWSError>;
890 /**
891 * Gets a registration code used to register a CA certificate with AWS IoT.
892 */
893 getRegistrationCode(callback?: (err: AWSError, data: Iot.Types.GetRegistrationCodeResponse) => void): Request<Iot.Types.GetRegistrationCodeResponse, AWSError>;
894 /**
895 * Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.
896 */
897 getStatistics(params: Iot.Types.GetStatisticsRequest, callback?: (err: AWSError, data: Iot.Types.GetStatisticsResponse) => void): Request<Iot.Types.GetStatisticsResponse, AWSError>;
898 /**
899 * Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.
900 */
901 getStatistics(callback?: (err: AWSError, data: Iot.Types.GetStatisticsResponse) => void): Request<Iot.Types.GetStatisticsResponse, AWSError>;
902 /**
903 * Gets information about the rule.
904 */
905 getTopicRule(params: Iot.Types.GetTopicRuleRequest, callback?: (err: AWSError, data: Iot.Types.GetTopicRuleResponse) => void): Request<Iot.Types.GetTopicRuleResponse, AWSError>;
906 /**
907 * Gets information about the rule.
908 */
909 getTopicRule(callback?: (err: AWSError, data: Iot.Types.GetTopicRuleResponse) => void): Request<Iot.Types.GetTopicRuleResponse, AWSError>;
910 /**
911 * Gets information about a topic rule destination.
912 */
913 getTopicRuleDestination(params: Iot.Types.GetTopicRuleDestinationRequest, callback?: (err: AWSError, data: Iot.Types.GetTopicRuleDestinationResponse) => void): Request<Iot.Types.GetTopicRuleDestinationResponse, AWSError>;
914 /**
915 * Gets information about a topic rule destination.
916 */
917 getTopicRuleDestination(callback?: (err: AWSError, data: Iot.Types.GetTopicRuleDestinationResponse) => void): Request<Iot.Types.GetTopicRuleDestinationResponse, AWSError>;
918 /**
919 * Gets the fine grained logging options.
920 */
921 getV2LoggingOptions(params: Iot.Types.GetV2LoggingOptionsRequest, callback?: (err: AWSError, data: Iot.Types.GetV2LoggingOptionsResponse) => void): Request<Iot.Types.GetV2LoggingOptionsResponse, AWSError>;
922 /**
923 * Gets the fine grained logging options.
924 */
925 getV2LoggingOptions(callback?: (err: AWSError, data: Iot.Types.GetV2LoggingOptionsResponse) => void): Request<Iot.Types.GetV2LoggingOptionsResponse, AWSError>;
926 /**
927 * Lists the active violations for a given Device Defender security profile.
928 */
929 listActiveViolations(params: Iot.Types.ListActiveViolationsRequest, callback?: (err: AWSError, data: Iot.Types.ListActiveViolationsResponse) => void): Request<Iot.Types.ListActiveViolationsResponse, AWSError>;
930 /**
931 * Lists the active violations for a given Device Defender security profile.
932 */
933 listActiveViolations(callback?: (err: AWSError, data: Iot.Types.ListActiveViolationsResponse) => void): Request<Iot.Types.ListActiveViolationsResponse, AWSError>;
934 /**
935 * Lists the policies attached to the specified thing group.
936 */
937 listAttachedPolicies(params: Iot.Types.ListAttachedPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListAttachedPoliciesResponse) => void): Request<Iot.Types.ListAttachedPoliciesResponse, AWSError>;
938 /**
939 * Lists the policies attached to the specified thing group.
940 */
941 listAttachedPolicies(callback?: (err: AWSError, data: Iot.Types.ListAttachedPoliciesResponse) => void): Request<Iot.Types.ListAttachedPoliciesResponse, AWSError>;
942 /**
943 * Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)
944 */
945 listAuditFindings(params: Iot.Types.ListAuditFindingsRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditFindingsResponse) => void): Request<Iot.Types.ListAuditFindingsResponse, AWSError>;
946 /**
947 * Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)
948 */
949 listAuditFindings(callback?: (err: AWSError, data: Iot.Types.ListAuditFindingsResponse) => void): Request<Iot.Types.ListAuditFindingsResponse, AWSError>;
950 /**
951 * Gets the status of audit mitigation action tasks that were executed.
952 */
953 listAuditMitigationActionsExecutions(params: Iot.Types.ListAuditMitigationActionsExecutionsRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsExecutionsResponse) => void): Request<Iot.Types.ListAuditMitigationActionsExecutionsResponse, AWSError>;
954 /**
955 * Gets the status of audit mitigation action tasks that were executed.
956 */
957 listAuditMitigationActionsExecutions(callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsExecutionsResponse) => void): Request<Iot.Types.ListAuditMitigationActionsExecutionsResponse, AWSError>;
958 /**
959 * Gets a list of audit mitigation action tasks that match the specified filters.
960 */
961 listAuditMitigationActionsTasks(params: Iot.Types.ListAuditMitigationActionsTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsTasksResponse) => void): Request<Iot.Types.ListAuditMitigationActionsTasksResponse, AWSError>;
962 /**
963 * Gets a list of audit mitigation action tasks that match the specified filters.
964 */
965 listAuditMitigationActionsTasks(callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsTasksResponse) => void): Request<Iot.Types.ListAuditMitigationActionsTasksResponse, AWSError>;
966 /**
967 * Lists the Device Defender audits that have been performed during a given time period.
968 */
969 listAuditTasks(params: Iot.Types.ListAuditTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditTasksResponse) => void): Request<Iot.Types.ListAuditTasksResponse, AWSError>;
970 /**
971 * Lists the Device Defender audits that have been performed during a given time period.
972 */
973 listAuditTasks(callback?: (err: AWSError, data: Iot.Types.ListAuditTasksResponse) => void): Request<Iot.Types.ListAuditTasksResponse, AWSError>;
974 /**
975 * Lists the authorizers registered in your account.
976 */
977 listAuthorizers(params: Iot.Types.ListAuthorizersRequest, callback?: (err: AWSError, data: Iot.Types.ListAuthorizersResponse) => void): Request<Iot.Types.ListAuthorizersResponse, AWSError>;
978 /**
979 * Lists the authorizers registered in your account.
980 */
981 listAuthorizers(callback?: (err: AWSError, data: Iot.Types.ListAuthorizersResponse) => void): Request<Iot.Types.ListAuthorizersResponse, AWSError>;
982 /**
983 * Lists the billing groups you have created.
984 */
985 listBillingGroups(params: Iot.Types.ListBillingGroupsRequest, callback?: (err: AWSError, data: Iot.Types.ListBillingGroupsResponse) => void): Request<Iot.Types.ListBillingGroupsResponse, AWSError>;
986 /**
987 * Lists the billing groups you have created.
988 */
989 listBillingGroups(callback?: (err: AWSError, data: Iot.Types.ListBillingGroupsResponse) => void): Request<Iot.Types.ListBillingGroupsResponse, AWSError>;
990 /**
991 * Lists the CA certificates registered for your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
992 */
993 listCACertificates(params: Iot.Types.ListCACertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListCACertificatesResponse) => void): Request<Iot.Types.ListCACertificatesResponse, AWSError>;
994 /**
995 * Lists the CA certificates registered for your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
996 */
997 listCACertificates(callback?: (err: AWSError, data: Iot.Types.ListCACertificatesResponse) => void): Request<Iot.Types.ListCACertificatesResponse, AWSError>;
998 /**
999 * Lists the certificates registered in your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
1000 */
1001 listCertificates(params: Iot.Types.ListCertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListCertificatesResponse) => void): Request<Iot.Types.ListCertificatesResponse, AWSError>;
1002 /**
1003 * Lists the certificates registered in your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
1004 */
1005 listCertificates(callback?: (err: AWSError, data: Iot.Types.ListCertificatesResponse) => void): Request<Iot.Types.ListCertificatesResponse, AWSError>;
1006 /**
1007 * List the device certificates signed by the specified CA certificate.
1008 */
1009 listCertificatesByCA(params: Iot.Types.ListCertificatesByCARequest, callback?: (err: AWSError, data: Iot.Types.ListCertificatesByCAResponse) => void): Request<Iot.Types.ListCertificatesByCAResponse, AWSError>;
1010 /**
1011 * List the device certificates signed by the specified CA certificate.
1012 */
1013 listCertificatesByCA(callback?: (err: AWSError, data: Iot.Types.ListCertificatesByCAResponse) => void): Request<Iot.Types.ListCertificatesByCAResponse, AWSError>;
1014 /**
1015 * List the set of dimensions that are defined for your AWS account.
1016 */
1017 listDimensions(params: Iot.Types.ListDimensionsRequest, callback?: (err: AWSError, data: Iot.Types.ListDimensionsResponse) => void): Request<Iot.Types.ListDimensionsResponse, AWSError>;
1018 /**
1019 * List the set of dimensions that are defined for your AWS account.
1020 */
1021 listDimensions(callback?: (err: AWSError, data: Iot.Types.ListDimensionsResponse) => void): Request<Iot.Types.ListDimensionsResponse, AWSError>;
1022 /**
1023 * Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. The domain configuration feature is in public preview and is subject to change.
1024 */
1025 listDomainConfigurations(params: Iot.Types.ListDomainConfigurationsRequest, callback?: (err: AWSError, data: Iot.Types.ListDomainConfigurationsResponse) => void): Request<Iot.Types.ListDomainConfigurationsResponse, AWSError>;
1026 /**
1027 * Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. The domain configuration feature is in public preview and is subject to change.
1028 */
1029 listDomainConfigurations(callback?: (err: AWSError, data: Iot.Types.ListDomainConfigurationsResponse) => void): Request<Iot.Types.ListDomainConfigurationsResponse, AWSError>;
1030 /**
1031 * Lists the search indices.
1032 */
1033 listIndices(params: Iot.Types.ListIndicesRequest, callback?: (err: AWSError, data: Iot.Types.ListIndicesResponse) => void): Request<Iot.Types.ListIndicesResponse, AWSError>;
1034 /**
1035 * Lists the search indices.
1036 */
1037 listIndices(callback?: (err: AWSError, data: Iot.Types.ListIndicesResponse) => void): Request<Iot.Types.ListIndicesResponse, AWSError>;
1038 /**
1039 * Lists the job executions for a job.
1040 */
1041 listJobExecutionsForJob(params: Iot.Types.ListJobExecutionsForJobRequest, callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForJobResponse) => void): Request<Iot.Types.ListJobExecutionsForJobResponse, AWSError>;
1042 /**
1043 * Lists the job executions for a job.
1044 */
1045 listJobExecutionsForJob(callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForJobResponse) => void): Request<Iot.Types.ListJobExecutionsForJobResponse, AWSError>;
1046 /**
1047 * Lists the job executions for the specified thing.
1048 */
1049 listJobExecutionsForThing(params: Iot.Types.ListJobExecutionsForThingRequest, callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForThingResponse) => void): Request<Iot.Types.ListJobExecutionsForThingResponse, AWSError>;
1050 /**
1051 * Lists the job executions for the specified thing.
1052 */
1053 listJobExecutionsForThing(callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForThingResponse) => void): Request<Iot.Types.ListJobExecutionsForThingResponse, AWSError>;
1054 /**
1055 * Lists jobs.
1056 */
1057 listJobs(params: Iot.Types.ListJobsRequest, callback?: (err: AWSError, data: Iot.Types.ListJobsResponse) => void): Request<Iot.Types.ListJobsResponse, AWSError>;
1058 /**
1059 * Lists jobs.
1060 */
1061 listJobs(callback?: (err: AWSError, data: Iot.Types.ListJobsResponse) => void): Request<Iot.Types.ListJobsResponse, AWSError>;
1062 /**
1063 * Gets a list of all mitigation actions that match the specified filter criteria.
1064 */
1065 listMitigationActions(params: Iot.Types.ListMitigationActionsRequest, callback?: (err: AWSError, data: Iot.Types.ListMitigationActionsResponse) => void): Request<Iot.Types.ListMitigationActionsResponse, AWSError>;
1066 /**
1067 * Gets a list of all mitigation actions that match the specified filter criteria.
1068 */
1069 listMitigationActions(callback?: (err: AWSError, data: Iot.Types.ListMitigationActionsResponse) => void): Request<Iot.Types.ListMitigationActionsResponse, AWSError>;
1070 /**
1071 * Lists OTA updates.
1072 */
1073 listOTAUpdates(params: Iot.Types.ListOTAUpdatesRequest, callback?: (err: AWSError, data: Iot.Types.ListOTAUpdatesResponse) => void): Request<Iot.Types.ListOTAUpdatesResponse, AWSError>;
1074 /**
1075 * Lists OTA updates.
1076 */
1077 listOTAUpdates(callback?: (err: AWSError, data: Iot.Types.ListOTAUpdatesResponse) => void): Request<Iot.Types.ListOTAUpdatesResponse, AWSError>;
1078 /**
1079 * Lists certificates that are being transferred but not yet accepted.
1080 */
1081 listOutgoingCertificates(params: Iot.Types.ListOutgoingCertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListOutgoingCertificatesResponse) => void): Request<Iot.Types.ListOutgoingCertificatesResponse, AWSError>;
1082 /**
1083 * Lists certificates that are being transferred but not yet accepted.
1084 */
1085 listOutgoingCertificates(callback?: (err: AWSError, data: Iot.Types.ListOutgoingCertificatesResponse) => void): Request<Iot.Types.ListOutgoingCertificatesResponse, AWSError>;
1086 /**
1087 * Lists your policies.
1088 */
1089 listPolicies(params: Iot.Types.ListPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListPoliciesResponse) => void): Request<Iot.Types.ListPoliciesResponse, AWSError>;
1090 /**
1091 * Lists your policies.
1092 */
1093 listPolicies(callback?: (err: AWSError, data: Iot.Types.ListPoliciesResponse) => void): Request<Iot.Types.ListPoliciesResponse, AWSError>;
1094 /**
1095 * Lists the principals associated with the specified policy. Note: This API is deprecated. Please use ListTargetsForPolicy instead.
1096 */
1097 listPolicyPrincipals(params: Iot.Types.ListPolicyPrincipalsRequest, callback?: (err: AWSError, data: Iot.Types.ListPolicyPrincipalsResponse) => void): Request<Iot.Types.ListPolicyPrincipalsResponse, AWSError>;
1098 /**
1099 * Lists the principals associated with the specified policy. Note: This API is deprecated. Please use ListTargetsForPolicy instead.
1100 */
1101 listPolicyPrincipals(callback?: (err: AWSError, data: Iot.Types.ListPolicyPrincipalsResponse) => void): Request<Iot.Types.ListPolicyPrincipalsResponse, AWSError>;
1102 /**
1103 * Lists the versions of the specified policy and identifies the default version.
1104 */
1105 listPolicyVersions(params: Iot.Types.ListPolicyVersionsRequest, callback?: (err: AWSError, data: Iot.Types.ListPolicyVersionsResponse) => void): Request<Iot.Types.ListPolicyVersionsResponse, AWSError>;
1106 /**
1107 * Lists the versions of the specified policy and identifies the default version.
1108 */
1109 listPolicyVersions(callback?: (err: AWSError, data: Iot.Types.ListPolicyVersionsResponse) => void): Request<Iot.Types.ListPolicyVersionsResponse, AWSError>;
1110 /**
1111 * Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This API is deprecated. Please use ListAttachedPolicies instead.
1112 */
1113 listPrincipalPolicies(params: Iot.Types.ListPrincipalPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListPrincipalPoliciesResponse) => void): Request<Iot.Types.ListPrincipalPoliciesResponse, AWSError>;
1114 /**
1115 * Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This API is deprecated. Please use ListAttachedPolicies instead.
1116 */
1117 listPrincipalPolicies(callback?: (err: AWSError, data: Iot.Types.ListPrincipalPoliciesResponse) => void): Request<Iot.Types.ListPrincipalPoliciesResponse, AWSError>;
1118 /**
1119 * Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
1120 */
1121 listPrincipalThings(params: Iot.Types.ListPrincipalThingsRequest, callback?: (err: AWSError, data: Iot.Types.ListPrincipalThingsResponse) => void): Request<Iot.Types.ListPrincipalThingsResponse, AWSError>;
1122 /**
1123 * Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
1124 */
1125 listPrincipalThings(callback?: (err: AWSError, data: Iot.Types.ListPrincipalThingsResponse) => void): Request<Iot.Types.ListPrincipalThingsResponse, AWSError>;
1126 /**
1127 * A list of fleet provisioning template versions.
1128 */
1129 listProvisioningTemplateVersions(params: Iot.Types.ListProvisioningTemplateVersionsRequest, callback?: (err: AWSError, data: Iot.Types.ListProvisioningTemplateVersionsResponse) => void): Request<Iot.Types.ListProvisioningTemplateVersionsResponse, AWSError>;
1130 /**
1131 * A list of fleet provisioning template versions.
1132 */
1133 listProvisioningTemplateVersions(callback?: (err: AWSError, data: Iot.Types.ListProvisioningTemplateVersionsResponse) => void): Request<Iot.Types.ListProvisioningTemplateVersionsResponse, AWSError>;
1134 /**
1135 * Lists the fleet provisioning templates in your AWS account.
1136 */
1137 listProvisioningTemplates(params: Iot.Types.ListProvisioningTemplatesRequest, callback?: (err: AWSError, data: Iot.Types.ListProvisioningTemplatesResponse) => void): Request<Iot.Types.ListProvisioningTemplatesResponse, AWSError>;
1138 /**
1139 * Lists the fleet provisioning templates in your AWS account.
1140 */
1141 listProvisioningTemplates(callback?: (err: AWSError, data: Iot.Types.ListProvisioningTemplatesResponse) => void): Request<Iot.Types.ListProvisioningTemplatesResponse, AWSError>;
1142 /**
1143 * Lists the role aliases registered in your account.
1144 */
1145 listRoleAliases(params: Iot.Types.ListRoleAliasesRequest, callback?: (err: AWSError, data: Iot.Types.ListRoleAliasesResponse) => void): Request<Iot.Types.ListRoleAliasesResponse, AWSError>;
1146 /**
1147 * Lists the role aliases registered in your account.
1148 */
1149 listRoleAliases(callback?: (err: AWSError, data: Iot.Types.ListRoleAliasesResponse) => void): Request<Iot.Types.ListRoleAliasesResponse, AWSError>;
1150 /**
1151 * Lists all of your scheduled audits.
1152 */
1153 listScheduledAudits(params: Iot.Types.ListScheduledAuditsRequest, callback?: (err: AWSError, data: Iot.Types.ListScheduledAuditsResponse) => void): Request<Iot.Types.ListScheduledAuditsResponse, AWSError>;
1154 /**
1155 * Lists all of your scheduled audits.
1156 */
1157 listScheduledAudits(callback?: (err: AWSError, data: Iot.Types.ListScheduledAuditsResponse) => void): Request<Iot.Types.ListScheduledAuditsResponse, AWSError>;
1158 /**
1159 * Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
1160 */
1161 listSecurityProfiles(params: Iot.Types.ListSecurityProfilesRequest, callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesResponse) => void): Request<Iot.Types.ListSecurityProfilesResponse, AWSError>;
1162 /**
1163 * Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
1164 */
1165 listSecurityProfiles(callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesResponse) => void): Request<Iot.Types.ListSecurityProfilesResponse, AWSError>;
1166 /**
1167 * Lists the Device Defender security profiles attached to a target (thing group).
1168 */
1169 listSecurityProfilesForTarget(params: Iot.Types.ListSecurityProfilesForTargetRequest, callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesForTargetResponse) => void): Request<Iot.Types.ListSecurityProfilesForTargetResponse, AWSError>;
1170 /**
1171 * Lists the Device Defender security profiles attached to a target (thing group).
1172 */
1173 listSecurityProfilesForTarget(callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesForTargetResponse) => void): Request<Iot.Types.ListSecurityProfilesForTargetResponse, AWSError>;
1174 /**
1175 * Lists all of the streams in your AWS account.
1176 */
1177 listStreams(params: Iot.Types.ListStreamsRequest, callback?: (err: AWSError, data: Iot.Types.ListStreamsResponse) => void): Request<Iot.Types.ListStreamsResponse, AWSError>;
1178 /**
1179 * Lists all of the streams in your AWS account.
1180 */
1181 listStreams(callback?: (err: AWSError, data: Iot.Types.ListStreamsResponse) => void): Request<Iot.Types.ListStreamsResponse, AWSError>;
1182 /**
1183 * Lists the tags (metadata) you have assigned to the resource.
1184 */
1185 listTagsForResource(params: Iot.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Iot.Types.ListTagsForResourceResponse) => void): Request<Iot.Types.ListTagsForResourceResponse, AWSError>;
1186 /**
1187 * Lists the tags (metadata) you have assigned to the resource.
1188 */
1189 listTagsForResource(callback?: (err: AWSError, data: Iot.Types.ListTagsForResourceResponse) => void): Request<Iot.Types.ListTagsForResourceResponse, AWSError>;
1190 /**
1191 * List targets for the specified policy.
1192 */
1193 listTargetsForPolicy(params: Iot.Types.ListTargetsForPolicyRequest, callback?: (err: AWSError, data: Iot.Types.ListTargetsForPolicyResponse) => void): Request<Iot.Types.ListTargetsForPolicyResponse, AWSError>;
1194 /**
1195 * List targets for the specified policy.
1196 */
1197 listTargetsForPolicy(callback?: (err: AWSError, data: Iot.Types.ListTargetsForPolicyResponse) => void): Request<Iot.Types.ListTargetsForPolicyResponse, AWSError>;
1198 /**
1199 * Lists the targets (thing groups) associated with a given Device Defender security profile.
1200 */
1201 listTargetsForSecurityProfile(params: Iot.Types.ListTargetsForSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.ListTargetsForSecurityProfileResponse) => void): Request<Iot.Types.ListTargetsForSecurityProfileResponse, AWSError>;
1202 /**
1203 * Lists the targets (thing groups) associated with a given Device Defender security profile.
1204 */
1205 listTargetsForSecurityProfile(callback?: (err: AWSError, data: Iot.Types.ListTargetsForSecurityProfileResponse) => void): Request<Iot.Types.ListTargetsForSecurityProfileResponse, AWSError>;
1206 /**
1207 * List the thing groups in your account.
1208 */
1209 listThingGroups(params: Iot.Types.ListThingGroupsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingGroupsResponse) => void): Request<Iot.Types.ListThingGroupsResponse, AWSError>;
1210 /**
1211 * List the thing groups in your account.
1212 */
1213 listThingGroups(callback?: (err: AWSError, data: Iot.Types.ListThingGroupsResponse) => void): Request<Iot.Types.ListThingGroupsResponse, AWSError>;
1214 /**
1215 * List the thing groups to which the specified thing belongs.
1216 */
1217 listThingGroupsForThing(params: Iot.Types.ListThingGroupsForThingRequest, callback?: (err: AWSError, data: Iot.Types.ListThingGroupsForThingResponse) => void): Request<Iot.Types.ListThingGroupsForThingResponse, AWSError>;
1218 /**
1219 * List the thing groups to which the specified thing belongs.
1220 */
1221 listThingGroupsForThing(callback?: (err: AWSError, data: Iot.Types.ListThingGroupsForThingResponse) => void): Request<Iot.Types.ListThingGroupsForThingResponse, AWSError>;
1222 /**
1223 * Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
1224 */
1225 listThingPrincipals(params: Iot.Types.ListThingPrincipalsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingPrincipalsResponse) => void): Request<Iot.Types.ListThingPrincipalsResponse, AWSError>;
1226 /**
1227 * Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
1228 */
1229 listThingPrincipals(callback?: (err: AWSError, data: Iot.Types.ListThingPrincipalsResponse) => void): Request<Iot.Types.ListThingPrincipalsResponse, AWSError>;
1230 /**
1231 * Information about the thing registration tasks.
1232 */
1233 listThingRegistrationTaskReports(params: Iot.Types.ListThingRegistrationTaskReportsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTaskReportsResponse) => void): Request<Iot.Types.ListThingRegistrationTaskReportsResponse, AWSError>;
1234 /**
1235 * Information about the thing registration tasks.
1236 */
1237 listThingRegistrationTaskReports(callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTaskReportsResponse) => void): Request<Iot.Types.ListThingRegistrationTaskReportsResponse, AWSError>;
1238 /**
1239 * List bulk thing provisioning tasks.
1240 */
1241 listThingRegistrationTasks(params: Iot.Types.ListThingRegistrationTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTasksResponse) => void): Request<Iot.Types.ListThingRegistrationTasksResponse, AWSError>;
1242 /**
1243 * List bulk thing provisioning tasks.
1244 */
1245 listThingRegistrationTasks(callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTasksResponse) => void): Request<Iot.Types.ListThingRegistrationTasksResponse, AWSError>;
1246 /**
1247 * Lists the existing thing types.
1248 */
1249 listThingTypes(params: Iot.Types.ListThingTypesRequest, callback?: (err: AWSError, data: Iot.Types.ListThingTypesResponse) => void): Request<Iot.Types.ListThingTypesResponse, AWSError>;
1250 /**
1251 * Lists the existing thing types.
1252 */
1253 listThingTypes(callback?: (err: AWSError, data: Iot.Types.ListThingTypesResponse) => void): Request<Iot.Types.ListThingTypesResponse, AWSError>;
1254 /**
1255 * Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.
1256 */
1257 listThings(params: Iot.Types.ListThingsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsResponse) => void): Request<Iot.Types.ListThingsResponse, AWSError>;
1258 /**
1259 * Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.
1260 */
1261 listThings(callback?: (err: AWSError, data: Iot.Types.ListThingsResponse) => void): Request<Iot.Types.ListThingsResponse, AWSError>;
1262 /**
1263 * Lists the things you have added to the given billing group.
1264 */
1265 listThingsInBillingGroup(params: Iot.Types.ListThingsInBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsInBillingGroupResponse) => void): Request<Iot.Types.ListThingsInBillingGroupResponse, AWSError>;
1266 /**
1267 * Lists the things you have added to the given billing group.
1268 */
1269 listThingsInBillingGroup(callback?: (err: AWSError, data: Iot.Types.ListThingsInBillingGroupResponse) => void): Request<Iot.Types.ListThingsInBillingGroupResponse, AWSError>;
1270 /**
1271 * Lists the things in the specified group.
1272 */
1273 listThingsInThingGroup(params: Iot.Types.ListThingsInThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsInThingGroupResponse) => void): Request<Iot.Types.ListThingsInThingGroupResponse, AWSError>;
1274 /**
1275 * Lists the things in the specified group.
1276 */
1277 listThingsInThingGroup(callback?: (err: AWSError, data: Iot.Types.ListThingsInThingGroupResponse) => void): Request<Iot.Types.ListThingsInThingGroupResponse, AWSError>;
1278 /**
1279 * Lists all the topic rule destinations in your AWS account.
1280 */
1281 listTopicRuleDestinations(params: Iot.Types.ListTopicRuleDestinationsRequest, callback?: (err: AWSError, data: Iot.Types.ListTopicRuleDestinationsResponse) => void): Request<Iot.Types.ListTopicRuleDestinationsResponse, AWSError>;
1282 /**
1283 * Lists all the topic rule destinations in your AWS account.
1284 */
1285 listTopicRuleDestinations(callback?: (err: AWSError, data: Iot.Types.ListTopicRuleDestinationsResponse) => void): Request<Iot.Types.ListTopicRuleDestinationsResponse, AWSError>;
1286 /**
1287 * Lists the rules for the specific topic.
1288 */
1289 listTopicRules(params: Iot.Types.ListTopicRulesRequest, callback?: (err: AWSError, data: Iot.Types.ListTopicRulesResponse) => void): Request<Iot.Types.ListTopicRulesResponse, AWSError>;
1290 /**
1291 * Lists the rules for the specific topic.
1292 */
1293 listTopicRules(callback?: (err: AWSError, data: Iot.Types.ListTopicRulesResponse) => void): Request<Iot.Types.ListTopicRulesResponse, AWSError>;
1294 /**
1295 * Lists logging levels.
1296 */
1297 listV2LoggingLevels(params: Iot.Types.ListV2LoggingLevelsRequest, callback?: (err: AWSError, data: Iot.Types.ListV2LoggingLevelsResponse) => void): Request<Iot.Types.ListV2LoggingLevelsResponse, AWSError>;
1298 /**
1299 * Lists logging levels.
1300 */
1301 listV2LoggingLevels(callback?: (err: AWSError, data: Iot.Types.ListV2LoggingLevelsResponse) => void): Request<Iot.Types.ListV2LoggingLevelsResponse, AWSError>;
1302 /**
1303 * Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).
1304 */
1305 listViolationEvents(params: Iot.Types.ListViolationEventsRequest, callback?: (err: AWSError, data: Iot.Types.ListViolationEventsResponse) => void): Request<Iot.Types.ListViolationEventsResponse, AWSError>;
1306 /**
1307 * Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).
1308 */
1309 listViolationEvents(callback?: (err: AWSError, data: Iot.Types.ListViolationEventsResponse) => void): Request<Iot.Types.ListViolationEventsResponse, AWSError>;
1310 /**
1311 * Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.
1312 */
1313 registerCACertificate(params: Iot.Types.RegisterCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.RegisterCACertificateResponse) => void): Request<Iot.Types.RegisterCACertificateResponse, AWSError>;
1314 /**
1315 * Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.
1316 */
1317 registerCACertificate(callback?: (err: AWSError, data: Iot.Types.RegisterCACertificateResponse) => void): Request<Iot.Types.RegisterCACertificateResponse, AWSError>;
1318 /**
1319 * Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
1320 */
1321 registerCertificate(params: Iot.Types.RegisterCertificateRequest, callback?: (err: AWSError, data: Iot.Types.RegisterCertificateResponse) => void): Request<Iot.Types.RegisterCertificateResponse, AWSError>;
1322 /**
1323 * Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
1324 */
1325 registerCertificate(callback?: (err: AWSError, data: Iot.Types.RegisterCertificateResponse) => void): Request<Iot.Types.RegisterCertificateResponse, AWSError>;
1326 /**
1327 * Provisions a thing in the device registry. RegisterThing calls other AWS IoT control plane APIs. These calls might exceed your account level AWS IoT Throttling Limits and cause throttle errors. Please contact AWS Customer Support to raise your throttling limits if necessary.
1328 */
1329 registerThing(params: Iot.Types.RegisterThingRequest, callback?: (err: AWSError, data: Iot.Types.RegisterThingResponse) => void): Request<Iot.Types.RegisterThingResponse, AWSError>;
1330 /**
1331 * Provisions a thing in the device registry. RegisterThing calls other AWS IoT control plane APIs. These calls might exceed your account level AWS IoT Throttling Limits and cause throttle errors. Please contact AWS Customer Support to raise your throttling limits if necessary.
1332 */
1333 registerThing(callback?: (err: AWSError, data: Iot.Types.RegisterThingResponse) => void): Request<Iot.Types.RegisterThingResponse, AWSError>;
1334 /**
1335 * Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
1336 */
1337 rejectCertificateTransfer(params: Iot.Types.RejectCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1338 /**
1339 * Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
1340 */
1341 rejectCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1342 /**
1343 * Removes the given thing from the billing group.
1344 */
1345 removeThingFromBillingGroup(params: Iot.Types.RemoveThingFromBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.RemoveThingFromBillingGroupResponse) => void): Request<Iot.Types.RemoveThingFromBillingGroupResponse, AWSError>;
1346 /**
1347 * Removes the given thing from the billing group.
1348 */
1349 removeThingFromBillingGroup(callback?: (err: AWSError, data: Iot.Types.RemoveThingFromBillingGroupResponse) => void): Request<Iot.Types.RemoveThingFromBillingGroupResponse, AWSError>;
1350 /**
1351 * Remove the specified thing from the specified group.
1352 */
1353 removeThingFromThingGroup(params: Iot.Types.RemoveThingFromThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.RemoveThingFromThingGroupResponse) => void): Request<Iot.Types.RemoveThingFromThingGroupResponse, AWSError>;
1354 /**
1355 * Remove the specified thing from the specified group.
1356 */
1357 removeThingFromThingGroup(callback?: (err: AWSError, data: Iot.Types.RemoveThingFromThingGroupResponse) => void): Request<Iot.Types.RemoveThingFromThingGroupResponse, AWSError>;
1358 /**
1359 * Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
1360 */
1361 replaceTopicRule(params: Iot.Types.ReplaceTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1362 /**
1363 * Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
1364 */
1365 replaceTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1366 /**
1367 * The query search index.
1368 */
1369 searchIndex(params: Iot.Types.SearchIndexRequest, callback?: (err: AWSError, data: Iot.Types.SearchIndexResponse) => void): Request<Iot.Types.SearchIndexResponse, AWSError>;
1370 /**
1371 * The query search index.
1372 */
1373 searchIndex(callback?: (err: AWSError, data: Iot.Types.SearchIndexResponse) => void): Request<Iot.Types.SearchIndexResponse, AWSError>;
1374 /**
1375 * Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
1376 */
1377 setDefaultAuthorizer(params: Iot.Types.SetDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.SetDefaultAuthorizerResponse) => void): Request<Iot.Types.SetDefaultAuthorizerResponse, AWSError>;
1378 /**
1379 * Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
1380 */
1381 setDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.SetDefaultAuthorizerResponse) => void): Request<Iot.Types.SetDefaultAuthorizerResponse, AWSError>;
1382 /**
1383 * Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
1384 */
1385 setDefaultPolicyVersion(params: Iot.Types.SetDefaultPolicyVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1386 /**
1387 * Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
1388 */
1389 setDefaultPolicyVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1390 /**
1391 * Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
1392 */
1393 setLoggingOptions(params: Iot.Types.SetLoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1394 /**
1395 * Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
1396 */
1397 setLoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1398 /**
1399 * Sets the logging level.
1400 */
1401 setV2LoggingLevel(params: Iot.Types.SetV2LoggingLevelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1402 /**
1403 * Sets the logging level.
1404 */
1405 setV2LoggingLevel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1406 /**
1407 * Sets the logging options for the V2 logging service.
1408 */
1409 setV2LoggingOptions(params: Iot.Types.SetV2LoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1410 /**
1411 * Sets the logging options for the V2 logging service.
1412 */
1413 setV2LoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1414 /**
1415 * Starts a task that applies a set of mitigation actions to the specified target.
1416 */
1417 startAuditMitigationActionsTask(params: Iot.Types.StartAuditMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.StartAuditMitigationActionsTaskResponse, AWSError>;
1418 /**
1419 * Starts a task that applies a set of mitigation actions to the specified target.
1420 */
1421 startAuditMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.StartAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.StartAuditMitigationActionsTaskResponse, AWSError>;
1422 /**
1423 * Starts an on-demand Device Defender audit.
1424 */
1425 startOnDemandAuditTask(params: Iot.Types.StartOnDemandAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartOnDemandAuditTaskResponse) => void): Request<Iot.Types.StartOnDemandAuditTaskResponse, AWSError>;
1426 /**
1427 * Starts an on-demand Device Defender audit.
1428 */
1429 startOnDemandAuditTask(callback?: (err: AWSError, data: Iot.Types.StartOnDemandAuditTaskResponse) => void): Request<Iot.Types.StartOnDemandAuditTaskResponse, AWSError>;
1430 /**
1431 * Creates a bulk thing provisioning task.
1432 */
1433 startThingRegistrationTask(params: Iot.Types.StartThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartThingRegistrationTaskResponse) => void): Request<Iot.Types.StartThingRegistrationTaskResponse, AWSError>;
1434 /**
1435 * Creates a bulk thing provisioning task.
1436 */
1437 startThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.StartThingRegistrationTaskResponse) => void): Request<Iot.Types.StartThingRegistrationTaskResponse, AWSError>;
1438 /**
1439 * Cancels a bulk thing provisioning task.
1440 */
1441 stopThingRegistrationTask(params: Iot.Types.StopThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.StopThingRegistrationTaskResponse) => void): Request<Iot.Types.StopThingRegistrationTaskResponse, AWSError>;
1442 /**
1443 * Cancels a bulk thing provisioning task.
1444 */
1445 stopThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.StopThingRegistrationTaskResponse) => void): Request<Iot.Types.StopThingRegistrationTaskResponse, AWSError>;
1446 /**
1447 * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
1448 */
1449 tagResource(params: Iot.Types.TagResourceRequest, callback?: (err: AWSError, data: Iot.Types.TagResourceResponse) => void): Request<Iot.Types.TagResourceResponse, AWSError>;
1450 /**
1451 * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
1452 */
1453 tagResource(callback?: (err: AWSError, data: Iot.Types.TagResourceResponse) => void): Request<Iot.Types.TagResourceResponse, AWSError>;
1454 /**
1455 * Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.
1456 */
1457 testAuthorization(params: Iot.Types.TestAuthorizationRequest, callback?: (err: AWSError, data: Iot.Types.TestAuthorizationResponse) => void): Request<Iot.Types.TestAuthorizationResponse, AWSError>;
1458 /**
1459 * Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.
1460 */
1461 testAuthorization(callback?: (err: AWSError, data: Iot.Types.TestAuthorizationResponse) => void): Request<Iot.Types.TestAuthorizationResponse, AWSError>;
1462 /**
1463 * Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.
1464 */
1465 testInvokeAuthorizer(params: Iot.Types.TestInvokeAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.TestInvokeAuthorizerResponse) => void): Request<Iot.Types.TestInvokeAuthorizerResponse, AWSError>;
1466 /**
1467 * Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.
1468 */
1469 testInvokeAuthorizer(callback?: (err: AWSError, data: Iot.Types.TestInvokeAuthorizerResponse) => void): Request<Iot.Types.TestInvokeAuthorizerResponse, AWSError>;
1470 /**
1471 * Transfers the specified certificate to the specified AWS account. You can cancel the transfer until it is acknowledged by the recipient. No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target. The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it. The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.
1472 */
1473 transferCertificate(params: Iot.Types.TransferCertificateRequest, callback?: (err: AWSError, data: Iot.Types.TransferCertificateResponse) => void): Request<Iot.Types.TransferCertificateResponse, AWSError>;
1474 /**
1475 * Transfers the specified certificate to the specified AWS account. You can cancel the transfer until it is acknowledged by the recipient. No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target. The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it. The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.
1476 */
1477 transferCertificate(callback?: (err: AWSError, data: Iot.Types.TransferCertificateResponse) => void): Request<Iot.Types.TransferCertificateResponse, AWSError>;
1478 /**
1479 * Removes the given tags (metadata) from the resource.
1480 */
1481 untagResource(params: Iot.Types.UntagResourceRequest, callback?: (err: AWSError, data: Iot.Types.UntagResourceResponse) => void): Request<Iot.Types.UntagResourceResponse, AWSError>;
1482 /**
1483 * Removes the given tags (metadata) from the resource.
1484 */
1485 untagResource(callback?: (err: AWSError, data: Iot.Types.UntagResourceResponse) => void): Request<Iot.Types.UntagResourceResponse, AWSError>;
1486 /**
1487 * Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
1488 */
1489 updateAccountAuditConfiguration(params: Iot.Types.UpdateAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateAccountAuditConfigurationResponse) => void): Request<Iot.Types.UpdateAccountAuditConfigurationResponse, AWSError>;
1490 /**
1491 * Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
1492 */
1493 updateAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.UpdateAccountAuditConfigurationResponse) => void): Request<Iot.Types.UpdateAccountAuditConfigurationResponse, AWSError>;
1494 /**
1495 * Updates an authorizer.
1496 */
1497 updateAuthorizer(params: Iot.Types.UpdateAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.UpdateAuthorizerResponse) => void): Request<Iot.Types.UpdateAuthorizerResponse, AWSError>;
1498 /**
1499 * Updates an authorizer.
1500 */
1501 updateAuthorizer(callback?: (err: AWSError, data: Iot.Types.UpdateAuthorizerResponse) => void): Request<Iot.Types.UpdateAuthorizerResponse, AWSError>;
1502 /**
1503 * Updates information about the billing group.
1504 */
1505 updateBillingGroup(params: Iot.Types.UpdateBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateBillingGroupResponse) => void): Request<Iot.Types.UpdateBillingGroupResponse, AWSError>;
1506 /**
1507 * Updates information about the billing group.
1508 */
1509 updateBillingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateBillingGroupResponse) => void): Request<Iot.Types.UpdateBillingGroupResponse, AWSError>;
1510 /**
1511 * Updates a registered CA certificate.
1512 */
1513 updateCACertificate(params: Iot.Types.UpdateCACertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1514 /**
1515 * Updates a registered CA certificate.
1516 */
1517 updateCACertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1518 /**
1519 * Updates the status of the specified certificate. This operation is idempotent. Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect. The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
1520 */
1521 updateCertificate(params: Iot.Types.UpdateCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1522 /**
1523 * Updates the status of the specified certificate. This operation is idempotent. Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect. The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
1524 */
1525 updateCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1526 /**
1527 * Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and re-create it).
1528 */
1529 updateDimension(params: Iot.Types.UpdateDimensionRequest, callback?: (err: AWSError, data: Iot.Types.UpdateDimensionResponse) => void): Request<Iot.Types.UpdateDimensionResponse, AWSError>;
1530 /**
1531 * Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and re-create it).
1532 */
1533 updateDimension(callback?: (err: AWSError, data: Iot.Types.UpdateDimensionResponse) => void): Request<Iot.Types.UpdateDimensionResponse, AWSError>;
1534 /**
1535 * Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. The domain configuration feature is in public preview and is subject to change.
1536 */
1537 updateDomainConfiguration(params: Iot.Types.UpdateDomainConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateDomainConfigurationResponse) => void): Request<Iot.Types.UpdateDomainConfigurationResponse, AWSError>;
1538 /**
1539 * Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. The domain configuration feature is in public preview and is subject to change.
1540 */
1541 updateDomainConfiguration(callback?: (err: AWSError, data: Iot.Types.UpdateDomainConfigurationResponse) => void): Request<Iot.Types.UpdateDomainConfigurationResponse, AWSError>;
1542 /**
1543 * Updates a dynamic thing group.
1544 */
1545 updateDynamicThingGroup(params: Iot.Types.UpdateDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateDynamicThingGroupResponse) => void): Request<Iot.Types.UpdateDynamicThingGroupResponse, AWSError>;
1546 /**
1547 * Updates a dynamic thing group.
1548 */
1549 updateDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateDynamicThingGroupResponse) => void): Request<Iot.Types.UpdateDynamicThingGroupResponse, AWSError>;
1550 /**
1551 * Updates the event configurations.
1552 */
1553 updateEventConfigurations(params: Iot.Types.UpdateEventConfigurationsRequest, callback?: (err: AWSError, data: Iot.Types.UpdateEventConfigurationsResponse) => void): Request<Iot.Types.UpdateEventConfigurationsResponse, AWSError>;
1554 /**
1555 * Updates the event configurations.
1556 */
1557 updateEventConfigurations(callback?: (err: AWSError, data: Iot.Types.UpdateEventConfigurationsResponse) => void): Request<Iot.Types.UpdateEventConfigurationsResponse, AWSError>;
1558 /**
1559 * Updates the search configuration.
1560 */
1561 updateIndexingConfiguration(params: Iot.Types.UpdateIndexingConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateIndexingConfigurationResponse) => void): Request<Iot.Types.UpdateIndexingConfigurationResponse, AWSError>;
1562 /**
1563 * Updates the search configuration.
1564 */
1565 updateIndexingConfiguration(callback?: (err: AWSError, data: Iot.Types.UpdateIndexingConfigurationResponse) => void): Request<Iot.Types.UpdateIndexingConfigurationResponse, AWSError>;
1566 /**
1567 * Updates supported fields of the specified job.
1568 */
1569 updateJob(params: Iot.Types.UpdateJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1570 /**
1571 * Updates supported fields of the specified job.
1572 */
1573 updateJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1574 /**
1575 * Updates the definition for the specified mitigation action.
1576 */
1577 updateMitigationAction(params: Iot.Types.UpdateMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.UpdateMitigationActionResponse) => void): Request<Iot.Types.UpdateMitigationActionResponse, AWSError>;
1578 /**
1579 * Updates the definition for the specified mitigation action.
1580 */
1581 updateMitigationAction(callback?: (err: AWSError, data: Iot.Types.UpdateMitigationActionResponse) => void): Request<Iot.Types.UpdateMitigationActionResponse, AWSError>;
1582 /**
1583 * Updates a fleet provisioning template.
1584 */
1585 updateProvisioningTemplate(params: Iot.Types.UpdateProvisioningTemplateRequest, callback?: (err: AWSError, data: Iot.Types.UpdateProvisioningTemplateResponse) => void): Request<Iot.Types.UpdateProvisioningTemplateResponse, AWSError>;
1586 /**
1587 * Updates a fleet provisioning template.
1588 */
1589 updateProvisioningTemplate(callback?: (err: AWSError, data: Iot.Types.UpdateProvisioningTemplateResponse) => void): Request<Iot.Types.UpdateProvisioningTemplateResponse, AWSError>;
1590 /**
1591 * Updates a role alias.
1592 */
1593 updateRoleAlias(params: Iot.Types.UpdateRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.UpdateRoleAliasResponse) => void): Request<Iot.Types.UpdateRoleAliasResponse, AWSError>;
1594 /**
1595 * Updates a role alias.
1596 */
1597 updateRoleAlias(callback?: (err: AWSError, data: Iot.Types.UpdateRoleAliasResponse) => void): Request<Iot.Types.UpdateRoleAliasResponse, AWSError>;
1598 /**
1599 * Updates a scheduled audit, including which checks are performed and how often the audit takes place.
1600 */
1601 updateScheduledAudit(params: Iot.Types.UpdateScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.UpdateScheduledAuditResponse) => void): Request<Iot.Types.UpdateScheduledAuditResponse, AWSError>;
1602 /**
1603 * Updates a scheduled audit, including which checks are performed and how often the audit takes place.
1604 */
1605 updateScheduledAudit(callback?: (err: AWSError, data: Iot.Types.UpdateScheduledAuditResponse) => void): Request<Iot.Types.UpdateScheduledAuditResponse, AWSError>;
1606 /**
1607 * Updates a Device Defender security profile.
1608 */
1609 updateSecurityProfile(params: Iot.Types.UpdateSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.UpdateSecurityProfileResponse) => void): Request<Iot.Types.UpdateSecurityProfileResponse, AWSError>;
1610 /**
1611 * Updates a Device Defender security profile.
1612 */
1613 updateSecurityProfile(callback?: (err: AWSError, data: Iot.Types.UpdateSecurityProfileResponse) => void): Request<Iot.Types.UpdateSecurityProfileResponse, AWSError>;
1614 /**
1615 * Updates an existing stream. The stream version will be incremented by one.
1616 */
1617 updateStream(params: Iot.Types.UpdateStreamRequest, callback?: (err: AWSError, data: Iot.Types.UpdateStreamResponse) => void): Request<Iot.Types.UpdateStreamResponse, AWSError>;
1618 /**
1619 * Updates an existing stream. The stream version will be incremented by one.
1620 */
1621 updateStream(callback?: (err: AWSError, data: Iot.Types.UpdateStreamResponse) => void): Request<Iot.Types.UpdateStreamResponse, AWSError>;
1622 /**
1623 * Updates the data for a thing.
1624 */
1625 updateThing(params: Iot.Types.UpdateThingRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingResponse) => void): Request<Iot.Types.UpdateThingResponse, AWSError>;
1626 /**
1627 * Updates the data for a thing.
1628 */
1629 updateThing(callback?: (err: AWSError, data: Iot.Types.UpdateThingResponse) => void): Request<Iot.Types.UpdateThingResponse, AWSError>;
1630 /**
1631 * Update a thing group.
1632 */
1633 updateThingGroup(params: Iot.Types.UpdateThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupResponse) => void): Request<Iot.Types.UpdateThingGroupResponse, AWSError>;
1634 /**
1635 * Update a thing group.
1636 */
1637 updateThingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupResponse) => void): Request<Iot.Types.UpdateThingGroupResponse, AWSError>;
1638 /**
1639 * Updates the groups to which the thing belongs.
1640 */
1641 updateThingGroupsForThing(params: Iot.Types.UpdateThingGroupsForThingRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupsForThingResponse) => void): Request<Iot.Types.UpdateThingGroupsForThingResponse, AWSError>;
1642 /**
1643 * Updates the groups to which the thing belongs.
1644 */
1645 updateThingGroupsForThing(callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupsForThingResponse) => void): Request<Iot.Types.UpdateThingGroupsForThingResponse, AWSError>;
1646 /**
1647 * Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
1648 */
1649 updateTopicRuleDestination(params: Iot.Types.UpdateTopicRuleDestinationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateTopicRuleDestinationResponse) => void): Request<Iot.Types.UpdateTopicRuleDestinationResponse, AWSError>;
1650 /**
1651 * Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
1652 */
1653 updateTopicRuleDestination(callback?: (err: AWSError, data: Iot.Types.UpdateTopicRuleDestinationResponse) => void): Request<Iot.Types.UpdateTopicRuleDestinationResponse, AWSError>;
1654 /**
1655 * Validates a Device Defender security profile behaviors specification.
1656 */
1657 validateSecurityProfileBehaviors(params: Iot.Types.ValidateSecurityProfileBehaviorsRequest, callback?: (err: AWSError, data: Iot.Types.ValidateSecurityProfileBehaviorsResponse) => void): Request<Iot.Types.ValidateSecurityProfileBehaviorsResponse, AWSError>;
1658 /**
1659 * Validates a Device Defender security profile behaviors specification.
1660 */
1661 validateSecurityProfileBehaviors(callback?: (err: AWSError, data: Iot.Types.ValidateSecurityProfileBehaviorsResponse) => void): Request<Iot.Types.ValidateSecurityProfileBehaviorsResponse, AWSError>;
1662}
1663declare namespace Iot {
1664 export type AbortAction = "CANCEL"|string;
1665 export interface AbortConfig {
1666 /**
1667 * The list of abort criteria to define rules to abort the job.
1668 */
1669 criteriaList: AbortCriteriaList;
1670 }
1671 export interface AbortCriteria {
1672 /**
1673 * The type of job execution failure to define a rule to initiate a job abort.
1674 */
1675 failureType: JobExecutionFailureType;
1676 /**
1677 * The type of abort action to initiate a job abort.
1678 */
1679 action: AbortAction;
1680 /**
1681 * The threshold as a percentage of the total number of executed things that will initiate a job abort. AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
1682 */
1683 thresholdPercentage: AbortThresholdPercentage;
1684 /**
1685 * Minimum number of executed things before evaluating an abort rule.
1686 */
1687 minNumberOfExecutedThings: MinimumNumberOfExecutedThings;
1688 }
1689 export type AbortCriteriaList = AbortCriteria[];
1690 export type AbortThresholdPercentage = number;
1691 export interface AcceptCertificateTransferRequest {
1692 /**
1693 * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
1694 */
1695 certificateId: CertificateId;
1696 /**
1697 * Specifies whether the certificate is active.
1698 */
1699 setAsActive?: SetAsActive;
1700 }
1701 export type AcmCertificateArn = string;
1702 export interface Action {
1703 /**
1704 * Write to a DynamoDB table.
1705 */
1706 dynamoDB?: DynamoDBAction;
1707 /**
1708 * Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
1709 */
1710 dynamoDBv2?: DynamoDBv2Action;
1711 /**
1712 * Invoke a Lambda function.
1713 */
1714 lambda?: LambdaAction;
1715 /**
1716 * Publish to an Amazon SNS topic.
1717 */
1718 sns?: SnsAction;
1719 /**
1720 * Publish to an Amazon SQS queue.
1721 */
1722 sqs?: SqsAction;
1723 /**
1724 * Write data to an Amazon Kinesis stream.
1725 */
1726 kinesis?: KinesisAction;
1727 /**
1728 * Publish to another MQTT topic.
1729 */
1730 republish?: RepublishAction;
1731 /**
1732 * Write to an Amazon S3 bucket.
1733 */
1734 s3?: S3Action;
1735 /**
1736 * Write to an Amazon Kinesis Firehose stream.
1737 */
1738 firehose?: FirehoseAction;
1739 /**
1740 * Capture a CloudWatch metric.
1741 */
1742 cloudwatchMetric?: CloudwatchMetricAction;
1743 /**
1744 * Change the state of a CloudWatch alarm.
1745 */
1746 cloudwatchAlarm?: CloudwatchAlarmAction;
1747 /**
1748 * Send data to CloudWatch Logs.
1749 */
1750 cloudwatchLogs?: CloudwatchLogsAction;
1751 /**
1752 * Write data to an Amazon Elasticsearch Service domain.
1753 */
1754 elasticsearch?: ElasticsearchAction;
1755 /**
1756 * Send a message to a Salesforce IoT Cloud Input Stream.
1757 */
1758 salesforce?: SalesforceAction;
1759 /**
1760 * Sends message data to an AWS IoT Analytics channel.
1761 */
1762 iotAnalytics?: IotAnalyticsAction;
1763 /**
1764 * Sends an input to an AWS IoT Events detector.
1765 */
1766 iotEvents?: IotEventsAction;
1767 /**
1768 * Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
1769 */
1770 iotSiteWise?: IotSiteWiseAction;
1771 /**
1772 * Starts execution of a Step Functions state machine.
1773 */
1774 stepFunctions?: StepFunctionsAction;
1775 /**
1776 * Send data to an HTTPS endpoint.
1777 */
1778 http?: HttpAction;
1779 }
1780 export type ActionList = Action[];
1781 export type ActionType = "PUBLISH"|"SUBSCRIBE"|"RECEIVE"|"CONNECT"|string;
1782 export interface ActiveViolation {
1783 /**
1784 * The ID of the active violation.
1785 */
1786 violationId?: ViolationId;
1787 /**
1788 * The name of the thing responsible for the active violation.
1789 */
1790 thingName?: DeviceDefenderThingName;
1791 /**
1792 * The security profile whose behavior is in violation.
1793 */
1794 securityProfileName?: SecurityProfileName;
1795 /**
1796 * The behavior which is being violated.
1797 */
1798 behavior?: Behavior;
1799 /**
1800 * The value of the metric (the measurement) which caused the most recent violation.
1801 */
1802 lastViolationValue?: MetricValue;
1803 /**
1804 * The time the most recent violation occurred.
1805 */
1806 lastViolationTime?: Timestamp;
1807 /**
1808 * The time the violation started.
1809 */
1810 violationStartTime?: Timestamp;
1811 }
1812 export type ActiveViolations = ActiveViolation[];
1813 export interface AddThingToBillingGroupRequest {
1814 /**
1815 * The name of the billing group.
1816 */
1817 billingGroupName?: BillingGroupName;
1818 /**
1819 * The ARN of the billing group.
1820 */
1821 billingGroupArn?: BillingGroupArn;
1822 /**
1823 * The name of the thing to be added to the billing group.
1824 */
1825 thingName?: ThingName;
1826 /**
1827 * The ARN of the thing to be added to the billing group.
1828 */
1829 thingArn?: ThingArn;
1830 }
1831 export interface AddThingToBillingGroupResponse {
1832 }
1833 export interface AddThingToThingGroupRequest {
1834 /**
1835 * The name of the group to which you are adding a thing.
1836 */
1837 thingGroupName?: ThingGroupName;
1838 /**
1839 * The ARN of the group to which you are adding a thing.
1840 */
1841 thingGroupArn?: ThingGroupArn;
1842 /**
1843 * The name of the thing to add to a group.
1844 */
1845 thingName?: ThingName;
1846 /**
1847 * The ARN of the thing to add to a group.
1848 */
1849 thingArn?: ThingArn;
1850 /**
1851 * Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
1852 */
1853 overrideDynamicGroups?: OverrideDynamicGroups;
1854 }
1855 export interface AddThingToThingGroupResponse {
1856 }
1857 export interface AddThingsToThingGroupParams {
1858 /**
1859 * The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.
1860 */
1861 thingGroupNames: ThingGroupNames;
1862 /**
1863 * Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.
1864 */
1865 overrideDynamicGroups?: OverrideDynamicGroups;
1866 }
1867 export type AdditionalMetricsToRetainList = BehaviorMetric[];
1868 export type AdditionalMetricsToRetainV2List = MetricToRetain[];
1869 export type AdditionalParameterMap = {[key: string]: Value};
1870 export type AggregationField = string;
1871 export type AlarmName = string;
1872 export interface AlertTarget {
1873 /**
1874 * The ARN of the notification target to which alerts are sent.
1875 */
1876 alertTargetArn: AlertTargetArn;
1877 /**
1878 * The ARN of the role that grants permission to send alerts to the notification target.
1879 */
1880 roleArn: RoleArn;
1881 }
1882 export type AlertTargetArn = string;
1883 export type AlertTargetType = "SNS"|string;
1884 export type AlertTargets = {[key: string]: AlertTarget};
1885 export type AllowAuthorizerOverride = boolean;
1886 export type AllowAutoRegistration = boolean;
1887 export interface Allowed {
1888 /**
1889 * A list of policies that allowed the authentication.
1890 */
1891 policies?: Policies;
1892 }
1893 export type ApproximateSecondsBeforeTimedOut = number;
1894 export type AscendingOrder = boolean;
1895 export type AssetId = string;
1896 export type AssetPropertyAlias = string;
1897 export type AssetPropertyBooleanValue = string;
1898 export type AssetPropertyDoubleValue = string;
1899 export type AssetPropertyEntryId = string;
1900 export type AssetPropertyId = string;
1901 export type AssetPropertyIntegerValue = string;
1902 export type AssetPropertyOffsetInNanos = string;
1903 export type AssetPropertyQuality = string;
1904 export type AssetPropertyStringValue = string;
1905 export type AssetPropertyTimeInSeconds = string;
1906 export interface AssetPropertyTimestamp {
1907 /**
1908 * A string that contains the time in seconds since epoch. Accepts substitution templates.
1909 */
1910 timeInSeconds: AssetPropertyTimeInSeconds;
1911 /**
1912 * Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
1913 */
1914 offsetInNanos?: AssetPropertyOffsetInNanos;
1915 }
1916 export interface AssetPropertyValue {
1917 /**
1918 * The value of the asset property.
1919 */
1920 value: AssetPropertyVariant;
1921 /**
1922 * The asset property value timestamp.
1923 */
1924 timestamp: AssetPropertyTimestamp;
1925 /**
1926 * Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD, BAD, or UNCERTAIN.
1927 */
1928 quality?: AssetPropertyQuality;
1929 }
1930 export type AssetPropertyValueList = AssetPropertyValue[];
1931 export interface AssetPropertyVariant {
1932 /**
1933 * Optional. The string value of the value entry. Accepts substitution templates.
1934 */
1935 stringValue?: AssetPropertyStringValue;
1936 /**
1937 * Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
1938 */
1939 integerValue?: AssetPropertyIntegerValue;
1940 /**
1941 * Optional. A string that contains the double value of the value entry. Accepts substitution templates.
1942 */
1943 doubleValue?: AssetPropertyDoubleValue;
1944 /**
1945 * Optional. A string that contains the boolean value (true or false) of the value entry. Accepts substitution templates.
1946 */
1947 booleanValue?: AssetPropertyBooleanValue;
1948 }
1949 export interface AssociateTargetsWithJobRequest {
1950 /**
1951 * A list of thing group ARNs that define the targets of the job.
1952 */
1953 targets: JobTargets;
1954 /**
1955 * The unique identifier you assigned to this job when it was created.
1956 */
1957 jobId: JobId;
1958 /**
1959 * An optional comment string describing why the job was associated with the targets.
1960 */
1961 comment?: Comment;
1962 }
1963 export interface AssociateTargetsWithJobResponse {
1964 /**
1965 * An ARN identifying the job.
1966 */
1967 jobArn?: JobArn;
1968 /**
1969 * The unique identifier you assigned to this job when it was created.
1970 */
1971 jobId?: JobId;
1972 /**
1973 * A short text description of the job.
1974 */
1975 description?: JobDescription;
1976 }
1977 export interface AttachPolicyRequest {
1978 /**
1979 * The name of the policy to attach.
1980 */
1981 policyName: PolicyName;
1982 /**
1983 * The identity to which the policy is attached.
1984 */
1985 target: PolicyTarget;
1986 }
1987 export interface AttachPrincipalPolicyRequest {
1988 /**
1989 * The policy name.
1990 */
1991 policyName: PolicyName;
1992 /**
1993 * The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
1994 */
1995 principal: Principal;
1996 }
1997 export interface AttachSecurityProfileRequest {
1998 /**
1999 * The security profile that is attached.
2000 */
2001 securityProfileName: SecurityProfileName;
2002 /**
2003 * The ARN of the target (thing group) to which the security profile is attached.
2004 */
2005 securityProfileTargetArn: SecurityProfileTargetArn;
2006 }
2007 export interface AttachSecurityProfileResponse {
2008 }
2009 export interface AttachThingPrincipalRequest {
2010 /**
2011 * The name of the thing.
2012 */
2013 thingName: ThingName;
2014 /**
2015 * The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
2016 */
2017 principal: Principal;
2018 }
2019 export interface AttachThingPrincipalResponse {
2020 }
2021 export type AttributeKey = string;
2022 export type AttributeName = string;
2023 export interface AttributePayload {
2024 /**
2025 * A JSON string containing up to three key-value pair in JSON format. For example: {\"attributes\":{\"string1\":\"string2\"}}
2026 */
2027 attributes?: Attributes;
2028 /**
2029 * Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them. To remove an attribute, call UpdateThing with an empty attribute value. The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.
2030 */
2031 merge?: Flag;
2032 }
2033 export type AttributeValue = string;
2034 export type Attributes = {[key: string]: AttributeValue};
2035 export type AttributesMap = {[key: string]: Value};
2036 export interface AuditCheckConfiguration {
2037 /**
2038 * True if this audit check is enabled for this account.
2039 */
2040 enabled?: Enabled;
2041 }
2042 export type AuditCheckConfigurations = {[key: string]: AuditCheckConfiguration};
2043 export interface AuditCheckDetails {
2044 /**
2045 * The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".
2046 */
2047 checkRunStatus?: AuditCheckRunStatus;
2048 /**
2049 * True if the check is complete and found all resources compliant.
2050 */
2051 checkCompliant?: CheckCompliant;
2052 /**
2053 * The number of resources on which the check was performed.
2054 */
2055 totalResourcesCount?: TotalResourcesCount;
2056 /**
2057 * The number of resources that were found noncompliant during the check.
2058 */
2059 nonCompliantResourcesCount?: NonCompliantResourcesCount;
2060 /**
2061 * The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".
2062 */
2063 errorCode?: ErrorCode;
2064 /**
2065 * The message associated with any error encountered when this check is performed during this audit.
2066 */
2067 message?: ErrorMessage;
2068 }
2069 export type AuditCheckName = string;
2070 export type AuditCheckRunStatus = "IN_PROGRESS"|"WAITING_FOR_DATA_COLLECTION"|"CANCELED"|"COMPLETED_COMPLIANT"|"COMPLETED_NON_COMPLIANT"|"FAILED"|string;
2071 export type AuditCheckToActionsMapping = {[key: string]: MitigationActionNameList};
2072 export type AuditCheckToReasonCodeFilter = {[key: string]: ReasonForNonComplianceCodes};
2073 export type AuditDetails = {[key: string]: AuditCheckDetails};
2074 export interface AuditFinding {
2075 /**
2076 * A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.
2077 */
2078 findingId?: FindingId;
2079 /**
2080 * The ID of the audit that generated this result (finding).
2081 */
2082 taskId?: AuditTaskId;
2083 /**
2084 * The audit check that generated this result.
2085 */
2086 checkName?: AuditCheckName;
2087 /**
2088 * The time the audit started.
2089 */
2090 taskStartTime?: Timestamp;
2091 /**
2092 * The time the result (finding) was discovered.
2093 */
2094 findingTime?: Timestamp;
2095 /**
2096 * The severity of the result (finding).
2097 */
2098 severity?: AuditFindingSeverity;
2099 /**
2100 * The resource that was found to be noncompliant with the audit check.
2101 */
2102 nonCompliantResource?: NonCompliantResource;
2103 /**
2104 * The list of related resources.
2105 */
2106 relatedResources?: RelatedResources;
2107 /**
2108 * The reason the resource was noncompliant.
2109 */
2110 reasonForNonCompliance?: ReasonForNonCompliance;
2111 /**
2112 * A code that indicates the reason that the resource was noncompliant.
2113 */
2114 reasonForNonComplianceCode?: ReasonForNonComplianceCode;
2115 }
2116 export type AuditFindingSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|string;
2117 export type AuditFindings = AuditFinding[];
2118 export type AuditFrequency = "DAILY"|"WEEKLY"|"BIWEEKLY"|"MONTHLY"|string;
2119 export interface AuditMitigationActionExecutionMetadata {
2120 /**
2121 * The unique identifier for the task that applies the mitigation action.
2122 */
2123 taskId?: AuditMitigationActionsTaskId;
2124 /**
2125 * The unique identifier for the findings to which the task and associated mitigation action are applied.
2126 */
2127 findingId?: FindingId;
2128 /**
2129 * The friendly name of the mitigation action being applied by the task.
2130 */
2131 actionName?: MitigationActionName;
2132 /**
2133 * The unique identifier for the mitigation action being applied by the task.
2134 */
2135 actionId?: MitigationActionId;
2136 /**
2137 * The current status of the task being executed.
2138 */
2139 status?: AuditMitigationActionsExecutionStatus;
2140 /**
2141 * The date and time when the task was started.
2142 */
2143 startTime?: Timestamp;
2144 /**
2145 * The date and time when the task was completed or canceled. Blank if the task is still running.
2146 */
2147 endTime?: Timestamp;
2148 /**
2149 * If an error occurred, the code that indicates which type of error occurred.
2150 */
2151 errorCode?: ErrorCode;
2152 /**
2153 * If an error occurred, a message that describes the error.
2154 */
2155 message?: ErrorMessage;
2156 }
2157 export type AuditMitigationActionExecutionMetadataList = AuditMitigationActionExecutionMetadata[];
2158 export type AuditMitigationActionsExecutionStatus = "IN_PROGRESS"|"COMPLETED"|"FAILED"|"CANCELED"|"SKIPPED"|"PENDING"|string;
2159 export type AuditMitigationActionsTaskId = string;
2160 export interface AuditMitigationActionsTaskMetadata {
2161 /**
2162 * The unique identifier for the task.
2163 */
2164 taskId?: AuditMitigationActionsTaskId;
2165 /**
2166 * The time at which the audit mitigation actions task was started.
2167 */
2168 startTime?: Timestamp;
2169 /**
2170 * The current state of the audit mitigation actions task.
2171 */
2172 taskStatus?: AuditMitigationActionsTaskStatus;
2173 }
2174 export type AuditMitigationActionsTaskMetadataList = AuditMitigationActionsTaskMetadata[];
2175 export type AuditMitigationActionsTaskStatistics = {[key: string]: TaskStatisticsForAuditCheck};
2176 export type AuditMitigationActionsTaskStatus = "IN_PROGRESS"|"COMPLETED"|"FAILED"|"CANCELED"|string;
2177 export interface AuditMitigationActionsTaskTarget {
2178 /**
2179 * If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.
2180 */
2181 auditTaskId?: AuditTaskId;
2182 /**
2183 * If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.
2184 */
2185 findingIds?: FindingIds;
2186 /**
2187 * Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.
2188 */
2189 auditCheckToReasonCodeFilter?: AuditCheckToReasonCodeFilter;
2190 }
2191 export interface AuditNotificationTarget {
2192 /**
2193 * The ARN of the target (SNS topic) to which audit notifications are sent.
2194 */
2195 targetArn?: TargetArn;
2196 /**
2197 * The ARN of the role that grants permission to send notifications to the target.
2198 */
2199 roleArn?: RoleArn;
2200 /**
2201 * True if notifications to the target are enabled.
2202 */
2203 enabled?: Enabled;
2204 }
2205 export type AuditNotificationTargetConfigurations = {[key: string]: AuditNotificationTarget};
2206 export type AuditNotificationType = "SNS"|string;
2207 export type AuditTaskId = string;
2208 export interface AuditTaskMetadata {
2209 /**
2210 * The ID of this audit.
2211 */
2212 taskId?: AuditTaskId;
2213 /**
2214 * The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
2215 */
2216 taskStatus?: AuditTaskStatus;
2217 /**
2218 * The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
2219 */
2220 taskType?: AuditTaskType;
2221 }
2222 export type AuditTaskMetadataList = AuditTaskMetadata[];
2223 export type AuditTaskStatus = "IN_PROGRESS"|"COMPLETED"|"FAILED"|"CANCELED"|string;
2224 export type AuditTaskType = "ON_DEMAND_AUDIT_TASK"|"SCHEDULED_AUDIT_TASK"|string;
2225 export type AuthDecision = "ALLOWED"|"EXPLICIT_DENY"|"IMPLICIT_DENY"|string;
2226 export interface AuthInfo {
2227 /**
2228 * The type of action for which the principal is being authorized.
2229 */
2230 actionType?: ActionType;
2231 /**
2232 * The resources for which the principal is being authorized to perform the specified action.
2233 */
2234 resources?: Resources;
2235 }
2236 export type AuthInfos = AuthInfo[];
2237 export interface AuthResult {
2238 /**
2239 * Authorization information.
2240 */
2241 authInfo?: AuthInfo;
2242 /**
2243 * The policies and statements that allowed the specified action.
2244 */
2245 allowed?: Allowed;
2246 /**
2247 * The policies and statements that denied the specified action.
2248 */
2249 denied?: Denied;
2250 /**
2251 * The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.
2252 */
2253 authDecision?: AuthDecision;
2254 /**
2255 * Contains any missing context values found while evaluating policy.
2256 */
2257 missingContextValues?: MissingContextValues;
2258 }
2259 export type AuthResults = AuthResult[];
2260 export type AuthorizerArn = string;
2261 export interface AuthorizerConfig {
2262 /**
2263 * The name of the authorization service for a domain configuration.
2264 */
2265 defaultAuthorizerName?: AuthorizerName;
2266 /**
2267 * A Boolean that specifies whether the domain configuration's authorization service can be overridden.
2268 */
2269 allowAuthorizerOverride?: AllowAuthorizerOverride;
2270 }
2271 export interface AuthorizerDescription {
2272 /**
2273 * The authorizer name.
2274 */
2275 authorizerName?: AuthorizerName;
2276 /**
2277 * The authorizer ARN.
2278 */
2279 authorizerArn?: AuthorizerArn;
2280 /**
2281 * The authorizer's Lambda function ARN.
2282 */
2283 authorizerFunctionArn?: AuthorizerFunctionArn;
2284 /**
2285 * The key used to extract the token from the HTTP headers.
2286 */
2287 tokenKeyName?: TokenKeyName;
2288 /**
2289 * The public keys used to validate the token signature returned by your custom authentication service.
2290 */
2291 tokenSigningPublicKeys?: PublicKeyMap;
2292 /**
2293 * The status of the authorizer.
2294 */
2295 status?: AuthorizerStatus;
2296 /**
2297 * The UNIX timestamp of when the authorizer was created.
2298 */
2299 creationDate?: DateType;
2300 /**
2301 * The UNIX timestamp of when the authorizer was last updated.
2302 */
2303 lastModifiedDate?: DateType;
2304 /**
2305 * Specifies whether AWS IoT validates the token signature in an authorization request.
2306 */
2307 signingDisabled?: BooleanKey;
2308 }
2309 export type AuthorizerFunctionArn = string;
2310 export type AuthorizerName = string;
2311 export type AuthorizerStatus = "ACTIVE"|"INACTIVE"|string;
2312 export interface AuthorizerSummary {
2313 /**
2314 * The authorizer name.
2315 */
2316 authorizerName?: AuthorizerName;
2317 /**
2318 * The authorizer ARN.
2319 */
2320 authorizerArn?: AuthorizerArn;
2321 }
2322 export type Authorizers = AuthorizerSummary[];
2323 export type AutoRegistrationStatus = "ENABLE"|"DISABLE"|string;
2324 export type Average = number;
2325 export type AwsAccountId = string;
2326 export type AwsArn = string;
2327 export type AwsIotJobArn = string;
2328 export type AwsIotJobId = string;
2329 export type AwsIotSqlVersion = string;
2330 export interface AwsJobExecutionsRolloutConfig {
2331 /**
2332 * The maximum number of OTA update job executions started per minute.
2333 */
2334 maximumPerMinute?: MaximumPerMinute;
2335 }
2336 export interface AwsJobPresignedUrlConfig {
2337 /**
2338 * How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.
2339 */
2340 expiresInSec?: ExpiresInSeconds;
2341 }
2342 export interface Behavior {
2343 /**
2344 * The name you have given to the behavior.
2345 */
2346 name: BehaviorName;
2347 /**
2348 * What is measured by the behavior.
2349 */
2350 metric?: BehaviorMetric;
2351 /**
2352 * The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.
2353 */
2354 metricDimension?: MetricDimension;
2355 /**
2356 * The criteria that determine if a device is behaving normally in regard to the metric.
2357 */
2358 criteria?: BehaviorCriteria;
2359 }
2360 export interface BehaviorCriteria {
2361 /**
2362 * The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).
2363 */
2364 comparisonOperator?: ComparisonOperator;
2365 /**
2366 * The value to be compared with the metric.
2367 */
2368 value?: MetricValue;
2369 /**
2370 * Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.
2371 */
2372 durationSeconds?: DurationSeconds;
2373 /**
2374 * If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
2375 */
2376 consecutiveDatapointsToAlarm?: ConsecutiveDatapointsToAlarm;
2377 /**
2378 * If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
2379 */
2380 consecutiveDatapointsToClear?: ConsecutiveDatapointsToClear;
2381 /**
2382 * A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
2383 */
2384 statisticalThreshold?: StatisticalThreshold;
2385 }
2386 export type BehaviorMetric = string;
2387 export type BehaviorName = string;
2388 export type Behaviors = Behavior[];
2389 export type BillingGroupArn = string;
2390 export type BillingGroupDescription = string;
2391 export type BillingGroupId = string;
2392 export interface BillingGroupMetadata {
2393 /**
2394 * The date the billing group was created.
2395 */
2396 creationDate?: CreationDate;
2397 }
2398 export type BillingGroupName = string;
2399 export type BillingGroupNameAndArnList = GroupNameAndArn[];
2400 export interface BillingGroupProperties {
2401 /**
2402 * The description of the billing group.
2403 */
2404 billingGroupDescription?: BillingGroupDescription;
2405 }
2406 export type Boolean = boolean;
2407 export type BooleanKey = boolean;
2408 export type BucketName = string;
2409 export interface CACertificate {
2410 /**
2411 * The ARN of the CA certificate.
2412 */
2413 certificateArn?: CertificateArn;
2414 /**
2415 * The ID of the CA certificate.
2416 */
2417 certificateId?: CertificateId;
2418 /**
2419 * The status of the CA certificate. The status value REGISTER_INACTIVE is deprecated and should not be used.
2420 */
2421 status?: CACertificateStatus;
2422 /**
2423 * The date the CA certificate was created.
2424 */
2425 creationDate?: DateType;
2426 }
2427 export interface CACertificateDescription {
2428 /**
2429 * The CA certificate ARN.
2430 */
2431 certificateArn?: CertificateArn;
2432 /**
2433 * The CA certificate ID.
2434 */
2435 certificateId?: CertificateId;
2436 /**
2437 * The status of a CA certificate.
2438 */
2439 status?: CACertificateStatus;
2440 /**
2441 * The CA certificate data, in PEM format.
2442 */
2443 certificatePem?: CertificatePem;
2444 /**
2445 * The owner of the CA certificate.
2446 */
2447 ownedBy?: AwsAccountId;
2448 /**
2449 * The date the CA certificate was created.
2450 */
2451 creationDate?: DateType;
2452 /**
2453 * Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"
2454 */
2455 autoRegistrationStatus?: AutoRegistrationStatus;
2456 /**
2457 * The date the CA certificate was last modified.
2458 */
2459 lastModifiedDate?: DateType;
2460 /**
2461 * The customer version of the CA certificate.
2462 */
2463 customerVersion?: CustomerVersion;
2464 /**
2465 * The generation ID of the CA certificate.
2466 */
2467 generationId?: GenerationId;
2468 /**
2469 * When the CA certificate is valid.
2470 */
2471 validity?: CertificateValidity;
2472 }
2473 export type CACertificateStatus = "ACTIVE"|"INACTIVE"|string;
2474 export type CACertificateUpdateAction = "DEACTIVATE"|string;
2475 export type CACertificates = CACertificate[];
2476 export interface CancelAuditMitigationActionsTaskRequest {
2477 /**
2478 * The unique identifier for the task that you want to cancel.
2479 */
2480 taskId: AuditMitigationActionsTaskId;
2481 }
2482 export interface CancelAuditMitigationActionsTaskResponse {
2483 }
2484 export interface CancelAuditTaskRequest {
2485 /**
2486 * The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".
2487 */
2488 taskId: AuditTaskId;
2489 }
2490 export interface CancelAuditTaskResponse {
2491 }
2492 export interface CancelCertificateTransferRequest {
2493 /**
2494 * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
2495 */
2496 certificateId: CertificateId;
2497 }
2498 export interface CancelJobExecutionRequest {
2499 /**
2500 * The ID of the job to be canceled.
2501 */
2502 jobId: JobId;
2503 /**
2504 * The name of the thing whose execution of the job will be canceled.
2505 */
2506 thingName: ThingName;
2507 /**
2508 * (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false. Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
2509 */
2510 force?: ForceFlag;
2511 /**
2512 * (Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
2513 */
2514 expectedVersion?: ExpectedVersion;
2515 /**
2516 * A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.
2517 */
2518 statusDetails?: DetailsMap;
2519 }
2520 export interface CancelJobRequest {
2521 /**
2522 * The unique identifier you assigned to this job when it was created.
2523 */
2524 jobId: JobId;
2525 /**
2526 * (Optional)A reason code string that explains why the job was canceled.
2527 */
2528 reasonCode?: ReasonCode;
2529 /**
2530 * An optional comment string describing why the job was canceled.
2531 */
2532 comment?: Comment;
2533 /**
2534 * (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false. Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.
2535 */
2536 force?: ForceFlag;
2537 }
2538 export interface CancelJobResponse {
2539 /**
2540 * The job ARN.
2541 */
2542 jobArn?: JobArn;
2543 /**
2544 * The unique identifier you assigned to this job when it was created.
2545 */
2546 jobId?: JobId;
2547 /**
2548 * A short text description of the job.
2549 */
2550 description?: JobDescription;
2551 }
2552 export type CanceledChecksCount = number;
2553 export type CanceledFindingsCount = number;
2554 export type CanceledThings = number;
2555 export type CannedAccessControlList = "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|"log-delivery-write"|string;
2556 export interface Certificate {
2557 /**
2558 * The ARN of the certificate.
2559 */
2560 certificateArn?: CertificateArn;
2561 /**
2562 * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
2563 */
2564 certificateId?: CertificateId;
2565 /**
2566 * The status of the certificate. The status value REGISTER_INACTIVE is deprecated and should not be used.
2567 */
2568 status?: CertificateStatus;
2569 /**
2570 * The date and time the certificate was created.
2571 */
2572 creationDate?: DateType;
2573 }
2574 export type CertificateArn = string;
2575 export interface CertificateDescription {
2576 /**
2577 * The ARN of the certificate.
2578 */
2579 certificateArn?: CertificateArn;
2580 /**
2581 * The ID of the certificate.
2582 */
2583 certificateId?: CertificateId;
2584 /**
2585 * The certificate ID of the CA certificate used to sign this certificate.
2586 */
2587 caCertificateId?: CertificateId;
2588 /**
2589 * The status of the certificate.
2590 */
2591 status?: CertificateStatus;
2592 /**
2593 * The certificate data, in PEM format.
2594 */
2595 certificatePem?: CertificatePem;
2596 /**
2597 * The ID of the AWS account that owns the certificate.
2598 */
2599 ownedBy?: AwsAccountId;
2600 /**
2601 * The ID of the AWS account of the previous owner of the certificate.
2602 */
2603 previousOwnedBy?: AwsAccountId;
2604 /**
2605 * The date and time the certificate was created.
2606 */
2607 creationDate?: DateType;
2608 /**
2609 * The date and time the certificate was last modified.
2610 */
2611 lastModifiedDate?: DateType;
2612 /**
2613 * The customer version of the certificate.
2614 */
2615 customerVersion?: CustomerVersion;
2616 /**
2617 * The transfer data.
2618 */
2619 transferData?: TransferData;
2620 /**
2621 * The generation ID of the certificate.
2622 */
2623 generationId?: GenerationId;
2624 /**
2625 * When the certificate is valid.
2626 */
2627 validity?: CertificateValidity;
2628 }
2629 export type CertificateId = string;
2630 export type CertificateName = string;
2631 export type CertificatePathOnDevice = string;
2632 export type CertificatePem = string;
2633 export type CertificateSigningRequest = string;
2634 export type CertificateStatus = "ACTIVE"|"INACTIVE"|"REVOKED"|"PENDING_TRANSFER"|"REGISTER_INACTIVE"|"PENDING_ACTIVATION"|string;
2635 export interface CertificateValidity {
2636 /**
2637 * The certificate is not valid before this date.
2638 */
2639 notBefore?: DateType;
2640 /**
2641 * The certificate is not valid after this date.
2642 */
2643 notAfter?: DateType;
2644 }
2645 export type Certificates = Certificate[];
2646 export type ChannelName = string;
2647 export type CheckCompliant = boolean;
2648 export type Cidr = string;
2649 export type Cidrs = Cidr[];
2650 export interface ClearDefaultAuthorizerRequest {
2651 }
2652 export interface ClearDefaultAuthorizerResponse {
2653 }
2654 export type ClientId = string;
2655 export type ClientRequestToken = string;
2656 export interface CloudwatchAlarmAction {
2657 /**
2658 * The IAM role that allows access to the CloudWatch alarm.
2659 */
2660 roleArn: AwsArn;
2661 /**
2662 * The CloudWatch alarm name.
2663 */
2664 alarmName: AlarmName;
2665 /**
2666 * The reason for the alarm change.
2667 */
2668 stateReason: StateReason;
2669 /**
2670 * The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
2671 */
2672 stateValue: StateValue;
2673 }
2674 export interface CloudwatchLogsAction {
2675 /**
2676 * The IAM role that allows access to the CloudWatch log.
2677 */
2678 roleArn: AwsArn;
2679 /**
2680 * The CloudWatch log group to which the action sends data.
2681 */
2682 logGroupName: LogGroupName;
2683 }
2684 export interface CloudwatchMetricAction {
2685 /**
2686 * The IAM role that allows access to the CloudWatch metric.
2687 */
2688 roleArn: AwsArn;
2689 /**
2690 * The CloudWatch metric namespace name.
2691 */
2692 metricNamespace: String;
2693 /**
2694 * The CloudWatch metric name.
2695 */
2696 metricName: String;
2697 /**
2698 * The CloudWatch metric value.
2699 */
2700 metricValue: String;
2701 /**
2702 * The metric unit supported by CloudWatch.
2703 */
2704 metricUnit: String;
2705 /**
2706 * An optional Unix timestamp.
2707 */
2708 metricTimestamp?: String;
2709 }
2710 export type Code = string;
2711 export interface CodeSigning {
2712 /**
2713 * The ID of the AWSSignerJob which was created to sign the file.
2714 */
2715 awsSignerJobId?: SigningJobId;
2716 /**
2717 * Describes the code-signing job.
2718 */
2719 startSigningJobParameter?: StartSigningJobParameter;
2720 /**
2721 * A custom method for code signing a file.
2722 */
2723 customCodeSigning?: CustomCodeSigning;
2724 }
2725 export interface CodeSigningCertificateChain {
2726 /**
2727 * The name of the certificate.
2728 */
2729 certificateName?: CertificateName;
2730 /**
2731 * A base64 encoded binary representation of the code signing certificate chain.
2732 */
2733 inlineDocument?: InlineDocument;
2734 }
2735 export interface CodeSigningSignature {
2736 /**
2737 * A base64 encoded binary representation of the code signing signature.
2738 */
2739 inlineDocument?: Signature;
2740 }
2741 export type CognitoIdentityPoolId = string;
2742 export type Comment = string;
2743 export type ComparisonOperator = "less-than"|"less-than-equals"|"greater-than"|"greater-than-equals"|"in-cidr-set"|"not-in-cidr-set"|"in-port-set"|"not-in-port-set"|string;
2744 export type CompliantChecksCount = number;
2745 export interface Configuration {
2746 /**
2747 * True to enable the configuration.
2748 */
2749 Enabled?: Enabled;
2750 }
2751 export interface ConfirmTopicRuleDestinationRequest {
2752 /**
2753 * The token used to confirm ownership or access to the topic rule confirmation URL.
2754 */
2755 confirmationToken: ConfirmationToken;
2756 }
2757 export interface ConfirmTopicRuleDestinationResponse {
2758 }
2759 export type ConfirmationToken = string;
2760 export type ConnectivityTimestamp = number;
2761 export type ConsecutiveDatapointsToAlarm = number;
2762 export type ConsecutiveDatapointsToClear = number;
2763 export type Count = number;
2764 export interface CreateAuthorizerRequest {
2765 /**
2766 * The authorizer name.
2767 */
2768 authorizerName: AuthorizerName;
2769 /**
2770 * The ARN of the authorizer's Lambda function.
2771 */
2772 authorizerFunctionArn: AuthorizerFunctionArn;
2773 /**
2774 * The name of the token key used to extract the token from the HTTP headers.
2775 */
2776 tokenKeyName?: TokenKeyName;
2777 /**
2778 * The public keys used to verify the digital signature returned by your custom authentication service.
2779 */
2780 tokenSigningPublicKeys?: PublicKeyMap;
2781 /**
2782 * The status of the create authorizer request.
2783 */
2784 status?: AuthorizerStatus;
2785 /**
2786 * Specifies whether AWS IoT validates the token signature in an authorization request.
2787 */
2788 signingDisabled?: BooleanKey;
2789 }
2790 export interface CreateAuthorizerResponse {
2791 /**
2792 * The authorizer's name.
2793 */
2794 authorizerName?: AuthorizerName;
2795 /**
2796 * The authorizer ARN.
2797 */
2798 authorizerArn?: AuthorizerArn;
2799 }
2800 export interface CreateBillingGroupRequest {
2801 /**
2802 * The name you wish to give to the billing group.
2803 */
2804 billingGroupName: BillingGroupName;
2805 /**
2806 * The properties of the billing group.
2807 */
2808 billingGroupProperties?: BillingGroupProperties;
2809 /**
2810 * Metadata which can be used to manage the billing group.
2811 */
2812 tags?: TagList;
2813 }
2814 export interface CreateBillingGroupResponse {
2815 /**
2816 * The name you gave to the billing group.
2817 */
2818 billingGroupName?: BillingGroupName;
2819 /**
2820 * The ARN of the billing group.
2821 */
2822 billingGroupArn?: BillingGroupArn;
2823 /**
2824 * The ID of the billing group.
2825 */
2826 billingGroupId?: BillingGroupId;
2827 }
2828 export interface CreateCertificateFromCsrRequest {
2829 /**
2830 * The certificate signing request (CSR).
2831 */
2832 certificateSigningRequest: CertificateSigningRequest;
2833 /**
2834 * Specifies whether the certificate is active.
2835 */
2836 setAsActive?: SetAsActive;
2837 }
2838 export interface CreateCertificateFromCsrResponse {
2839 /**
2840 * The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.
2841 */
2842 certificateArn?: CertificateArn;
2843 /**
2844 * The ID of the certificate. Certificate management operations only take a certificateId.
2845 */
2846 certificateId?: CertificateId;
2847 /**
2848 * The certificate data, in PEM format.
2849 */
2850 certificatePem?: CertificatePem;
2851 }
2852 export interface CreateDimensionRequest {
2853 /**
2854 * A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
2855 */
2856 name: DimensionName;
2857 /**
2858 * Specifies the type of dimension. Supported types: TOPIC_FILTER.
2859 */
2860 type: DimensionType;
2861 /**
2862 * Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
2863 */
2864 stringValues: DimensionStringValues;
2865 /**
2866 * Metadata that can be used to manage the dimension.
2867 */
2868 tags?: TagList;
2869 /**
2870 * Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
2871 */
2872 clientRequestToken: ClientRequestToken;
2873 }
2874 export interface CreateDimensionResponse {
2875 /**
2876 * A unique identifier for the dimension.
2877 */
2878 name?: DimensionName;
2879 /**
2880 * The ARN (Amazon resource name) of the created dimension.
2881 */
2882 arn?: DimensionArn;
2883 }
2884 export interface CreateDomainConfigurationRequest {
2885 /**
2886 * The name of the domain configuration. This value must be unique to a region.
2887 */
2888 domainConfigurationName: DomainConfigurationName;
2889 /**
2890 * The name of the domain.
2891 */
2892 domainName?: DomainName;
2893 /**
2894 * The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for AWS-managed domains.
2895 */
2896 serverCertificateArns?: ServerCertificateArns;
2897 /**
2898 * The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for AWS-managed domains.
2899 */
2900 validationCertificateArn?: AcmCertificateArn;
2901 /**
2902 * An object that specifies the authorization service for a domain.
2903 */
2904 authorizerConfig?: AuthorizerConfig;
2905 /**
2906 * The type of service delivered by the endpoint.
2907 */
2908 serviceType?: ServiceType;
2909 }
2910 export interface CreateDomainConfigurationResponse {
2911 /**
2912 * The name of the domain configuration.
2913 */
2914 domainConfigurationName?: DomainConfigurationName;
2915 /**
2916 * The ARN of the domain configuration.
2917 */
2918 domainConfigurationArn?: DomainConfigurationArn;
2919 }
2920 export interface CreateDynamicThingGroupRequest {
2921 /**
2922 * The dynamic thing group name to create.
2923 */
2924 thingGroupName: ThingGroupName;
2925 /**
2926 * The dynamic thing group properties.
2927 */
2928 thingGroupProperties?: ThingGroupProperties;
2929 /**
2930 * The dynamic thing group index name. Currently one index is supported: "AWS_Things".
2931 */
2932 indexName?: IndexName;
2933 /**
2934 * The dynamic thing group search query string. See Query Syntax for information about query string syntax.
2935 */
2936 queryString: QueryString;
2937 /**
2938 * The dynamic thing group query version. Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
2939 */
2940 queryVersion?: QueryVersion;
2941 /**
2942 * Metadata which can be used to manage the dynamic thing group.
2943 */
2944 tags?: TagList;
2945 }
2946 export interface CreateDynamicThingGroupResponse {
2947 /**
2948 * The dynamic thing group name.
2949 */
2950 thingGroupName?: ThingGroupName;
2951 /**
2952 * The dynamic thing group ARN.
2953 */
2954 thingGroupArn?: ThingGroupArn;
2955 /**
2956 * The dynamic thing group ID.
2957 */
2958 thingGroupId?: ThingGroupId;
2959 /**
2960 * The dynamic thing group index name.
2961 */
2962 indexName?: IndexName;
2963 /**
2964 * The dynamic thing group search query string.
2965 */
2966 queryString?: QueryString;
2967 /**
2968 * The dynamic thing group query version.
2969 */
2970 queryVersion?: QueryVersion;
2971 }
2972 export interface CreateJobRequest {
2973 /**
2974 * A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
2975 */
2976 jobId: JobId;
2977 /**
2978 * A list of things and thing groups to which the job should be sent.
2979 */
2980 targets: JobTargets;
2981 /**
2982 * An S3 link to the job document.
2983 */
2984 documentSource?: JobDocumentSource;
2985 /**
2986 * The job document. If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document. The placeholder link is of the following form: ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} where bucket is your bucket name and key is the object in the bucket to which you are linking.
2987 */
2988 document?: JobDocument;
2989 /**
2990 * A short text description of the job.
2991 */
2992 description?: JobDescription;
2993 /**
2994 * Configuration information for pre-signed S3 URLs.
2995 */
2996 presignedUrlConfig?: PresignedUrlConfig;
2997 /**
2998 * Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
2999 */
3000 targetSelection?: TargetSelection;
3001 /**
3002 * Allows you to create a staged rollout of the job.
3003 */
3004 jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
3005 /**
3006 * Allows you to create criteria to abort a job.
3007 */
3008 abortConfig?: AbortConfig;
3009 /**
3010 * Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.
3011 */
3012 timeoutConfig?: TimeoutConfig;
3013 /**
3014 * Metadata which can be used to manage the job.
3015 */
3016 tags?: TagList;
3017 }
3018 export interface CreateJobResponse {
3019 /**
3020 * The job ARN.
3021 */
3022 jobArn?: JobArn;
3023 /**
3024 * The unique identifier you assigned to this job.
3025 */
3026 jobId?: JobId;
3027 /**
3028 * The job description.
3029 */
3030 description?: JobDescription;
3031 }
3032 export interface CreateKeysAndCertificateRequest {
3033 /**
3034 * Specifies whether the certificate is active.
3035 */
3036 setAsActive?: SetAsActive;
3037 }
3038 export interface CreateKeysAndCertificateResponse {
3039 /**
3040 * The ARN of the certificate.
3041 */
3042 certificateArn?: CertificateArn;
3043 /**
3044 * The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate).
3045 */
3046 certificateId?: CertificateId;
3047 /**
3048 * The certificate data, in PEM format.
3049 */
3050 certificatePem?: CertificatePem;
3051 /**
3052 * The generated key pair.
3053 */
3054 keyPair?: KeyPair;
3055 }
3056 export interface CreateMitigationActionRequest {
3057 /**
3058 * A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).
3059 */
3060 actionName: MitigationActionName;
3061 /**
3062 * The ARN of the IAM role that is used to apply the mitigation action.
3063 */
3064 roleArn: RoleArn;
3065 /**
3066 * Defines the type of action and the parameters for that action.
3067 */
3068 actionParams: MitigationActionParams;
3069 /**
3070 * Metadata that can be used to manage the mitigation action.
3071 */
3072 tags?: TagList;
3073 }
3074 export interface CreateMitigationActionResponse {
3075 /**
3076 * The ARN for the new mitigation action.
3077 */
3078 actionArn?: MitigationActionArn;
3079 /**
3080 * A unique identifier for the new mitigation action.
3081 */
3082 actionId?: MitigationActionId;
3083 }
3084 export interface CreateOTAUpdateRequest {
3085 /**
3086 * The ID of the OTA update to be created.
3087 */
3088 otaUpdateId: OTAUpdateId;
3089 /**
3090 * The description of the OTA update.
3091 */
3092 description?: OTAUpdateDescription;
3093 /**
3094 * The targeted devices to receive OTA updates.
3095 */
3096 targets: Targets;
3097 /**
3098 * The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
3099 */
3100 protocols?: Protocols;
3101 /**
3102 * Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
3103 */
3104 targetSelection?: TargetSelection;
3105 /**
3106 * Configuration for the rollout of OTA updates.
3107 */
3108 awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig;
3109 /**
3110 * Configuration information for pre-signed URLs.
3111 */
3112 awsJobPresignedUrlConfig?: AwsJobPresignedUrlConfig;
3113 /**
3114 * The files to be streamed by the OTA update.
3115 */
3116 files: OTAUpdateFiles;
3117 /**
3118 * The IAM role that allows access to the AWS IoT Jobs service.
3119 */
3120 roleArn: RoleArn;
3121 /**
3122 * A list of additional OTA update parameters which are name-value pairs.
3123 */
3124 additionalParameters?: AdditionalParameterMap;
3125 /**
3126 * Metadata which can be used to manage updates.
3127 */
3128 tags?: TagList;
3129 }
3130 export interface CreateOTAUpdateResponse {
3131 /**
3132 * The OTA update ID.
3133 */
3134 otaUpdateId?: OTAUpdateId;
3135 /**
3136 * The AWS IoT job ID associated with the OTA update.
3137 */
3138 awsIotJobId?: AwsIotJobId;
3139 /**
3140 * The OTA update ARN.
3141 */
3142 otaUpdateArn?: OTAUpdateArn;
3143 /**
3144 * The AWS IoT job ARN associated with the OTA update.
3145 */
3146 awsIotJobArn?: AwsIotJobArn;
3147 /**
3148 * The OTA update status.
3149 */
3150 otaUpdateStatus?: OTAUpdateStatus;
3151 }
3152 export interface CreatePolicyRequest {
3153 /**
3154 * The policy name.
3155 */
3156 policyName: PolicyName;
3157 /**
3158 * The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.
3159 */
3160 policyDocument: PolicyDocument;
3161 }
3162 export interface CreatePolicyResponse {
3163 /**
3164 * The policy name.
3165 */
3166 policyName?: PolicyName;
3167 /**
3168 * The policy ARN.
3169 */
3170 policyArn?: PolicyArn;
3171 /**
3172 * The JSON document that describes the policy.
3173 */
3174 policyDocument?: PolicyDocument;
3175 /**
3176 * The policy version ID.
3177 */
3178 policyVersionId?: PolicyVersionId;
3179 }
3180 export interface CreatePolicyVersionRequest {
3181 /**
3182 * The policy name.
3183 */
3184 policyName: PolicyName;
3185 /**
3186 * The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.
3187 */
3188 policyDocument: PolicyDocument;
3189 /**
3190 * Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
3191 */
3192 setAsDefault?: SetAsDefault;
3193 }
3194 export interface CreatePolicyVersionResponse {
3195 /**
3196 * The policy ARN.
3197 */
3198 policyArn?: PolicyArn;
3199 /**
3200 * The JSON document that describes the policy.
3201 */
3202 policyDocument?: PolicyDocument;
3203 /**
3204 * The policy version ID.
3205 */
3206 policyVersionId?: PolicyVersionId;
3207 /**
3208 * Specifies whether the policy version is the default.
3209 */
3210 isDefaultVersion?: IsDefaultVersion;
3211 }
3212 export interface CreateProvisioningClaimRequest {
3213 /**
3214 * The name of the provisioning template to use.
3215 */
3216 templateName: TemplateName;
3217 }
3218 export interface CreateProvisioningClaimResponse {
3219 /**
3220 * The ID of the certificate.
3221 */
3222 certificateId?: CertificateId;
3223 /**
3224 * The provisioning claim certificate.
3225 */
3226 certificatePem?: CertificatePem;
3227 /**
3228 * The provisioning claim key pair.
3229 */
3230 keyPair?: KeyPair;
3231 /**
3232 * The provisioning claim expiration time.
3233 */
3234 expiration?: DateType;
3235 }
3236 export interface CreateProvisioningTemplateRequest {
3237 /**
3238 * The name of the fleet provisioning template.
3239 */
3240 templateName: TemplateName;
3241 /**
3242 * The description of the fleet provisioning template.
3243 */
3244 description?: TemplateDescription;
3245 /**
3246 * The JSON formatted contents of the fleet provisioning template.
3247 */
3248 templateBody: TemplateBody;
3249 /**
3250 * True to enable the fleet provisioning template, otherwise false.
3251 */
3252 enabled?: Enabled;
3253 /**
3254 * The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
3255 */
3256 provisioningRoleArn: RoleArn;
3257 /**
3258 * Metadata which can be used to manage the fleet provisioning template. For URI Request parameters use format: ...key1=value1&amp;key2=value2... For the CLI command-line parameter use format: &amp;&amp;tags "key1=value1&amp;key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&amp;key2=value2..."
3259 */
3260 tags?: TagList;
3261 }
3262 export interface CreateProvisioningTemplateResponse {
3263 /**
3264 * The ARN that identifies the provisioning template.
3265 */
3266 templateArn?: TemplateArn;
3267 /**
3268 * The name of the fleet provisioning template.
3269 */
3270 templateName?: TemplateName;
3271 /**
3272 * The default version of the fleet provisioning template.
3273 */
3274 defaultVersionId?: TemplateVersionId;
3275 }
3276 export interface CreateProvisioningTemplateVersionRequest {
3277 /**
3278 * The name of the fleet provisioning template.
3279 */
3280 templateName: TemplateName;
3281 /**
3282 * The JSON formatted contents of the fleet provisioning template.
3283 */
3284 templateBody: TemplateBody;
3285 /**
3286 * Sets a fleet provision template version as the default version.
3287 */
3288 setAsDefault?: SetAsDefault;
3289 }
3290 export interface CreateProvisioningTemplateVersionResponse {
3291 /**
3292 * The ARN that identifies the provisioning template.
3293 */
3294 templateArn?: TemplateArn;
3295 /**
3296 * The name of the fleet provisioning template.
3297 */
3298 templateName?: TemplateName;
3299 /**
3300 * The version of the fleet provisioning template.
3301 */
3302 versionId?: TemplateVersionId;
3303 /**
3304 * True if the fleet provisioning template version is the default version, otherwise false.
3305 */
3306 isDefaultVersion?: IsDefaultVersion;
3307 }
3308 export interface CreateRoleAliasRequest {
3309 /**
3310 * The role alias that points to a role ARN. This allows you to change the role without having to update the device.
3311 */
3312 roleAlias: RoleAlias;
3313 /**
3314 * The role ARN.
3315 */
3316 roleArn: RoleArn;
3317 /**
3318 * How long (in seconds) the credentials will be valid.
3319 */
3320 credentialDurationSeconds?: CredentialDurationSeconds;
3321 }
3322 export interface CreateRoleAliasResponse {
3323 /**
3324 * The role alias.
3325 */
3326 roleAlias?: RoleAlias;
3327 /**
3328 * The role alias ARN.
3329 */
3330 roleAliasArn?: RoleAliasArn;
3331 }
3332 export interface CreateScheduledAuditRequest {
3333 /**
3334 * How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The start time of each audit is determined by the system.
3335 */
3336 frequency: AuditFrequency;
3337 /**
3338 * The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
3339 */
3340 dayOfMonth?: DayOfMonth;
3341 /**
3342 * The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
3343 */
3344 dayOfWeek?: DayOfWeek;
3345 /**
3346 * Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
3347 */
3348 targetCheckNames: TargetAuditCheckNames;
3349 /**
3350 * The name you want to give to the scheduled audit. (Max. 128 chars)
3351 */
3352 scheduledAuditName: ScheduledAuditName;
3353 /**
3354 * Metadata that can be used to manage the scheduled audit.
3355 */
3356 tags?: TagList;
3357 }
3358 export interface CreateScheduledAuditResponse {
3359 /**
3360 * The ARN of the scheduled audit.
3361 */
3362 scheduledAuditArn?: ScheduledAuditArn;
3363 }
3364 export interface CreateSecurityProfileRequest {
3365 /**
3366 * The name you are giving to the security profile.
3367 */
3368 securityProfileName: SecurityProfileName;
3369 /**
3370 * A description of the security profile.
3371 */
3372 securityProfileDescription?: SecurityProfileDescription;
3373 /**
3374 * Specifies the behaviors that, when violated by a device (thing), cause an alert.
3375 */
3376 behaviors?: Behaviors;
3377 /**
3378 * Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
3379 */
3380 alertTargets?: AlertTargets;
3381 /**
3382 * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Note: This API field is deprecated. Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
3383 */
3384 additionalMetricsToRetain?: AdditionalMetricsToRetainList;
3385 /**
3386 * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
3387 */
3388 additionalMetricsToRetainV2?: AdditionalMetricsToRetainV2List;
3389 /**
3390 * Metadata that can be used to manage the security profile.
3391 */
3392 tags?: TagList;
3393 }
3394 export interface CreateSecurityProfileResponse {
3395 /**
3396 * The name you gave to the security profile.
3397 */
3398 securityProfileName?: SecurityProfileName;
3399 /**
3400 * The ARN of the security profile.
3401 */
3402 securityProfileArn?: SecurityProfileArn;
3403 }
3404 export interface CreateStreamRequest {
3405 /**
3406 * The stream ID.
3407 */
3408 streamId: StreamId;
3409 /**
3410 * A description of the stream.
3411 */
3412 description?: StreamDescription;
3413 /**
3414 * The files to stream.
3415 */
3416 files: StreamFiles;
3417 /**
3418 * An IAM role that allows the IoT service principal assumes to access your S3 files.
3419 */
3420 roleArn: RoleArn;
3421 /**
3422 * Metadata which can be used to manage streams.
3423 */
3424 tags?: TagList;
3425 }
3426 export interface CreateStreamResponse {
3427 /**
3428 * The stream ID.
3429 */
3430 streamId?: StreamId;
3431 /**
3432 * The stream ARN.
3433 */
3434 streamArn?: StreamArn;
3435 /**
3436 * A description of the stream.
3437 */
3438 description?: StreamDescription;
3439 /**
3440 * The version of the stream.
3441 */
3442 streamVersion?: StreamVersion;
3443 }
3444 export interface CreateThingGroupRequest {
3445 /**
3446 * The thing group name to create.
3447 */
3448 thingGroupName: ThingGroupName;
3449 /**
3450 * The name of the parent thing group.
3451 */
3452 parentGroupName?: ThingGroupName;
3453 /**
3454 * The thing group properties.
3455 */
3456 thingGroupProperties?: ThingGroupProperties;
3457 /**
3458 * Metadata which can be used to manage the thing group.
3459 */
3460 tags?: TagList;
3461 }
3462 export interface CreateThingGroupResponse {
3463 /**
3464 * The thing group name.
3465 */
3466 thingGroupName?: ThingGroupName;
3467 /**
3468 * The thing group ARN.
3469 */
3470 thingGroupArn?: ThingGroupArn;
3471 /**
3472 * The thing group ID.
3473 */
3474 thingGroupId?: ThingGroupId;
3475 }
3476 export interface CreateThingRequest {
3477 /**
3478 * The name of the thing to create.
3479 */
3480 thingName: ThingName;
3481 /**
3482 * The name of the thing type associated with the new thing.
3483 */
3484 thingTypeName?: ThingTypeName;
3485 /**
3486 * The attribute payload, which consists of up to three name/value pairs in a JSON document. For example: {\"attributes\":{\"string1\":\"string2\"}}
3487 */
3488 attributePayload?: AttributePayload;
3489 /**
3490 * The name of the billing group the thing will be added to.
3491 */
3492 billingGroupName?: BillingGroupName;
3493 }
3494 export interface CreateThingResponse {
3495 /**
3496 * The name of the new thing.
3497 */
3498 thingName?: ThingName;
3499 /**
3500 * The ARN of the new thing.
3501 */
3502 thingArn?: ThingArn;
3503 /**
3504 * The thing ID.
3505 */
3506 thingId?: ThingId;
3507 }
3508 export interface CreateThingTypeRequest {
3509 /**
3510 * The name of the thing type.
3511 */
3512 thingTypeName: ThingTypeName;
3513 /**
3514 * The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.
3515 */
3516 thingTypeProperties?: ThingTypeProperties;
3517 /**
3518 * Metadata which can be used to manage the thing type.
3519 */
3520 tags?: TagList;
3521 }
3522 export interface CreateThingTypeResponse {
3523 /**
3524 * The name of the thing type.
3525 */
3526 thingTypeName?: ThingTypeName;
3527 /**
3528 * The Amazon Resource Name (ARN) of the thing type.
3529 */
3530 thingTypeArn?: ThingTypeArn;
3531 /**
3532 * The thing type ID.
3533 */
3534 thingTypeId?: ThingTypeId;
3535 }
3536 export interface CreateTopicRuleDestinationRequest {
3537 /**
3538 * The topic rule destination configuration.
3539 */
3540 destinationConfiguration: TopicRuleDestinationConfiguration;
3541 }
3542 export interface CreateTopicRuleDestinationResponse {
3543 /**
3544 * The topic rule destination.
3545 */
3546 topicRuleDestination?: TopicRuleDestination;
3547 }
3548 export interface CreateTopicRuleRequest {
3549 /**
3550 * The name of the rule.
3551 */
3552 ruleName: RuleName;
3553 /**
3554 * The rule payload.
3555 */
3556 topicRulePayload: TopicRulePayload;
3557 /**
3558 * Metadata which can be used to manage the topic rule. For URI Request parameters use format: ...key1=value1&amp;key2=value2... For the CLI command-line parameter use format: --tags "key1=value1&amp;key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&amp;key2=value2..."
3559 */
3560 tags?: String;
3561 }
3562 export type CreatedAtDate = Date;
3563 export type CreationDate = Date;
3564 export type CredentialDurationSeconds = number;
3565 export interface CustomCodeSigning {
3566 /**
3567 * The signature for the file.
3568 */
3569 signature?: CodeSigningSignature;
3570 /**
3571 * The certificate chain.
3572 */
3573 certificateChain?: CodeSigningCertificateChain;
3574 /**
3575 * The hash algorithm used to code sign the file.
3576 */
3577 hashAlgorithm?: HashAlgorithm;
3578 /**
3579 * The signature algorithm used to code sign the file.
3580 */
3581 signatureAlgorithm?: SignatureAlgorithm;
3582 }
3583 export type CustomerVersion = number;
3584 export type DateType = Date;
3585 export type DayOfMonth = string;
3586 export type DayOfWeek = "SUN"|"MON"|"TUE"|"WED"|"THU"|"FRI"|"SAT"|string;
3587 export interface DeleteAccountAuditConfigurationRequest {
3588 /**
3589 * If true, all scheduled audits are deleted.
3590 */
3591 deleteScheduledAudits?: DeleteScheduledAudits;
3592 }
3593 export interface DeleteAccountAuditConfigurationResponse {
3594 }
3595 export type DeleteAdditionalMetricsToRetain = boolean;
3596 export type DeleteAlertTargets = boolean;
3597 export interface DeleteAuthorizerRequest {
3598 /**
3599 * The name of the authorizer to delete.
3600 */
3601 authorizerName: AuthorizerName;
3602 }
3603 export interface DeleteAuthorizerResponse {
3604 }
3605 export type DeleteBehaviors = boolean;
3606 export interface DeleteBillingGroupRequest {
3607 /**
3608 * The name of the billing group.
3609 */
3610 billingGroupName: BillingGroupName;
3611 /**
3612 * The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException.
3613 */
3614 expectedVersion?: OptionalVersion;
3615 }
3616 export interface DeleteBillingGroupResponse {
3617 }
3618 export interface DeleteCACertificateRequest {
3619 /**
3620 * The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)
3621 */
3622 certificateId: CertificateId;
3623 }
3624 export interface DeleteCACertificateResponse {
3625 }
3626 export interface DeleteCertificateRequest {
3627 /**
3628 * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
3629 */
3630 certificateId: CertificateId;
3631 /**
3632 * Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.
3633 */
3634 forceDelete?: ForceDelete;
3635 }
3636 export interface DeleteDimensionRequest {
3637 /**
3638 * The unique identifier for the dimension that you want to delete.
3639 */
3640 name: DimensionName;
3641 }
3642 export interface DeleteDimensionResponse {
3643 }
3644 export interface DeleteDomainConfigurationRequest {
3645 /**
3646 * The name of the domain configuration to be deleted.
3647 */
3648 domainConfigurationName: DomainConfigurationName;
3649 }
3650 export interface DeleteDomainConfigurationResponse {
3651 }
3652 export interface DeleteDynamicThingGroupRequest {
3653 /**
3654 * The name of the dynamic thing group to delete.
3655 */
3656 thingGroupName: ThingGroupName;
3657 /**
3658 * The expected version of the dynamic thing group to delete.
3659 */
3660 expectedVersion?: OptionalVersion;
3661 }
3662 export interface DeleteDynamicThingGroupResponse {
3663 }
3664 export interface DeleteJobExecutionRequest {
3665 /**
3666 * The ID of the job whose execution on a particular device will be deleted.
3667 */
3668 jobId: JobId;
3669 /**
3670 * The name of the thing whose job execution will be deleted.
3671 */
3672 thingName: ThingName;
3673 /**
3674 * The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device. Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.
3675 */
3676 executionNumber: ExecutionNumber;
3677 /**
3678 * (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false. Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
3679 */
3680 force?: ForceFlag;
3681 }
3682 export interface DeleteJobRequest {
3683 /**
3684 * The ID of the job to be deleted. After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
3685 */
3686 jobId: JobId;
3687 /**
3688 * (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false. Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.
3689 */
3690 force?: ForceFlag;
3691 }
3692 export interface DeleteMitigationActionRequest {
3693 /**
3694 * The name of the mitigation action that you want to delete.
3695 */
3696 actionName: MitigationActionName;
3697 }
3698 export interface DeleteMitigationActionResponse {
3699 }
3700 export interface DeleteOTAUpdateRequest {
3701 /**
3702 * The OTA update ID to delete.
3703 */
3704 otaUpdateId: OTAUpdateId;
3705 /**
3706 * Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.
3707 */
3708 deleteStream?: DeleteStream;
3709 /**
3710 * Specifies if the AWS Job associated with the OTA update should be deleted with the OTA update is deleted.
3711 */
3712 forceDeleteAWSJob?: ForceDeleteAWSJob;
3713 }
3714 export interface DeleteOTAUpdateResponse {
3715 }
3716 export interface DeletePolicyRequest {
3717 /**
3718 * The name of the policy to delete.
3719 */
3720 policyName: PolicyName;
3721 }
3722 export interface DeletePolicyVersionRequest {
3723 /**
3724 * The name of the policy.
3725 */
3726 policyName: PolicyName;
3727 /**
3728 * The policy version ID.
3729 */
3730 policyVersionId: PolicyVersionId;
3731 }
3732 export interface DeleteProvisioningTemplateRequest {
3733 /**
3734 * The name of the fleet provision template to delete.
3735 */
3736 templateName: TemplateName;
3737 }
3738 export interface DeleteProvisioningTemplateResponse {
3739 }
3740 export interface DeleteProvisioningTemplateVersionRequest {
3741 /**
3742 * The name of the fleet provisioning template version to delete.
3743 */
3744 templateName: TemplateName;
3745 /**
3746 * The fleet provisioning template version ID to delete.
3747 */
3748 versionId: TemplateVersionId;
3749 }
3750 export interface DeleteProvisioningTemplateVersionResponse {
3751 }
3752 export interface DeleteRegistrationCodeRequest {
3753 }
3754 export interface DeleteRegistrationCodeResponse {
3755 }
3756 export interface DeleteRoleAliasRequest {
3757 /**
3758 * The role alias to delete.
3759 */
3760 roleAlias: RoleAlias;
3761 }
3762 export interface DeleteRoleAliasResponse {
3763 }
3764 export interface DeleteScheduledAuditRequest {
3765 /**
3766 * The name of the scheduled audit you want to delete.
3767 */
3768 scheduledAuditName: ScheduledAuditName;
3769 }
3770 export interface DeleteScheduledAuditResponse {
3771 }
3772 export type DeleteScheduledAudits = boolean;
3773 export interface DeleteSecurityProfileRequest {
3774 /**
3775 * The name of the security profile to be deleted.
3776 */
3777 securityProfileName: SecurityProfileName;
3778 /**
3779 * The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
3780 */
3781 expectedVersion?: OptionalVersion;
3782 }
3783 export interface DeleteSecurityProfileResponse {
3784 }
3785 export type DeleteStream = boolean;
3786 export interface DeleteStreamRequest {
3787 /**
3788 * The stream ID.
3789 */
3790 streamId: StreamId;
3791 }
3792 export interface DeleteStreamResponse {
3793 }
3794 export interface DeleteThingGroupRequest {
3795 /**
3796 * The name of the thing group to delete.
3797 */
3798 thingGroupName: ThingGroupName;
3799 /**
3800 * The expected version of the thing group to delete.
3801 */
3802 expectedVersion?: OptionalVersion;
3803 }
3804 export interface DeleteThingGroupResponse {
3805 }
3806 export interface DeleteThingRequest {
3807 /**
3808 * The name of the thing to delete.
3809 */
3810 thingName: ThingName;
3811 /**
3812 * The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException.
3813 */
3814 expectedVersion?: OptionalVersion;
3815 }
3816 export interface DeleteThingResponse {
3817 }
3818 export interface DeleteThingTypeRequest {
3819 /**
3820 * The name of the thing type.
3821 */
3822 thingTypeName: ThingTypeName;
3823 }
3824 export interface DeleteThingTypeResponse {
3825 }
3826 export interface DeleteTopicRuleDestinationRequest {
3827 /**
3828 * The ARN of the topic rule destination to delete.
3829 */
3830 arn: AwsArn;
3831 }
3832 export interface DeleteTopicRuleDestinationResponse {
3833 }
3834 export interface DeleteTopicRuleRequest {
3835 /**
3836 * The name of the rule.
3837 */
3838 ruleName: RuleName;
3839 }
3840 export interface DeleteV2LoggingLevelRequest {
3841 /**
3842 * The type of resource for which you are configuring logging. Must be THING_Group.
3843 */
3844 targetType: LogTargetType;
3845 /**
3846 * The name of the resource for which you are configuring logging.
3847 */
3848 targetName: LogTargetName;
3849 }
3850 export type DeliveryStreamName = string;
3851 export interface Denied {
3852 /**
3853 * Information that implicitly denies the authorization. When a policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.
3854 */
3855 implicitDeny?: ImplicitDeny;
3856 /**
3857 * Information that explicitly denies the authorization.
3858 */
3859 explicitDeny?: ExplicitDeny;
3860 }
3861 export interface DeprecateThingTypeRequest {
3862 /**
3863 * The name of the thing type to deprecate.
3864 */
3865 thingTypeName: ThingTypeName;
3866 /**
3867 * Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.
3868 */
3869 undoDeprecate?: UndoDeprecate;
3870 }
3871 export interface DeprecateThingTypeResponse {
3872 }
3873 export type DeprecationDate = Date;
3874 export interface DescribeAccountAuditConfigurationRequest {
3875 }
3876 export interface DescribeAccountAuditConfigurationResponse {
3877 /**
3878 * The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit. On the first call to UpdateAccountAuditConfiguration, this parameter is required.
3879 */
3880 roleArn?: RoleArn;
3881 /**
3882 * Information about the targets to which audit notifications are sent for this account.
3883 */
3884 auditNotificationTargetConfigurations?: AuditNotificationTargetConfigurations;
3885 /**
3886 * Which audit checks are enabled and disabled for this account.
3887 */
3888 auditCheckConfigurations?: AuditCheckConfigurations;
3889 }
3890 export interface DescribeAuditFindingRequest {
3891 /**
3892 * A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.
3893 */
3894 findingId: FindingId;
3895 }
3896 export interface DescribeAuditFindingResponse {
3897 finding?: AuditFinding;
3898 }
3899 export interface DescribeAuditMitigationActionsTaskRequest {
3900 /**
3901 * The unique identifier for the audit mitigation task.
3902 */
3903 taskId: AuditMitigationActionsTaskId;
3904 }
3905 export interface DescribeAuditMitigationActionsTaskResponse {
3906 /**
3907 * The current status of the task.
3908 */
3909 taskStatus?: AuditMitigationActionsTaskStatus;
3910 /**
3911 * The date and time when the task was started.
3912 */
3913 startTime?: Timestamp;
3914 /**
3915 * The date and time when the task was completed or canceled.
3916 */
3917 endTime?: Timestamp;
3918 /**
3919 * Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.
3920 */
3921 taskStatistics?: AuditMitigationActionsTaskStatistics;
3922 /**
3923 * Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.
3924 */
3925 target?: AuditMitigationActionsTaskTarget;
3926 /**
3927 * Specifies the mitigation actions that should be applied to specific audit checks.
3928 */
3929 auditCheckToActionsMapping?: AuditCheckToActionsMapping;
3930 /**
3931 * Specifies the mitigation actions and their parameters that are applied as part of this task.
3932 */
3933 actionsDefinition?: MitigationActionList;
3934 }
3935 export interface DescribeAuditTaskRequest {
3936 /**
3937 * The ID of the audit whose information you want to get.
3938 */
3939 taskId: AuditTaskId;
3940 }
3941 export interface DescribeAuditTaskResponse {
3942 /**
3943 * The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
3944 */
3945 taskStatus?: AuditTaskStatus;
3946 /**
3947 * The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
3948 */
3949 taskType?: AuditTaskType;
3950 /**
3951 * The time the audit started.
3952 */
3953 taskStartTime?: Timestamp;
3954 /**
3955 * Statistical information about the audit.
3956 */
3957 taskStatistics?: TaskStatistics;
3958 /**
3959 * The name of the scheduled audit (only if the audit was a scheduled audit).
3960 */
3961 scheduledAuditName?: ScheduledAuditName;
3962 /**
3963 * Detailed information about each check performed during this audit.
3964 */
3965 auditDetails?: AuditDetails;
3966 }
3967 export interface DescribeAuthorizerRequest {
3968 /**
3969 * The name of the authorizer to describe.
3970 */
3971 authorizerName: AuthorizerName;
3972 }
3973 export interface DescribeAuthorizerResponse {
3974 /**
3975 * The authorizer description.
3976 */
3977 authorizerDescription?: AuthorizerDescription;
3978 }
3979 export interface DescribeBillingGroupRequest {
3980 /**
3981 * The name of the billing group.
3982 */
3983 billingGroupName: BillingGroupName;
3984 }
3985 export interface DescribeBillingGroupResponse {
3986 /**
3987 * The name of the billing group.
3988 */
3989 billingGroupName?: BillingGroupName;
3990 /**
3991 * The ID of the billing group.
3992 */
3993 billingGroupId?: BillingGroupId;
3994 /**
3995 * The ARN of the billing group.
3996 */
3997 billingGroupArn?: BillingGroupArn;
3998 /**
3999 * The version of the billing group.
4000 */
4001 version?: Version;
4002 /**
4003 * The properties of the billing group.
4004 */
4005 billingGroupProperties?: BillingGroupProperties;
4006 /**
4007 * Additional information about the billing group.
4008 */
4009 billingGroupMetadata?: BillingGroupMetadata;
4010 }
4011 export interface DescribeCACertificateRequest {
4012 /**
4013 * The CA certificate identifier.
4014 */
4015 certificateId: CertificateId;
4016 }
4017 export interface DescribeCACertificateResponse {
4018 /**
4019 * The CA certificate description.
4020 */
4021 certificateDescription?: CACertificateDescription;
4022 /**
4023 * Information about the registration configuration.
4024 */
4025 registrationConfig?: RegistrationConfig;
4026 }
4027 export interface DescribeCertificateRequest {
4028 /**
4029 * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
4030 */
4031 certificateId: CertificateId;
4032 }
4033 export interface DescribeCertificateResponse {
4034 /**
4035 * The description of the certificate.
4036 */
4037 certificateDescription?: CertificateDescription;
4038 }
4039 export interface DescribeDefaultAuthorizerRequest {
4040 }
4041 export interface DescribeDefaultAuthorizerResponse {
4042 /**
4043 * The default authorizer's description.
4044 */
4045 authorizerDescription?: AuthorizerDescription;
4046 }
4047 export interface DescribeDimensionRequest {
4048 /**
4049 * The unique identifier for the dimension.
4050 */
4051 name: DimensionName;
4052 }
4053 export interface DescribeDimensionResponse {
4054 /**
4055 * The unique identifier for the dimension.
4056 */
4057 name?: DimensionName;
4058 /**
4059 * The ARN (Amazon resource name) for the dimension.
4060 */
4061 arn?: DimensionArn;
4062 /**
4063 * The type of the dimension.
4064 */
4065 type?: DimensionType;
4066 /**
4067 * 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.
4068 */
4069 stringValues?: DimensionStringValues;
4070 /**
4071 * The date the dimension was created.
4072 */
4073 creationDate?: Timestamp;
4074 /**
4075 * The date the dimension was last modified.
4076 */
4077 lastModifiedDate?: Timestamp;
4078 }
4079 export interface DescribeDomainConfigurationRequest {
4080 /**
4081 * The name of the domain configuration.
4082 */
4083 domainConfigurationName: ReservedDomainConfigurationName;
4084 }
4085 export interface DescribeDomainConfigurationResponse {
4086 /**
4087 * The name of the domain configuration.
4088 */
4089 domainConfigurationName?: ReservedDomainConfigurationName;
4090 /**
4091 * The ARN of the domain configuration.
4092 */
4093 domainConfigurationArn?: DomainConfigurationArn;
4094 /**
4095 * The name of the domain.
4096 */
4097 domainName?: DomainName;
4098 /**
4099 * A list containing summary information about the server certificate included in the domain configuration.
4100 */
4101 serverCertificates?: ServerCertificates;
4102 /**
4103 * An object that specifies the authorization service for a domain.
4104 */
4105 authorizerConfig?: AuthorizerConfig;
4106 /**
4107 * A Boolean value that specifies the current state of the domain configuration.
4108 */
4109 domainConfigurationStatus?: DomainConfigurationStatus;
4110 /**
4111 * The type of service delivered by the endpoint.
4112 */
4113 serviceType?: ServiceType;
4114 /**
4115 * The type of the domain.
4116 */
4117 domainType?: DomainType;
4118 }
4119 export interface DescribeEndpointRequest {
4120 /**
4121 * The endpoint type. Valid endpoint types include: iot:Data - Returns a VeriSign signed data endpoint. iot:Data-ATS - Returns an ATS signed data endpoint. iot:CredentialProvider - Returns an AWS IoT credentials provider API endpoint. iot:Jobs - Returns an AWS IoT device management Jobs API endpoint. We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.
4122 */
4123 endpointType?: EndpointType;
4124 }
4125 export interface DescribeEndpointResponse {
4126 /**
4127 * The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.
4128 */
4129 endpointAddress?: EndpointAddress;
4130 }
4131 export interface DescribeEventConfigurationsRequest {
4132 }
4133 export interface DescribeEventConfigurationsResponse {
4134 /**
4135 * The event configurations.
4136 */
4137 eventConfigurations?: EventConfigurations;
4138 /**
4139 * The creation date of the event configuration.
4140 */
4141 creationDate?: CreationDate;
4142 /**
4143 * The date the event configurations were last modified.
4144 */
4145 lastModifiedDate?: LastModifiedDate;
4146 }
4147 export interface DescribeIndexRequest {
4148 /**
4149 * The index name.
4150 */
4151 indexName: IndexName;
4152 }
4153 export interface DescribeIndexResponse {
4154 /**
4155 * The index name.
4156 */
4157 indexName?: IndexName;
4158 /**
4159 * The index status.
4160 */
4161 indexStatus?: IndexStatus;
4162 /**
4163 * Contains a value that specifies the type of indexing performed. Valid values are: REGISTRY – Your thing index contains only registry data. REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data. REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data. REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.
4164 */
4165 schema?: IndexSchema;
4166 }
4167 export interface DescribeJobExecutionRequest {
4168 /**
4169 * The unique identifier you assigned to this job when it was created.
4170 */
4171 jobId: JobId;
4172 /**
4173 * The name of the thing on which the job execution is running.
4174 */
4175 thingName: ThingName;
4176 /**
4177 * A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.
4178 */
4179 executionNumber?: ExecutionNumber;
4180 }
4181 export interface DescribeJobExecutionResponse {
4182 /**
4183 * Information about the job execution.
4184 */
4185 execution?: JobExecution;
4186 }
4187 export interface DescribeJobRequest {
4188 /**
4189 * The unique identifier you assigned to this job when it was created.
4190 */
4191 jobId: JobId;
4192 }
4193 export interface DescribeJobResponse {
4194 /**
4195 * An S3 link to the job document.
4196 */
4197 documentSource?: JobDocumentSource;
4198 /**
4199 * Information about the job.
4200 */
4201 job?: Job;
4202 }
4203 export interface DescribeMitigationActionRequest {
4204 /**
4205 * The friendly name that uniquely identifies the mitigation action.
4206 */
4207 actionName: MitigationActionName;
4208 }
4209 export interface DescribeMitigationActionResponse {
4210 /**
4211 * The friendly name that uniquely identifies the mitigation action.
4212 */
4213 actionName?: MitigationActionName;
4214 /**
4215 * The type of mitigation action.
4216 */
4217 actionType?: MitigationActionType;
4218 /**
4219 * The ARN that identifies this migration action.
4220 */
4221 actionArn?: MitigationActionArn;
4222 /**
4223 * A unique identifier for this action.
4224 */
4225 actionId?: MitigationActionId;
4226 /**
4227 * The ARN of the IAM role used to apply this action.
4228 */
4229 roleArn?: RoleArn;
4230 /**
4231 * Parameters that control how the mitigation action is applied, specific to the type of mitigation action.
4232 */
4233 actionParams?: MitigationActionParams;
4234 /**
4235 * The date and time when the mitigation action was added to your AWS account.
4236 */
4237 creationDate?: Timestamp;
4238 /**
4239 * The date and time when the mitigation action was last changed.
4240 */
4241 lastModifiedDate?: Timestamp;
4242 }
4243 export interface DescribeProvisioningTemplateRequest {
4244 /**
4245 * The name of the fleet provisioning template.
4246 */
4247 templateName: TemplateName;
4248 }
4249 export interface DescribeProvisioningTemplateResponse {
4250 /**
4251 * The ARN of the fleet provisioning template.
4252 */
4253 templateArn?: TemplateArn;
4254 /**
4255 * The name of the fleet provisioning template.
4256 */
4257 templateName?: TemplateName;
4258 /**
4259 * The description of the fleet provisioning template.
4260 */
4261 description?: TemplateDescription;
4262 /**
4263 * The date when the fleet provisioning template was created.
4264 */
4265 creationDate?: DateType;
4266 /**
4267 * The date when the fleet provisioning template was last modified.
4268 */
4269 lastModifiedDate?: DateType;
4270 /**
4271 * The default fleet template version ID.
4272 */
4273 defaultVersionId?: TemplateVersionId;
4274 /**
4275 * The JSON formatted contents of the fleet provisioning template.
4276 */
4277 templateBody?: TemplateBody;
4278 /**
4279 * True if the fleet provisioning template is enabled, otherwise false.
4280 */
4281 enabled?: Enabled;
4282 /**
4283 * The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
4284 */
4285 provisioningRoleArn?: RoleArn;
4286 }
4287 export interface DescribeProvisioningTemplateVersionRequest {
4288 /**
4289 * The template name.
4290 */
4291 templateName: TemplateName;
4292 /**
4293 * The fleet provisioning template version ID.
4294 */
4295 versionId: TemplateVersionId;
4296 }
4297 export interface DescribeProvisioningTemplateVersionResponse {
4298 /**
4299 * The fleet provisioning template version ID.
4300 */
4301 versionId?: TemplateVersionId;
4302 /**
4303 * The date when the fleet provisioning template version was created.
4304 */
4305 creationDate?: DateType;
4306 /**
4307 * The JSON formatted contents of the fleet provisioning template version.
4308 */
4309 templateBody?: TemplateBody;
4310 /**
4311 * True if the fleet provisioning template version is the default version.
4312 */
4313 isDefaultVersion?: IsDefaultVersion;
4314 }
4315 export interface DescribeRoleAliasRequest {
4316 /**
4317 * The role alias to describe.
4318 */
4319 roleAlias: RoleAlias;
4320 }
4321 export interface DescribeRoleAliasResponse {
4322 /**
4323 * The role alias description.
4324 */
4325 roleAliasDescription?: RoleAliasDescription;
4326 }
4327 export interface DescribeScheduledAuditRequest {
4328 /**
4329 * The name of the scheduled audit whose information you want to get.
4330 */
4331 scheduledAuditName: ScheduledAuditName;
4332 }
4333 export interface DescribeScheduledAuditResponse {
4334 /**
4335 * How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.
4336 */
4337 frequency?: AuditFrequency;
4338 /**
4339 * The day of the month on which the scheduled audit takes place. Will be "1" through "31" or "LAST". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
4340 */
4341 dayOfMonth?: DayOfMonth;
4342 /**
4343 * The day of the week on which the scheduled audit takes place. One of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT".
4344 */
4345 dayOfWeek?: DayOfWeek;
4346 /**
4347 * Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
4348 */
4349 targetCheckNames?: TargetAuditCheckNames;
4350 /**
4351 * The name of the scheduled audit.
4352 */
4353 scheduledAuditName?: ScheduledAuditName;
4354 /**
4355 * The ARN of the scheduled audit.
4356 */
4357 scheduledAuditArn?: ScheduledAuditArn;
4358 }
4359 export interface DescribeSecurityProfileRequest {
4360 /**
4361 * The name of the security profile whose information you want to get.
4362 */
4363 securityProfileName: SecurityProfileName;
4364 }
4365 export interface DescribeSecurityProfileResponse {
4366 /**
4367 * The name of the security profile.
4368 */
4369 securityProfileName?: SecurityProfileName;
4370 /**
4371 * The ARN of the security profile.
4372 */
4373 securityProfileArn?: SecurityProfileArn;
4374 /**
4375 * A description of the security profile (associated with the security profile when it was created or updated).
4376 */
4377 securityProfileDescription?: SecurityProfileDescription;
4378 /**
4379 * Specifies the behaviors that, when violated by a device (thing), cause an alert.
4380 */
4381 behaviors?: Behaviors;
4382 /**
4383 * Where the alerts are sent. (Alerts are always sent to the console.)
4384 */
4385 alertTargets?: AlertTargets;
4386 /**
4387 * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Note: This API field is deprecated. Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.
4388 */
4389 additionalMetricsToRetain?: AdditionalMetricsToRetainList;
4390 /**
4391 * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
4392 */
4393 additionalMetricsToRetainV2?: AdditionalMetricsToRetainV2List;
4394 /**
4395 * The version of the security profile. A new version is generated whenever the security profile is updated.
4396 */
4397 version?: Version;
4398 /**
4399 * The time the security profile was created.
4400 */
4401 creationDate?: Timestamp;
4402 /**
4403 * The time the security profile was last modified.
4404 */
4405 lastModifiedDate?: Timestamp;
4406 }
4407 export interface DescribeStreamRequest {
4408 /**
4409 * The stream ID.
4410 */
4411 streamId: StreamId;
4412 }
4413 export interface DescribeStreamResponse {
4414 /**
4415 * Information about the stream.
4416 */
4417 streamInfo?: StreamInfo;
4418 }
4419 export interface DescribeThingGroupRequest {
4420 /**
4421 * The name of the thing group.
4422 */
4423 thingGroupName: ThingGroupName;
4424 }
4425 export interface DescribeThingGroupResponse {
4426 /**
4427 * The name of the thing group.
4428 */
4429 thingGroupName?: ThingGroupName;
4430 /**
4431 * The thing group ID.
4432 */
4433 thingGroupId?: ThingGroupId;
4434 /**
4435 * The thing group ARN.
4436 */
4437 thingGroupArn?: ThingGroupArn;
4438 /**
4439 * The version of the thing group.
4440 */
4441 version?: Version;
4442 /**
4443 * The thing group properties.
4444 */
4445 thingGroupProperties?: ThingGroupProperties;
4446 /**
4447 * Thing group metadata.
4448 */
4449 thingGroupMetadata?: ThingGroupMetadata;
4450 /**
4451 * The dynamic thing group index name.
4452 */
4453 indexName?: IndexName;
4454 /**
4455 * The dynamic thing group search query string.
4456 */
4457 queryString?: QueryString;
4458 /**
4459 * The dynamic thing group query version.
4460 */
4461 queryVersion?: QueryVersion;
4462 /**
4463 * The dynamic thing group status.
4464 */
4465 status?: DynamicGroupStatus;
4466 }
4467 export interface DescribeThingRegistrationTaskRequest {
4468 /**
4469 * The task ID.
4470 */
4471 taskId: TaskId;
4472 }
4473 export interface DescribeThingRegistrationTaskResponse {
4474 /**
4475 * The task ID.
4476 */
4477 taskId?: TaskId;
4478 /**
4479 * The task creation date.
4480 */
4481 creationDate?: CreationDate;
4482 /**
4483 * The date when the task was last modified.
4484 */
4485 lastModifiedDate?: LastModifiedDate;
4486 /**
4487 * The task's template.
4488 */
4489 templateBody?: TemplateBody;
4490 /**
4491 * The S3 bucket that contains the input file.
4492 */
4493 inputFileBucket?: RegistryS3BucketName;
4494 /**
4495 * The input file key.
4496 */
4497 inputFileKey?: RegistryS3KeyName;
4498 /**
4499 * The role ARN that grants access to the input file bucket.
4500 */
4501 roleArn?: RoleArn;
4502 /**
4503 * The status of the bulk thing provisioning task.
4504 */
4505 status?: Status;
4506 /**
4507 * The message.
4508 */
4509 message?: ErrorMessage;
4510 /**
4511 * The number of things successfully provisioned.
4512 */
4513 successCount?: Count;
4514 /**
4515 * The number of things that failed to be provisioned.
4516 */
4517 failureCount?: Count;
4518 /**
4519 * The progress of the bulk provisioning task expressed as a percentage.
4520 */
4521 percentageProgress?: Percentage;
4522 }
4523 export interface DescribeThingRequest {
4524 /**
4525 * The name of the thing.
4526 */
4527 thingName: ThingName;
4528 }
4529 export interface DescribeThingResponse {
4530 /**
4531 * The default client ID.
4532 */
4533 defaultClientId?: ClientId;
4534 /**
4535 * The name of the thing.
4536 */
4537 thingName?: ThingName;
4538 /**
4539 * The ID of the thing to describe.
4540 */
4541 thingId?: ThingId;
4542 /**
4543 * The ARN of the thing to describe.
4544 */
4545 thingArn?: ThingArn;
4546 /**
4547 * The thing type name.
4548 */
4549 thingTypeName?: ThingTypeName;
4550 /**
4551 * The thing attributes.
4552 */
4553 attributes?: Attributes;
4554 /**
4555 * The current version of the thing record in the registry. To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.
4556 */
4557 version?: Version;
4558 /**
4559 * The name of the billing group the thing belongs to.
4560 */
4561 billingGroupName?: BillingGroupName;
4562 }
4563 export interface DescribeThingTypeRequest {
4564 /**
4565 * The name of the thing type.
4566 */
4567 thingTypeName: ThingTypeName;
4568 }
4569 export interface DescribeThingTypeResponse {
4570 /**
4571 * The name of the thing type.
4572 */
4573 thingTypeName?: ThingTypeName;
4574 /**
4575 * The thing type ID.
4576 */
4577 thingTypeId?: ThingTypeId;
4578 /**
4579 * The thing type ARN.
4580 */
4581 thingTypeArn?: ThingTypeArn;
4582 /**
4583 * The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.
4584 */
4585 thingTypeProperties?: ThingTypeProperties;
4586 /**
4587 * The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.
4588 */
4589 thingTypeMetadata?: ThingTypeMetadata;
4590 }
4591 export type Description = string;
4592 export interface Destination {
4593 /**
4594 * Describes the location in S3 of the updated firmware.
4595 */
4596 s3Destination?: S3Destination;
4597 }
4598 export interface DetachPolicyRequest {
4599 /**
4600 * The policy to detach.
4601 */
4602 policyName: PolicyName;
4603 /**
4604 * The target from which the policy will be detached.
4605 */
4606 target: PolicyTarget;
4607 }
4608 export interface DetachPrincipalPolicyRequest {
4609 /**
4610 * The name of the policy to detach.
4611 */
4612 policyName: PolicyName;
4613 /**
4614 * The principal. If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.
4615 */
4616 principal: Principal;
4617 }
4618 export interface DetachSecurityProfileRequest {
4619 /**
4620 * The security profile that is detached.
4621 */
4622 securityProfileName: SecurityProfileName;
4623 /**
4624 * The ARN of the thing group from which the security profile is detached.
4625 */
4626 securityProfileTargetArn: SecurityProfileTargetArn;
4627 }
4628 export interface DetachSecurityProfileResponse {
4629 }
4630 export interface DetachThingPrincipalRequest {
4631 /**
4632 * The name of the thing.
4633 */
4634 thingName: ThingName;
4635 /**
4636 * If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.
4637 */
4638 principal: Principal;
4639 }
4640 export interface DetachThingPrincipalResponse {
4641 }
4642 export type DetailsKey = string;
4643 export type DetailsMap = {[key: string]: DetailsValue};
4644 export type DetailsValue = string;
4645 export type DeviceCertificateUpdateAction = "DEACTIVATE"|string;
4646 export type DeviceDefenderThingName = string;
4647 export type DimensionArn = string;
4648 export type DimensionName = string;
4649 export type DimensionNames = DimensionName[];
4650 export type DimensionStringValue = string;
4651 export type DimensionStringValues = DimensionStringValue[];
4652 export type DimensionType = "TOPIC_FILTER"|string;
4653 export type DimensionValueOperator = "IN"|"NOT_IN"|string;
4654 export type DisableAllLogs = boolean;
4655 export interface DisableTopicRuleRequest {
4656 /**
4657 * The name of the rule to disable.
4658 */
4659 ruleName: RuleName;
4660 }
4661 export type DomainConfigurationArn = string;
4662 export type DomainConfigurationName = string;
4663 export type DomainConfigurationStatus = "ENABLED"|"DISABLED"|string;
4664 export interface DomainConfigurationSummary {
4665 /**
4666 * The name of the domain configuration. This value must be unique to a region.
4667 */
4668 domainConfigurationName?: ReservedDomainConfigurationName;
4669 /**
4670 * The ARN of the domain configuration.
4671 */
4672 domainConfigurationArn?: DomainConfigurationArn;
4673 /**
4674 * The type of service delivered by the endpoint.
4675 */
4676 serviceType?: ServiceType;
4677 }
4678 export type DomainConfigurations = DomainConfigurationSummary[];
4679 export type DomainName = string;
4680 export type DomainType = "ENDPOINT"|"AWS_MANAGED"|"CUSTOMER_MANAGED"|string;
4681 export type DurationSeconds = number;
4682 export type DynamicGroupStatus = "ACTIVE"|"BUILDING"|"REBUILDING"|string;
4683 export interface DynamoDBAction {
4684 /**
4685 * The name of the DynamoDB table.
4686 */
4687 tableName: TableName;
4688 /**
4689 * The ARN of the IAM role that grants access to the DynamoDB table.
4690 */
4691 roleArn: AwsArn;
4692 /**
4693 * The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.
4694 */
4695 operation?: DynamoOperation;
4696 /**
4697 * The hash key name.
4698 */
4699 hashKeyField: HashKeyField;
4700 /**
4701 * The hash key value.
4702 */
4703 hashKeyValue: HashKeyValue;
4704 /**
4705 * The hash key type. Valid values are "STRING" or "NUMBER"
4706 */
4707 hashKeyType?: DynamoKeyType;
4708 /**
4709 * The range key name.
4710 */
4711 rangeKeyField?: RangeKeyField;
4712 /**
4713 * The range key value.
4714 */
4715 rangeKeyValue?: RangeKeyValue;
4716 /**
4717 * The range key type. Valid values are "STRING" or "NUMBER"
4718 */
4719 rangeKeyType?: DynamoKeyType;
4720 /**
4721 * The action payload. This name can be customized.
4722 */
4723 payloadField?: PayloadField;
4724 }
4725 export interface DynamoDBv2Action {
4726 /**
4727 * The ARN of the IAM role that grants access to the DynamoDB table.
4728 */
4729 roleArn: AwsArn;
4730 /**
4731 * Specifies the DynamoDB table to which the message data will be written. For example: { "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } } Each attribute in the message payload will be written to a separate column in the DynamoDB database.
4732 */
4733 putItem: PutItemInput;
4734 }
4735 export type DynamoKeyType = "STRING"|"NUMBER"|string;
4736 export type DynamoOperation = string;
4737 export type EffectivePolicies = EffectivePolicy[];
4738 export interface EffectivePolicy {
4739 /**
4740 * The policy name.
4741 */
4742 policyName?: PolicyName;
4743 /**
4744 * The policy ARN.
4745 */
4746 policyArn?: PolicyArn;
4747 /**
4748 * The IAM policy document.
4749 */
4750 policyDocument?: PolicyDocument;
4751 }
4752 export interface ElasticsearchAction {
4753 /**
4754 * The IAM role ARN that has access to Elasticsearch.
4755 */
4756 roleArn: AwsArn;
4757 /**
4758 * The endpoint of your Elasticsearch domain.
4759 */
4760 endpoint: ElasticsearchEndpoint;
4761 /**
4762 * The Elasticsearch index where you want to store your data.
4763 */
4764 index: ElasticsearchIndex;
4765 /**
4766 * The type of document you are storing.
4767 */
4768 type: ElasticsearchType;
4769 /**
4770 * The unique identifier for the document you are storing.
4771 */
4772 id: ElasticsearchId;
4773 }
4774 export type ElasticsearchEndpoint = string;
4775 export type ElasticsearchId = string;
4776 export type ElasticsearchIndex = string;
4777 export type ElasticsearchType = string;
4778 export interface EnableIoTLoggingParams {
4779 /**
4780 * The ARN of the IAM role used for logging.
4781 */
4782 roleArnForLogging: RoleArn;
4783 /**
4784 * Specifies the types of information to be logged.
4785 */
4786 logLevel: LogLevel;
4787 }
4788 export interface EnableTopicRuleRequest {
4789 /**
4790 * The name of the topic rule to enable.
4791 */
4792 ruleName: RuleName;
4793 }
4794 export type Enabled = boolean;
4795 export type EndpointAddress = string;
4796 export type EndpointType = string;
4797 export type ErrorCode = string;
4798 export interface ErrorInfo {
4799 /**
4800 * The error code.
4801 */
4802 code?: Code;
4803 /**
4804 * The error message.
4805 */
4806 message?: OTAUpdateErrorMessage;
4807 }
4808 export type ErrorMessage = string;
4809 export type EvaluationStatistic = string;
4810 export type EventConfigurations = {[key: string]: Configuration};
4811 export type EventType = "THING"|"THING_GROUP"|"THING_TYPE"|"THING_GROUP_MEMBERSHIP"|"THING_GROUP_HIERARCHY"|"THING_TYPE_ASSOCIATION"|"JOB"|"JOB_EXECUTION"|"POLICY"|"CERTIFICATE"|"CA_CERTIFICATE"|string;
4812 export type ExecutionNamePrefix = string;
4813 export type ExecutionNumber = number;
4814 export type ExpectedVersion = number;
4815 export type ExpiresInSec = number;
4816 export type ExpiresInSeconds = number;
4817 export interface ExplicitDeny {
4818 /**
4819 * The policies that denied the authorization.
4820 */
4821 policies?: Policies;
4822 }
4823 export interface ExponentialRolloutRate {
4824 /**
4825 * The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
4826 */
4827 baseRatePerMinute: RolloutRatePerMinute;
4828 /**
4829 * The exponential factor to increase the rate of rollout for a job.
4830 */
4831 incrementFactor: IncrementFactor;
4832 /**
4833 * The criteria to initiate the increase in rate of rollout for a job. AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).
4834 */
4835 rateIncreaseCriteria: RateIncreaseCriteria;
4836 }
4837 export type FailedChecksCount = number;
4838 export type FailedFindingsCount = number;
4839 export type FailedThings = number;
4840 export interface Field {
4841 /**
4842 * The name of the field.
4843 */
4844 name?: FieldName;
4845 /**
4846 * The datatype of the field.
4847 */
4848 type?: FieldType;
4849 }
4850 export type FieldName = string;
4851 export type FieldType = "Number"|"String"|"Boolean"|string;
4852 export type Fields = Field[];
4853 export type FileId = number;
4854 export interface FileLocation {
4855 /**
4856 * The stream that contains the OTA update.
4857 */
4858 stream?: Stream;
4859 /**
4860 * The location of the updated firmware in S3.
4861 */
4862 s3Location?: S3Location;
4863 }
4864 export type FileName = string;
4865 export type FindingId = string;
4866 export type FindingIds = FindingId[];
4867 export interface FirehoseAction {
4868 /**
4869 * The IAM role that grants access to the Amazon Kinesis Firehose stream.
4870 */
4871 roleArn: AwsArn;
4872 /**
4873 * The delivery stream name.
4874 */
4875 deliveryStreamName: DeliveryStreamName;
4876 /**
4877 * A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
4878 */
4879 separator?: FirehoseSeparator;
4880 }
4881 export type FirehoseSeparator = string;
4882 export type Flag = boolean;
4883 export type ForceDelete = boolean;
4884 export type ForceDeleteAWSJob = boolean;
4885 export type ForceFlag = boolean;
4886 export type Forced = boolean;
4887 export type FunctionArn = string;
4888 export type GenerationId = string;
4889 export interface GetCardinalityRequest {
4890 /**
4891 * The name of the index to search.
4892 */
4893 indexName?: IndexName;
4894 /**
4895 * The search query.
4896 */
4897 queryString: QueryString;
4898 /**
4899 * The field to aggregate.
4900 */
4901 aggregationField?: AggregationField;
4902 /**
4903 * The query version.
4904 */
4905 queryVersion?: QueryVersion;
4906 }
4907 export interface GetCardinalityResponse {
4908 /**
4909 * The approximate count of unique values that match the query.
4910 */
4911 cardinality?: Count;
4912 }
4913 export interface GetEffectivePoliciesRequest {
4914 /**
4915 * The principal.
4916 */
4917 principal?: Principal;
4918 /**
4919 * The Cognito identity pool ID.
4920 */
4921 cognitoIdentityPoolId?: CognitoIdentityPoolId;
4922 /**
4923 * The thing name.
4924 */
4925 thingName?: ThingName;
4926 }
4927 export interface GetEffectivePoliciesResponse {
4928 /**
4929 * The effective policies.
4930 */
4931 effectivePolicies?: EffectivePolicies;
4932 }
4933 export interface GetIndexingConfigurationRequest {
4934 }
4935 export interface GetIndexingConfigurationResponse {
4936 /**
4937 * Thing indexing configuration.
4938 */
4939 thingIndexingConfiguration?: ThingIndexingConfiguration;
4940 /**
4941 * The index configuration.
4942 */
4943 thingGroupIndexingConfiguration?: ThingGroupIndexingConfiguration;
4944 }
4945 export interface GetJobDocumentRequest {
4946 /**
4947 * The unique identifier you assigned to this job when it was created.
4948 */
4949 jobId: JobId;
4950 }
4951 export interface GetJobDocumentResponse {
4952 /**
4953 * The job document content.
4954 */
4955 document?: JobDocument;
4956 }
4957 export interface GetLoggingOptionsRequest {
4958 }
4959 export interface GetLoggingOptionsResponse {
4960 /**
4961 * The ARN of the IAM role that grants access.
4962 */
4963 roleArn?: AwsArn;
4964 /**
4965 * The logging level.
4966 */
4967 logLevel?: LogLevel;
4968 }
4969 export interface GetOTAUpdateRequest {
4970 /**
4971 * The OTA update ID.
4972 */
4973 otaUpdateId: OTAUpdateId;
4974 }
4975 export interface GetOTAUpdateResponse {
4976 /**
4977 * The OTA update info.
4978 */
4979 otaUpdateInfo?: OTAUpdateInfo;
4980 }
4981 export interface GetPercentilesRequest {
4982 /**
4983 * The name of the index to search.
4984 */
4985 indexName?: IndexName;
4986 /**
4987 * The query string.
4988 */
4989 queryString: QueryString;
4990 /**
4991 * The field to aggregate.
4992 */
4993 aggregationField?: AggregationField;
4994 /**
4995 * The query version.
4996 */
4997 queryVersion?: QueryVersion;
4998 /**
4999 * The percentile groups returned.
5000 */
5001 percents?: PercentList;
5002 }
5003 export interface GetPercentilesResponse {
5004 /**
5005 * The percentile values of the aggregated fields.
5006 */
5007 percentiles?: Percentiles;
5008 }
5009 export interface GetPolicyRequest {
5010 /**
5011 * The name of the policy.
5012 */
5013 policyName: PolicyName;
5014 }
5015 export interface GetPolicyResponse {
5016 /**
5017 * The policy name.
5018 */
5019 policyName?: PolicyName;
5020 /**
5021 * The policy ARN.
5022 */
5023 policyArn?: PolicyArn;
5024 /**
5025 * The JSON document that describes the policy.
5026 */
5027 policyDocument?: PolicyDocument;
5028 /**
5029 * The default policy version ID.
5030 */
5031 defaultVersionId?: PolicyVersionId;
5032 /**
5033 * The date the policy was created.
5034 */
5035 creationDate?: DateType;
5036 /**
5037 * The date the policy was last modified.
5038 */
5039 lastModifiedDate?: DateType;
5040 /**
5041 * The generation ID of the policy.
5042 */
5043 generationId?: GenerationId;
5044 }
5045 export interface GetPolicyVersionRequest {
5046 /**
5047 * The name of the policy.
5048 */
5049 policyName: PolicyName;
5050 /**
5051 * The policy version ID.
5052 */
5053 policyVersionId: PolicyVersionId;
5054 }
5055 export interface GetPolicyVersionResponse {
5056 /**
5057 * The policy ARN.
5058 */
5059 policyArn?: PolicyArn;
5060 /**
5061 * The policy name.
5062 */
5063 policyName?: PolicyName;
5064 /**
5065 * The JSON document that describes the policy.
5066 */
5067 policyDocument?: PolicyDocument;
5068 /**
5069 * The policy version ID.
5070 */
5071 policyVersionId?: PolicyVersionId;
5072 /**
5073 * Specifies whether the policy version is the default.
5074 */
5075 isDefaultVersion?: IsDefaultVersion;
5076 /**
5077 * The date the policy was created.
5078 */
5079 creationDate?: DateType;
5080 /**
5081 * The date the policy was last modified.
5082 */
5083 lastModifiedDate?: DateType;
5084 /**
5085 * The generation ID of the policy version.
5086 */
5087 generationId?: GenerationId;
5088 }
5089 export interface GetRegistrationCodeRequest {
5090 }
5091 export interface GetRegistrationCodeResponse {
5092 /**
5093 * The CA certificate registration code.
5094 */
5095 registrationCode?: RegistrationCode;
5096 }
5097 export interface GetStatisticsRequest {
5098 /**
5099 * The name of the index to search. The default value is AWS_Things.
5100 */
5101 indexName?: IndexName;
5102 /**
5103 * The query used to search. You can specify "*" for the query string to get the count of all indexed things in your AWS account.
5104 */
5105 queryString: QueryString;
5106 /**
5107 * The aggregation field name.
5108 */
5109 aggregationField?: AggregationField;
5110 /**
5111 * The version of the query used to search.
5112 */
5113 queryVersion?: QueryVersion;
5114 }
5115 export interface GetStatisticsResponse {
5116 /**
5117 * The statistics returned by the Fleet Indexing service based on the query and aggregation field.
5118 */
5119 statistics?: Statistics;
5120 }
5121 export interface GetTopicRuleDestinationRequest {
5122 /**
5123 * The ARN of the topic rule destination.
5124 */
5125 arn: AwsArn;
5126 }
5127 export interface GetTopicRuleDestinationResponse {
5128 /**
5129 * The topic rule destination.
5130 */
5131 topicRuleDestination?: TopicRuleDestination;
5132 }
5133 export interface GetTopicRuleRequest {
5134 /**
5135 * The name of the rule.
5136 */
5137 ruleName: RuleName;
5138 }
5139 export interface GetTopicRuleResponse {
5140 /**
5141 * The rule ARN.
5142 */
5143 ruleArn?: RuleArn;
5144 /**
5145 * The rule.
5146 */
5147 rule?: TopicRule;
5148 }
5149 export interface GetV2LoggingOptionsRequest {
5150 }
5151 export interface GetV2LoggingOptionsResponse {
5152 /**
5153 * The IAM role ARN AWS IoT uses to write to your CloudWatch logs.
5154 */
5155 roleArn?: AwsArn;
5156 /**
5157 * The default log level.
5158 */
5159 defaultLogLevel?: LogLevel;
5160 /**
5161 * Disables all logs.
5162 */
5163 disableAllLogs?: DisableAllLogs;
5164 }
5165 export interface GroupNameAndArn {
5166 /**
5167 * The group name.
5168 */
5169 groupName?: ThingGroupName;
5170 /**
5171 * The group ARN.
5172 */
5173 groupArn?: ThingGroupArn;
5174 }
5175 export type HashAlgorithm = string;
5176 export type HashKeyField = string;
5177 export type HashKeyValue = string;
5178 export type HeaderKey = string;
5179 export type HeaderList = HttpActionHeader[];
5180 export type HeaderValue = string;
5181 export interface HttpAction {
5182 /**
5183 * The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.
5184 */
5185 url: Url;
5186 /**
5187 * The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
5188 */
5189 confirmationUrl?: Url;
5190 /**
5191 * The HTTP headers to send with the message data.
5192 */
5193 headers?: HeaderList;
5194 /**
5195 * The authentication method to use when sending data to an HTTPS endpoint.
5196 */
5197 auth?: HttpAuthorization;
5198 }
5199 export interface HttpActionHeader {
5200 /**
5201 * The HTTP header key.
5202 */
5203 key: HeaderKey;
5204 /**
5205 * The HTTP header value. Substitution templates are supported.
5206 */
5207 value: HeaderValue;
5208 }
5209 export interface HttpAuthorization {
5210 /**
5211 * Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process.
5212 */
5213 sigv4?: SigV4Authorization;
5214 }
5215 export interface HttpContext {
5216 /**
5217 * The header keys and values in an HTTP authorization request.
5218 */
5219 headers?: HttpHeaders;
5220 /**
5221 * The query string keys and values in an HTTP authorization request.
5222 */
5223 queryString?: HttpQueryString;
5224 }
5225 export type HttpHeaderName = string;
5226 export type HttpHeaderValue = string;
5227 export type HttpHeaders = {[key: string]: HttpHeaderValue};
5228 export type HttpQueryString = string;
5229 export interface HttpUrlDestinationConfiguration {
5230 /**
5231 * The URL AWS IoT uses to confirm ownership of or access to the topic rule destination URL.
5232 */
5233 confirmationUrl: Url;
5234 }
5235 export interface HttpUrlDestinationProperties {
5236 /**
5237 * The URL used to confirm the HTTP topic rule destination URL.
5238 */
5239 confirmationUrl?: Url;
5240 }
5241 export interface HttpUrlDestinationSummary {
5242 /**
5243 * The URL used to confirm ownership of or access to the HTTP topic rule destination URL.
5244 */
5245 confirmationUrl?: Url;
5246 }
5247 export interface ImplicitDeny {
5248 /**
5249 * Policies that don't contain a matching allow or deny statement for the specified action on the specified resource.
5250 */
5251 policies?: Policies;
5252 }
5253 export type InProgressChecksCount = number;
5254 export type InProgressThings = number;
5255 export type InProgressTimeoutInMinutes = number;
5256 export type IncrementFactor = number;
5257 export type IndexName = string;
5258 export type IndexNamesList = IndexName[];
5259 export type IndexSchema = string;
5260 export type IndexStatus = "ACTIVE"|"BUILDING"|"REBUILDING"|string;
5261 export type InlineDocument = string;
5262 export type InputName = string;
5263 export interface IotAnalyticsAction {
5264 /**
5265 * (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
5266 */
5267 channelArn?: AwsArn;
5268 /**
5269 * The name of the IoT Analytics channel to which message data will be sent.
5270 */
5271 channelName?: ChannelName;
5272 /**
5273 * The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
5274 */
5275 roleArn?: AwsArn;
5276 }
5277 export interface IotEventsAction {
5278 /**
5279 * The name of the AWS IoT Events input.
5280 */
5281 inputName: InputName;
5282 /**
5283 * [Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.
5284 */
5285 messageId?: MessageId;
5286 /**
5287 * The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
5288 */
5289 roleArn: AwsArn;
5290 }
5291 export interface IotSiteWiseAction {
5292 /**
5293 * A list of asset property value entries.
5294 */
5295 putAssetPropertyValueEntries: PutAssetPropertyValueEntryList;
5296 /**
5297 * The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoTSiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue"). The trust policy can restrict access to specific asset hierarchy paths.
5298 */
5299 roleArn: AwsArn;
5300 }
5301 export type IsAuthenticated = boolean;
5302 export type IsDefaultVersion = boolean;
5303 export type IsDisabled = boolean;
5304 export interface Job {
5305 /**
5306 * An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
5307 */
5308 jobArn?: JobArn;
5309 /**
5310 * The unique identifier you assigned to this job when it was created.
5311 */
5312 jobId?: JobId;
5313 /**
5314 * Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
5315 */
5316 targetSelection?: TargetSelection;
5317 /**
5318 * The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
5319 */
5320 status?: JobStatus;
5321 /**
5322 * Will be true if the job was canceled with the optional force parameter set to true.
5323 */
5324 forceCanceled?: Forced;
5325 /**
5326 * If the job was updated, provides the reason code for the update.
5327 */
5328 reasonCode?: ReasonCode;
5329 /**
5330 * If the job was updated, describes the reason for the update.
5331 */
5332 comment?: Comment;
5333 /**
5334 * A list of IoT things and thing groups to which the job should be sent.
5335 */
5336 targets?: JobTargets;
5337 /**
5338 * A short text description of the job.
5339 */
5340 description?: JobDescription;
5341 /**
5342 * Configuration for pre-signed S3 URLs.
5343 */
5344 presignedUrlConfig?: PresignedUrlConfig;
5345 /**
5346 * Allows you to create a staged rollout of a job.
5347 */
5348 jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
5349 /**
5350 * Configuration for criteria to abort the job.
5351 */
5352 abortConfig?: AbortConfig;
5353 /**
5354 * The time, in seconds since the epoch, when the job was created.
5355 */
5356 createdAt?: DateType;
5357 /**
5358 * The time, in seconds since the epoch, when the job was last updated.
5359 */
5360 lastUpdatedAt?: DateType;
5361 /**
5362 * The time, in seconds since the epoch, when the job was completed.
5363 */
5364 completedAt?: DateType;
5365 /**
5366 * Details about the job process.
5367 */
5368 jobProcessDetails?: JobProcessDetails;
5369 /**
5370 * Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
5371 */
5372 timeoutConfig?: TimeoutConfig;
5373 }
5374 export type JobArn = string;
5375 export type JobDescription = string;
5376 export type JobDocument = string;
5377 export type JobDocumentSource = string;
5378 export interface JobExecution {
5379 /**
5380 * The unique identifier you assigned to the job when it was created.
5381 */
5382 jobId?: JobId;
5383 /**
5384 * The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
5385 */
5386 status?: JobExecutionStatus;
5387 /**
5388 * Will be true if the job execution was canceled with the optional force parameter set to true.
5389 */
5390 forceCanceled?: Forced;
5391 /**
5392 * A collection of name/value pairs that describe the status of the job execution.
5393 */
5394 statusDetails?: JobExecutionStatusDetails;
5395 /**
5396 * The ARN of the thing on which the job execution is running.
5397 */
5398 thingArn?: ThingArn;
5399 /**
5400 * The time, in seconds since the epoch, when the job execution was queued.
5401 */
5402 queuedAt?: DateType;
5403 /**
5404 * The time, in seconds since the epoch, when the job execution started.
5405 */
5406 startedAt?: DateType;
5407 /**
5408 * The time, in seconds since the epoch, when the job execution was last updated.
5409 */
5410 lastUpdatedAt?: DateType;
5411 /**
5412 * A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
5413 */
5414 executionNumber?: ExecutionNumber;
5415 /**
5416 * The version of the job execution. Job execution versions are incremented each time they are updated by a device.
5417 */
5418 versionNumber?: VersionNumber;
5419 /**
5420 * The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.
5421 */
5422 approximateSecondsBeforeTimedOut?: ApproximateSecondsBeforeTimedOut;
5423 }
5424 export type JobExecutionFailureType = "FAILED"|"REJECTED"|"TIMED_OUT"|"ALL"|string;
5425 export type JobExecutionStatus = "QUEUED"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"TIMED_OUT"|"REJECTED"|"REMOVED"|"CANCELED"|string;
5426 export interface JobExecutionStatusDetails {
5427 /**
5428 * The job execution status.
5429 */
5430 detailsMap?: DetailsMap;
5431 }
5432 export interface JobExecutionSummary {
5433 /**
5434 * The status of the job execution.
5435 */
5436 status?: JobExecutionStatus;
5437 /**
5438 * The time, in seconds since the epoch, when the job execution was queued.
5439 */
5440 queuedAt?: DateType;
5441 /**
5442 * The time, in seconds since the epoch, when the job execution started.
5443 */
5444 startedAt?: DateType;
5445 /**
5446 * The time, in seconds since the epoch, when the job execution was last updated.
5447 */
5448 lastUpdatedAt?: DateType;
5449 /**
5450 * A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used later in commands which return or update job execution information.
5451 */
5452 executionNumber?: ExecutionNumber;
5453 }
5454 export interface JobExecutionSummaryForJob {
5455 /**
5456 * The ARN of the thing on which the job execution is running.
5457 */
5458 thingArn?: ThingArn;
5459 /**
5460 * Contains a subset of information about a job execution.
5461 */
5462 jobExecutionSummary?: JobExecutionSummary;
5463 }
5464 export type JobExecutionSummaryForJobList = JobExecutionSummaryForJob[];
5465 export interface JobExecutionSummaryForThing {
5466 /**
5467 * The unique identifier you assigned to this job when it was created.
5468 */
5469 jobId?: JobId;
5470 /**
5471 * Contains a subset of information about a job execution.
5472 */
5473 jobExecutionSummary?: JobExecutionSummary;
5474 }
5475 export type JobExecutionSummaryForThingList = JobExecutionSummaryForThing[];
5476 export interface JobExecutionsRolloutConfig {
5477 /**
5478 * The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
5479 */
5480 maximumPerMinute?: MaxJobExecutionsPerMin;
5481 /**
5482 * The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
5483 */
5484 exponentialRate?: ExponentialRolloutRate;
5485 }
5486 export type JobId = string;
5487 export interface JobProcessDetails {
5488 /**
5489 * 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.
5490 */
5491 processingTargets?: ProcessingTargetNameList;
5492 /**
5493 * The number of things that cancelled the job.
5494 */
5495 numberOfCanceledThings?: CanceledThings;
5496 /**
5497 * The number of things which successfully completed the job.
5498 */
5499 numberOfSucceededThings?: SucceededThings;
5500 /**
5501 * The number of things that failed executing the job.
5502 */
5503 numberOfFailedThings?: FailedThings;
5504 /**
5505 * The number of things that rejected the job.
5506 */
5507 numberOfRejectedThings?: RejectedThings;
5508 /**
5509 * The number of things that are awaiting execution of the job.
5510 */
5511 numberOfQueuedThings?: QueuedThings;
5512 /**
5513 * The number of things currently executing the job.
5514 */
5515 numberOfInProgressThings?: InProgressThings;
5516 /**
5517 * The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.
5518 */
5519 numberOfRemovedThings?: RemovedThings;
5520 /**
5521 * The number of things whose job execution status is TIMED_OUT.
5522 */
5523 numberOfTimedOutThings?: TimedOutThings;
5524 }
5525 export type JobStatus = "IN_PROGRESS"|"CANCELED"|"COMPLETED"|"DELETION_IN_PROGRESS"|string;
5526 export interface JobSummary {
5527 /**
5528 * The job ARN.
5529 */
5530 jobArn?: JobArn;
5531 /**
5532 * The unique identifier you assigned to this job when it was created.
5533 */
5534 jobId?: JobId;
5535 /**
5536 * The ID of the thing group.
5537 */
5538 thingGroupId?: ThingGroupId;
5539 /**
5540 * Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
5541 */
5542 targetSelection?: TargetSelection;
5543 /**
5544 * The job summary status.
5545 */
5546 status?: JobStatus;
5547 /**
5548 * The time, in seconds since the epoch, when the job was created.
5549 */
5550 createdAt?: DateType;
5551 /**
5552 * The time, in seconds since the epoch, when the job was last updated.
5553 */
5554 lastUpdatedAt?: DateType;
5555 /**
5556 * The time, in seconds since the epoch, when the job completed.
5557 */
5558 completedAt?: DateType;
5559 }
5560 export type JobSummaryList = JobSummary[];
5561 export type JobTargets = TargetArn[];
5562 export type JsonDocument = string;
5563 export type Key = string;
5564 export type KeyName = string;
5565 export interface KeyPair {
5566 /**
5567 * The public key.
5568 */
5569 PublicKey?: PublicKey;
5570 /**
5571 * The private key.
5572 */
5573 PrivateKey?: PrivateKey;
5574 }
5575 export type KeyValue = string;
5576 export interface KinesisAction {
5577 /**
5578 * The ARN of the IAM role that grants access to the Amazon Kinesis stream.
5579 */
5580 roleArn: AwsArn;
5581 /**
5582 * The name of the Amazon Kinesis stream.
5583 */
5584 streamName: StreamName;
5585 /**
5586 * The partition key.
5587 */
5588 partitionKey?: PartitionKey;
5589 }
5590 export interface LambdaAction {
5591 /**
5592 * The ARN of the Lambda function.
5593 */
5594 functionArn: FunctionArn;
5595 }
5596 export type LaserMaxResults = number;
5597 export type LastModifiedDate = Date;
5598 export interface ListActiveViolationsRequest {
5599 /**
5600 * The name of the thing whose active violations are listed.
5601 */
5602 thingName?: DeviceDefenderThingName;
5603 /**
5604 * The name of the Device Defender security profile for which violations are listed.
5605 */
5606 securityProfileName?: SecurityProfileName;
5607 /**
5608 * The token for the next set of results.
5609 */
5610 nextToken?: NextToken;
5611 /**
5612 * The maximum number of results to return at one time.
5613 */
5614 maxResults?: MaxResults;
5615 }
5616 export interface ListActiveViolationsResponse {
5617 /**
5618 * The list of active violations.
5619 */
5620 activeViolations?: ActiveViolations;
5621 /**
5622 * A token that can be used to retrieve the next set of results, or null if there are no additional results.
5623 */
5624 nextToken?: NextToken;
5625 }
5626 export interface ListAttachedPoliciesRequest {
5627 /**
5628 * The group or principal for which the policies will be listed.
5629 */
5630 target: PolicyTarget;
5631 /**
5632 * When true, recursively list attached policies.
5633 */
5634 recursive?: Recursive;
5635 /**
5636 * The token to retrieve the next set of results.
5637 */
5638 marker?: Marker;
5639 /**
5640 * The maximum number of results to be returned per request.
5641 */
5642 pageSize?: PageSize;
5643 }
5644 export interface ListAttachedPoliciesResponse {
5645 /**
5646 * The policies.
5647 */
5648 policies?: Policies;
5649 /**
5650 * The token to retrieve the next set of results, or ``null`` if there are no more results.
5651 */
5652 nextMarker?: Marker;
5653 }
5654 export interface ListAuditFindingsRequest {
5655 /**
5656 * A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.
5657 */
5658 taskId?: AuditTaskId;
5659 /**
5660 * A filter to limit results to the findings for the specified audit check.
5661 */
5662 checkName?: AuditCheckName;
5663 /**
5664 * Information identifying the noncompliant resource.
5665 */
5666 resourceIdentifier?: ResourceIdentifier;
5667 /**
5668 * The maximum number of results to return at one time. The default is 25.
5669 */
5670 maxResults?: MaxResults;
5671 /**
5672 * The token for the next set of results.
5673 */
5674 nextToken?: NextToken;
5675 /**
5676 * A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
5677 */
5678 startTime?: Timestamp;
5679 /**
5680 * A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.
5681 */
5682 endTime?: Timestamp;
5683 }
5684 export interface ListAuditFindingsResponse {
5685 /**
5686 * The findings (results) of the audit.
5687 */
5688 findings?: AuditFindings;
5689 /**
5690 * A token that can be used to retrieve the next set of results, or null if there are no additional results.
5691 */
5692 nextToken?: NextToken;
5693 }
5694 export interface ListAuditMitigationActionsExecutionsRequest {
5695 /**
5696 * Specify this filter to limit results to actions for a specific audit mitigation actions task.
5697 */
5698 taskId: AuditMitigationActionsTaskId;
5699 /**
5700 * Specify this filter to limit results to those with a specific status.
5701 */
5702 actionStatus?: AuditMitigationActionsExecutionStatus;
5703 /**
5704 * Specify this filter to limit results to those that were applied to a specific audit finding.
5705 */
5706 findingId: FindingId;
5707 /**
5708 * The maximum number of results to return at one time. The default is 25.
5709 */
5710 maxResults?: MaxResults;
5711 /**
5712 * The token for the next set of results.
5713 */
5714 nextToken?: NextToken;
5715 }
5716 export interface ListAuditMitigationActionsExecutionsResponse {
5717 /**
5718 * A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.
5719 */
5720 actionsExecutions?: AuditMitigationActionExecutionMetadataList;
5721 /**
5722 * The token for the next set of results.
5723 */
5724 nextToken?: NextToken;
5725 }
5726 export interface ListAuditMitigationActionsTasksRequest {
5727 /**
5728 * Specify this filter to limit results to tasks that were applied to results for a specific audit.
5729 */
5730 auditTaskId?: AuditTaskId;
5731 /**
5732 * Specify this filter to limit results to tasks that were applied to a specific audit finding.
5733 */
5734 findingId?: FindingId;
5735 /**
5736 * Specify this filter to limit results to tasks that are in a specific state.
5737 */
5738 taskStatus?: AuditMitigationActionsTaskStatus;
5739 /**
5740 * The maximum number of results to return at one time. The default is 25.
5741 */
5742 maxResults?: MaxResults;
5743 /**
5744 * The token for the next set of results.
5745 */
5746 nextToken?: NextToken;
5747 /**
5748 * Specify this filter to limit results to tasks that began on or after a specific date and time.
5749 */
5750 startTime: Timestamp;
5751 /**
5752 * Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.
5753 */
5754 endTime: Timestamp;
5755 }
5756 export interface ListAuditMitigationActionsTasksResponse {
5757 /**
5758 * The collection of audit mitigation tasks that matched the filter criteria.
5759 */
5760 tasks?: AuditMitigationActionsTaskMetadataList;
5761 /**
5762 * The token for the next set of results.
5763 */
5764 nextToken?: NextToken;
5765 }
5766 export interface ListAuditTasksRequest {
5767 /**
5768 * The beginning of the time period. Audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".
5769 */
5770 startTime: Timestamp;
5771 /**
5772 * The end of the time period.
5773 */
5774 endTime: Timestamp;
5775 /**
5776 * A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
5777 */
5778 taskType?: AuditTaskType;
5779 /**
5780 * A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
5781 */
5782 taskStatus?: AuditTaskStatus;
5783 /**
5784 * The token for the next set of results.
5785 */
5786 nextToken?: NextToken;
5787 /**
5788 * The maximum number of results to return at one time. The default is 25.
5789 */
5790 maxResults?: MaxResults;
5791 }
5792 export interface ListAuditTasksResponse {
5793 /**
5794 * The audits that were performed during the specified time period.
5795 */
5796 tasks?: AuditTaskMetadataList;
5797 /**
5798 * A token that can be used to retrieve the next set of results, or null if there are no additional results.
5799 */
5800 nextToken?: NextToken;
5801 }
5802 export interface ListAuthorizersRequest {
5803 /**
5804 * The maximum number of results to return at one time.
5805 */
5806 pageSize?: PageSize;
5807 /**
5808 * A marker used to get the next set of results.
5809 */
5810 marker?: Marker;
5811 /**
5812 * Return the list of authorizers in ascending alphabetical order.
5813 */
5814 ascendingOrder?: AscendingOrder;
5815 /**
5816 * The status of the list authorizers request.
5817 */
5818 status?: AuthorizerStatus;
5819 }
5820 export interface ListAuthorizersResponse {
5821 /**
5822 * The authorizers.
5823 */
5824 authorizers?: Authorizers;
5825 /**
5826 * A marker used to get the next set of results.
5827 */
5828 nextMarker?: Marker;
5829 }
5830 export interface ListBillingGroupsRequest {
5831 /**
5832 * The token to retrieve the next set of results.
5833 */
5834 nextToken?: NextToken;
5835 /**
5836 * The maximum number of results to return per request.
5837 */
5838 maxResults?: RegistryMaxResults;
5839 /**
5840 * Limit the results to billing groups whose names have the given prefix.
5841 */
5842 namePrefixFilter?: BillingGroupName;
5843 }
5844 export interface ListBillingGroupsResponse {
5845 /**
5846 * The list of billing groups.
5847 */
5848 billingGroups?: BillingGroupNameAndArnList;
5849 /**
5850 * The token used to get the next set of results, or null if there are no additional results.
5851 */
5852 nextToken?: NextToken;
5853 }
5854 export interface ListCACertificatesRequest {
5855 /**
5856 * The result page size.
5857 */
5858 pageSize?: PageSize;
5859 /**
5860 * The marker for the next set of results.
5861 */
5862 marker?: Marker;
5863 /**
5864 * Determines the order of the results.
5865 */
5866 ascendingOrder?: AscendingOrder;
5867 }
5868 export interface ListCACertificatesResponse {
5869 /**
5870 * The CA certificates registered in your AWS account.
5871 */
5872 certificates?: CACertificates;
5873 /**
5874 * The current position within the list of CA certificates.
5875 */
5876 nextMarker?: Marker;
5877 }
5878 export interface ListCertificatesByCARequest {
5879 /**
5880 * The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.
5881 */
5882 caCertificateId: CertificateId;
5883 /**
5884 * The result page size.
5885 */
5886 pageSize?: PageSize;
5887 /**
5888 * The marker for the next set of results.
5889 */
5890 marker?: Marker;
5891 /**
5892 * Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
5893 */
5894 ascendingOrder?: AscendingOrder;
5895 }
5896 export interface ListCertificatesByCAResponse {
5897 /**
5898 * The device certificates signed by the specified CA certificate.
5899 */
5900 certificates?: Certificates;
5901 /**
5902 * The marker for the next set of results, or null if there are no additional results.
5903 */
5904 nextMarker?: Marker;
5905 }
5906 export interface ListCertificatesRequest {
5907 /**
5908 * The result page size.
5909 */
5910 pageSize?: PageSize;
5911 /**
5912 * The marker for the next set of results.
5913 */
5914 marker?: Marker;
5915 /**
5916 * Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
5917 */
5918 ascendingOrder?: AscendingOrder;
5919 }
5920 export interface ListCertificatesResponse {
5921 /**
5922 * The descriptions of the certificates.
5923 */
5924 certificates?: Certificates;
5925 /**
5926 * The marker for the next set of results, or null if there are no additional results.
5927 */
5928 nextMarker?: Marker;
5929 }
5930 export interface ListDimensionsRequest {
5931 /**
5932 * The token for the next set of results.
5933 */
5934 nextToken?: NextToken;
5935 /**
5936 * The maximum number of results to retrieve at one time.
5937 */
5938 maxResults?: MaxResults;
5939 }
5940 export interface ListDimensionsResponse {
5941 /**
5942 * A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.
5943 */
5944 dimensionNames?: DimensionNames;
5945 /**
5946 * A token that can be used to retrieve the next set of results, or null if there are no additional results.
5947 */
5948 nextToken?: NextToken;
5949 }
5950 export interface ListDomainConfigurationsRequest {
5951 /**
5952 * The marker for the next set of results.
5953 */
5954 marker?: Marker;
5955 /**
5956 * The result page size.
5957 */
5958 pageSize?: PageSize;
5959 /**
5960 * The type of service delivered by the endpoint.
5961 */
5962 serviceType?: ServiceType;
5963 }
5964 export interface ListDomainConfigurationsResponse {
5965 /**
5966 * A list of objects that contain summary information about the user's domain configurations.
5967 */
5968 domainConfigurations?: DomainConfigurations;
5969 /**
5970 * The marker for the next set of results.
5971 */
5972 nextMarker?: Marker;
5973 }
5974 export interface ListIndicesRequest {
5975 /**
5976 * The token used to get the next set of results, or null if there are no additional results.
5977 */
5978 nextToken?: NextToken;
5979 /**
5980 * The maximum number of results to return at one time.
5981 */
5982 maxResults?: QueryMaxResults;
5983 }
5984 export interface ListIndicesResponse {
5985 /**
5986 * The index names.
5987 */
5988 indexNames?: IndexNamesList;
5989 /**
5990 * The token used to get the next set of results, or null if there are no additional results.
5991 */
5992 nextToken?: NextToken;
5993 }
5994 export interface ListJobExecutionsForJobRequest {
5995 /**
5996 * The unique identifier you assigned to this job when it was created.
5997 */
5998 jobId: JobId;
5999 /**
6000 * The status of the job.
6001 */
6002 status?: JobExecutionStatus;
6003 /**
6004 * The maximum number of results to be returned per request.
6005 */
6006 maxResults?: LaserMaxResults;
6007 /**
6008 * The token to retrieve the next set of results.
6009 */
6010 nextToken?: NextToken;
6011 }
6012 export interface ListJobExecutionsForJobResponse {
6013 /**
6014 * A list of job execution summaries.
6015 */
6016 executionSummaries?: JobExecutionSummaryForJobList;
6017 /**
6018 * The token for the next set of results, or null if there are no additional results.
6019 */
6020 nextToken?: NextToken;
6021 }
6022 export interface ListJobExecutionsForThingRequest {
6023 /**
6024 * The thing name.
6025 */
6026 thingName: ThingName;
6027 /**
6028 * An optional filter that lets you search for jobs that have the specified status.
6029 */
6030 status?: JobExecutionStatus;
6031 /**
6032 * The maximum number of results to be returned per request.
6033 */
6034 maxResults?: LaserMaxResults;
6035 /**
6036 * The token to retrieve the next set of results.
6037 */
6038 nextToken?: NextToken;
6039 }
6040 export interface ListJobExecutionsForThingResponse {
6041 /**
6042 * A list of job execution summaries.
6043 */
6044 executionSummaries?: JobExecutionSummaryForThingList;
6045 /**
6046 * The token for the next set of results, or null if there are no additional results.
6047 */
6048 nextToken?: NextToken;
6049 }
6050 export interface ListJobsRequest {
6051 /**
6052 * An optional filter that lets you search for jobs that have the specified status.
6053 */
6054 status?: JobStatus;
6055 /**
6056 * Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
6057 */
6058 targetSelection?: TargetSelection;
6059 /**
6060 * The maximum number of results to return per request.
6061 */
6062 maxResults?: LaserMaxResults;
6063 /**
6064 * The token to retrieve the next set of results.
6065 */
6066 nextToken?: NextToken;
6067 /**
6068 * A filter that limits the returned jobs to those for the specified group.
6069 */
6070 thingGroupName?: ThingGroupName;
6071 /**
6072 * A filter that limits the returned jobs to those for the specified group.
6073 */
6074 thingGroupId?: ThingGroupId;
6075 }
6076 export interface ListJobsResponse {
6077 /**
6078 * A list of jobs.
6079 */
6080 jobs?: JobSummaryList;
6081 /**
6082 * The token for the next set of results, or null if there are no additional results.
6083 */
6084 nextToken?: NextToken;
6085 }
6086 export interface ListMitigationActionsRequest {
6087 /**
6088 * Specify a value to limit the result to mitigation actions with a specific action type.
6089 */
6090 actionType?: MitigationActionType;
6091 /**
6092 * The maximum number of results to return at one time. The default is 25.
6093 */
6094 maxResults?: MaxResults;
6095 /**
6096 * The token for the next set of results.
6097 */
6098 nextToken?: NextToken;
6099 }
6100 export interface ListMitigationActionsResponse {
6101 /**
6102 * A set of actions that matched the specified filter criteria.
6103 */
6104 actionIdentifiers?: MitigationActionIdentifierList;
6105 /**
6106 * The token for the next set of results.
6107 */
6108 nextToken?: NextToken;
6109 }
6110 export interface ListOTAUpdatesRequest {
6111 /**
6112 * The maximum number of results to return at one time.
6113 */
6114 maxResults?: MaxResults;
6115 /**
6116 * A token used to retrieve the next set of results.
6117 */
6118 nextToken?: NextToken;
6119 /**
6120 * The OTA update job status.
6121 */
6122 otaUpdateStatus?: OTAUpdateStatus;
6123 }
6124 export interface ListOTAUpdatesResponse {
6125 /**
6126 * A list of OTA update jobs.
6127 */
6128 otaUpdates?: OTAUpdatesSummary;
6129 /**
6130 * A token to use to get the next set of results.
6131 */
6132 nextToken?: NextToken;
6133 }
6134 export interface ListOutgoingCertificatesRequest {
6135 /**
6136 * The result page size.
6137 */
6138 pageSize?: PageSize;
6139 /**
6140 * The marker for the next set of results.
6141 */
6142 marker?: Marker;
6143 /**
6144 * Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
6145 */
6146 ascendingOrder?: AscendingOrder;
6147 }
6148 export interface ListOutgoingCertificatesResponse {
6149 /**
6150 * The certificates that are being transferred but not yet accepted.
6151 */
6152 outgoingCertificates?: OutgoingCertificates;
6153 /**
6154 * The marker for the next set of results.
6155 */
6156 nextMarker?: Marker;
6157 }
6158 export interface ListPoliciesRequest {
6159 /**
6160 * The marker for the next set of results.
6161 */
6162 marker?: Marker;
6163 /**
6164 * The result page size.
6165 */
6166 pageSize?: PageSize;
6167 /**
6168 * Specifies the order for results. If true, the results are returned in ascending creation order.
6169 */
6170 ascendingOrder?: AscendingOrder;
6171 }
6172 export interface ListPoliciesResponse {
6173 /**
6174 * The descriptions of the policies.
6175 */
6176 policies?: Policies;
6177 /**
6178 * The marker for the next set of results, or null if there are no additional results.
6179 */
6180 nextMarker?: Marker;
6181 }
6182 export interface ListPolicyPrincipalsRequest {
6183 /**
6184 * The policy name.
6185 */
6186 policyName: PolicyName;
6187 /**
6188 * The marker for the next set of results.
6189 */
6190 marker?: Marker;
6191 /**
6192 * The result page size.
6193 */
6194 pageSize?: PageSize;
6195 /**
6196 * Specifies the order for results. If true, the results are returned in ascending creation order.
6197 */
6198 ascendingOrder?: AscendingOrder;
6199 }
6200 export interface ListPolicyPrincipalsResponse {
6201 /**
6202 * The descriptions of the principals.
6203 */
6204 principals?: Principals;
6205 /**
6206 * The marker for the next set of results, or null if there are no additional results.
6207 */
6208 nextMarker?: Marker;
6209 }
6210 export interface ListPolicyVersionsRequest {
6211 /**
6212 * The policy name.
6213 */
6214 policyName: PolicyName;
6215 }
6216 export interface ListPolicyVersionsResponse {
6217 /**
6218 * The policy versions.
6219 */
6220 policyVersions?: PolicyVersions;
6221 }
6222 export interface ListPrincipalPoliciesRequest {
6223 /**
6224 * The principal.
6225 */
6226 principal: Principal;
6227 /**
6228 * The marker for the next set of results.
6229 */
6230 marker?: Marker;
6231 /**
6232 * The result page size.
6233 */
6234 pageSize?: PageSize;
6235 /**
6236 * Specifies the order for results. If true, results are returned in ascending creation order.
6237 */
6238 ascendingOrder?: AscendingOrder;
6239 }
6240 export interface ListPrincipalPoliciesResponse {
6241 /**
6242 * The policies.
6243 */
6244 policies?: Policies;
6245 /**
6246 * The marker for the next set of results, or null if there are no additional results.
6247 */
6248 nextMarker?: Marker;
6249 }
6250 export interface ListPrincipalThingsRequest {
6251 /**
6252 * The token to retrieve the next set of results.
6253 */
6254 nextToken?: NextToken;
6255 /**
6256 * The maximum number of results to return in this operation.
6257 */
6258 maxResults?: RegistryMaxResults;
6259 /**
6260 * The principal.
6261 */
6262 principal: Principal;
6263 }
6264 export interface ListPrincipalThingsResponse {
6265 /**
6266 * The things.
6267 */
6268 things?: ThingNameList;
6269 /**
6270 * The token used to get the next set of results, or null if there are no additional results.
6271 */
6272 nextToken?: NextToken;
6273 }
6274 export interface ListProvisioningTemplateVersionsRequest {
6275 /**
6276 * The name of the fleet provisioning template.
6277 */
6278 templateName: TemplateName;
6279 /**
6280 * The maximum number of results to return at one time.
6281 */
6282 maxResults?: MaxResults;
6283 /**
6284 * A token to retrieve the next set of results.
6285 */
6286 nextToken?: NextToken;
6287 }
6288 export interface ListProvisioningTemplateVersionsResponse {
6289 /**
6290 * The list of fleet provisioning template versions.
6291 */
6292 versions?: ProvisioningTemplateVersionListing;
6293 /**
6294 * A token to retrieve the next set of results.
6295 */
6296 nextToken?: NextToken;
6297 }
6298 export interface ListProvisioningTemplatesRequest {
6299 /**
6300 * The maximum number of results to return at one time.
6301 */
6302 maxResults?: MaxResults;
6303 /**
6304 * A token to retrieve the next set of results.
6305 */
6306 nextToken?: NextToken;
6307 }
6308 export interface ListProvisioningTemplatesResponse {
6309 /**
6310 * A list of fleet provisioning templates
6311 */
6312 templates?: ProvisioningTemplateListing;
6313 /**
6314 * A token to retrieve the next set of results.
6315 */
6316 nextToken?: NextToken;
6317 }
6318 export interface ListRoleAliasesRequest {
6319 /**
6320 * The maximum number of results to return at one time.
6321 */
6322 pageSize?: PageSize;
6323 /**
6324 * A marker used to get the next set of results.
6325 */
6326 marker?: Marker;
6327 /**
6328 * Return the list of role aliases in ascending alphabetical order.
6329 */
6330 ascendingOrder?: AscendingOrder;
6331 }
6332 export interface ListRoleAliasesResponse {
6333 /**
6334 * The role aliases.
6335 */
6336 roleAliases?: RoleAliases;
6337 /**
6338 * A marker used to get the next set of results.
6339 */
6340 nextMarker?: Marker;
6341 }
6342 export interface ListScheduledAuditsRequest {
6343 /**
6344 * The token for the next set of results.
6345 */
6346 nextToken?: NextToken;
6347 /**
6348 * The maximum number of results to return at one time. The default is 25.
6349 */
6350 maxResults?: MaxResults;
6351 }
6352 export interface ListScheduledAuditsResponse {
6353 /**
6354 * The list of scheduled audits.
6355 */
6356 scheduledAudits?: ScheduledAuditMetadataList;
6357 /**
6358 * A token that can be used to retrieve the next set of results, or null if there are no additional results.
6359 */
6360 nextToken?: NextToken;
6361 }
6362 export interface ListSecurityProfilesForTargetRequest {
6363 /**
6364 * The token for the next set of results.
6365 */
6366 nextToken?: NextToken;
6367 /**
6368 * The maximum number of results to return at one time.
6369 */
6370 maxResults?: MaxResults;
6371 /**
6372 * If true, return child groups too.
6373 */
6374 recursive?: Recursive;
6375 /**
6376 * The ARN of the target (thing group) whose attached security profiles you want to get.
6377 */
6378 securityProfileTargetArn: SecurityProfileTargetArn;
6379 }
6380 export interface ListSecurityProfilesForTargetResponse {
6381 /**
6382 * A list of security profiles and their associated targets.
6383 */
6384 securityProfileTargetMappings?: SecurityProfileTargetMappings;
6385 /**
6386 * A token that can be used to retrieve the next set of results, or null if there are no additional results.
6387 */
6388 nextToken?: NextToken;
6389 }
6390 export interface ListSecurityProfilesRequest {
6391 /**
6392 * The token for the next set of results.
6393 */
6394 nextToken?: NextToken;
6395 /**
6396 * The maximum number of results to return at one time.
6397 */
6398 maxResults?: MaxResults;
6399 /**
6400 * A filter to limit results to the security profiles that use the defined dimension.
6401 */
6402 dimensionName?: DimensionName;
6403 }
6404 export interface ListSecurityProfilesResponse {
6405 /**
6406 * A list of security profile identifiers (names and ARNs).
6407 */
6408 securityProfileIdentifiers?: SecurityProfileIdentifiers;
6409 /**
6410 * A token that can be used to retrieve the next set of results, or null if there are no additional results.
6411 */
6412 nextToken?: NextToken;
6413 }
6414 export interface ListStreamsRequest {
6415 /**
6416 * The maximum number of results to return at a time.
6417 */
6418 maxResults?: MaxResults;
6419 /**
6420 * A token used to get the next set of results.
6421 */
6422 nextToken?: NextToken;
6423 /**
6424 * Set to true to return the list of streams in ascending order.
6425 */
6426 ascendingOrder?: AscendingOrder;
6427 }
6428 export interface ListStreamsResponse {
6429 /**
6430 * A list of streams.
6431 */
6432 streams?: StreamsSummary;
6433 /**
6434 * A token used to get the next set of results.
6435 */
6436 nextToken?: NextToken;
6437 }
6438 export interface ListTagsForResourceRequest {
6439 /**
6440 * The ARN of the resource.
6441 */
6442 resourceArn: ResourceArn;
6443 /**
6444 * The token to retrieve the next set of results.
6445 */
6446 nextToken?: NextToken;
6447 }
6448 export interface ListTagsForResourceResponse {
6449 /**
6450 * The list of tags assigned to the resource.
6451 */
6452 tags?: TagList;
6453 /**
6454 * The token used to get the next set of results, or null if there are no additional results.
6455 */
6456 nextToken?: NextToken;
6457 }
6458 export interface ListTargetsForPolicyRequest {
6459 /**
6460 * The policy name.
6461 */
6462 policyName: PolicyName;
6463 /**
6464 * A marker used to get the next set of results.
6465 */
6466 marker?: Marker;
6467 /**
6468 * The maximum number of results to return at one time.
6469 */
6470 pageSize?: PageSize;
6471 }
6472 export interface ListTargetsForPolicyResponse {
6473 /**
6474 * The policy targets.
6475 */
6476 targets?: PolicyTargets;
6477 /**
6478 * A marker used to get the next set of results.
6479 */
6480 nextMarker?: Marker;
6481 }
6482 export interface ListTargetsForSecurityProfileRequest {
6483 /**
6484 * The security profile.
6485 */
6486 securityProfileName: SecurityProfileName;
6487 /**
6488 * The token for the next set of results.
6489 */
6490 nextToken?: NextToken;
6491 /**
6492 * The maximum number of results to return at one time.
6493 */
6494 maxResults?: MaxResults;
6495 }
6496 export interface ListTargetsForSecurityProfileResponse {
6497 /**
6498 * The thing groups to which the security profile is attached.
6499 */
6500 securityProfileTargets?: SecurityProfileTargets;
6501 /**
6502 * A token that can be used to retrieve the next set of results, or null if there are no additional results.
6503 */
6504 nextToken?: NextToken;
6505 }
6506 export interface ListThingGroupsForThingRequest {
6507 /**
6508 * The thing name.
6509 */
6510 thingName: ThingName;
6511 /**
6512 * The token to retrieve the next set of results.
6513 */
6514 nextToken?: NextToken;
6515 /**
6516 * The maximum number of results to return at one time.
6517 */
6518 maxResults?: RegistryMaxResults;
6519 }
6520 export interface ListThingGroupsForThingResponse {
6521 /**
6522 * The thing groups.
6523 */
6524 thingGroups?: ThingGroupNameAndArnList;
6525 /**
6526 * The token used to get the next set of results, or null if there are no additional results.
6527 */
6528 nextToken?: NextToken;
6529 }
6530 export interface ListThingGroupsRequest {
6531 /**
6532 * The token to retrieve the next set of results.
6533 */
6534 nextToken?: NextToken;
6535 /**
6536 * The maximum number of results to return at one time.
6537 */
6538 maxResults?: RegistryMaxResults;
6539 /**
6540 * A filter that limits the results to those with the specified parent group.
6541 */
6542 parentGroup?: ThingGroupName;
6543 /**
6544 * A filter that limits the results to those with the specified name prefix.
6545 */
6546 namePrefixFilter?: ThingGroupName;
6547 /**
6548 * If true, return child groups as well.
6549 */
6550 recursive?: RecursiveWithoutDefault;
6551 }
6552 export interface ListThingGroupsResponse {
6553 /**
6554 * The thing groups.
6555 */
6556 thingGroups?: ThingGroupNameAndArnList;
6557 /**
6558 * The token used to get the next set of results, or null if there are no additional results.
6559 */
6560 nextToken?: NextToken;
6561 }
6562 export interface ListThingPrincipalsRequest {
6563 /**
6564 * The name of the thing.
6565 */
6566 thingName: ThingName;
6567 }
6568 export interface ListThingPrincipalsResponse {
6569 /**
6570 * The principals associated with the thing.
6571 */
6572 principals?: Principals;
6573 }
6574 export interface ListThingRegistrationTaskReportsRequest {
6575 /**
6576 * The id of the task.
6577 */
6578 taskId: TaskId;
6579 /**
6580 * The type of task report.
6581 */
6582 reportType: ReportType;
6583 /**
6584 * The token to retrieve the next set of results.
6585 */
6586 nextToken?: NextToken;
6587 /**
6588 * The maximum number of results to return per request.
6589 */
6590 maxResults?: RegistryMaxResults;
6591 }
6592 export interface ListThingRegistrationTaskReportsResponse {
6593 /**
6594 * Links to the task resources.
6595 */
6596 resourceLinks?: S3FileUrlList;
6597 /**
6598 * The type of task report.
6599 */
6600 reportType?: ReportType;
6601 /**
6602 * The token used to get the next set of results, or null if there are no additional results.
6603 */
6604 nextToken?: NextToken;
6605 }
6606 export interface ListThingRegistrationTasksRequest {
6607 /**
6608 * The token to retrieve the next set of results.
6609 */
6610 nextToken?: NextToken;
6611 /**
6612 * The maximum number of results to return at one time.
6613 */
6614 maxResults?: RegistryMaxResults;
6615 /**
6616 * The status of the bulk thing provisioning task.
6617 */
6618 status?: Status;
6619 }
6620 export interface ListThingRegistrationTasksResponse {
6621 /**
6622 * A list of bulk thing provisioning task IDs.
6623 */
6624 taskIds?: TaskIdList;
6625 /**
6626 * The token used to get the next set of results, or null if there are no additional results.
6627 */
6628 nextToken?: NextToken;
6629 }
6630 export interface ListThingTypesRequest {
6631 /**
6632 * The token to retrieve the next set of results.
6633 */
6634 nextToken?: NextToken;
6635 /**
6636 * The maximum number of results to return in this operation.
6637 */
6638 maxResults?: RegistryMaxResults;
6639 /**
6640 * The name of the thing type.
6641 */
6642 thingTypeName?: ThingTypeName;
6643 }
6644 export interface ListThingTypesResponse {
6645 /**
6646 * The thing types.
6647 */
6648 thingTypes?: ThingTypeList;
6649 /**
6650 * The token for the next set of results, or null if there are no additional results.
6651 */
6652 nextToken?: NextToken;
6653 }
6654 export interface ListThingsInBillingGroupRequest {
6655 /**
6656 * The name of the billing group.
6657 */
6658 billingGroupName: BillingGroupName;
6659 /**
6660 * The token to retrieve the next set of results.
6661 */
6662 nextToken?: NextToken;
6663 /**
6664 * The maximum number of results to return per request.
6665 */
6666 maxResults?: RegistryMaxResults;
6667 }
6668 export interface ListThingsInBillingGroupResponse {
6669 /**
6670 * A list of things in the billing group.
6671 */
6672 things?: ThingNameList;
6673 /**
6674 * The token used to get the next set of results, or null if there are no additional results.
6675 */
6676 nextToken?: NextToken;
6677 }
6678 export interface ListThingsInThingGroupRequest {
6679 /**
6680 * The thing group name.
6681 */
6682 thingGroupName: ThingGroupName;
6683 /**
6684 * When true, list things in this thing group and in all child groups as well.
6685 */
6686 recursive?: Recursive;
6687 /**
6688 * The token to retrieve the next set of results.
6689 */
6690 nextToken?: NextToken;
6691 /**
6692 * The maximum number of results to return at one time.
6693 */
6694 maxResults?: RegistryMaxResults;
6695 }
6696 export interface ListThingsInThingGroupResponse {
6697 /**
6698 * The things in the specified thing group.
6699 */
6700 things?: ThingNameList;
6701 /**
6702 * The token used to get the next set of results, or null if there are no additional results.
6703 */
6704 nextToken?: NextToken;
6705 }
6706 export interface ListThingsRequest {
6707 /**
6708 * The token to retrieve the next set of results.
6709 */
6710 nextToken?: NextToken;
6711 /**
6712 * The maximum number of results to return in this operation.
6713 */
6714 maxResults?: RegistryMaxResults;
6715 /**
6716 * The attribute name used to search for things.
6717 */
6718 attributeName?: AttributeName;
6719 /**
6720 * The attribute value used to search for things.
6721 */
6722 attributeValue?: AttributeValue;
6723 /**
6724 * The name of the thing type used to search for things.
6725 */
6726 thingTypeName?: ThingTypeName;
6727 }
6728 export interface ListThingsResponse {
6729 /**
6730 * The things.
6731 */
6732 things?: ThingAttributeList;
6733 /**
6734 * The token used to get the next set of results, or null if there are no additional results.
6735 */
6736 nextToken?: NextToken;
6737 }
6738 export interface ListTopicRuleDestinationsRequest {
6739 /**
6740 * The maximum number of results to return at one time.
6741 */
6742 maxResults?: TopicRuleDestinationMaxResults;
6743 /**
6744 * The token to retrieve the next set of results.
6745 */
6746 nextToken?: NextToken;
6747 }
6748 export interface ListTopicRuleDestinationsResponse {
6749 /**
6750 * Information about a topic rule destination.
6751 */
6752 destinationSummaries?: TopicRuleDestinationSummaries;
6753 /**
6754 * The token to retrieve the next set of results.
6755 */
6756 nextToken?: NextToken;
6757 }
6758 export interface ListTopicRulesRequest {
6759 /**
6760 * The topic.
6761 */
6762 topic?: Topic;
6763 /**
6764 * The maximum number of results to return.
6765 */
6766 maxResults?: TopicRuleMaxResults;
6767 /**
6768 * A token used to retrieve the next value.
6769 */
6770 nextToken?: NextToken;
6771 /**
6772 * Specifies whether the rule is disabled.
6773 */
6774 ruleDisabled?: IsDisabled;
6775 }
6776 export interface ListTopicRulesResponse {
6777 /**
6778 * The rules.
6779 */
6780 rules?: TopicRuleList;
6781 /**
6782 * A token used to retrieve the next value.
6783 */
6784 nextToken?: NextToken;
6785 }
6786 export interface ListV2LoggingLevelsRequest {
6787 /**
6788 * The type of resource for which you are configuring logging. Must be THING_Group.
6789 */
6790 targetType?: LogTargetType;
6791 /**
6792 * The token used to get the next set of results, or null if there are no additional results.
6793 */
6794 nextToken?: NextToken;
6795 /**
6796 * The maximum number of results to return at one time.
6797 */
6798 maxResults?: SkyfallMaxResults;
6799 }
6800 export interface ListV2LoggingLevelsResponse {
6801 /**
6802 * The logging configuration for a target.
6803 */
6804 logTargetConfigurations?: LogTargetConfigurations;
6805 /**
6806 * The token used to get the next set of results, or null if there are no additional results.
6807 */
6808 nextToken?: NextToken;
6809 }
6810 export interface ListViolationEventsRequest {
6811 /**
6812 * The start time for the alerts to be listed.
6813 */
6814 startTime: Timestamp;
6815 /**
6816 * The end time for the alerts to be listed.
6817 */
6818 endTime: Timestamp;
6819 /**
6820 * A filter to limit results to those alerts caused by the specified thing.
6821 */
6822 thingName?: DeviceDefenderThingName;
6823 /**
6824 * A filter to limit results to those alerts generated by the specified security profile.
6825 */
6826 securityProfileName?: SecurityProfileName;
6827 /**
6828 * The token for the next set of results.
6829 */
6830 nextToken?: NextToken;
6831 /**
6832 * The maximum number of results to return at one time.
6833 */
6834 maxResults?: MaxResults;
6835 }
6836 export interface ListViolationEventsResponse {
6837 /**
6838 * The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.
6839 */
6840 violationEvents?: ViolationEvents;
6841 /**
6842 * A token that can be used to retrieve the next set of results, or null if there are no additional results.
6843 */
6844 nextToken?: NextToken;
6845 }
6846 export type LogGroupName = string;
6847 export type LogLevel = "DEBUG"|"INFO"|"ERROR"|"WARN"|"DISABLED"|string;
6848 export interface LogTarget {
6849 /**
6850 * The target type.
6851 */
6852 targetType: LogTargetType;
6853 /**
6854 * The target name.
6855 */
6856 targetName?: LogTargetName;
6857 }
6858 export interface LogTargetConfiguration {
6859 /**
6860 * A log target
6861 */
6862 logTarget?: LogTarget;
6863 /**
6864 * The logging level.
6865 */
6866 logLevel?: LogLevel;
6867 }
6868 export type LogTargetConfigurations = LogTargetConfiguration[];
6869 export type LogTargetName = string;
6870 export type LogTargetType = "DEFAULT"|"THING_GROUP"|string;
6871 export interface LoggingOptionsPayload {
6872 /**
6873 * The ARN of the IAM role that grants access.
6874 */
6875 roleArn: AwsArn;
6876 /**
6877 * The log level.
6878 */
6879 logLevel?: LogLevel;
6880 }
6881 export type Marker = string;
6882 export type MaxJobExecutionsPerMin = number;
6883 export type MaxResults = number;
6884 export type Maximum = number;
6885 export type MaximumPerMinute = number;
6886 export type Message = string;
6887 export type MessageFormat = "RAW"|"JSON"|string;
6888 export type MessageId = string;
6889 export interface MetricDimension {
6890 /**
6891 * A unique identifier for the dimension.
6892 */
6893 dimensionName: DimensionName;
6894 /**
6895 * Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.
6896 */
6897 operator?: DimensionValueOperator;
6898 }
6899 export interface MetricToRetain {
6900 /**
6901 * What is measured by the behavior.
6902 */
6903 metric: BehaviorMetric;
6904 /**
6905 * The dimension of a metric.
6906 */
6907 metricDimension?: MetricDimension;
6908 }
6909 export interface MetricValue {
6910 /**
6911 * If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.
6912 */
6913 count?: UnsignedLong;
6914 /**
6915 * If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
6916 */
6917 cidrs?: Cidrs;
6918 /**
6919 * If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
6920 */
6921 ports?: Ports;
6922 }
6923 export type Minimum = number;
6924 export type MinimumNumberOfExecutedThings = number;
6925 export type MissingContextValue = string;
6926 export type MissingContextValues = MissingContextValue[];
6927 export interface MitigationAction {
6928 /**
6929 * A user-friendly name for the mitigation action.
6930 */
6931 name?: MitigationActionName;
6932 /**
6933 * A unique identifier for the mitigation action.
6934 */
6935 id?: MitigationActionId;
6936 /**
6937 * The IAM role ARN used to apply this mitigation action.
6938 */
6939 roleArn?: RoleArn;
6940 /**
6941 * The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
6942 */
6943 actionParams?: MitigationActionParams;
6944 }
6945 export type MitigationActionArn = string;
6946 export type MitigationActionId = string;
6947 export interface MitigationActionIdentifier {
6948 /**
6949 * The friendly name of the mitigation action.
6950 */
6951 actionName?: MitigationActionName;
6952 /**
6953 * The IAM role ARN used to apply this mitigation action.
6954 */
6955 actionArn?: MitigationActionArn;
6956 /**
6957 * The date when this mitigation action was created.
6958 */
6959 creationDate?: Timestamp;
6960 }
6961 export type MitigationActionIdentifierList = MitigationActionIdentifier[];
6962 export type MitigationActionList = MitigationAction[];
6963 export type MitigationActionName = string;
6964 export type MitigationActionNameList = MitigationActionName[];
6965 export interface MitigationActionParams {
6966 /**
6967 * Parameters to define a mitigation action that changes the state of the device certificate to inactive.
6968 */
6969 updateDeviceCertificateParams?: UpdateDeviceCertificateParams;
6970 /**
6971 * Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
6972 */
6973 updateCACertificateParams?: UpdateCACertificateParams;
6974 /**
6975 * Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.
6976 */
6977 addThingsToThingGroupParams?: AddThingsToThingGroupParams;
6978 /**
6979 * Parameters to define a mitigation action that adds a blank policy to restrict permissions.
6980 */
6981 replaceDefaultPolicyVersionParams?: ReplaceDefaultPolicyVersionParams;
6982 /**
6983 * Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.
6984 */
6985 enableIoTLoggingParams?: EnableIoTLoggingParams;
6986 /**
6987 * Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.
6988 */
6989 publishFindingToSnsParams?: PublishFindingToSnsParams;
6990 }
6991 export type MitigationActionType = "UPDATE_DEVICE_CERTIFICATE"|"UPDATE_CA_CERTIFICATE"|"ADD_THINGS_TO_THING_GROUP"|"REPLACE_DEFAULT_POLICY_VERSION"|"ENABLE_IOT_LOGGING"|"PUBLISH_FINDING_TO_SNS"|string;
6992 export type MqttClientId = string;
6993 export interface MqttContext {
6994 /**
6995 * The value of the username key in an MQTT authorization request.
6996 */
6997 username?: MqttUsername;
6998 /**
6999 * The value of the password key in an MQTT authorization request.
7000 */
7001 password?: MqttPassword;
7002 /**
7003 * The value of the clientId key in an MQTT authorization request.
7004 */
7005 clientId?: MqttClientId;
7006 }
7007 export type MqttPassword = Buffer|Uint8Array|Blob|string;
7008 export type MqttUsername = string;
7009 export type NextToken = string;
7010 export type NonCompliantChecksCount = number;
7011 export interface NonCompliantResource {
7012 /**
7013 * The type of the noncompliant resource.
7014 */
7015 resourceType?: ResourceType;
7016 /**
7017 * Information that identifies the noncompliant resource.
7018 */
7019 resourceIdentifier?: ResourceIdentifier;
7020 /**
7021 * Other information about the noncompliant resource.
7022 */
7023 additionalInfo?: StringMap;
7024 }
7025 export type NonCompliantResourcesCount = number;
7026 export type NumberOfThings = number;
7027 export type OTAUpdateArn = string;
7028 export type OTAUpdateDescription = string;
7029 export type OTAUpdateErrorMessage = string;
7030 export interface OTAUpdateFile {
7031 /**
7032 * The name of the file.
7033 */
7034 fileName?: FileName;
7035 /**
7036 * The file version.
7037 */
7038 fileVersion?: OTAUpdateFileVersion;
7039 /**
7040 * The location of the updated firmware.
7041 */
7042 fileLocation?: FileLocation;
7043 /**
7044 * The code signing method of the file.
7045 */
7046 codeSigning?: CodeSigning;
7047 /**
7048 * A list of name/attribute pairs.
7049 */
7050 attributes?: AttributesMap;
7051 }
7052 export type OTAUpdateFileVersion = string;
7053 export type OTAUpdateFiles = OTAUpdateFile[];
7054 export type OTAUpdateId = string;
7055 export interface OTAUpdateInfo {
7056 /**
7057 * The OTA update ID.
7058 */
7059 otaUpdateId?: OTAUpdateId;
7060 /**
7061 * The OTA update ARN.
7062 */
7063 otaUpdateArn?: OTAUpdateArn;
7064 /**
7065 * The date when the OTA update was created.
7066 */
7067 creationDate?: DateType;
7068 /**
7069 * The date when the OTA update was last updated.
7070 */
7071 lastModifiedDate?: DateType;
7072 /**
7073 * A description of the OTA update.
7074 */
7075 description?: OTAUpdateDescription;
7076 /**
7077 * The targets of the OTA update.
7078 */
7079 targets?: Targets;
7080 /**
7081 * The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
7082 */
7083 protocols?: Protocols;
7084 /**
7085 * Configuration for the rollout of OTA updates.
7086 */
7087 awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig;
7088 /**
7089 * Configuration information for pre-signed URLs. Valid when protocols contains HTTP.
7090 */
7091 awsJobPresignedUrlConfig?: AwsJobPresignedUrlConfig;
7092 /**
7093 * Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
7094 */
7095 targetSelection?: TargetSelection;
7096 /**
7097 * A list of files associated with the OTA update.
7098 */
7099 otaUpdateFiles?: OTAUpdateFiles;
7100 /**
7101 * The status of the OTA update.
7102 */
7103 otaUpdateStatus?: OTAUpdateStatus;
7104 /**
7105 * The AWS IoT job ID associated with the OTA update.
7106 */
7107 awsIotJobId?: AwsIotJobId;
7108 /**
7109 * The AWS IoT job ARN associated with the OTA update.
7110 */
7111 awsIotJobArn?: AwsIotJobArn;
7112 /**
7113 * Error information associated with the OTA update.
7114 */
7115 errorInfo?: ErrorInfo;
7116 /**
7117 * A collection of name/value pairs
7118 */
7119 additionalParameters?: AdditionalParameterMap;
7120 }
7121 export type OTAUpdateStatus = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"CREATE_FAILED"|string;
7122 export interface OTAUpdateSummary {
7123 /**
7124 * The OTA update ID.
7125 */
7126 otaUpdateId?: OTAUpdateId;
7127 /**
7128 * The OTA update ARN.
7129 */
7130 otaUpdateArn?: OTAUpdateArn;
7131 /**
7132 * The date when the OTA update was created.
7133 */
7134 creationDate?: DateType;
7135 }
7136 export type OTAUpdatesSummary = OTAUpdateSummary[];
7137 export type OptionalVersion = number;
7138 export interface OutgoingCertificate {
7139 /**
7140 * The certificate ARN.
7141 */
7142 certificateArn?: CertificateArn;
7143 /**
7144 * The certificate ID.
7145 */
7146 certificateId?: CertificateId;
7147 /**
7148 * The AWS account to which the transfer was made.
7149 */
7150 transferredTo?: AwsAccountId;
7151 /**
7152 * The date the transfer was initiated.
7153 */
7154 transferDate?: DateType;
7155 /**
7156 * The transfer message.
7157 */
7158 transferMessage?: Message;
7159 /**
7160 * The certificate creation date.
7161 */
7162 creationDate?: DateType;
7163 }
7164 export type OutgoingCertificates = OutgoingCertificate[];
7165 export type OverrideDynamicGroups = boolean;
7166 export type PageSize = number;
7167 export type Parameter = string;
7168 export type Parameters = {[key: string]: Value};
7169 export type PartitionKey = string;
7170 export type PayloadField = string;
7171 export type Percent = number;
7172 export type PercentList = Percent[];
7173 export interface PercentPair {
7174 /**
7175 * The percentile.
7176 */
7177 percent?: Percent;
7178 /**
7179 * The value of the percentile.
7180 */
7181 value?: PercentValue;
7182 }
7183 export type PercentValue = number;
7184 export type Percentage = number;
7185 export type Percentiles = PercentPair[];
7186 export type Platform = string;
7187 export type Policies = Policy[];
7188 export interface Policy {
7189 /**
7190 * The policy name.
7191 */
7192 policyName?: PolicyName;
7193 /**
7194 * The policy ARN.
7195 */
7196 policyArn?: PolicyArn;
7197 }
7198 export type PolicyArn = string;
7199 export type PolicyDocument = string;
7200 export type PolicyDocuments = PolicyDocument[];
7201 export type PolicyName = string;
7202 export type PolicyNames = PolicyName[];
7203 export type PolicyTarget = string;
7204 export type PolicyTargets = PolicyTarget[];
7205 export type PolicyTemplateName = "BLANK_POLICY"|string;
7206 export interface PolicyVersion {
7207 /**
7208 * The policy version ID.
7209 */
7210 versionId?: PolicyVersionId;
7211 /**
7212 * Specifies whether the policy version is the default.
7213 */
7214 isDefaultVersion?: IsDefaultVersion;
7215 /**
7216 * The date and time the policy was created.
7217 */
7218 createDate?: DateType;
7219 }
7220 export type PolicyVersionId = string;
7221 export interface PolicyVersionIdentifier {
7222 /**
7223 * The name of the policy.
7224 */
7225 policyName?: PolicyName;
7226 /**
7227 * The ID of the version of the policy associated with the resource.
7228 */
7229 policyVersionId?: PolicyVersionId;
7230 }
7231 export type PolicyVersions = PolicyVersion[];
7232 export type Port = number;
7233 export type Ports = Port[];
7234 export type Prefix = string;
7235 export interface PresignedUrlConfig {
7236 /**
7237 * The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
7238 */
7239 roleArn?: RoleArn;
7240 /**
7241 * How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
7242 */
7243 expiresInSec?: ExpiresInSec;
7244 }
7245 export type Principal = string;
7246 export type PrincipalArn = string;
7247 export type PrincipalId = string;
7248 export type Principals = PrincipalArn[];
7249 export type PrivateKey = string;
7250 export type ProcessingTargetName = string;
7251 export type ProcessingTargetNameList = ProcessingTargetName[];
7252 export type Protocol = "MQTT"|"HTTP"|string;
7253 export type Protocols = Protocol[];
7254 export type ProvisioningTemplateListing = ProvisioningTemplateSummary[];
7255 export interface ProvisioningTemplateSummary {
7256 /**
7257 * The ARN of the fleet provisioning template.
7258 */
7259 templateArn?: TemplateArn;
7260 /**
7261 * The name of the fleet provisioning template.
7262 */
7263 templateName?: TemplateName;
7264 /**
7265 * The description of the fleet provisioning template.
7266 */
7267 description?: TemplateDescription;
7268 /**
7269 * The date when the fleet provisioning template summary was created.
7270 */
7271 creationDate?: DateType;
7272 /**
7273 * The date when the fleet provisioning template summary was last modified.
7274 */
7275 lastModifiedDate?: DateType;
7276 /**
7277 * True if the fleet provision template is enabled, otherwise false.
7278 */
7279 enabled?: Enabled;
7280 }
7281 export type ProvisioningTemplateVersionListing = ProvisioningTemplateVersionSummary[];
7282 export interface ProvisioningTemplateVersionSummary {
7283 /**
7284 * The ID of the fleet privisioning template version.
7285 */
7286 versionId?: TemplateVersionId;
7287 /**
7288 * The date when the fleet provisioning template version was created
7289 */
7290 creationDate?: DateType;
7291 /**
7292 * True if the fleet provisioning template version is the default version, otherwise false.
7293 */
7294 isDefaultVersion?: IsDefaultVersion;
7295 }
7296 export type PublicKey = string;
7297 export type PublicKeyMap = {[key: string]: KeyValue};
7298 export interface PublishFindingToSnsParams {
7299 /**
7300 * The ARN of the topic to which you want to publish the findings.
7301 */
7302 topicArn: SnsTopicArn;
7303 }
7304 export interface PutAssetPropertyValueEntry {
7305 /**
7306 * Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
7307 */
7308 entryId?: AssetPropertyEntryId;
7309 /**
7310 * The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.
7311 */
7312 assetId?: AssetId;
7313 /**
7314 * The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.
7315 */
7316 propertyId?: AssetPropertyId;
7317 /**
7318 * The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.
7319 */
7320 propertyAlias?: AssetPropertyAlias;
7321 /**
7322 * A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
7323 */
7324 propertyValues: AssetPropertyValueList;
7325 }
7326 export type PutAssetPropertyValueEntryList = PutAssetPropertyValueEntry[];
7327 export interface PutItemInput {
7328 /**
7329 * The table where the message data will be written.
7330 */
7331 tableName: TableName;
7332 }
7333 export type Qos = number;
7334 export type QueryMaxResults = number;
7335 export type QueryString = string;
7336 export type QueryVersion = string;
7337 export type QueueUrl = string;
7338 export type QueuedThings = number;
7339 export type RangeKeyField = string;
7340 export type RangeKeyValue = string;
7341 export interface RateIncreaseCriteria {
7342 /**
7343 * The threshold for number of notified things that will initiate the increase in rate of rollout.
7344 */
7345 numberOfNotifiedThings?: NumberOfThings;
7346 /**
7347 * The threshold for number of succeeded things that will initiate the increase in rate of rollout.
7348 */
7349 numberOfSucceededThings?: NumberOfThings;
7350 }
7351 export type ReasonCode = string;
7352 export type ReasonForNonCompliance = string;
7353 export type ReasonForNonComplianceCode = string;
7354 export type ReasonForNonComplianceCodes = ReasonForNonComplianceCode[];
7355 export type Recursive = boolean;
7356 export type RecursiveWithoutDefault = boolean;
7357 export interface RegisterCACertificateRequest {
7358 /**
7359 * The CA certificate.
7360 */
7361 caCertificate: CertificatePem;
7362 /**
7363 * The private key verification certificate.
7364 */
7365 verificationCertificate: CertificatePem;
7366 /**
7367 * A boolean value that specifies if the CA certificate is set to active.
7368 */
7369 setAsActive?: SetAsActive;
7370 /**
7371 * Allows this CA certificate to be used for auto registration of device certificates.
7372 */
7373 allowAutoRegistration?: AllowAutoRegistration;
7374 /**
7375 * Information about the registration configuration.
7376 */
7377 registrationConfig?: RegistrationConfig;
7378 }
7379 export interface RegisterCACertificateResponse {
7380 /**
7381 * The CA certificate ARN.
7382 */
7383 certificateArn?: CertificateArn;
7384 /**
7385 * The CA certificate identifier.
7386 */
7387 certificateId?: CertificateId;
7388 }
7389 export interface RegisterCertificateRequest {
7390 /**
7391 * The certificate data, in PEM format.
7392 */
7393 certificatePem: CertificatePem;
7394 /**
7395 * The CA certificate used to sign the device certificate being registered.
7396 */
7397 caCertificatePem?: CertificatePem;
7398 /**
7399 * A boolean value that specifies if the certificate is set to active.
7400 */
7401 setAsActive?: SetAsActiveFlag;
7402 /**
7403 * The status of the register certificate request.
7404 */
7405 status?: CertificateStatus;
7406 }
7407 export interface RegisterCertificateResponse {
7408 /**
7409 * The certificate ARN.
7410 */
7411 certificateArn?: CertificateArn;
7412 /**
7413 * The certificate identifier.
7414 */
7415 certificateId?: CertificateId;
7416 }
7417 export interface RegisterThingRequest {
7418 /**
7419 * The provisioning template. See Provisioning Devices That Have Device Certificates for more information.
7420 */
7421 templateBody: TemplateBody;
7422 /**
7423 * The parameters for provisioning a thing. See Programmatic Provisioning for more information.
7424 */
7425 parameters?: Parameters;
7426 }
7427 export interface RegisterThingResponse {
7428 /**
7429 * .
7430 */
7431 certificatePem?: CertificatePem;
7432 /**
7433 * ARNs for the generated resources.
7434 */
7435 resourceArns?: ResourceArns;
7436 }
7437 export type RegistrationCode = string;
7438 export interface RegistrationConfig {
7439 /**
7440 * The template body.
7441 */
7442 templateBody?: TemplateBody;
7443 /**
7444 * The ARN of the role.
7445 */
7446 roleArn?: RoleArn;
7447 }
7448 export type RegistryMaxResults = number;
7449 export type RegistryS3BucketName = string;
7450 export type RegistryS3KeyName = string;
7451 export interface RejectCertificateTransferRequest {
7452 /**
7453 * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
7454 */
7455 certificateId: CertificateId;
7456 /**
7457 * The reason the certificate transfer was rejected.
7458 */
7459 rejectReason?: Message;
7460 }
7461 export type RejectedThings = number;
7462 export interface RelatedResource {
7463 /**
7464 * The type of resource.
7465 */
7466 resourceType?: ResourceType;
7467 /**
7468 * Information that identifies the resource.
7469 */
7470 resourceIdentifier?: ResourceIdentifier;
7471 /**
7472 * Other information about the resource.
7473 */
7474 additionalInfo?: StringMap;
7475 }
7476 export type RelatedResources = RelatedResource[];
7477 export type RemoveAuthorizerConfig = boolean;
7478 export type RemoveAutoRegistration = boolean;
7479 export interface RemoveThingFromBillingGroupRequest {
7480 /**
7481 * The name of the billing group.
7482 */
7483 billingGroupName?: BillingGroupName;
7484 /**
7485 * The ARN of the billing group.
7486 */
7487 billingGroupArn?: BillingGroupArn;
7488 /**
7489 * The name of the thing to be removed from the billing group.
7490 */
7491 thingName?: ThingName;
7492 /**
7493 * The ARN of the thing to be removed from the billing group.
7494 */
7495 thingArn?: ThingArn;
7496 }
7497 export interface RemoveThingFromBillingGroupResponse {
7498 }
7499 export interface RemoveThingFromThingGroupRequest {
7500 /**
7501 * The group name.
7502 */
7503 thingGroupName?: ThingGroupName;
7504 /**
7505 * The group ARN.
7506 */
7507 thingGroupArn?: ThingGroupArn;
7508 /**
7509 * The name of the thing to remove from the group.
7510 */
7511 thingName?: ThingName;
7512 /**
7513 * The ARN of the thing to remove from the group.
7514 */
7515 thingArn?: ThingArn;
7516 }
7517 export interface RemoveThingFromThingGroupResponse {
7518 }
7519 export type RemoveThingType = boolean;
7520 export type RemovedThings = number;
7521 export interface ReplaceDefaultPolicyVersionParams {
7522 /**
7523 * The name of the template to be applied. The only supported value is BLANK_POLICY.
7524 */
7525 templateName: PolicyTemplateName;
7526 }
7527 export interface ReplaceTopicRuleRequest {
7528 /**
7529 * The name of the rule.
7530 */
7531 ruleName: RuleName;
7532 /**
7533 * The rule payload.
7534 */
7535 topicRulePayload: TopicRulePayload;
7536 }
7537 export type ReportType = "ERRORS"|"RESULTS"|string;
7538 export interface RepublishAction {
7539 /**
7540 * The ARN of the IAM role that grants access.
7541 */
7542 roleArn: AwsArn;
7543 /**
7544 * The name of the MQTT topic.
7545 */
7546 topic: TopicPattern;
7547 /**
7548 * The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
7549 */
7550 qos?: Qos;
7551 }
7552 export type ReservedDomainConfigurationName = string;
7553 export type Resource = string;
7554 export type ResourceArn = string;
7555 export type ResourceArns = {[key: string]: ResourceArn};
7556 export interface ResourceIdentifier {
7557 /**
7558 * The ID of the certificate attached to the resource.
7559 */
7560 deviceCertificateId?: CertificateId;
7561 /**
7562 * The ID of the CA certificate used to authorize the certificate.
7563 */
7564 caCertificateId?: CertificateId;
7565 /**
7566 * The ID of the Amazon Cognito identity pool.
7567 */
7568 cognitoIdentityPoolId?: CognitoIdentityPoolId;
7569 /**
7570 * The client ID.
7571 */
7572 clientId?: ClientId;
7573 /**
7574 * The version of the policy associated with the resource.
7575 */
7576 policyVersionIdentifier?: PolicyVersionIdentifier;
7577 /**
7578 * The account with which the resource is associated.
7579 */
7580 account?: AwsAccountId;
7581 /**
7582 * The ARN of the IAM role that has overly permissive actions.
7583 */
7584 iamRoleArn?: RoleArn;
7585 /**
7586 * The ARN of the role alias that has overly permissive actions.
7587 */
7588 roleAliasArn?: RoleAliasArn;
7589 }
7590 export type ResourceLogicalId = string;
7591 export type ResourceType = "DEVICE_CERTIFICATE"|"CA_CERTIFICATE"|"IOT_POLICY"|"COGNITO_IDENTITY_POOL"|"CLIENT_ID"|"ACCOUNT_SETTINGS"|"ROLE_ALIAS"|"IAM_ROLE"|string;
7592 export type Resources = Resource[];
7593 export type RoleAlias = string;
7594 export type RoleAliasArn = string;
7595 export interface RoleAliasDescription {
7596 /**
7597 * The role alias.
7598 */
7599 roleAlias?: RoleAlias;
7600 /**
7601 * The ARN of the role alias.
7602 */
7603 roleAliasArn?: RoleAliasArn;
7604 /**
7605 * The role ARN.
7606 */
7607 roleArn?: RoleArn;
7608 /**
7609 * The role alias owner.
7610 */
7611 owner?: AwsAccountId;
7612 /**
7613 * The number of seconds for which the credential is valid.
7614 */
7615 credentialDurationSeconds?: CredentialDurationSeconds;
7616 /**
7617 * The UNIX timestamp of when the role alias was created.
7618 */
7619 creationDate?: DateType;
7620 /**
7621 * The UNIX timestamp of when the role alias was last modified.
7622 */
7623 lastModifiedDate?: DateType;
7624 }
7625 export type RoleAliases = RoleAlias[];
7626 export type RoleArn = string;
7627 export type RolloutRatePerMinute = number;
7628 export type RuleArn = string;
7629 export type RuleName = string;
7630 export interface S3Action {
7631 /**
7632 * The ARN of the IAM role that grants access.
7633 */
7634 roleArn: AwsArn;
7635 /**
7636 * The Amazon S3 bucket.
7637 */
7638 bucketName: BucketName;
7639 /**
7640 * The object key.
7641 */
7642 key: Key;
7643 /**
7644 * The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.
7645 */
7646 cannedAcl?: CannedAccessControlList;
7647 }
7648 export type S3Bucket = string;
7649 export interface S3Destination {
7650 /**
7651 * The S3 bucket that contains the updated firmware.
7652 */
7653 bucket?: S3Bucket;
7654 /**
7655 * The S3 prefix.
7656 */
7657 prefix?: Prefix;
7658 }
7659 export type S3FileUrl = string;
7660 export type S3FileUrlList = S3FileUrl[];
7661 export type S3Key = string;
7662 export interface S3Location {
7663 /**
7664 * The S3 bucket.
7665 */
7666 bucket?: S3Bucket;
7667 /**
7668 * The S3 key.
7669 */
7670 key?: S3Key;
7671 /**
7672 * The S3 bucket version.
7673 */
7674 version?: S3Version;
7675 }
7676 export type S3Version = string;
7677 export type SQL = string;
7678 export interface SalesforceAction {
7679 /**
7680 * The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream.
7681 */
7682 token: SalesforceToken;
7683 /**
7684 * The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream.
7685 */
7686 url: SalesforceEndpoint;
7687 }
7688 export type SalesforceEndpoint = string;
7689 export type SalesforceToken = string;
7690 export type ScheduledAuditArn = string;
7691 export interface ScheduledAuditMetadata {
7692 /**
7693 * The name of the scheduled audit.
7694 */
7695 scheduledAuditName?: ScheduledAuditName;
7696 /**
7697 * The ARN of the scheduled audit.
7698 */
7699 scheduledAuditArn?: ScheduledAuditArn;
7700 /**
7701 * How often the scheduled audit occurs.
7702 */
7703 frequency?: AuditFrequency;
7704 /**
7705 * The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
7706 */
7707 dayOfMonth?: DayOfMonth;
7708 /**
7709 * The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").
7710 */
7711 dayOfWeek?: DayOfWeek;
7712 }
7713 export type ScheduledAuditMetadataList = ScheduledAuditMetadata[];
7714 export type ScheduledAuditName = string;
7715 export interface SearchIndexRequest {
7716 /**
7717 * The search index name.
7718 */
7719 indexName?: IndexName;
7720 /**
7721 * The search query string.
7722 */
7723 queryString: QueryString;
7724 /**
7725 * The token used to get the next set of results, or null if there are no additional results.
7726 */
7727 nextToken?: NextToken;
7728 /**
7729 * The maximum number of results to return at one time.
7730 */
7731 maxResults?: QueryMaxResults;
7732 /**
7733 * The query version.
7734 */
7735 queryVersion?: QueryVersion;
7736 }
7737 export interface SearchIndexResponse {
7738 /**
7739 * The token used to get the next set of results, or null if there are no additional results.
7740 */
7741 nextToken?: NextToken;
7742 /**
7743 * The things that match the search query.
7744 */
7745 things?: ThingDocumentList;
7746 /**
7747 * The thing groups that match the search query.
7748 */
7749 thingGroups?: ThingGroupDocumentList;
7750 }
7751 export type SearchableAttributes = AttributeName[];
7752 export type Seconds = number;
7753 export type SecurityProfileArn = string;
7754 export type SecurityProfileDescription = string;
7755 export interface SecurityProfileIdentifier {
7756 /**
7757 * The name you have given to the security profile.
7758 */
7759 name: SecurityProfileName;
7760 /**
7761 * The ARN of the security profile.
7762 */
7763 arn: SecurityProfileArn;
7764 }
7765 export type SecurityProfileIdentifiers = SecurityProfileIdentifier[];
7766 export type SecurityProfileName = string;
7767 export interface SecurityProfileTarget {
7768 /**
7769 * The ARN of the security profile.
7770 */
7771 arn: SecurityProfileTargetArn;
7772 }
7773 export type SecurityProfileTargetArn = string;
7774 export interface SecurityProfileTargetMapping {
7775 /**
7776 * Information that identifies the security profile.
7777 */
7778 securityProfileIdentifier?: SecurityProfileIdentifier;
7779 /**
7780 * Information about the target (thing group) associated with the security profile.
7781 */
7782 target?: SecurityProfileTarget;
7783 }
7784 export type SecurityProfileTargetMappings = SecurityProfileTargetMapping[];
7785 export type SecurityProfileTargets = SecurityProfileTarget[];
7786 export type ServerCertificateArns = AcmCertificateArn[];
7787 export type ServerCertificateStatus = "INVALID"|"VALID"|string;
7788 export type ServerCertificateStatusDetail = string;
7789 export interface ServerCertificateSummary {
7790 /**
7791 * The ARN of the server certificate.
7792 */
7793 serverCertificateArn?: AcmCertificateArn;
7794 /**
7795 * The status of the server certificate.
7796 */
7797 serverCertificateStatus?: ServerCertificateStatus;
7798 /**
7799 * Details that explain the status of the server certificate.
7800 */
7801 serverCertificateStatusDetail?: ServerCertificateStatusDetail;
7802 }
7803 export type ServerCertificates = ServerCertificateSummary[];
7804 export type ServerName = string;
7805 export type ServiceName = string;
7806 export type ServiceType = "DATA"|"CREDENTIAL_PROVIDER"|"JOBS"|string;
7807 export type SetAsActive = boolean;
7808 export type SetAsActiveFlag = boolean;
7809 export type SetAsDefault = boolean;
7810 export interface SetDefaultAuthorizerRequest {
7811 /**
7812 * The authorizer name.
7813 */
7814 authorizerName: AuthorizerName;
7815 }
7816 export interface SetDefaultAuthorizerResponse {
7817 /**
7818 * The authorizer name.
7819 */
7820 authorizerName?: AuthorizerName;
7821 /**
7822 * The authorizer ARN.
7823 */
7824 authorizerArn?: AuthorizerArn;
7825 }
7826 export interface SetDefaultPolicyVersionRequest {
7827 /**
7828 * The policy name.
7829 */
7830 policyName: PolicyName;
7831 /**
7832 * The policy version ID.
7833 */
7834 policyVersionId: PolicyVersionId;
7835 }
7836 export interface SetLoggingOptionsRequest {
7837 /**
7838 * The logging options payload.
7839 */
7840 loggingOptionsPayload: LoggingOptionsPayload;
7841 }
7842 export interface SetV2LoggingLevelRequest {
7843 /**
7844 * The log target.
7845 */
7846 logTarget: LogTarget;
7847 /**
7848 * The log level.
7849 */
7850 logLevel: LogLevel;
7851 }
7852 export interface SetV2LoggingOptionsRequest {
7853 /**
7854 * The ARN of the role that allows IoT to write to Cloudwatch logs.
7855 */
7856 roleArn?: AwsArn;
7857 /**
7858 * The default logging level.
7859 */
7860 defaultLogLevel?: LogLevel;
7861 /**
7862 * If true all logs are disabled. The default is false.
7863 */
7864 disableAllLogs?: DisableAllLogs;
7865 }
7866 export interface SigV4Authorization {
7867 /**
7868 * The signing region.
7869 */
7870 signingRegion: SigningRegion;
7871 /**
7872 * The service name to use while signing with Sig V4.
7873 */
7874 serviceName: ServiceName;
7875 /**
7876 * The ARN of the signing role.
7877 */
7878 roleArn: AwsArn;
7879 }
7880 export type Signature = Buffer|Uint8Array|Blob|string;
7881 export type SignatureAlgorithm = string;
7882 export type SigningJobId = string;
7883 export type SigningProfileName = string;
7884 export interface SigningProfileParameter {
7885 /**
7886 * Certificate ARN.
7887 */
7888 certificateArn?: CertificateArn;
7889 /**
7890 * The hardware platform of your device.
7891 */
7892 platform?: Platform;
7893 /**
7894 * The location of the code-signing certificate on your device.
7895 */
7896 certificatePathOnDevice?: CertificatePathOnDevice;
7897 }
7898 export type SigningRegion = string;
7899 export type SkippedFindingsCount = number;
7900 export type SkyfallMaxResults = number;
7901 export interface SnsAction {
7902 /**
7903 * The ARN of the SNS topic.
7904 */
7905 targetArn: AwsArn;
7906 /**
7907 * The ARN of the IAM role that grants access.
7908 */
7909 roleArn: AwsArn;
7910 /**
7911 * (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
7912 */
7913 messageFormat?: MessageFormat;
7914 }
7915 export type SnsTopicArn = string;
7916 export interface SqsAction {
7917 /**
7918 * The ARN of the IAM role that grants access.
7919 */
7920 roleArn: AwsArn;
7921 /**
7922 * The URL of the Amazon SQS queue.
7923 */
7924 queueUrl: QueueUrl;
7925 /**
7926 * Specifies whether to use Base64 encoding.
7927 */
7928 useBase64?: UseBase64;
7929 }
7930 export interface StartAuditMitigationActionsTaskRequest {
7931 /**
7932 * A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.
7933 */
7934 taskId: AuditMitigationActionsTaskId;
7935 /**
7936 * Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a speecific set of findings.
7937 */
7938 target: AuditMitigationActionsTaskTarget;
7939 /**
7940 * For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.
7941 */
7942 auditCheckToActionsMapping: AuditCheckToActionsMapping;
7943 /**
7944 * Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.
7945 */
7946 clientRequestToken: ClientRequestToken;
7947 }
7948 export interface StartAuditMitigationActionsTaskResponse {
7949 /**
7950 * The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.
7951 */
7952 taskId?: AuditMitigationActionsTaskId;
7953 }
7954 export interface StartOnDemandAuditTaskRequest {
7955 /**
7956 * Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.
7957 */
7958 targetCheckNames: TargetAuditCheckNames;
7959 }
7960 export interface StartOnDemandAuditTaskResponse {
7961 /**
7962 * The ID of the on-demand audit you started.
7963 */
7964 taskId?: AuditTaskId;
7965 }
7966 export interface StartSigningJobParameter {
7967 /**
7968 * Describes the code-signing profile.
7969 */
7970 signingProfileParameter?: SigningProfileParameter;
7971 /**
7972 * The code-signing profile name.
7973 */
7974 signingProfileName?: SigningProfileName;
7975 /**
7976 * The location to write the code-signed file.
7977 */
7978 destination?: Destination;
7979 }
7980 export interface StartThingRegistrationTaskRequest {
7981 /**
7982 * The provisioning template.
7983 */
7984 templateBody: TemplateBody;
7985 /**
7986 * The S3 bucket that contains the input file.
7987 */
7988 inputFileBucket: RegistryS3BucketName;
7989 /**
7990 * The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).
7991 */
7992 inputFileKey: RegistryS3KeyName;
7993 /**
7994 * The IAM role ARN that grants permission the input file.
7995 */
7996 roleArn: RoleArn;
7997 }
7998 export interface StartThingRegistrationTaskResponse {
7999 /**
8000 * The bulk thing provisioning task ID.
8001 */
8002 taskId?: TaskId;
8003 }
8004 export type StateMachineName = string;
8005 export type StateReason = string;
8006 export type StateValue = string;
8007 export interface StatisticalThreshold {
8008 /**
8009 * The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
8010 */
8011 statistic?: EvaluationStatistic;
8012 }
8013 export interface Statistics {
8014 /**
8015 * The count of things that match the query.
8016 */
8017 count?: Count;
8018 /**
8019 * The average of the aggregated field values.
8020 */
8021 average?: Average;
8022 /**
8023 * The sum of the aggregated field values.
8024 */
8025 sum?: Sum;
8026 /**
8027 * The minimum aggregated field value.
8028 */
8029 minimum?: Minimum;
8030 /**
8031 * The maximum aggregated field value.
8032 */
8033 maximum?: Maximum;
8034 /**
8035 * The sum of the squares of the aggregated field values.
8036 */
8037 sumOfSquares?: SumOfSquares;
8038 /**
8039 * The variance of the aggregated field values.
8040 */
8041 variance?: Variance;
8042 /**
8043 * The standard deviation of the aggregated field values.
8044 */
8045 stdDeviation?: StdDeviation;
8046 }
8047 export type Status = "InProgress"|"Completed"|"Failed"|"Cancelled"|"Cancelling"|string;
8048 export type StdDeviation = number;
8049 export interface StepFunctionsAction {
8050 /**
8051 * (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
8052 */
8053 executionNamePrefix?: ExecutionNamePrefix;
8054 /**
8055 * The name of the Step Functions state machine whose execution will be started.
8056 */
8057 stateMachineName: StateMachineName;
8058 /**
8059 * The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
8060 */
8061 roleArn: AwsArn;
8062 }
8063 export interface StopThingRegistrationTaskRequest {
8064 /**
8065 * The bulk thing provisioning task ID.
8066 */
8067 taskId: TaskId;
8068 }
8069 export interface StopThingRegistrationTaskResponse {
8070 }
8071 export interface Stream {
8072 /**
8073 * The stream ID.
8074 */
8075 streamId?: StreamId;
8076 /**
8077 * The ID of a file associated with a stream.
8078 */
8079 fileId?: FileId;
8080 }
8081 export type StreamArn = string;
8082 export type StreamDescription = string;
8083 export interface StreamFile {
8084 /**
8085 * The file ID.
8086 */
8087 fileId?: FileId;
8088 /**
8089 * The location of the file in S3.
8090 */
8091 s3Location?: S3Location;
8092 }
8093 export type StreamFiles = StreamFile[];
8094 export type StreamId = string;
8095 export interface StreamInfo {
8096 /**
8097 * The stream ID.
8098 */
8099 streamId?: StreamId;
8100 /**
8101 * The stream ARN.
8102 */
8103 streamArn?: StreamArn;
8104 /**
8105 * The stream version.
8106 */
8107 streamVersion?: StreamVersion;
8108 /**
8109 * The description of the stream.
8110 */
8111 description?: StreamDescription;
8112 /**
8113 * The files to stream.
8114 */
8115 files?: StreamFiles;
8116 /**
8117 * The date when the stream was created.
8118 */
8119 createdAt?: DateType;
8120 /**
8121 * The date when the stream was last updated.
8122 */
8123 lastUpdatedAt?: DateType;
8124 /**
8125 * An IAM role AWS IoT assumes to access your S3 files.
8126 */
8127 roleArn?: RoleArn;
8128 }
8129 export type StreamName = string;
8130 export interface StreamSummary {
8131 /**
8132 * The stream ID.
8133 */
8134 streamId?: StreamId;
8135 /**
8136 * The stream ARN.
8137 */
8138 streamArn?: StreamArn;
8139 /**
8140 * The stream version.
8141 */
8142 streamVersion?: StreamVersion;
8143 /**
8144 * A description of the stream.
8145 */
8146 description?: StreamDescription;
8147 }
8148 export type StreamVersion = number;
8149 export type StreamsSummary = StreamSummary[];
8150 export type String = string;
8151 export type StringMap = {[key: string]: String};
8152 export type SucceededFindingsCount = number;
8153 export type SucceededThings = number;
8154 export type Sum = number;
8155 export type SumOfSquares = number;
8156 export type TableName = string;
8157 export interface Tag {
8158 /**
8159 * The tag's key.
8160 */
8161 Key?: TagKey;
8162 /**
8163 * The tag's value.
8164 */
8165 Value?: TagValue;
8166 }
8167 export type TagKey = string;
8168 export type TagKeyList = TagKey[];
8169 export type TagList = Tag[];
8170 export interface TagResourceRequest {
8171 /**
8172 * The ARN of the resource.
8173 */
8174 resourceArn: ResourceArn;
8175 /**
8176 * The new or modified tags for the resource.
8177 */
8178 tags: TagList;
8179 }
8180 export interface TagResourceResponse {
8181 }
8182 export type TagValue = string;
8183 export type Target = string;
8184 export type TargetArn = string;
8185 export type TargetAuditCheckNames = AuditCheckName[];
8186 export type TargetSelection = "CONTINUOUS"|"SNAPSHOT"|string;
8187 export type Targets = Target[];
8188 export type TaskId = string;
8189 export type TaskIdList = TaskId[];
8190 export interface TaskStatistics {
8191 /**
8192 * The number of checks in this audit.
8193 */
8194 totalChecks?: TotalChecksCount;
8195 /**
8196 * The number of checks in progress.
8197 */
8198 inProgressChecks?: InProgressChecksCount;
8199 /**
8200 * The number of checks waiting for data collection.
8201 */
8202 waitingForDataCollectionChecks?: WaitingForDataCollectionChecksCount;
8203 /**
8204 * The number of checks that found compliant resources.
8205 */
8206 compliantChecks?: CompliantChecksCount;
8207 /**
8208 * The number of checks that found noncompliant resources.
8209 */
8210 nonCompliantChecks?: NonCompliantChecksCount;
8211 /**
8212 * The number of checks.
8213 */
8214 failedChecks?: FailedChecksCount;
8215 /**
8216 * The number of checks that did not run because the audit was canceled.
8217 */
8218 canceledChecks?: CanceledChecksCount;
8219 }
8220 export interface TaskStatisticsForAuditCheck {
8221 /**
8222 * The total number of findings to which a task is being applied.
8223 */
8224 totalFindingsCount?: TotalFindingsCount;
8225 /**
8226 * The number of findings for which at least one of the actions failed when applied.
8227 */
8228 failedFindingsCount?: FailedFindingsCount;
8229 /**
8230 * The number of findings for which all mitigation actions succeeded when applied.
8231 */
8232 succeededFindingsCount?: SucceededFindingsCount;
8233 /**
8234 * The number of findings skipped because of filter conditions provided in the parameters to the command.
8235 */
8236 skippedFindingsCount?: SkippedFindingsCount;
8237 /**
8238 * The number of findings to which the mitigation action task was canceled when applied.
8239 */
8240 canceledFindingsCount?: CanceledFindingsCount;
8241 }
8242 export type TemplateArn = string;
8243 export type TemplateBody = string;
8244 export type TemplateDescription = string;
8245 export type TemplateName = string;
8246 export type TemplateVersionId = number;
8247 export interface TestAuthorizationRequest {
8248 /**
8249 * The principal.
8250 */
8251 principal?: Principal;
8252 /**
8253 * The Cognito identity pool ID.
8254 */
8255 cognitoIdentityPoolId?: CognitoIdentityPoolId;
8256 /**
8257 * A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
8258 */
8259 authInfos: AuthInfos;
8260 /**
8261 * The MQTT client ID.
8262 */
8263 clientId?: ClientId;
8264 /**
8265 * When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
8266 */
8267 policyNamesToAdd?: PolicyNames;
8268 /**
8269 * When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
8270 */
8271 policyNamesToSkip?: PolicyNames;
8272 }
8273 export interface TestAuthorizationResponse {
8274 /**
8275 * The authentication results.
8276 */
8277 authResults?: AuthResults;
8278 }
8279 export interface TestInvokeAuthorizerRequest {
8280 /**
8281 * The custom authorizer name.
8282 */
8283 authorizerName: AuthorizerName;
8284 /**
8285 * The token returned by your custom authentication service.
8286 */
8287 token?: Token;
8288 /**
8289 * The signature made with the token and your custom authentication service's private key.
8290 */
8291 tokenSignature?: TokenSignature;
8292 /**
8293 * Specifies a test HTTP authorization request.
8294 */
8295 httpContext?: HttpContext;
8296 /**
8297 * Specifies a test MQTT authorization request.
8298 */
8299 mqttContext?: MqttContext;
8300 /**
8301 * Specifies a test TLS authorization request.
8302 */
8303 tlsContext?: TlsContext;
8304 }
8305 export interface TestInvokeAuthorizerResponse {
8306 /**
8307 * True if the token is authenticated, otherwise false.
8308 */
8309 isAuthenticated?: IsAuthenticated;
8310 /**
8311 * The principal ID.
8312 */
8313 principalId?: PrincipalId;
8314 /**
8315 * IAM policy documents.
8316 */
8317 policyDocuments?: PolicyDocuments;
8318 /**
8319 * The number of seconds after which the temporary credentials are refreshed.
8320 */
8321 refreshAfterInSeconds?: Seconds;
8322 /**
8323 * The number of seconds after which the connection is terminated.
8324 */
8325 disconnectAfterInSeconds?: Seconds;
8326 }
8327 export type ThingArn = string;
8328 export interface ThingAttribute {
8329 /**
8330 * The name of the thing.
8331 */
8332 thingName?: ThingName;
8333 /**
8334 * The name of the thing type, if the thing has been associated with a type.
8335 */
8336 thingTypeName?: ThingTypeName;
8337 /**
8338 * The thing ARN.
8339 */
8340 thingArn?: ThingArn;
8341 /**
8342 * A list of thing attributes which are name-value pairs.
8343 */
8344 attributes?: Attributes;
8345 /**
8346 * The version of the thing record in the registry.
8347 */
8348 version?: Version;
8349 }
8350 export type ThingAttributeList = ThingAttribute[];
8351 export interface ThingConnectivity {
8352 /**
8353 * True if the thing is connected to the AWS IoT service; false if it is not connected.
8354 */
8355 connected?: Boolean;
8356 /**
8357 * The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for more than a few weeks, the time value might be missing.
8358 */
8359 timestamp?: ConnectivityTimestamp;
8360 }
8361 export type ThingConnectivityIndexingMode = "OFF"|"STATUS"|string;
8362 export interface ThingDocument {
8363 /**
8364 * The thing name.
8365 */
8366 thingName?: ThingName;
8367 /**
8368 * The thing ID.
8369 */
8370 thingId?: ThingId;
8371 /**
8372 * The thing type name.
8373 */
8374 thingTypeName?: ThingTypeName;
8375 /**
8376 * Thing group names.
8377 */
8378 thingGroupNames?: ThingGroupNameList;
8379 /**
8380 * The attributes.
8381 */
8382 attributes?: Attributes;
8383 /**
8384 * The shadow.
8385 */
8386 shadow?: JsonDocument;
8387 /**
8388 * Indicates whether the thing is connected to the AWS IoT service.
8389 */
8390 connectivity?: ThingConnectivity;
8391 }
8392 export type ThingDocumentList = ThingDocument[];
8393 export type ThingGroupArn = string;
8394 export type ThingGroupDescription = string;
8395 export interface ThingGroupDocument {
8396 /**
8397 * The thing group name.
8398 */
8399 thingGroupName?: ThingGroupName;
8400 /**
8401 * The thing group ID.
8402 */
8403 thingGroupId?: ThingGroupId;
8404 /**
8405 * The thing group description.
8406 */
8407 thingGroupDescription?: ThingGroupDescription;
8408 /**
8409 * The thing group attributes.
8410 */
8411 attributes?: Attributes;
8412 /**
8413 * Parent group names.
8414 */
8415 parentGroupNames?: ThingGroupNameList;
8416 }
8417 export type ThingGroupDocumentList = ThingGroupDocument[];
8418 export type ThingGroupId = string;
8419 export interface ThingGroupIndexingConfiguration {
8420 /**
8421 * Thing group indexing mode.
8422 */
8423 thingGroupIndexingMode: ThingGroupIndexingMode;
8424 /**
8425 * Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
8426 */
8427 managedFields?: Fields;
8428 /**
8429 * A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields. Contains custom field names and their data type.
8430 */
8431 customFields?: Fields;
8432 }
8433 export type ThingGroupIndexingMode = "OFF"|"ON"|string;
8434 export type ThingGroupList = ThingGroupName[];
8435 export interface ThingGroupMetadata {
8436 /**
8437 * The parent thing group name.
8438 */
8439 parentGroupName?: ThingGroupName;
8440 /**
8441 * The root parent thing group.
8442 */
8443 rootToParentThingGroups?: ThingGroupNameAndArnList;
8444 /**
8445 * The UNIX timestamp of when the thing group was created.
8446 */
8447 creationDate?: CreationDate;
8448 }
8449 export type ThingGroupName = string;
8450 export type ThingGroupNameAndArnList = GroupNameAndArn[];
8451 export type ThingGroupNameList = ThingGroupName[];
8452 export type ThingGroupNames = ThingGroupName[];
8453 export interface ThingGroupProperties {
8454 /**
8455 * The thing group description.
8456 */
8457 thingGroupDescription?: ThingGroupDescription;
8458 /**
8459 * The thing group attributes in JSON format.
8460 */
8461 attributePayload?: AttributePayload;
8462 }
8463 export type ThingId = string;
8464 export interface ThingIndexingConfiguration {
8465 /**
8466 * Thing indexing mode. Valid values are: REGISTRY – Your thing index contains registry data only. REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data. OFF - Thing indexing is disabled.
8467 */
8468 thingIndexingMode: ThingIndexingMode;
8469 /**
8470 * Thing connectivity indexing mode. Valid values are: STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF. OFF - Thing connectivity status indexing is disabled.
8471 */
8472 thingConnectivityIndexingMode?: ThingConnectivityIndexingMode;
8473 /**
8474 * Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
8475 */
8476 managedFields?: Fields;
8477 /**
8478 * Contains custom field names and their data type.
8479 */
8480 customFields?: Fields;
8481 }
8482 export type ThingIndexingMode = "OFF"|"REGISTRY"|"REGISTRY_AND_SHADOW"|string;
8483 export type ThingName = string;
8484 export type ThingNameList = ThingName[];
8485 export type ThingTypeArn = string;
8486 export interface ThingTypeDefinition {
8487 /**
8488 * The name of the thing type.
8489 */
8490 thingTypeName?: ThingTypeName;
8491 /**
8492 * The thing type ARN.
8493 */
8494 thingTypeArn?: ThingTypeArn;
8495 /**
8496 * The ThingTypeProperties for the thing type.
8497 */
8498 thingTypeProperties?: ThingTypeProperties;
8499 /**
8500 * The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.
8501 */
8502 thingTypeMetadata?: ThingTypeMetadata;
8503 }
8504 export type ThingTypeDescription = string;
8505 export type ThingTypeId = string;
8506 export type ThingTypeList = ThingTypeDefinition[];
8507 export interface ThingTypeMetadata {
8508 /**
8509 * Whether the thing type is deprecated. If true, no new things could be associated with this type.
8510 */
8511 deprecated?: Boolean;
8512 /**
8513 * The date and time when the thing type was deprecated.
8514 */
8515 deprecationDate?: DeprecationDate;
8516 /**
8517 * The date and time when the thing type was created.
8518 */
8519 creationDate?: CreationDate;
8520 }
8521 export type ThingTypeName = string;
8522 export interface ThingTypeProperties {
8523 /**
8524 * The description of the thing type.
8525 */
8526 thingTypeDescription?: ThingTypeDescription;
8527 /**
8528 * A list of searchable thing attribute names.
8529 */
8530 searchableAttributes?: SearchableAttributes;
8531 }
8532 export type TimedOutThings = number;
8533 export interface TimeoutConfig {
8534 /**
8535 * Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
8536 */
8537 inProgressTimeoutInMinutes?: InProgressTimeoutInMinutes;
8538 }
8539 export type Timestamp = Date;
8540 export interface TlsContext {
8541 /**
8542 * The value of the serverName key in a TLS authorization request.
8543 */
8544 serverName?: ServerName;
8545 }
8546 export type Token = string;
8547 export type TokenKeyName = string;
8548 export type TokenSignature = string;
8549 export type Topic = string;
8550 export type TopicPattern = string;
8551 export interface TopicRule {
8552 /**
8553 * The name of the rule.
8554 */
8555 ruleName?: RuleName;
8556 /**
8557 * The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
8558 */
8559 sql?: SQL;
8560 /**
8561 * The description of the rule.
8562 */
8563 description?: Description;
8564 /**
8565 * The date and time the rule was created.
8566 */
8567 createdAt?: CreatedAtDate;
8568 /**
8569 * The actions associated with the rule.
8570 */
8571 actions?: ActionList;
8572 /**
8573 * Specifies whether the rule is disabled.
8574 */
8575 ruleDisabled?: IsDisabled;
8576 /**
8577 * The version of the SQL rules engine to use when evaluating the rule.
8578 */
8579 awsIotSqlVersion?: AwsIotSqlVersion;
8580 /**
8581 * The action to perform when an error occurs.
8582 */
8583 errorAction?: Action;
8584 }
8585 export interface TopicRuleDestination {
8586 /**
8587 * The topic rule destination URL.
8588 */
8589 arn?: AwsArn;
8590 /**
8591 * The status of the topic rule destination. Valid values are: IN_PROGRESS A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. ENABLED Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
8592 */
8593 status?: TopicRuleDestinationStatus;
8594 /**
8595 * Additional details or reason why the topic rule destination is in the current status.
8596 */
8597 statusReason?: String;
8598 /**
8599 * Properties of the HTTP URL.
8600 */
8601 httpUrlProperties?: HttpUrlDestinationProperties;
8602 }
8603 export interface TopicRuleDestinationConfiguration {
8604 /**
8605 * Configuration of the HTTP URL.
8606 */
8607 httpUrlConfiguration?: HttpUrlDestinationConfiguration;
8608 }
8609 export type TopicRuleDestinationMaxResults = number;
8610 export type TopicRuleDestinationStatus = "ENABLED"|"IN_PROGRESS"|"DISABLED"|"ERROR"|string;
8611 export type TopicRuleDestinationSummaries = TopicRuleDestinationSummary[];
8612 export interface TopicRuleDestinationSummary {
8613 /**
8614 * The topic rule destination ARN.
8615 */
8616 arn?: AwsArn;
8617 /**
8618 * The status of the topic rule destination. Valid values are: IN_PROGRESS A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. ENABLED Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
8619 */
8620 status?: TopicRuleDestinationStatus;
8621 /**
8622 * The reason the topic rule destination is in the current status.
8623 */
8624 statusReason?: String;
8625 /**
8626 * Information about the HTTP URL.
8627 */
8628 httpUrlSummary?: HttpUrlDestinationSummary;
8629 }
8630 export type TopicRuleList = TopicRuleListItem[];
8631 export interface TopicRuleListItem {
8632 /**
8633 * The rule ARN.
8634 */
8635 ruleArn?: RuleArn;
8636 /**
8637 * The name of the rule.
8638 */
8639 ruleName?: RuleName;
8640 /**
8641 * The pattern for the topic names that apply.
8642 */
8643 topicPattern?: TopicPattern;
8644 /**
8645 * The date and time the rule was created.
8646 */
8647 createdAt?: CreatedAtDate;
8648 /**
8649 * Specifies whether the rule is disabled.
8650 */
8651 ruleDisabled?: IsDisabled;
8652 }
8653 export type TopicRuleMaxResults = number;
8654 export interface TopicRulePayload {
8655 /**
8656 * The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
8657 */
8658 sql: SQL;
8659 /**
8660 * The description of the rule.
8661 */
8662 description?: Description;
8663 /**
8664 * The actions associated with the rule.
8665 */
8666 actions: ActionList;
8667 /**
8668 * Specifies whether the rule is disabled.
8669 */
8670 ruleDisabled?: IsDisabled;
8671 /**
8672 * The version of the SQL rules engine to use when evaluating the rule.
8673 */
8674 awsIotSqlVersion?: AwsIotSqlVersion;
8675 /**
8676 * The action to take when an error occurs.
8677 */
8678 errorAction?: Action;
8679 }
8680 export type TotalChecksCount = number;
8681 export type TotalFindingsCount = number;
8682 export type TotalResourcesCount = number;
8683 export interface TransferCertificateRequest {
8684 /**
8685 * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
8686 */
8687 certificateId: CertificateId;
8688 /**
8689 * The AWS account.
8690 */
8691 targetAwsAccount: AwsAccountId;
8692 /**
8693 * The transfer message.
8694 */
8695 transferMessage?: Message;
8696 }
8697 export interface TransferCertificateResponse {
8698 /**
8699 * The ARN of the certificate.
8700 */
8701 transferredCertificateArn?: CertificateArn;
8702 }
8703 export interface TransferData {
8704 /**
8705 * The transfer message.
8706 */
8707 transferMessage?: Message;
8708 /**
8709 * The reason why the transfer was rejected.
8710 */
8711 rejectReason?: Message;
8712 /**
8713 * The date the transfer took place.
8714 */
8715 transferDate?: DateType;
8716 /**
8717 * The date the transfer was accepted.
8718 */
8719 acceptDate?: DateType;
8720 /**
8721 * The date the transfer was rejected.
8722 */
8723 rejectDate?: DateType;
8724 }
8725 export type UndoDeprecate = boolean;
8726 export type UnsignedLong = number;
8727 export interface UntagResourceRequest {
8728 /**
8729 * The ARN of the resource.
8730 */
8731 resourceArn: ResourceArn;
8732 /**
8733 * A list of the keys of the tags to be removed from the resource.
8734 */
8735 tagKeys: TagKeyList;
8736 }
8737 export interface UntagResourceResponse {
8738 }
8739 export interface UpdateAccountAuditConfigurationRequest {
8740 /**
8741 * The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.
8742 */
8743 roleArn?: RoleArn;
8744 /**
8745 * Information about the targets to which audit notifications are sent.
8746 */
8747 auditNotificationTargetConfigurations?: AuditNotificationTargetConfigurations;
8748 /**
8749 * Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled. Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted. You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself. On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.
8750 */
8751 auditCheckConfigurations?: AuditCheckConfigurations;
8752 }
8753 export interface UpdateAccountAuditConfigurationResponse {
8754 }
8755 export interface UpdateAuthorizerRequest {
8756 /**
8757 * The authorizer name.
8758 */
8759 authorizerName: AuthorizerName;
8760 /**
8761 * The ARN of the authorizer's Lambda function.
8762 */
8763 authorizerFunctionArn?: AuthorizerFunctionArn;
8764 /**
8765 * The key used to extract the token from the HTTP headers.
8766 */
8767 tokenKeyName?: TokenKeyName;
8768 /**
8769 * The public keys used to verify the token signature.
8770 */
8771 tokenSigningPublicKeys?: PublicKeyMap;
8772 /**
8773 * The status of the update authorizer request.
8774 */
8775 status?: AuthorizerStatus;
8776 }
8777 export interface UpdateAuthorizerResponse {
8778 /**
8779 * The authorizer name.
8780 */
8781 authorizerName?: AuthorizerName;
8782 /**
8783 * The authorizer ARN.
8784 */
8785 authorizerArn?: AuthorizerArn;
8786 }
8787 export interface UpdateBillingGroupRequest {
8788 /**
8789 * The name of the billing group.
8790 */
8791 billingGroupName: BillingGroupName;
8792 /**
8793 * The properties of the billing group.
8794 */
8795 billingGroupProperties: BillingGroupProperties;
8796 /**
8797 * The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException.
8798 */
8799 expectedVersion?: OptionalVersion;
8800 }
8801 export interface UpdateBillingGroupResponse {
8802 /**
8803 * The latest version of the billing group.
8804 */
8805 version?: Version;
8806 }
8807 export interface UpdateCACertificateParams {
8808 /**
8809 * The action that you want to apply to the CA cerrtificate. The only supported value is DEACTIVATE.
8810 */
8811 action: CACertificateUpdateAction;
8812 }
8813 export interface UpdateCACertificateRequest {
8814 /**
8815 * The CA certificate identifier.
8816 */
8817 certificateId: CertificateId;
8818 /**
8819 * The updated status of the CA certificate. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
8820 */
8821 newStatus?: CACertificateStatus;
8822 /**
8823 * The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".
8824 */
8825 newAutoRegistrationStatus?: AutoRegistrationStatus;
8826 /**
8827 * Information about the registration configuration.
8828 */
8829 registrationConfig?: RegistrationConfig;
8830 /**
8831 * If true, removes auto registration.
8832 */
8833 removeAutoRegistration?: RemoveAutoRegistration;
8834 }
8835 export interface UpdateCertificateRequest {
8836 /**
8837 * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
8838 */
8839 certificateId: CertificateId;
8840 /**
8841 * The new status. Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by AWS IoT. They are not intended for developer use. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
8842 */
8843 newStatus: CertificateStatus;
8844 }
8845 export interface UpdateDeviceCertificateParams {
8846 /**
8847 * The action that you want to apply to the device cerrtificate. The only supported value is DEACTIVATE.
8848 */
8849 action: DeviceCertificateUpdateAction;
8850 }
8851 export interface UpdateDimensionRequest {
8852 /**
8853 * A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
8854 */
8855 name: DimensionName;
8856 /**
8857 * Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
8858 */
8859 stringValues: DimensionStringValues;
8860 }
8861 export interface UpdateDimensionResponse {
8862 /**
8863 * A unique identifier for the dimension.
8864 */
8865 name?: DimensionName;
8866 /**
8867 * The ARN (Amazon resource name) of the created dimension.
8868 */
8869 arn?: DimensionArn;
8870 /**
8871 * The type of the dimension.
8872 */
8873 type?: DimensionType;
8874 /**
8875 * 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.
8876 */
8877 stringValues?: DimensionStringValues;
8878 /**
8879 * The date and time, in milliseconds since epoch, when the dimension was initially created.
8880 */
8881 creationDate?: Timestamp;
8882 /**
8883 * The date and time, in milliseconds since epoch, when the dimension was most recently updated.
8884 */
8885 lastModifiedDate?: Timestamp;
8886 }
8887 export interface UpdateDomainConfigurationRequest {
8888 /**
8889 * The name of the domain configuration to be updated.
8890 */
8891 domainConfigurationName: ReservedDomainConfigurationName;
8892 /**
8893 * An object that specifies the authorization service for a domain.
8894 */
8895 authorizerConfig?: AuthorizerConfig;
8896 /**
8897 * The status to which the domain configuration should be updated.
8898 */
8899 domainConfigurationStatus?: DomainConfigurationStatus;
8900 /**
8901 * Removes the authorization configuration from a domain.
8902 */
8903 removeAuthorizerConfig?: RemoveAuthorizerConfig;
8904 }
8905 export interface UpdateDomainConfigurationResponse {
8906 /**
8907 * The name of the domain configuration that was updated.
8908 */
8909 domainConfigurationName?: ReservedDomainConfigurationName;
8910 /**
8911 * The ARN of the domain configuration that was updated.
8912 */
8913 domainConfigurationArn?: DomainConfigurationArn;
8914 }
8915 export interface UpdateDynamicThingGroupRequest {
8916 /**
8917 * The name of the dynamic thing group to update.
8918 */
8919 thingGroupName: ThingGroupName;
8920 /**
8921 * The dynamic thing group properties to update.
8922 */
8923 thingGroupProperties: ThingGroupProperties;
8924 /**
8925 * The expected version of the dynamic thing group to update.
8926 */
8927 expectedVersion?: OptionalVersion;
8928 /**
8929 * The dynamic thing group index to update. Currently one index is supported: 'AWS_Things'.
8930 */
8931 indexName?: IndexName;
8932 /**
8933 * The dynamic thing group search query string to update.
8934 */
8935 queryString?: QueryString;
8936 /**
8937 * The dynamic thing group query version to update. Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
8938 */
8939 queryVersion?: QueryVersion;
8940 }
8941 export interface UpdateDynamicThingGroupResponse {
8942 /**
8943 * The dynamic thing group version.
8944 */
8945 version?: Version;
8946 }
8947 export interface UpdateEventConfigurationsRequest {
8948 /**
8949 * The new event configuration values.
8950 */
8951 eventConfigurations?: EventConfigurations;
8952 }
8953 export interface UpdateEventConfigurationsResponse {
8954 }
8955 export interface UpdateIndexingConfigurationRequest {
8956 /**
8957 * Thing indexing configuration.
8958 */
8959 thingIndexingConfiguration?: ThingIndexingConfiguration;
8960 /**
8961 * Thing group indexing configuration.
8962 */
8963 thingGroupIndexingConfiguration?: ThingGroupIndexingConfiguration;
8964 }
8965 export interface UpdateIndexingConfigurationResponse {
8966 }
8967 export interface UpdateJobRequest {
8968 /**
8969 * The ID of the job to be updated.
8970 */
8971 jobId: JobId;
8972 /**
8973 * A short text description of the job.
8974 */
8975 description?: JobDescription;
8976 /**
8977 * Configuration information for pre-signed S3 URLs.
8978 */
8979 presignedUrlConfig?: PresignedUrlConfig;
8980 /**
8981 * Allows you to create a staged rollout of the job.
8982 */
8983 jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
8984 /**
8985 * Allows you to create criteria to abort a job.
8986 */
8987 abortConfig?: AbortConfig;
8988 /**
8989 * Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.
8990 */
8991 timeoutConfig?: TimeoutConfig;
8992 }
8993 export interface UpdateMitigationActionRequest {
8994 /**
8995 * The friendly name for the mitigation action. You can't change the name by using UpdateMitigationAction. Instead, you must delete and re-create the mitigation action with the new name.
8996 */
8997 actionName: MitigationActionName;
8998 /**
8999 * The ARN of the IAM role that is used to apply the mitigation action.
9000 */
9001 roleArn?: RoleArn;
9002 /**
9003 * Defines the type of action and the parameters for that action.
9004 */
9005 actionParams?: MitigationActionParams;
9006 }
9007 export interface UpdateMitigationActionResponse {
9008 /**
9009 * The ARN for the new mitigation action.
9010 */
9011 actionArn?: MitigationActionArn;
9012 /**
9013 * A unique identifier for the mitigation action.
9014 */
9015 actionId?: MitigationActionId;
9016 }
9017 export interface UpdateProvisioningTemplateRequest {
9018 /**
9019 * The name of the fleet provisioning template.
9020 */
9021 templateName: TemplateName;
9022 /**
9023 * The description of the fleet provisioning template.
9024 */
9025 description?: TemplateDescription;
9026 /**
9027 * True to enable the fleet provisioning template, otherwise false.
9028 */
9029 enabled?: Enabled;
9030 /**
9031 * The ID of the default provisioning template version.
9032 */
9033 defaultVersionId?: TemplateVersionId;
9034 /**
9035 * The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
9036 */
9037 provisioningRoleArn?: RoleArn;
9038 }
9039 export interface UpdateProvisioningTemplateResponse {
9040 }
9041 export interface UpdateRoleAliasRequest {
9042 /**
9043 * The role alias to update.
9044 */
9045 roleAlias: RoleAlias;
9046 /**
9047 * The role ARN.
9048 */
9049 roleArn?: RoleArn;
9050 /**
9051 * The number of seconds the credential will be valid.
9052 */
9053 credentialDurationSeconds?: CredentialDurationSeconds;
9054 }
9055 export interface UpdateRoleAliasResponse {
9056 /**
9057 * The role alias.
9058 */
9059 roleAlias?: RoleAlias;
9060 /**
9061 * The role alias ARN.
9062 */
9063 roleAliasArn?: RoleAliasArn;
9064 }
9065 export interface UpdateScheduledAuditRequest {
9066 /**
9067 * How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.
9068 */
9069 frequency?: AuditFrequency;
9070 /**
9071 * The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
9072 */
9073 dayOfMonth?: DayOfMonth;
9074 /**
9075 * The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
9076 */
9077 dayOfWeek?: DayOfWeek;
9078 /**
9079 * Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
9080 */
9081 targetCheckNames?: TargetAuditCheckNames;
9082 /**
9083 * The name of the scheduled audit. (Max. 128 chars)
9084 */
9085 scheduledAuditName: ScheduledAuditName;
9086 }
9087 export interface UpdateScheduledAuditResponse {
9088 /**
9089 * The ARN of the scheduled audit.
9090 */
9091 scheduledAuditArn?: ScheduledAuditArn;
9092 }
9093 export interface UpdateSecurityProfileRequest {
9094 /**
9095 * The name of the security profile you want to update.
9096 */
9097 securityProfileName: SecurityProfileName;
9098 /**
9099 * A description of the security profile.
9100 */
9101 securityProfileDescription?: SecurityProfileDescription;
9102 /**
9103 * Specifies the behaviors that, when violated by a device (thing), cause an alert.
9104 */
9105 behaviors?: Behaviors;
9106 /**
9107 * Where the alerts are sent. (Alerts are always sent to the console.)
9108 */
9109 alertTargets?: AlertTargets;
9110 /**
9111 * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Note: This API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
9112 */
9113 additionalMetricsToRetain?: AdditionalMetricsToRetainList;
9114 /**
9115 * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
9116 */
9117 additionalMetricsToRetainV2?: AdditionalMetricsToRetainV2List;
9118 /**
9119 * If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
9120 */
9121 deleteBehaviors?: DeleteBehaviors;
9122 /**
9123 * If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
9124 */
9125 deleteAlertTargets?: DeleteAlertTargets;
9126 /**
9127 * If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
9128 */
9129 deleteAdditionalMetricsToRetain?: DeleteAdditionalMetricsToRetain;
9130 /**
9131 * The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
9132 */
9133 expectedVersion?: OptionalVersion;
9134 }
9135 export interface UpdateSecurityProfileResponse {
9136 /**
9137 * The name of the security profile that was updated.
9138 */
9139 securityProfileName?: SecurityProfileName;
9140 /**
9141 * The ARN of the security profile that was updated.
9142 */
9143 securityProfileArn?: SecurityProfileArn;
9144 /**
9145 * The description of the security profile.
9146 */
9147 securityProfileDescription?: SecurityProfileDescription;
9148 /**
9149 * Specifies the behaviors that, when violated by a device (thing), cause an alert.
9150 */
9151 behaviors?: Behaviors;
9152 /**
9153 * Where the alerts are sent. (Alerts are always sent to the console.)
9154 */
9155 alertTargets?: AlertTargets;
9156 /**
9157 * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here. Note: This API field is deprecated. Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.
9158 */
9159 additionalMetricsToRetain?: AdditionalMetricsToRetainList;
9160 /**
9161 * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
9162 */
9163 additionalMetricsToRetainV2?: AdditionalMetricsToRetainV2List;
9164 /**
9165 * The updated version of the security profile.
9166 */
9167 version?: Version;
9168 /**
9169 * The time the security profile was created.
9170 */
9171 creationDate?: Timestamp;
9172 /**
9173 * The time the security profile was last modified.
9174 */
9175 lastModifiedDate?: Timestamp;
9176 }
9177 export interface UpdateStreamRequest {
9178 /**
9179 * The stream ID.
9180 */
9181 streamId: StreamId;
9182 /**
9183 * The description of the stream.
9184 */
9185 description?: StreamDescription;
9186 /**
9187 * The files associated with the stream.
9188 */
9189 files?: StreamFiles;
9190 /**
9191 * An IAM role that allows the IoT service principal assumes to access your S3 files.
9192 */
9193 roleArn?: RoleArn;
9194 }
9195 export interface UpdateStreamResponse {
9196 /**
9197 * The stream ID.
9198 */
9199 streamId?: StreamId;
9200 /**
9201 * The stream ARN.
9202 */
9203 streamArn?: StreamArn;
9204 /**
9205 * A description of the stream.
9206 */
9207 description?: StreamDescription;
9208 /**
9209 * The stream version.
9210 */
9211 streamVersion?: StreamVersion;
9212 }
9213 export interface UpdateThingGroupRequest {
9214 /**
9215 * The thing group to update.
9216 */
9217 thingGroupName: ThingGroupName;
9218 /**
9219 * The thing group properties.
9220 */
9221 thingGroupProperties: ThingGroupProperties;
9222 /**
9223 * The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.
9224 */
9225 expectedVersion?: OptionalVersion;
9226 }
9227 export interface UpdateThingGroupResponse {
9228 /**
9229 * The version of the updated thing group.
9230 */
9231 version?: Version;
9232 }
9233 export interface UpdateThingGroupsForThingRequest {
9234 /**
9235 * The thing whose group memberships will be updated.
9236 */
9237 thingName?: ThingName;
9238 /**
9239 * The groups to which the thing will be added.
9240 */
9241 thingGroupsToAdd?: ThingGroupList;
9242 /**
9243 * The groups from which the thing will be removed.
9244 */
9245 thingGroupsToRemove?: ThingGroupList;
9246 /**
9247 * Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
9248 */
9249 overrideDynamicGroups?: OverrideDynamicGroups;
9250 }
9251 export interface UpdateThingGroupsForThingResponse {
9252 }
9253 export interface UpdateThingRequest {
9254 /**
9255 * The name of the thing to update.
9256 */
9257 thingName: ThingName;
9258 /**
9259 * The name of the thing type.
9260 */
9261 thingTypeName?: ThingTypeName;
9262 /**
9263 * A list of thing attributes, a JSON string containing name-value pairs. For example: {\"attributes\":{\"name1\":\"value2\"}} This data is used to add new attributes or update existing attributes.
9264 */
9265 attributePayload?: AttributePayload;
9266 /**
9267 * The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.
9268 */
9269 expectedVersion?: OptionalVersion;
9270 /**
9271 * Remove a thing type association. If true, the association is removed.
9272 */
9273 removeThingType?: RemoveThingType;
9274 }
9275 export interface UpdateThingResponse {
9276 }
9277 export interface UpdateTopicRuleDestinationRequest {
9278 /**
9279 * The ARN of the topic rule destination.
9280 */
9281 arn: AwsArn;
9282 /**
9283 * The status of the topic rule destination. Valid values are: IN_PROGRESS A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. ENABLED Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
9284 */
9285 status: TopicRuleDestinationStatus;
9286 }
9287 export interface UpdateTopicRuleDestinationResponse {
9288 }
9289 export type Url = string;
9290 export type UseBase64 = boolean;
9291 export type Valid = boolean;
9292 export interface ValidateSecurityProfileBehaviorsRequest {
9293 /**
9294 * Specifies the behaviors that, when violated by a device (thing), cause an alert.
9295 */
9296 behaviors: Behaviors;
9297 }
9298 export interface ValidateSecurityProfileBehaviorsResponse {
9299 /**
9300 * True if the behaviors were valid.
9301 */
9302 valid?: Valid;
9303 /**
9304 * The list of any errors found in the behaviors.
9305 */
9306 validationErrors?: ValidationErrors;
9307 }
9308 export interface ValidationError {
9309 /**
9310 * The description of an error found in the behaviors.
9311 */
9312 errorMessage?: ErrorMessage;
9313 }
9314 export type ValidationErrors = ValidationError[];
9315 export type Value = string;
9316 export type Variance = number;
9317 export type Version = number;
9318 export type VersionNumber = number;
9319 export interface ViolationEvent {
9320 /**
9321 * The ID of the violation event.
9322 */
9323 violationId?: ViolationId;
9324 /**
9325 * The name of the thing responsible for the violation event.
9326 */
9327 thingName?: DeviceDefenderThingName;
9328 /**
9329 * The name of the security profile whose behavior was violated.
9330 */
9331 securityProfileName?: SecurityProfileName;
9332 /**
9333 * The behavior which was violated.
9334 */
9335 behavior?: Behavior;
9336 /**
9337 * The value of the metric (the measurement).
9338 */
9339 metricValue?: MetricValue;
9340 /**
9341 * The type of violation event.
9342 */
9343 violationEventType?: ViolationEventType;
9344 /**
9345 * The time the violation event occurred.
9346 */
9347 violationEventTime?: Timestamp;
9348 }
9349 export type ViolationEventType = "in-alarm"|"alarm-cleared"|"alarm-invalidated"|string;
9350 export type ViolationEvents = ViolationEvent[];
9351 export type ViolationId = string;
9352 export type WaitingForDataCollectionChecksCount = number;
9353 /**
9354 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
9355 */
9356 export type apiVersion = "2015-05-28"|"latest"|string;
9357 export interface ClientApiVersions {
9358 /**
9359 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
9360 */
9361 apiVersion?: apiVersion;
9362 }
9363 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
9364 /**
9365 * Contains interfaces for use with the Iot client.
9366 */
9367 export import Types = Iot;
9368}
9369export = Iot;