aws-sdk 2.976.0 → 2.980.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -1
- package/README.md +1 -1
- package/apis/cloudformation-2010-05-15.min.json +27 -1
- package/apis/compute-optimizer-2019-11-01.min.json +98 -25
- package/apis/ec2-2016-11-15.min.json +8 -1
- package/apis/elasticmapreduce-2009-03-31.min.json +84 -21
- package/apis/firehose-2015-08-04.min.json +104 -79
- package/apis/iot-2015-05-28.min.json +481 -232
- package/apis/iot-2015-05-28.paginators.json +12 -0
- package/apis/kms-2014-11-01.examples.json +100 -94
- package/apis/kms-2014-11-01.min.json +54 -34
- package/apis/rekognition-2016-06-27.min.json +134 -110
- package/apis/s3-2006-03-01.examples.json +162 -162
- package/clients/cloudformation.d.ts +116 -80
- package/clients/codebuild.d.ts +3 -3
- package/clients/computeoptimizer.d.ts +181 -81
- package/clients/ec2.d.ts +34 -22
- package/clients/emr.d.ts +78 -15
- package/clients/firehose.d.ts +39 -10
- package/clients/iot.d.ts +829 -506
- package/clients/kms.d.ts +293 -280
- package/clients/memorydb.d.ts +2 -2
- package/clients/polly.d.ts +2 -2
- package/clients/rekognition.d.ts +27 -7
- package/clients/s3.d.ts +6 -6
- package/clients/sqs.d.ts +4 -4
- package/clients/transcribeservice.d.ts +3 -3
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +14 -16
- package/dist/aws-sdk.js +907 -481
- package/dist/aws-sdk.min.js +85 -85
- package/dist/xml2js.js +2 -3
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/iot.d.ts
CHANGED
|
@@ -12,443 +12,459 @@ declare class Iot extends Service {
|
|
|
12
12
|
constructor(options?: Iot.Types.ClientConfiguration)
|
|
13
13
|
config: Config & Iot.Types.ClientConfiguration;
|
|
14
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.
|
|
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. Requires permission to access the AcceptCertificateTransfer action.
|
|
16
16
|
*/
|
|
17
17
|
acceptCertificateTransfer(params: Iot.Types.AcceptCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
18
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.
|
|
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. Requires permission to access the AcceptCertificateTransfer action.
|
|
20
20
|
*/
|
|
21
21
|
acceptCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
22
22
|
/**
|
|
23
|
-
* Adds a thing to a billing group.
|
|
23
|
+
* Adds a thing to a billing group. Requires permission to access the AddThingToBillingGroup action.
|
|
24
24
|
*/
|
|
25
25
|
addThingToBillingGroup(params: Iot.Types.AddThingToBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.AddThingToBillingGroupResponse) => void): Request<Iot.Types.AddThingToBillingGroupResponse, AWSError>;
|
|
26
26
|
/**
|
|
27
|
-
* Adds a thing to a billing group.
|
|
27
|
+
* Adds a thing to a billing group. Requires permission to access the AddThingToBillingGroup action.
|
|
28
28
|
*/
|
|
29
29
|
addThingToBillingGroup(callback?: (err: AWSError, data: Iot.Types.AddThingToBillingGroupResponse) => void): Request<Iot.Types.AddThingToBillingGroupResponse, AWSError>;
|
|
30
30
|
/**
|
|
31
|
-
* Adds a thing to a thing group.
|
|
31
|
+
* Adds a thing to a thing group. Requires permission to access the AddThingToThingGroup action.
|
|
32
32
|
*/
|
|
33
33
|
addThingToThingGroup(params: Iot.Types.AddThingToThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.AddThingToThingGroupResponse) => void): Request<Iot.Types.AddThingToThingGroupResponse, AWSError>;
|
|
34
34
|
/**
|
|
35
|
-
* Adds a thing to a thing group.
|
|
35
|
+
* Adds a thing to a thing group. Requires permission to access the AddThingToThingGroup action.
|
|
36
36
|
*/
|
|
37
37
|
addThingToThingGroup(callback?: (err: AWSError, data: Iot.Types.AddThingToThingGroupResponse) => void): Request<Iot.Types.AddThingToThingGroupResponse, AWSError>;
|
|
38
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.
|
|
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. Requires permission to access the AssociateTargetsWithJob action.
|
|
40
40
|
*/
|
|
41
41
|
associateTargetsWithJob(params: Iot.Types.AssociateTargetsWithJobRequest, callback?: (err: AWSError, data: Iot.Types.AssociateTargetsWithJobResponse) => void): Request<Iot.Types.AssociateTargetsWithJobResponse, AWSError>;
|
|
42
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.
|
|
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. Requires permission to access the AssociateTargetsWithJob action.
|
|
44
44
|
*/
|
|
45
45
|
associateTargetsWithJob(callback?: (err: AWSError, data: Iot.Types.AssociateTargetsWithJobResponse) => void): Request<Iot.Types.AssociateTargetsWithJobResponse, AWSError>;
|
|
46
46
|
/**
|
|
47
|
-
* Attaches the specified policy to the specified principal (certificate or other credential).
|
|
47
|
+
* Attaches the specified policy to the specified principal (certificate or other credential). Requires permission to access the AttachPolicy action.
|
|
48
48
|
*/
|
|
49
49
|
attachPolicy(params: Iot.Types.AttachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
50
50
|
/**
|
|
51
|
-
* Attaches the specified policy to the specified principal (certificate or other credential).
|
|
51
|
+
* Attaches the specified policy to the specified principal (certificate or other credential). Requires permission to access the AttachPolicy action.
|
|
52
52
|
*/
|
|
53
53
|
attachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
54
54
|
/**
|
|
55
|
-
* Attaches the specified policy to the specified principal (certificate or other credential). Note: This
|
|
55
|
+
* Attaches the specified policy to the specified principal (certificate or other credential). Note: This action is deprecated. Please use AttachPolicy instead. Requires permission to access the AttachPrincipalPolicy action.
|
|
56
56
|
*/
|
|
57
57
|
attachPrincipalPolicy(params: Iot.Types.AttachPrincipalPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
58
58
|
/**
|
|
59
|
-
* Attaches the specified policy to the specified principal (certificate or other credential). Note: This
|
|
59
|
+
* Attaches the specified policy to the specified principal (certificate or other credential). Note: This action is deprecated. Please use AttachPolicy instead. Requires permission to access the AttachPrincipalPolicy action.
|
|
60
60
|
*/
|
|
61
61
|
attachPrincipalPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
62
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.
|
|
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. Requires permission to access the AttachSecurityProfile action.
|
|
64
64
|
*/
|
|
65
65
|
attachSecurityProfile(params: Iot.Types.AttachSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.AttachSecurityProfileResponse) => void): Request<Iot.Types.AttachSecurityProfileResponse, AWSError>;
|
|
66
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.
|
|
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. Requires permission to access the AttachSecurityProfile action.
|
|
68
68
|
*/
|
|
69
69
|
attachSecurityProfile(callback?: (err: AWSError, data: Iot.Types.AttachSecurityProfileResponse) => void): Request<Iot.Types.AttachSecurityProfileResponse, AWSError>;
|
|
70
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.
|
|
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. Requires permission to access the AttachThingPrincipal action.
|
|
72
72
|
*/
|
|
73
73
|
attachThingPrincipal(params: Iot.Types.AttachThingPrincipalRequest, callback?: (err: AWSError, data: Iot.Types.AttachThingPrincipalResponse) => void): Request<Iot.Types.AttachThingPrincipalResponse, AWSError>;
|
|
74
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.
|
|
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. Requires permission to access the AttachThingPrincipal action.
|
|
76
76
|
*/
|
|
77
77
|
attachThingPrincipal(callback?: (err: AWSError, data: Iot.Types.AttachThingPrincipalResponse) => void): Request<Iot.Types.AttachThingPrincipalResponse, AWSError>;
|
|
78
78
|
/**
|
|
79
|
-
* Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
|
|
79
|
+
* Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs. Requires permission to access the CancelAuditMitigationActionsTask action.
|
|
80
80
|
*/
|
|
81
81
|
cancelAuditMitigationActionsTask(params: Iot.Types.CancelAuditMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.CancelAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelAuditMitigationActionsTaskResponse, AWSError>;
|
|
82
82
|
/**
|
|
83
|
-
* Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
|
|
83
|
+
* Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs. Requires permission to access the CancelAuditMitigationActionsTask action.
|
|
84
84
|
*/
|
|
85
85
|
cancelAuditMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.CancelAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelAuditMitigationActionsTaskResponse, AWSError>;
|
|
86
86
|
/**
|
|
87
|
-
* Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.
|
|
87
|
+
* Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs. Requires permission to access the CancelAuditTask action.
|
|
88
88
|
*/
|
|
89
89
|
cancelAuditTask(params: Iot.Types.CancelAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.CancelAuditTaskResponse) => void): Request<Iot.Types.CancelAuditTaskResponse, AWSError>;
|
|
90
90
|
/**
|
|
91
|
-
* Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.
|
|
91
|
+
* Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs. Requires permission to access the CancelAuditTask action.
|
|
92
92
|
*/
|
|
93
93
|
cancelAuditTask(callback?: (err: AWSError, data: Iot.Types.CancelAuditTaskResponse) => void): Request<Iot.Types.CancelAuditTaskResponse, AWSError>;
|
|
94
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,
|
|
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, 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. Requires permission to access the CancelCertificateTransfer action.
|
|
96
96
|
*/
|
|
97
97
|
cancelCertificateTransfer(params: Iot.Types.CancelCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
98
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,
|
|
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, 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. Requires permission to access the CancelCertificateTransfer action.
|
|
100
100
|
*/
|
|
101
101
|
cancelCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
102
102
|
/**
|
|
103
|
-
* Cancels a Device Defender ML Detect mitigation action.
|
|
103
|
+
* Cancels a Device Defender ML Detect mitigation action. Requires permission to access the CancelDetectMitigationActionsTask action.
|
|
104
104
|
*/
|
|
105
105
|
cancelDetectMitigationActionsTask(params: Iot.Types.CancelDetectMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.CancelDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelDetectMitigationActionsTaskResponse, AWSError>;
|
|
106
106
|
/**
|
|
107
|
-
* Cancels a Device Defender ML Detect mitigation action.
|
|
107
|
+
* Cancels a Device Defender ML Detect mitigation action. Requires permission to access the CancelDetectMitigationActionsTask action.
|
|
108
108
|
*/
|
|
109
109
|
cancelDetectMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.CancelDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelDetectMitigationActionsTaskResponse, AWSError>;
|
|
110
110
|
/**
|
|
111
|
-
* Cancels a job.
|
|
111
|
+
* Cancels a job. Requires permission to access the CancelJob action.
|
|
112
112
|
*/
|
|
113
113
|
cancelJob(params: Iot.Types.CancelJobRequest, callback?: (err: AWSError, data: Iot.Types.CancelJobResponse) => void): Request<Iot.Types.CancelJobResponse, AWSError>;
|
|
114
114
|
/**
|
|
115
|
-
* Cancels a job.
|
|
115
|
+
* Cancels a job. Requires permission to access the CancelJob action.
|
|
116
116
|
*/
|
|
117
117
|
cancelJob(callback?: (err: AWSError, data: Iot.Types.CancelJobResponse) => void): Request<Iot.Types.CancelJobResponse, AWSError>;
|
|
118
118
|
/**
|
|
119
|
-
* Cancels the execution of a job for a given thing.
|
|
119
|
+
* Cancels the execution of a job for a given thing. Requires permission to access the CancelJobExecution action.
|
|
120
120
|
*/
|
|
121
121
|
cancelJobExecution(params: Iot.Types.CancelJobExecutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
122
122
|
/**
|
|
123
|
-
* Cancels the execution of a job for a given thing.
|
|
123
|
+
* Cancels the execution of a job for a given thing. Requires permission to access the CancelJobExecution action.
|
|
124
124
|
*/
|
|
125
125
|
cancelJobExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
126
126
|
/**
|
|
127
|
-
* Clears the default authorizer.
|
|
127
|
+
* Clears the default authorizer. Requires permission to access the ClearDefaultAuthorizer action.
|
|
128
128
|
*/
|
|
129
129
|
clearDefaultAuthorizer(params: Iot.Types.ClearDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.ClearDefaultAuthorizerResponse) => void): Request<Iot.Types.ClearDefaultAuthorizerResponse, AWSError>;
|
|
130
130
|
/**
|
|
131
|
-
* Clears the default authorizer.
|
|
131
|
+
* Clears the default authorizer. Requires permission to access the ClearDefaultAuthorizer action.
|
|
132
132
|
*/
|
|
133
133
|
clearDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.ClearDefaultAuthorizerResponse) => void): Request<Iot.Types.ClearDefaultAuthorizerResponse, AWSError>;
|
|
134
134
|
/**
|
|
135
|
-
* Confirms a topic rule destination. When you create a rule requiring a destination,
|
|
135
|
+
* Confirms a topic rule destination. When you create a rule requiring a destination, 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. Requires permission to access the ConfirmTopicRuleDestination action.
|
|
136
136
|
*/
|
|
137
137
|
confirmTopicRuleDestination(params: Iot.Types.ConfirmTopicRuleDestinationRequest, callback?: (err: AWSError, data: Iot.Types.ConfirmTopicRuleDestinationResponse) => void): Request<Iot.Types.ConfirmTopicRuleDestinationResponse, AWSError>;
|
|
138
138
|
/**
|
|
139
|
-
* Confirms a topic rule destination. When you create a rule requiring a destination,
|
|
139
|
+
* Confirms a topic rule destination. When you create a rule requiring a destination, 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. Requires permission to access the ConfirmTopicRuleDestination action.
|
|
140
140
|
*/
|
|
141
141
|
confirmTopicRuleDestination(callback?: (err: AWSError, data: Iot.Types.ConfirmTopicRuleDestinationResponse) => void): Request<Iot.Types.ConfirmTopicRuleDestinationResponse, AWSError>;
|
|
142
142
|
/**
|
|
143
|
-
* Creates a Device Defender audit suppression.
|
|
143
|
+
* Creates a Device Defender audit suppression. Requires permission to access the CreateAuditSuppression action.
|
|
144
144
|
*/
|
|
145
145
|
createAuditSuppression(params: Iot.Types.CreateAuditSuppressionRequest, callback?: (err: AWSError, data: Iot.Types.CreateAuditSuppressionResponse) => void): Request<Iot.Types.CreateAuditSuppressionResponse, AWSError>;
|
|
146
146
|
/**
|
|
147
|
-
* Creates a Device Defender audit suppression.
|
|
147
|
+
* Creates a Device Defender audit suppression. Requires permission to access the CreateAuditSuppression action.
|
|
148
148
|
*/
|
|
149
149
|
createAuditSuppression(callback?: (err: AWSError, data: Iot.Types.CreateAuditSuppressionResponse) => void): Request<Iot.Types.CreateAuditSuppressionResponse, AWSError>;
|
|
150
150
|
/**
|
|
151
|
-
* Creates an authorizer.
|
|
151
|
+
* Creates an authorizer. Requires permission to access the CreateAuthorizer action.
|
|
152
152
|
*/
|
|
153
153
|
createAuthorizer(params: Iot.Types.CreateAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.CreateAuthorizerResponse) => void): Request<Iot.Types.CreateAuthorizerResponse, AWSError>;
|
|
154
154
|
/**
|
|
155
|
-
* Creates an authorizer.
|
|
155
|
+
* Creates an authorizer. Requires permission to access the CreateAuthorizer action.
|
|
156
156
|
*/
|
|
157
157
|
createAuthorizer(callback?: (err: AWSError, data: Iot.Types.CreateAuthorizerResponse) => void): Request<Iot.Types.CreateAuthorizerResponse, AWSError>;
|
|
158
158
|
/**
|
|
159
|
-
* Creates a billing group.
|
|
159
|
+
* Creates a billing group. Requires permission to access the CreateBillingGroup action.
|
|
160
160
|
*/
|
|
161
161
|
createBillingGroup(params: Iot.Types.CreateBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateBillingGroupResponse) => void): Request<Iot.Types.CreateBillingGroupResponse, AWSError>;
|
|
162
162
|
/**
|
|
163
|
-
* Creates a billing group.
|
|
163
|
+
* Creates a billing group. Requires permission to access the CreateBillingGroup action.
|
|
164
164
|
*/
|
|
165
165
|
createBillingGroup(callback?: (err: AWSError, data: Iot.Types.CreateBillingGroupResponse) => void): Request<Iot.Types.CreateBillingGroupResponse, AWSError>;
|
|
166
166
|
/**
|
|
167
|
-
* 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
|
|
167
|
+
* 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. Requires permission to access the CreateCertificateFromCsr action. 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 Amazon Web Services 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: > 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: > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
|
|
168
168
|
*/
|
|
169
169
|
createCertificateFromCsr(params: Iot.Types.CreateCertificateFromCsrRequest, callback?: (err: AWSError, data: Iot.Types.CreateCertificateFromCsrResponse) => void): Request<Iot.Types.CreateCertificateFromCsrResponse, AWSError>;
|
|
170
170
|
/**
|
|
171
|
-
* 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
|
|
171
|
+
* 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. Requires permission to access the CreateCertificateFromCsr action. 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 Amazon Web Services 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: > 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: > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
|
|
172
172
|
*/
|
|
173
173
|
createCertificateFromCsr(callback?: (err: AWSError, data: Iot.Types.CreateCertificateFromCsrResponse) => void): Request<Iot.Types.CreateCertificateFromCsrResponse, AWSError>;
|
|
174
174
|
/**
|
|
175
|
-
* Use this API to define a Custom Metric published by your devices to Device Defender.
|
|
175
|
+
* Use this API to define a Custom Metric published by your devices to Device Defender. Requires permission to access the CreateCustomMetric action.
|
|
176
176
|
*/
|
|
177
177
|
createCustomMetric(params: Iot.Types.CreateCustomMetricRequest, callback?: (err: AWSError, data: Iot.Types.CreateCustomMetricResponse) => void): Request<Iot.Types.CreateCustomMetricResponse, AWSError>;
|
|
178
178
|
/**
|
|
179
|
-
* Use this API to define a Custom Metric published by your devices to Device Defender.
|
|
179
|
+
* Use this API to define a Custom Metric published by your devices to Device Defender. Requires permission to access the CreateCustomMetric action.
|
|
180
180
|
*/
|
|
181
181
|
createCustomMetric(callback?: (err: AWSError, data: Iot.Types.CreateCustomMetricResponse) => void): Request<Iot.Types.CreateCustomMetricResponse, AWSError>;
|
|
182
182
|
/**
|
|
183
|
-
* Create a dimension that you can use to limit the scope of a metric used in a security profile for
|
|
183
|
+
* Create a dimension that you can use to limit the scope of a metric used in a security profile for 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. Requires permission to access the CreateDimension action.
|
|
184
184
|
*/
|
|
185
185
|
createDimension(params: Iot.Types.CreateDimensionRequest, callback?: (err: AWSError, data: Iot.Types.CreateDimensionResponse) => void): Request<Iot.Types.CreateDimensionResponse, AWSError>;
|
|
186
186
|
/**
|
|
187
|
-
* Create a dimension that you can use to limit the scope of a metric used in a security profile for
|
|
187
|
+
* Create a dimension that you can use to limit the scope of a metric used in a security profile for 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. Requires permission to access the CreateDimension action.
|
|
188
188
|
*/
|
|
189
189
|
createDimension(callback?: (err: AWSError, data: Iot.Types.CreateDimensionResponse) => void): Request<Iot.Types.CreateDimensionResponse, AWSError>;
|
|
190
190
|
/**
|
|
191
|
-
* Creates a domain configuration.
|
|
191
|
+
* Creates a domain configuration. Requires permission to access the CreateDomainConfiguration action.
|
|
192
192
|
*/
|
|
193
193
|
createDomainConfiguration(params: Iot.Types.CreateDomainConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.CreateDomainConfigurationResponse) => void): Request<Iot.Types.CreateDomainConfigurationResponse, AWSError>;
|
|
194
194
|
/**
|
|
195
|
-
* Creates a domain configuration.
|
|
195
|
+
* Creates a domain configuration. Requires permission to access the CreateDomainConfiguration action.
|
|
196
196
|
*/
|
|
197
197
|
createDomainConfiguration(callback?: (err: AWSError, data: Iot.Types.CreateDomainConfigurationResponse) => void): Request<Iot.Types.CreateDomainConfigurationResponse, AWSError>;
|
|
198
198
|
/**
|
|
199
|
-
* Creates a dynamic thing group.
|
|
199
|
+
* Creates a dynamic thing group. Requires permission to access the CreateDynamicThingGroup action.
|
|
200
200
|
*/
|
|
201
201
|
createDynamicThingGroup(params: Iot.Types.CreateDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateDynamicThingGroupResponse) => void): Request<Iot.Types.CreateDynamicThingGroupResponse, AWSError>;
|
|
202
202
|
/**
|
|
203
|
-
* Creates a dynamic thing group.
|
|
203
|
+
* Creates a dynamic thing group. Requires permission to access the CreateDynamicThingGroup action.
|
|
204
204
|
*/
|
|
205
205
|
createDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.CreateDynamicThingGroupResponse) => void): Request<Iot.Types.CreateDynamicThingGroupResponse, AWSError>;
|
|
206
206
|
/**
|
|
207
|
-
* Creates a
|
|
207
|
+
* Creates a fleet metric. Requires permission to access the CreateFleetMetric action.
|
|
208
|
+
*/
|
|
209
|
+
createFleetMetric(params: Iot.Types.CreateFleetMetricRequest, callback?: (err: AWSError, data: Iot.Types.CreateFleetMetricResponse) => void): Request<Iot.Types.CreateFleetMetricResponse, AWSError>;
|
|
210
|
+
/**
|
|
211
|
+
* Creates a fleet metric. Requires permission to access the CreateFleetMetric action.
|
|
212
|
+
*/
|
|
213
|
+
createFleetMetric(callback?: (err: AWSError, data: Iot.Types.CreateFleetMetricResponse) => void): Request<Iot.Types.CreateFleetMetricResponse, AWSError>;
|
|
214
|
+
/**
|
|
215
|
+
* Creates a job. Requires permission to access the CreateJob action.
|
|
208
216
|
*/
|
|
209
217
|
createJob(params: Iot.Types.CreateJobRequest, callback?: (err: AWSError, data: Iot.Types.CreateJobResponse) => void): Request<Iot.Types.CreateJobResponse, AWSError>;
|
|
210
218
|
/**
|
|
211
|
-
* Creates a job.
|
|
219
|
+
* Creates a job. Requires permission to access the CreateJob action.
|
|
212
220
|
*/
|
|
213
221
|
createJob(callback?: (err: AWSError, data: Iot.Types.CreateJobResponse) => void): Request<Iot.Types.CreateJobResponse, AWSError>;
|
|
214
222
|
/**
|
|
215
|
-
* Creates a job template.
|
|
223
|
+
* Creates a job template. Requires permission to access the CreateJobTemplate action.
|
|
216
224
|
*/
|
|
217
225
|
createJobTemplate(params: Iot.Types.CreateJobTemplateRequest, callback?: (err: AWSError, data: Iot.Types.CreateJobTemplateResponse) => void): Request<Iot.Types.CreateJobTemplateResponse, AWSError>;
|
|
218
226
|
/**
|
|
219
|
-
* Creates a job template.
|
|
227
|
+
* Creates a job template. Requires permission to access the CreateJobTemplate action.
|
|
220
228
|
*/
|
|
221
229
|
createJobTemplate(callback?: (err: AWSError, data: Iot.Types.CreateJobTemplateResponse) => void): Request<Iot.Types.CreateJobTemplateResponse, AWSError>;
|
|
222
230
|
/**
|
|
223
|
-
* 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
|
|
231
|
+
* 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 IoT issues the private key for this certificate, so it is important to keep it in a secure location. Requires permission to access the CreateKeysAndCertificate action.
|
|
224
232
|
*/
|
|
225
233
|
createKeysAndCertificate(params: Iot.Types.CreateKeysAndCertificateRequest, callback?: (err: AWSError, data: Iot.Types.CreateKeysAndCertificateResponse) => void): Request<Iot.Types.CreateKeysAndCertificateResponse, AWSError>;
|
|
226
234
|
/**
|
|
227
|
-
* 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
|
|
235
|
+
* 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 IoT issues the private key for this certificate, so it is important to keep it in a secure location. Requires permission to access the CreateKeysAndCertificate action.
|
|
228
236
|
*/
|
|
229
237
|
createKeysAndCertificate(callback?: (err: AWSError, data: Iot.Types.CreateKeysAndCertificateResponse) => void): Request<Iot.Types.CreateKeysAndCertificateResponse, AWSError>;
|
|
230
238
|
/**
|
|
231
|
-
* Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.
|
|
239
|
+
* Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change. Requires permission to access the CreateMitigationAction action.
|
|
232
240
|
*/
|
|
233
241
|
createMitigationAction(params: Iot.Types.CreateMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.CreateMitigationActionResponse) => void): Request<Iot.Types.CreateMitigationActionResponse, AWSError>;
|
|
234
242
|
/**
|
|
235
|
-
* Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.
|
|
243
|
+
* Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change. Requires permission to access the CreateMitigationAction action.
|
|
236
244
|
*/
|
|
237
245
|
createMitigationAction(callback?: (err: AWSError, data: Iot.Types.CreateMitigationActionResponse) => void): Request<Iot.Types.CreateMitigationActionResponse, AWSError>;
|
|
238
246
|
/**
|
|
239
|
-
* Creates an
|
|
247
|
+
* Creates an IoT OTA update on a target group of things or groups. Requires permission to access the CreateOTAUpdate action.
|
|
240
248
|
*/
|
|
241
249
|
createOTAUpdate(params: Iot.Types.CreateOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.CreateOTAUpdateResponse) => void): Request<Iot.Types.CreateOTAUpdateResponse, AWSError>;
|
|
242
250
|
/**
|
|
243
|
-
* Creates an
|
|
251
|
+
* Creates an IoT OTA update on a target group of things or groups. Requires permission to access the CreateOTAUpdate action.
|
|
244
252
|
*/
|
|
245
253
|
createOTAUpdate(callback?: (err: AWSError, data: Iot.Types.CreateOTAUpdateResponse) => void): Request<Iot.Types.CreateOTAUpdateResponse, AWSError>;
|
|
246
254
|
/**
|
|
247
|
-
* Creates an
|
|
255
|
+
* Creates an 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. Requires permission to access the CreatePolicy action.
|
|
248
256
|
*/
|
|
249
257
|
createPolicy(params: Iot.Types.CreatePolicyRequest, callback?: (err: AWSError, data: Iot.Types.CreatePolicyResponse) => void): Request<Iot.Types.CreatePolicyResponse, AWSError>;
|
|
250
258
|
/**
|
|
251
|
-
* Creates an
|
|
259
|
+
* Creates an 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. Requires permission to access the CreatePolicy action.
|
|
252
260
|
*/
|
|
253
261
|
createPolicy(callback?: (err: AWSError, data: Iot.Types.CreatePolicyResponse) => void): Request<Iot.Types.CreatePolicyResponse, AWSError>;
|
|
254
262
|
/**
|
|
255
|
-
* Creates a new version of the specified
|
|
263
|
+
* Creates a new version of the specified 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). Requires permission to access the CreatePolicyVersion action.
|
|
256
264
|
*/
|
|
257
265
|
createPolicyVersion(params: Iot.Types.CreatePolicyVersionRequest, callback?: (err: AWSError, data: Iot.Types.CreatePolicyVersionResponse) => void): Request<Iot.Types.CreatePolicyVersionResponse, AWSError>;
|
|
258
266
|
/**
|
|
259
|
-
* Creates a new version of the specified
|
|
267
|
+
* Creates a new version of the specified 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). Requires permission to access the CreatePolicyVersion action.
|
|
260
268
|
*/
|
|
261
269
|
createPolicyVersion(callback?: (err: AWSError, data: Iot.Types.CreatePolicyVersionResponse) => void): Request<Iot.Types.CreatePolicyVersionResponse, AWSError>;
|
|
262
270
|
/**
|
|
263
|
-
* Creates a provisioning claim.
|
|
271
|
+
* Creates a provisioning claim. Requires permission to access the CreateProvisioningClaim action.
|
|
264
272
|
*/
|
|
265
273
|
createProvisioningClaim(params: Iot.Types.CreateProvisioningClaimRequest, callback?: (err: AWSError, data: Iot.Types.CreateProvisioningClaimResponse) => void): Request<Iot.Types.CreateProvisioningClaimResponse, AWSError>;
|
|
266
274
|
/**
|
|
267
|
-
* Creates a provisioning claim.
|
|
275
|
+
* Creates a provisioning claim. Requires permission to access the CreateProvisioningClaim action.
|
|
268
276
|
*/
|
|
269
277
|
createProvisioningClaim(callback?: (err: AWSError, data: Iot.Types.CreateProvisioningClaimResponse) => void): Request<Iot.Types.CreateProvisioningClaimResponse, AWSError>;
|
|
270
278
|
/**
|
|
271
|
-
* Creates a fleet provisioning template.
|
|
279
|
+
* Creates a fleet provisioning template. Requires permission to access the CreateProvisioningTemplate action.
|
|
272
280
|
*/
|
|
273
281
|
createProvisioningTemplate(params: Iot.Types.CreateProvisioningTemplateRequest, callback?: (err: AWSError, data: Iot.Types.CreateProvisioningTemplateResponse) => void): Request<Iot.Types.CreateProvisioningTemplateResponse, AWSError>;
|
|
274
282
|
/**
|
|
275
|
-
* Creates a fleet provisioning template.
|
|
283
|
+
* Creates a fleet provisioning template. Requires permission to access the CreateProvisioningTemplate action.
|
|
276
284
|
*/
|
|
277
285
|
createProvisioningTemplate(callback?: (err: AWSError, data: Iot.Types.CreateProvisioningTemplateResponse) => void): Request<Iot.Types.CreateProvisioningTemplateResponse, AWSError>;
|
|
278
286
|
/**
|
|
279
|
-
* Creates a new version of a fleet provisioning template.
|
|
287
|
+
* Creates a new version of a fleet provisioning template. Requires permission to access the CreateProvisioningTemplateVersion action.
|
|
280
288
|
*/
|
|
281
289
|
createProvisioningTemplateVersion(params: Iot.Types.CreateProvisioningTemplateVersionRequest, callback?: (err: AWSError, data: Iot.Types.CreateProvisioningTemplateVersionResponse) => void): Request<Iot.Types.CreateProvisioningTemplateVersionResponse, AWSError>;
|
|
282
290
|
/**
|
|
283
|
-
* Creates a new version of a fleet provisioning template.
|
|
291
|
+
* Creates a new version of a fleet provisioning template. Requires permission to access the CreateProvisioningTemplateVersion action.
|
|
284
292
|
*/
|
|
285
293
|
createProvisioningTemplateVersion(callback?: (err: AWSError, data: Iot.Types.CreateProvisioningTemplateVersionResponse) => void): Request<Iot.Types.CreateProvisioningTemplateVersionResponse, AWSError>;
|
|
286
294
|
/**
|
|
287
|
-
* Creates a role alias.
|
|
295
|
+
* Creates a role alias. Requires permission to access the CreateRoleAlias action.
|
|
288
296
|
*/
|
|
289
297
|
createRoleAlias(params: Iot.Types.CreateRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.CreateRoleAliasResponse) => void): Request<Iot.Types.CreateRoleAliasResponse, AWSError>;
|
|
290
298
|
/**
|
|
291
|
-
* Creates a role alias.
|
|
299
|
+
* Creates a role alias. Requires permission to access the CreateRoleAlias action.
|
|
292
300
|
*/
|
|
293
301
|
createRoleAlias(callback?: (err: AWSError, data: Iot.Types.CreateRoleAliasResponse) => void): Request<Iot.Types.CreateRoleAliasResponse, AWSError>;
|
|
294
302
|
/**
|
|
295
|
-
* Creates a scheduled audit that is run at a specified time interval.
|
|
303
|
+
* Creates a scheduled audit that is run at a specified time interval. Requires permission to access the CreateScheduledAudit action.
|
|
296
304
|
*/
|
|
297
305
|
createScheduledAudit(params: Iot.Types.CreateScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.CreateScheduledAuditResponse) => void): Request<Iot.Types.CreateScheduledAuditResponse, AWSError>;
|
|
298
306
|
/**
|
|
299
|
-
* Creates a scheduled audit that is run at a specified time interval.
|
|
307
|
+
* Creates a scheduled audit that is run at a specified time interval. Requires permission to access the CreateScheduledAudit action.
|
|
300
308
|
*/
|
|
301
309
|
createScheduledAudit(callback?: (err: AWSError, data: Iot.Types.CreateScheduledAuditResponse) => void): Request<Iot.Types.CreateScheduledAuditResponse, AWSError>;
|
|
302
310
|
/**
|
|
303
|
-
* Creates a Device Defender security profile.
|
|
311
|
+
* Creates a Device Defender security profile. Requires permission to access the CreateSecurityProfile action.
|
|
304
312
|
*/
|
|
305
313
|
createSecurityProfile(params: Iot.Types.CreateSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.CreateSecurityProfileResponse) => void): Request<Iot.Types.CreateSecurityProfileResponse, AWSError>;
|
|
306
314
|
/**
|
|
307
|
-
* Creates a Device Defender security profile.
|
|
315
|
+
* Creates a Device Defender security profile. Requires permission to access the CreateSecurityProfile action.
|
|
308
316
|
*/
|
|
309
317
|
createSecurityProfile(callback?: (err: AWSError, data: Iot.Types.CreateSecurityProfileResponse) => void): Request<Iot.Types.CreateSecurityProfileResponse, AWSError>;
|
|
310
318
|
/**
|
|
311
|
-
* 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.
|
|
319
|
+
* 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. Requires permission to access the CreateStream action.
|
|
312
320
|
*/
|
|
313
321
|
createStream(params: Iot.Types.CreateStreamRequest, callback?: (err: AWSError, data: Iot.Types.CreateStreamResponse) => void): Request<Iot.Types.CreateStreamResponse, AWSError>;
|
|
314
322
|
/**
|
|
315
|
-
* 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.
|
|
323
|
+
* 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. Requires permission to access the CreateStream action.
|
|
316
324
|
*/
|
|
317
325
|
createStream(callback?: (err: AWSError, data: Iot.Types.CreateStreamResponse) => void): Request<Iot.Types.CreateStreamResponse, AWSError>;
|
|
318
326
|
/**
|
|
319
|
-
* 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.
|
|
327
|
+
* 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. Requires permission to access the CreateThing action.
|
|
320
328
|
*/
|
|
321
329
|
createThing(params: Iot.Types.CreateThingRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingResponse) => void): Request<Iot.Types.CreateThingResponse, AWSError>;
|
|
322
330
|
/**
|
|
323
|
-
* 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.
|
|
331
|
+
* 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. Requires permission to access the CreateThing action.
|
|
324
332
|
*/
|
|
325
333
|
createThing(callback?: (err: AWSError, data: Iot.Types.CreateThingResponse) => void): Request<Iot.Types.CreateThingResponse, AWSError>;
|
|
326
334
|
/**
|
|
327
|
-
* Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions.
|
|
335
|
+
* Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions. Requires permission to access the CreateThingGroup action.
|
|
328
336
|
*/
|
|
329
337
|
createThingGroup(params: Iot.Types.CreateThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingGroupResponse) => void): Request<Iot.Types.CreateThingGroupResponse, AWSError>;
|
|
330
338
|
/**
|
|
331
|
-
* Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions.
|
|
339
|
+
* Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions. Requires permission to access the CreateThingGroup action.
|
|
332
340
|
*/
|
|
333
341
|
createThingGroup(callback?: (err: AWSError, data: Iot.Types.CreateThingGroupResponse) => void): Request<Iot.Types.CreateThingGroupResponse, AWSError>;
|
|
334
342
|
/**
|
|
335
|
-
* Creates a new thing type.
|
|
343
|
+
* Creates a new thing type. Requires permission to access the CreateThingType action.
|
|
336
344
|
*/
|
|
337
345
|
createThingType(params: Iot.Types.CreateThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingTypeResponse) => void): Request<Iot.Types.CreateThingTypeResponse, AWSError>;
|
|
338
346
|
/**
|
|
339
|
-
* Creates a new thing type.
|
|
347
|
+
* Creates a new thing type. Requires permission to access the CreateThingType action.
|
|
340
348
|
*/
|
|
341
349
|
createThingType(callback?: (err: AWSError, data: Iot.Types.CreateThingTypeResponse) => void): Request<Iot.Types.CreateThingTypeResponse, AWSError>;
|
|
342
350
|
/**
|
|
343
|
-
* 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.
|
|
351
|
+
* 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. Requires permission to access the CreateTopicRule action.
|
|
344
352
|
*/
|
|
345
353
|
createTopicRule(params: Iot.Types.CreateTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
346
354
|
/**
|
|
347
|
-
* 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.
|
|
355
|
+
* 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. Requires permission to access the CreateTopicRule action.
|
|
348
356
|
*/
|
|
349
357
|
createTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
350
358
|
/**
|
|
351
|
-
* Creates a topic rule destination. The destination must be confirmed prior to use.
|
|
359
|
+
* Creates a topic rule destination. The destination must be confirmed prior to use. Requires permission to access the CreateTopicRuleDestination action.
|
|
352
360
|
*/
|
|
353
361
|
createTopicRuleDestination(params: Iot.Types.CreateTopicRuleDestinationRequest, callback?: (err: AWSError, data: Iot.Types.CreateTopicRuleDestinationResponse) => void): Request<Iot.Types.CreateTopicRuleDestinationResponse, AWSError>;
|
|
354
362
|
/**
|
|
355
|
-
* Creates a topic rule destination. The destination must be confirmed prior to use.
|
|
363
|
+
* Creates a topic rule destination. The destination must be confirmed prior to use. Requires permission to access the CreateTopicRuleDestination action.
|
|
356
364
|
*/
|
|
357
365
|
createTopicRuleDestination(callback?: (err: AWSError, data: Iot.Types.CreateTopicRuleDestinationResponse) => void): Request<Iot.Types.CreateTopicRuleDestinationResponse, AWSError>;
|
|
358
366
|
/**
|
|
359
|
-
* 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.
|
|
367
|
+
* 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. Requires permission to access the DeleteAccountAuditConfiguration action.
|
|
360
368
|
*/
|
|
361
369
|
deleteAccountAuditConfiguration(params: Iot.Types.DeleteAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DeleteAccountAuditConfigurationResponse) => void): Request<Iot.Types.DeleteAccountAuditConfigurationResponse, AWSError>;
|
|
362
370
|
/**
|
|
363
|
-
* 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.
|
|
371
|
+
* 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. Requires permission to access the DeleteAccountAuditConfiguration action.
|
|
364
372
|
*/
|
|
365
373
|
deleteAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.DeleteAccountAuditConfigurationResponse) => void): Request<Iot.Types.DeleteAccountAuditConfigurationResponse, AWSError>;
|
|
366
374
|
/**
|
|
367
|
-
* Deletes a Device Defender audit suppression.
|
|
375
|
+
* Deletes a Device Defender audit suppression. Requires permission to access the DeleteAuditSuppression action.
|
|
368
376
|
*/
|
|
369
377
|
deleteAuditSuppression(params: Iot.Types.DeleteAuditSuppressionRequest, callback?: (err: AWSError, data: Iot.Types.DeleteAuditSuppressionResponse) => void): Request<Iot.Types.DeleteAuditSuppressionResponse, AWSError>;
|
|
370
378
|
/**
|
|
371
|
-
* Deletes a Device Defender audit suppression.
|
|
379
|
+
* Deletes a Device Defender audit suppression. Requires permission to access the DeleteAuditSuppression action.
|
|
372
380
|
*/
|
|
373
381
|
deleteAuditSuppression(callback?: (err: AWSError, data: Iot.Types.DeleteAuditSuppressionResponse) => void): Request<Iot.Types.DeleteAuditSuppressionResponse, AWSError>;
|
|
374
382
|
/**
|
|
375
|
-
* Deletes an authorizer.
|
|
383
|
+
* Deletes an authorizer. Requires permission to access the DeleteAuthorizer action.
|
|
376
384
|
*/
|
|
377
385
|
deleteAuthorizer(params: Iot.Types.DeleteAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DeleteAuthorizerResponse) => void): Request<Iot.Types.DeleteAuthorizerResponse, AWSError>;
|
|
378
386
|
/**
|
|
379
|
-
* Deletes an authorizer.
|
|
387
|
+
* Deletes an authorizer. Requires permission to access the DeleteAuthorizer action.
|
|
380
388
|
*/
|
|
381
389
|
deleteAuthorizer(callback?: (err: AWSError, data: Iot.Types.DeleteAuthorizerResponse) => void): Request<Iot.Types.DeleteAuthorizerResponse, AWSError>;
|
|
382
390
|
/**
|
|
383
|
-
* Deletes the billing group.
|
|
391
|
+
* Deletes the billing group. Requires permission to access the DeleteBillingGroup action.
|
|
384
392
|
*/
|
|
385
393
|
deleteBillingGroup(params: Iot.Types.DeleteBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteBillingGroupResponse) => void): Request<Iot.Types.DeleteBillingGroupResponse, AWSError>;
|
|
386
394
|
/**
|
|
387
|
-
* Deletes the billing group.
|
|
395
|
+
* Deletes the billing group. Requires permission to access the DeleteBillingGroup action.
|
|
388
396
|
*/
|
|
389
397
|
deleteBillingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteBillingGroupResponse) => void): Request<Iot.Types.DeleteBillingGroupResponse, AWSError>;
|
|
390
398
|
/**
|
|
391
|
-
* Deletes a registered CA certificate.
|
|
399
|
+
* Deletes a registered CA certificate. Requires permission to access the DeleteCACertificate action.
|
|
392
400
|
*/
|
|
393
401
|
deleteCACertificate(params: Iot.Types.DeleteCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.DeleteCACertificateResponse) => void): Request<Iot.Types.DeleteCACertificateResponse, AWSError>;
|
|
394
402
|
/**
|
|
395
|
-
* Deletes a registered CA certificate.
|
|
403
|
+
* Deletes a registered CA certificate. Requires permission to access the DeleteCACertificate action.
|
|
396
404
|
*/
|
|
397
405
|
deleteCACertificate(callback?: (err: AWSError, data: Iot.Types.DeleteCACertificateResponse) => void): Request<Iot.Types.DeleteCACertificateResponse, AWSError>;
|
|
398
406
|
/**
|
|
399
|
-
* 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
|
|
407
|
+
* 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 DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status. Requires permission to access the DeleteCertificate action.
|
|
400
408
|
*/
|
|
401
409
|
deleteCertificate(params: Iot.Types.DeleteCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
402
410
|
/**
|
|
403
|
-
* 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
|
|
411
|
+
* 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 DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status. Requires permission to access the DeleteCertificate action.
|
|
404
412
|
*/
|
|
405
413
|
deleteCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
406
414
|
/**
|
|
407
|
-
* Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name.
|
|
415
|
+
* Deletes a Device Defender detect custom metric. Requires permission to access the DeleteCustomMetric action. Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name.
|
|
408
416
|
*/
|
|
409
417
|
deleteCustomMetric(params: Iot.Types.DeleteCustomMetricRequest, callback?: (err: AWSError, data: Iot.Types.DeleteCustomMetricResponse) => void): Request<Iot.Types.DeleteCustomMetricResponse, AWSError>;
|
|
410
418
|
/**
|
|
411
|
-
* Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name.
|
|
419
|
+
* Deletes a Device Defender detect custom metric. Requires permission to access the DeleteCustomMetric action. Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles API with metricName set to your custom metric name.
|
|
412
420
|
*/
|
|
413
421
|
deleteCustomMetric(callback?: (err: AWSError, data: Iot.Types.DeleteCustomMetricResponse) => void): Request<Iot.Types.DeleteCustomMetricResponse, AWSError>;
|
|
414
422
|
/**
|
|
415
|
-
* Removes the specified dimension from your
|
|
423
|
+
* Removes the specified dimension from your Amazon Web Services accounts. Requires permission to access the DeleteDimension action.
|
|
416
424
|
*/
|
|
417
425
|
deleteDimension(params: Iot.Types.DeleteDimensionRequest, callback?: (err: AWSError, data: Iot.Types.DeleteDimensionResponse) => void): Request<Iot.Types.DeleteDimensionResponse, AWSError>;
|
|
418
426
|
/**
|
|
419
|
-
* Removes the specified dimension from your
|
|
427
|
+
* Removes the specified dimension from your Amazon Web Services accounts. Requires permission to access the DeleteDimension action.
|
|
420
428
|
*/
|
|
421
429
|
deleteDimension(callback?: (err: AWSError, data: Iot.Types.DeleteDimensionResponse) => void): Request<Iot.Types.DeleteDimensionResponse, AWSError>;
|
|
422
430
|
/**
|
|
423
|
-
* Deletes the specified domain configuration.
|
|
431
|
+
* Deletes the specified domain configuration. Requires permission to access the DeleteDomainConfiguration action.
|
|
424
432
|
*/
|
|
425
433
|
deleteDomainConfiguration(params: Iot.Types.DeleteDomainConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DeleteDomainConfigurationResponse) => void): Request<Iot.Types.DeleteDomainConfigurationResponse, AWSError>;
|
|
426
434
|
/**
|
|
427
|
-
* Deletes the specified domain configuration.
|
|
435
|
+
* Deletes the specified domain configuration. Requires permission to access the DeleteDomainConfiguration action.
|
|
428
436
|
*/
|
|
429
437
|
deleteDomainConfiguration(callback?: (err: AWSError, data: Iot.Types.DeleteDomainConfigurationResponse) => void): Request<Iot.Types.DeleteDomainConfigurationResponse, AWSError>;
|
|
430
438
|
/**
|
|
431
|
-
* Deletes a dynamic thing group.
|
|
439
|
+
* Deletes a dynamic thing group. Requires permission to access the DeleteDynamicThingGroup action.
|
|
432
440
|
*/
|
|
433
441
|
deleteDynamicThingGroup(params: Iot.Types.DeleteDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteDynamicThingGroupResponse) => void): Request<Iot.Types.DeleteDynamicThingGroupResponse, AWSError>;
|
|
434
442
|
/**
|
|
435
|
-
* Deletes a dynamic thing group.
|
|
443
|
+
* Deletes a dynamic thing group. Requires permission to access the DeleteDynamicThingGroup action.
|
|
436
444
|
*/
|
|
437
445
|
deleteDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteDynamicThingGroupResponse) => void): Request<Iot.Types.DeleteDynamicThingGroupResponse, AWSError>;
|
|
438
446
|
/**
|
|
439
|
-
* Deletes
|
|
447
|
+
* Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist. Requires permission to access the DeleteFleetMetric action.
|
|
448
|
+
*/
|
|
449
|
+
deleteFleetMetric(params: Iot.Types.DeleteFleetMetricRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
450
|
+
/**
|
|
451
|
+
* Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist. Requires permission to access the DeleteFleetMetric action.
|
|
452
|
+
*/
|
|
453
|
+
deleteFleetMetric(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
454
|
+
/**
|
|
455
|
+
* 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. Requires permission to access the DeleteJob action.
|
|
440
456
|
*/
|
|
441
457
|
deleteJob(params: Iot.Types.DeleteJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
442
458
|
/**
|
|
443
|
-
* 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.
|
|
459
|
+
* 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. Requires permission to access the DeleteJob action.
|
|
444
460
|
*/
|
|
445
461
|
deleteJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
446
462
|
/**
|
|
447
|
-
* Deletes a job execution.
|
|
463
|
+
* Deletes a job execution. Requires permission to access the DeleteJobExecution action.
|
|
448
464
|
*/
|
|
449
465
|
deleteJobExecution(params: Iot.Types.DeleteJobExecutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
450
466
|
/**
|
|
451
|
-
* Deletes a job execution.
|
|
467
|
+
* Deletes a job execution. Requires permission to access the DeleteJobExecution action.
|
|
452
468
|
*/
|
|
453
469
|
deleteJobExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
454
470
|
/**
|
|
@@ -460,163 +476,163 @@ declare class Iot extends Service {
|
|
|
460
476
|
*/
|
|
461
477
|
deleteJobTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
462
478
|
/**
|
|
463
|
-
* Deletes a defined mitigation action from your
|
|
479
|
+
* Deletes a defined mitigation action from your Amazon Web Services accounts. Requires permission to access the DeleteMitigationAction action.
|
|
464
480
|
*/
|
|
465
481
|
deleteMitigationAction(params: Iot.Types.DeleteMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.DeleteMitigationActionResponse) => void): Request<Iot.Types.DeleteMitigationActionResponse, AWSError>;
|
|
466
482
|
/**
|
|
467
|
-
* Deletes a defined mitigation action from your
|
|
483
|
+
* Deletes a defined mitigation action from your Amazon Web Services accounts. Requires permission to access the DeleteMitigationAction action.
|
|
468
484
|
*/
|
|
469
485
|
deleteMitigationAction(callback?: (err: AWSError, data: Iot.Types.DeleteMitigationActionResponse) => void): Request<Iot.Types.DeleteMitigationActionResponse, AWSError>;
|
|
470
486
|
/**
|
|
471
|
-
* Delete an OTA update.
|
|
487
|
+
* Delete an OTA update. Requires permission to access the DeleteOTAUpdate action.
|
|
472
488
|
*/
|
|
473
489
|
deleteOTAUpdate(params: Iot.Types.DeleteOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.DeleteOTAUpdateResponse) => void): Request<Iot.Types.DeleteOTAUpdateResponse, AWSError>;
|
|
474
490
|
/**
|
|
475
|
-
* Delete an OTA update.
|
|
491
|
+
* Delete an OTA update. Requires permission to access the DeleteOTAUpdate action.
|
|
476
492
|
*/
|
|
477
493
|
deleteOTAUpdate(callback?: (err: AWSError, data: Iot.Types.DeleteOTAUpdateResponse) => void): Request<Iot.Types.DeleteOTAUpdateResponse, AWSError>;
|
|
478
494
|
/**
|
|
479
|
-
* 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
|
|
495
|
+
* 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 action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy. When a policy is deleted using DeletePolicy, its default version is deleted with it. Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted. Requires permission to access the DeletePolicy action.
|
|
480
496
|
*/
|
|
481
497
|
deletePolicy(params: Iot.Types.DeletePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
482
498
|
/**
|
|
483
|
-
* 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
|
|
499
|
+
* 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 action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy. When a policy is deleted using DeletePolicy, its default version is deleted with it. Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted. Requires permission to access the DeletePolicy action.
|
|
484
500
|
*/
|
|
485
501
|
deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
486
502
|
/**
|
|
487
|
-
* Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this
|
|
503
|
+
* Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. 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. Requires permission to access the DeletePolicyVersion action.
|
|
488
504
|
*/
|
|
489
505
|
deletePolicyVersion(params: Iot.Types.DeletePolicyVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
490
506
|
/**
|
|
491
|
-
* Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this
|
|
507
|
+
* Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. 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. Requires permission to access the DeletePolicyVersion action.
|
|
492
508
|
*/
|
|
493
509
|
deletePolicyVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
494
510
|
/**
|
|
495
|
-
* Deletes a fleet provisioning template.
|
|
511
|
+
* Deletes a fleet provisioning template. Requires permission to access the DeleteProvisioningTemplate action.
|
|
496
512
|
*/
|
|
497
513
|
deleteProvisioningTemplate(params: Iot.Types.DeleteProvisioningTemplateRequest, callback?: (err: AWSError, data: Iot.Types.DeleteProvisioningTemplateResponse) => void): Request<Iot.Types.DeleteProvisioningTemplateResponse, AWSError>;
|
|
498
514
|
/**
|
|
499
|
-
* Deletes a fleet provisioning template.
|
|
515
|
+
* Deletes a fleet provisioning template. Requires permission to access the DeleteProvisioningTemplate action.
|
|
500
516
|
*/
|
|
501
517
|
deleteProvisioningTemplate(callback?: (err: AWSError, data: Iot.Types.DeleteProvisioningTemplateResponse) => void): Request<Iot.Types.DeleteProvisioningTemplateResponse, AWSError>;
|
|
502
518
|
/**
|
|
503
|
-
* Deletes a fleet provisioning template version.
|
|
519
|
+
* Deletes a fleet provisioning template version. Requires permission to access the DeleteProvisioningTemplateVersion action.
|
|
504
520
|
*/
|
|
505
521
|
deleteProvisioningTemplateVersion(params: Iot.Types.DeleteProvisioningTemplateVersionRequest, callback?: (err: AWSError, data: Iot.Types.DeleteProvisioningTemplateVersionResponse) => void): Request<Iot.Types.DeleteProvisioningTemplateVersionResponse, AWSError>;
|
|
506
522
|
/**
|
|
507
|
-
* Deletes a fleet provisioning template version.
|
|
523
|
+
* Deletes a fleet provisioning template version. Requires permission to access the DeleteProvisioningTemplateVersion action.
|
|
508
524
|
*/
|
|
509
525
|
deleteProvisioningTemplateVersion(callback?: (err: AWSError, data: Iot.Types.DeleteProvisioningTemplateVersionResponse) => void): Request<Iot.Types.DeleteProvisioningTemplateVersionResponse, AWSError>;
|
|
510
526
|
/**
|
|
511
|
-
* Deletes a CA certificate registration code.
|
|
527
|
+
* Deletes a CA certificate registration code. Requires permission to access the DeleteRegistrationCode action.
|
|
512
528
|
*/
|
|
513
529
|
deleteRegistrationCode(params: Iot.Types.DeleteRegistrationCodeRequest, callback?: (err: AWSError, data: Iot.Types.DeleteRegistrationCodeResponse) => void): Request<Iot.Types.DeleteRegistrationCodeResponse, AWSError>;
|
|
514
530
|
/**
|
|
515
|
-
* Deletes a CA certificate registration code.
|
|
531
|
+
* Deletes a CA certificate registration code. Requires permission to access the DeleteRegistrationCode action.
|
|
516
532
|
*/
|
|
517
533
|
deleteRegistrationCode(callback?: (err: AWSError, data: Iot.Types.DeleteRegistrationCodeResponse) => void): Request<Iot.Types.DeleteRegistrationCodeResponse, AWSError>;
|
|
518
534
|
/**
|
|
519
|
-
* Deletes a role alias
|
|
535
|
+
* Deletes a role alias Requires permission to access the DeleteRoleAlias action.
|
|
520
536
|
*/
|
|
521
537
|
deleteRoleAlias(params: Iot.Types.DeleteRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.DeleteRoleAliasResponse) => void): Request<Iot.Types.DeleteRoleAliasResponse, AWSError>;
|
|
522
538
|
/**
|
|
523
|
-
* Deletes a role alias
|
|
539
|
+
* Deletes a role alias Requires permission to access the DeleteRoleAlias action.
|
|
524
540
|
*/
|
|
525
541
|
deleteRoleAlias(callback?: (err: AWSError, data: Iot.Types.DeleteRoleAliasResponse) => void): Request<Iot.Types.DeleteRoleAliasResponse, AWSError>;
|
|
526
542
|
/**
|
|
527
|
-
* Deletes a scheduled audit.
|
|
543
|
+
* Deletes a scheduled audit. Requires permission to access the DeleteScheduledAudit action.
|
|
528
544
|
*/
|
|
529
545
|
deleteScheduledAudit(params: Iot.Types.DeleteScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.DeleteScheduledAuditResponse) => void): Request<Iot.Types.DeleteScheduledAuditResponse, AWSError>;
|
|
530
546
|
/**
|
|
531
|
-
* Deletes a scheduled audit.
|
|
547
|
+
* Deletes a scheduled audit. Requires permission to access the DeleteScheduledAudit action.
|
|
532
548
|
*/
|
|
533
549
|
deleteScheduledAudit(callback?: (err: AWSError, data: Iot.Types.DeleteScheduledAuditResponse) => void): Request<Iot.Types.DeleteScheduledAuditResponse, AWSError>;
|
|
534
550
|
/**
|
|
535
|
-
* Deletes a Device Defender security profile.
|
|
551
|
+
* Deletes a Device Defender security profile. Requires permission to access the DeleteSecurityProfile action.
|
|
536
552
|
*/
|
|
537
553
|
deleteSecurityProfile(params: Iot.Types.DeleteSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DeleteSecurityProfileResponse) => void): Request<Iot.Types.DeleteSecurityProfileResponse, AWSError>;
|
|
538
554
|
/**
|
|
539
|
-
* Deletes a Device Defender security profile.
|
|
555
|
+
* Deletes a Device Defender security profile. Requires permission to access the DeleteSecurityProfile action.
|
|
540
556
|
*/
|
|
541
557
|
deleteSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DeleteSecurityProfileResponse) => void): Request<Iot.Types.DeleteSecurityProfileResponse, AWSError>;
|
|
542
558
|
/**
|
|
543
|
-
* Deletes a stream.
|
|
559
|
+
* Deletes a stream. Requires permission to access the DeleteStream action.
|
|
544
560
|
*/
|
|
545
561
|
deleteStream(params: Iot.Types.DeleteStreamRequest, callback?: (err: AWSError, data: Iot.Types.DeleteStreamResponse) => void): Request<Iot.Types.DeleteStreamResponse, AWSError>;
|
|
546
562
|
/**
|
|
547
|
-
* Deletes a stream.
|
|
563
|
+
* Deletes a stream. Requires permission to access the DeleteStream action.
|
|
548
564
|
*/
|
|
549
565
|
deleteStream(callback?: (err: AWSError, data: Iot.Types.DeleteStreamResponse) => void): Request<Iot.Types.DeleteStreamResponse, AWSError>;
|
|
550
566
|
/**
|
|
551
|
-
* Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
|
|
567
|
+
* Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist. Requires permission to access the DeleteThing action.
|
|
552
568
|
*/
|
|
553
569
|
deleteThing(params: Iot.Types.DeleteThingRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingResponse) => void): Request<Iot.Types.DeleteThingResponse, AWSError>;
|
|
554
570
|
/**
|
|
555
|
-
* Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
|
|
571
|
+
* Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist. Requires permission to access the DeleteThing action.
|
|
556
572
|
*/
|
|
557
573
|
deleteThing(callback?: (err: AWSError, data: Iot.Types.DeleteThingResponse) => void): Request<Iot.Types.DeleteThingResponse, AWSError>;
|
|
558
574
|
/**
|
|
559
|
-
* Deletes a thing group.
|
|
575
|
+
* Deletes a thing group. Requires permission to access the DeleteThingGroup action.
|
|
560
576
|
*/
|
|
561
577
|
deleteThingGroup(params: Iot.Types.DeleteThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingGroupResponse) => void): Request<Iot.Types.DeleteThingGroupResponse, AWSError>;
|
|
562
578
|
/**
|
|
563
|
-
* Deletes a thing group.
|
|
579
|
+
* Deletes a thing group. Requires permission to access the DeleteThingGroup action.
|
|
564
580
|
*/
|
|
565
581
|
deleteThingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteThingGroupResponse) => void): Request<Iot.Types.DeleteThingGroupResponse, AWSError>;
|
|
566
582
|
/**
|
|
567
|
-
* 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.
|
|
583
|
+
* 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. Requires permission to access the DeleteThingType action.
|
|
568
584
|
*/
|
|
569
585
|
deleteThingType(params: Iot.Types.DeleteThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingTypeResponse) => void): Request<Iot.Types.DeleteThingTypeResponse, AWSError>;
|
|
570
586
|
/**
|
|
571
|
-
* 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.
|
|
587
|
+
* 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. Requires permission to access the DeleteThingType action.
|
|
572
588
|
*/
|
|
573
589
|
deleteThingType(callback?: (err: AWSError, data: Iot.Types.DeleteThingTypeResponse) => void): Request<Iot.Types.DeleteThingTypeResponse, AWSError>;
|
|
574
590
|
/**
|
|
575
|
-
* Deletes the rule.
|
|
591
|
+
* Deletes the rule. Requires permission to access the DeleteTopicRule action.
|
|
576
592
|
*/
|
|
577
593
|
deleteTopicRule(params: Iot.Types.DeleteTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
578
594
|
/**
|
|
579
|
-
* Deletes the rule.
|
|
595
|
+
* Deletes the rule. Requires permission to access the DeleteTopicRule action.
|
|
580
596
|
*/
|
|
581
597
|
deleteTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
582
598
|
/**
|
|
583
|
-
* Deletes a topic rule destination.
|
|
599
|
+
* Deletes a topic rule destination. Requires permission to access the DeleteTopicRuleDestination action.
|
|
584
600
|
*/
|
|
585
601
|
deleteTopicRuleDestination(params: Iot.Types.DeleteTopicRuleDestinationRequest, callback?: (err: AWSError, data: Iot.Types.DeleteTopicRuleDestinationResponse) => void): Request<Iot.Types.DeleteTopicRuleDestinationResponse, AWSError>;
|
|
586
602
|
/**
|
|
587
|
-
* Deletes a topic rule destination.
|
|
603
|
+
* Deletes a topic rule destination. Requires permission to access the DeleteTopicRuleDestination action.
|
|
588
604
|
*/
|
|
589
605
|
deleteTopicRuleDestination(callback?: (err: AWSError, data: Iot.Types.DeleteTopicRuleDestinationResponse) => void): Request<Iot.Types.DeleteTopicRuleDestinationResponse, AWSError>;
|
|
590
606
|
/**
|
|
591
|
-
* Deletes a logging level.
|
|
607
|
+
* Deletes a logging level. Requires permission to access the DeleteV2LoggingLevel action.
|
|
592
608
|
*/
|
|
593
609
|
deleteV2LoggingLevel(params: Iot.Types.DeleteV2LoggingLevelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
594
610
|
/**
|
|
595
|
-
* Deletes a logging level.
|
|
611
|
+
* Deletes a logging level. Requires permission to access the DeleteV2LoggingLevel action.
|
|
596
612
|
*/
|
|
597
613
|
deleteV2LoggingLevel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
598
614
|
/**
|
|
599
|
-
* Deprecates a thing type. You can not associate new things with deprecated thing type.
|
|
615
|
+
* Deprecates a thing type. You can not associate new things with deprecated thing type. Requires permission to access the DeprecateThingType action.
|
|
600
616
|
*/
|
|
601
617
|
deprecateThingType(params: Iot.Types.DeprecateThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DeprecateThingTypeResponse) => void): Request<Iot.Types.DeprecateThingTypeResponse, AWSError>;
|
|
602
618
|
/**
|
|
603
|
-
* Deprecates a thing type. You can not associate new things with deprecated thing type.
|
|
619
|
+
* Deprecates a thing type. You can not associate new things with deprecated thing type. Requires permission to access the DeprecateThingType action.
|
|
604
620
|
*/
|
|
605
621
|
deprecateThingType(callback?: (err: AWSError, data: Iot.Types.DeprecateThingTypeResponse) => void): Request<Iot.Types.DeprecateThingTypeResponse, AWSError>;
|
|
606
622
|
/**
|
|
607
|
-
* 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.
|
|
623
|
+
* 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. Requires permission to access the DescribeAccountAuditConfiguration action.
|
|
608
624
|
*/
|
|
609
625
|
describeAccountAuditConfiguration(params: Iot.Types.DescribeAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAccountAuditConfigurationResponse) => void): Request<Iot.Types.DescribeAccountAuditConfigurationResponse, AWSError>;
|
|
610
626
|
/**
|
|
611
|
-
* 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.
|
|
627
|
+
* 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. Requires permission to access the DescribeAccountAuditConfiguration action.
|
|
612
628
|
*/
|
|
613
629
|
describeAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.DescribeAccountAuditConfigurationResponse) => void): Request<Iot.Types.DescribeAccountAuditConfigurationResponse, AWSError>;
|
|
614
630
|
/**
|
|
615
|
-
* Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
|
|
631
|
+
* Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding. Requires permission to access the DescribeAuditFinding action.
|
|
616
632
|
*/
|
|
617
633
|
describeAuditFinding(params: Iot.Types.DescribeAuditFindingRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuditFindingResponse) => void): Request<Iot.Types.DescribeAuditFindingResponse, AWSError>;
|
|
618
634
|
/**
|
|
619
|
-
* Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
|
|
635
|
+
* Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding. Requires permission to access the DescribeAuditFinding action.
|
|
620
636
|
*/
|
|
621
637
|
describeAuditFinding(callback?: (err: AWSError, data: Iot.Types.DescribeAuditFindingResponse) => void): Request<Iot.Types.DescribeAuditFindingResponse, AWSError>;
|
|
622
638
|
/**
|
|
@@ -636,123 +652,131 @@ declare class Iot extends Service {
|
|
|
636
652
|
*/
|
|
637
653
|
describeAuditSuppression(callback?: (err: AWSError, data: Iot.Types.DescribeAuditSuppressionResponse) => void): Request<Iot.Types.DescribeAuditSuppressionResponse, AWSError>;
|
|
638
654
|
/**
|
|
639
|
-
* Gets information about a Device Defender audit.
|
|
655
|
+
* Gets information about a Device Defender audit. Requires permission to access the DescribeAuditTask action.
|
|
640
656
|
*/
|
|
641
657
|
describeAuditTask(params: Iot.Types.DescribeAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuditTaskResponse) => void): Request<Iot.Types.DescribeAuditTaskResponse, AWSError>;
|
|
642
658
|
/**
|
|
643
|
-
* Gets information about a Device Defender audit.
|
|
659
|
+
* Gets information about a Device Defender audit. Requires permission to access the DescribeAuditTask action.
|
|
644
660
|
*/
|
|
645
661
|
describeAuditTask(callback?: (err: AWSError, data: Iot.Types.DescribeAuditTaskResponse) => void): Request<Iot.Types.DescribeAuditTaskResponse, AWSError>;
|
|
646
662
|
/**
|
|
647
|
-
* Describes an authorizer.
|
|
663
|
+
* Describes an authorizer. Requires permission to access the DescribeAuthorizer action.
|
|
648
664
|
*/
|
|
649
665
|
describeAuthorizer(params: Iot.Types.DescribeAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuthorizerResponse) => void): Request<Iot.Types.DescribeAuthorizerResponse, AWSError>;
|
|
650
666
|
/**
|
|
651
|
-
* Describes an authorizer.
|
|
667
|
+
* Describes an authorizer. Requires permission to access the DescribeAuthorizer action.
|
|
652
668
|
*/
|
|
653
669
|
describeAuthorizer(callback?: (err: AWSError, data: Iot.Types.DescribeAuthorizerResponse) => void): Request<Iot.Types.DescribeAuthorizerResponse, AWSError>;
|
|
654
670
|
/**
|
|
655
|
-
* Returns information about a billing group.
|
|
671
|
+
* Returns information about a billing group. Requires permission to access the DescribeBillingGroup action.
|
|
656
672
|
*/
|
|
657
673
|
describeBillingGroup(params: Iot.Types.DescribeBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DescribeBillingGroupResponse) => void): Request<Iot.Types.DescribeBillingGroupResponse, AWSError>;
|
|
658
674
|
/**
|
|
659
|
-
* Returns information about a billing group.
|
|
675
|
+
* Returns information about a billing group. Requires permission to access the DescribeBillingGroup action.
|
|
660
676
|
*/
|
|
661
677
|
describeBillingGroup(callback?: (err: AWSError, data: Iot.Types.DescribeBillingGroupResponse) => void): Request<Iot.Types.DescribeBillingGroupResponse, AWSError>;
|
|
662
678
|
/**
|
|
663
|
-
* Describes a registered CA certificate.
|
|
679
|
+
* Describes a registered CA certificate. Requires permission to access the DescribeCACertificate action.
|
|
664
680
|
*/
|
|
665
681
|
describeCACertificate(params: Iot.Types.DescribeCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.DescribeCACertificateResponse) => void): Request<Iot.Types.DescribeCACertificateResponse, AWSError>;
|
|
666
682
|
/**
|
|
667
|
-
* Describes a registered CA certificate.
|
|
683
|
+
* Describes a registered CA certificate. Requires permission to access the DescribeCACertificate action.
|
|
668
684
|
*/
|
|
669
685
|
describeCACertificate(callback?: (err: AWSError, data: Iot.Types.DescribeCACertificateResponse) => void): Request<Iot.Types.DescribeCACertificateResponse, AWSError>;
|
|
670
686
|
/**
|
|
671
|
-
* Gets information about the specified certificate.
|
|
687
|
+
* Gets information about the specified certificate. Requires permission to access the DescribeCertificate action.
|
|
672
688
|
*/
|
|
673
689
|
describeCertificate(params: Iot.Types.DescribeCertificateRequest, callback?: (err: AWSError, data: Iot.Types.DescribeCertificateResponse) => void): Request<Iot.Types.DescribeCertificateResponse, AWSError>;
|
|
674
690
|
/**
|
|
675
|
-
* Gets information about the specified certificate.
|
|
691
|
+
* Gets information about the specified certificate. Requires permission to access the DescribeCertificate action.
|
|
676
692
|
*/
|
|
677
693
|
describeCertificate(callback?: (err: AWSError, data: Iot.Types.DescribeCertificateResponse) => void): Request<Iot.Types.DescribeCertificateResponse, AWSError>;
|
|
678
694
|
/**
|
|
679
|
-
* Gets information about a Device Defender detect custom metric.
|
|
695
|
+
* Gets information about a Device Defender detect custom metric. Requires permission to access the DescribeCustomMetric action.
|
|
680
696
|
*/
|
|
681
697
|
describeCustomMetric(params: Iot.Types.DescribeCustomMetricRequest, callback?: (err: AWSError, data: Iot.Types.DescribeCustomMetricResponse) => void): Request<Iot.Types.DescribeCustomMetricResponse, AWSError>;
|
|
682
698
|
/**
|
|
683
|
-
* Gets information about a Device Defender detect custom metric.
|
|
699
|
+
* Gets information about a Device Defender detect custom metric. Requires permission to access the DescribeCustomMetric action.
|
|
684
700
|
*/
|
|
685
701
|
describeCustomMetric(callback?: (err: AWSError, data: Iot.Types.DescribeCustomMetricResponse) => void): Request<Iot.Types.DescribeCustomMetricResponse, AWSError>;
|
|
686
702
|
/**
|
|
687
|
-
* Describes the default authorizer.
|
|
703
|
+
* Describes the default authorizer. Requires permission to access the DescribeDefaultAuthorizer action.
|
|
688
704
|
*/
|
|
689
705
|
describeDefaultAuthorizer(params: Iot.Types.DescribeDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DescribeDefaultAuthorizerResponse) => void): Request<Iot.Types.DescribeDefaultAuthorizerResponse, AWSError>;
|
|
690
706
|
/**
|
|
691
|
-
* Describes the default authorizer.
|
|
707
|
+
* Describes the default authorizer. Requires permission to access the DescribeDefaultAuthorizer action.
|
|
692
708
|
*/
|
|
693
709
|
describeDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.DescribeDefaultAuthorizerResponse) => void): Request<Iot.Types.DescribeDefaultAuthorizerResponse, AWSError>;
|
|
694
710
|
/**
|
|
695
|
-
* Gets information about a Device Defender ML Detect mitigation action.
|
|
711
|
+
* Gets information about a Device Defender ML Detect mitigation action. Requires permission to access the DescribeDetectMitigationActionsTask action.
|
|
696
712
|
*/
|
|
697
713
|
describeDetectMitigationActionsTask(params: Iot.Types.DescribeDetectMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.DescribeDetectMitigationActionsTaskResponse, AWSError>;
|
|
698
714
|
/**
|
|
699
|
-
* Gets information about a Device Defender ML Detect mitigation action.
|
|
715
|
+
* Gets information about a Device Defender ML Detect mitigation action. Requires permission to access the DescribeDetectMitigationActionsTask action.
|
|
700
716
|
*/
|
|
701
717
|
describeDetectMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.DescribeDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.DescribeDetectMitigationActionsTaskResponse, AWSError>;
|
|
702
718
|
/**
|
|
703
|
-
* Provides details about a dimension that is defined in your
|
|
719
|
+
* Provides details about a dimension that is defined in your Amazon Web Services accounts. Requires permission to access the DescribeDimension action.
|
|
704
720
|
*/
|
|
705
721
|
describeDimension(params: Iot.Types.DescribeDimensionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeDimensionResponse) => void): Request<Iot.Types.DescribeDimensionResponse, AWSError>;
|
|
706
722
|
/**
|
|
707
|
-
* Provides details about a dimension that is defined in your
|
|
723
|
+
* Provides details about a dimension that is defined in your Amazon Web Services accounts. Requires permission to access the DescribeDimension action.
|
|
708
724
|
*/
|
|
709
725
|
describeDimension(callback?: (err: AWSError, data: Iot.Types.DescribeDimensionResponse) => void): Request<Iot.Types.DescribeDimensionResponse, AWSError>;
|
|
710
726
|
/**
|
|
711
|
-
* Gets summary information about a domain configuration.
|
|
727
|
+
* Gets summary information about a domain configuration. Requires permission to access the DescribeDomainConfiguration action.
|
|
712
728
|
*/
|
|
713
729
|
describeDomainConfiguration(params: Iot.Types.DescribeDomainConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DescribeDomainConfigurationResponse) => void): Request<Iot.Types.DescribeDomainConfigurationResponse, AWSError>;
|
|
714
730
|
/**
|
|
715
|
-
* Gets summary information about a domain configuration.
|
|
731
|
+
* Gets summary information about a domain configuration. Requires permission to access the DescribeDomainConfiguration action.
|
|
716
732
|
*/
|
|
717
733
|
describeDomainConfiguration(callback?: (err: AWSError, data: Iot.Types.DescribeDomainConfigurationResponse) => void): Request<Iot.Types.DescribeDomainConfigurationResponse, AWSError>;
|
|
718
734
|
/**
|
|
719
|
-
* Returns a unique endpoint specific to the
|
|
735
|
+
* Returns a unique endpoint specific to the Amazon Web Services account making the call. Requires permission to access the DescribeEndpoint action.
|
|
720
736
|
*/
|
|
721
737
|
describeEndpoint(params: Iot.Types.DescribeEndpointRequest, callback?: (err: AWSError, data: Iot.Types.DescribeEndpointResponse) => void): Request<Iot.Types.DescribeEndpointResponse, AWSError>;
|
|
722
738
|
/**
|
|
723
|
-
* Returns a unique endpoint specific to the
|
|
739
|
+
* Returns a unique endpoint specific to the Amazon Web Services account making the call. Requires permission to access the DescribeEndpoint action.
|
|
724
740
|
*/
|
|
725
741
|
describeEndpoint(callback?: (err: AWSError, data: Iot.Types.DescribeEndpointResponse) => void): Request<Iot.Types.DescribeEndpointResponse, AWSError>;
|
|
726
742
|
/**
|
|
727
|
-
* Describes event configurations.
|
|
743
|
+
* Describes event configurations. Requires permission to access the DescribeEventConfigurations action.
|
|
728
744
|
*/
|
|
729
745
|
describeEventConfigurations(params: Iot.Types.DescribeEventConfigurationsRequest, callback?: (err: AWSError, data: Iot.Types.DescribeEventConfigurationsResponse) => void): Request<Iot.Types.DescribeEventConfigurationsResponse, AWSError>;
|
|
730
746
|
/**
|
|
731
|
-
* Describes event configurations.
|
|
747
|
+
* Describes event configurations. Requires permission to access the DescribeEventConfigurations action.
|
|
732
748
|
*/
|
|
733
749
|
describeEventConfigurations(callback?: (err: AWSError, data: Iot.Types.DescribeEventConfigurationsResponse) => void): Request<Iot.Types.DescribeEventConfigurationsResponse, AWSError>;
|
|
734
750
|
/**
|
|
735
|
-
*
|
|
751
|
+
* Gets information about the specified fleet metric. Requires permission to access the DescribeFleetMetric action.
|
|
752
|
+
*/
|
|
753
|
+
describeFleetMetric(params: Iot.Types.DescribeFleetMetricRequest, callback?: (err: AWSError, data: Iot.Types.DescribeFleetMetricResponse) => void): Request<Iot.Types.DescribeFleetMetricResponse, AWSError>;
|
|
754
|
+
/**
|
|
755
|
+
* Gets information about the specified fleet metric. Requires permission to access the DescribeFleetMetric action.
|
|
756
|
+
*/
|
|
757
|
+
describeFleetMetric(callback?: (err: AWSError, data: Iot.Types.DescribeFleetMetricResponse) => void): Request<Iot.Types.DescribeFleetMetricResponse, AWSError>;
|
|
758
|
+
/**
|
|
759
|
+
* Describes a search index. Requires permission to access the DescribeIndex action.
|
|
736
760
|
*/
|
|
737
761
|
describeIndex(params: Iot.Types.DescribeIndexRequest, callback?: (err: AWSError, data: Iot.Types.DescribeIndexResponse) => void): Request<Iot.Types.DescribeIndexResponse, AWSError>;
|
|
738
762
|
/**
|
|
739
|
-
* Describes a search index.
|
|
763
|
+
* Describes a search index. Requires permission to access the DescribeIndex action.
|
|
740
764
|
*/
|
|
741
765
|
describeIndex(callback?: (err: AWSError, data: Iot.Types.DescribeIndexResponse) => void): Request<Iot.Types.DescribeIndexResponse, AWSError>;
|
|
742
766
|
/**
|
|
743
|
-
* Describes a job.
|
|
767
|
+
* Describes a job. Requires permission to access the DescribeJob action.
|
|
744
768
|
*/
|
|
745
769
|
describeJob(params: Iot.Types.DescribeJobRequest, callback?: (err: AWSError, data: Iot.Types.DescribeJobResponse) => void): Request<Iot.Types.DescribeJobResponse, AWSError>;
|
|
746
770
|
/**
|
|
747
|
-
* Describes a job.
|
|
771
|
+
* Describes a job. Requires permission to access the DescribeJob action.
|
|
748
772
|
*/
|
|
749
773
|
describeJob(callback?: (err: AWSError, data: Iot.Types.DescribeJobResponse) => void): Request<Iot.Types.DescribeJobResponse, AWSError>;
|
|
750
774
|
/**
|
|
751
|
-
* Describes a job execution.
|
|
775
|
+
* Describes a job execution. Requires permission to access the DescribeJobExecution action.
|
|
752
776
|
*/
|
|
753
777
|
describeJobExecution(params: Iot.Types.DescribeJobExecutionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeJobExecutionResponse) => void): Request<Iot.Types.DescribeJobExecutionResponse, AWSError>;
|
|
754
778
|
/**
|
|
755
|
-
* Describes a job execution.
|
|
779
|
+
* Describes a job execution. Requires permission to access the DescribeJobExecution action.
|
|
756
780
|
*/
|
|
757
781
|
describeJobExecution(callback?: (err: AWSError, data: Iot.Types.DescribeJobExecutionResponse) => void): Request<Iot.Types.DescribeJobExecutionResponse, AWSError>;
|
|
758
782
|
/**
|
|
@@ -764,603 +788,619 @@ declare class Iot extends Service {
|
|
|
764
788
|
*/
|
|
765
789
|
describeJobTemplate(callback?: (err: AWSError, data: Iot.Types.DescribeJobTemplateResponse) => void): Request<Iot.Types.DescribeJobTemplateResponse, AWSError>;
|
|
766
790
|
/**
|
|
767
|
-
* Gets information about a mitigation action.
|
|
791
|
+
* Gets information about a mitigation action. Requires permission to access the DescribeMitigationAction action.
|
|
768
792
|
*/
|
|
769
793
|
describeMitigationAction(params: Iot.Types.DescribeMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeMitigationActionResponse) => void): Request<Iot.Types.DescribeMitigationActionResponse, AWSError>;
|
|
770
794
|
/**
|
|
771
|
-
* Gets information about a mitigation action.
|
|
795
|
+
* Gets information about a mitigation action. Requires permission to access the DescribeMitigationAction action.
|
|
772
796
|
*/
|
|
773
797
|
describeMitigationAction(callback?: (err: AWSError, data: Iot.Types.DescribeMitigationActionResponse) => void): Request<Iot.Types.DescribeMitigationActionResponse, AWSError>;
|
|
774
798
|
/**
|
|
775
|
-
* Returns information about a fleet provisioning template.
|
|
799
|
+
* Returns information about a fleet provisioning template. Requires permission to access the DescribeProvisioningTemplate action.
|
|
776
800
|
*/
|
|
777
801
|
describeProvisioningTemplate(params: Iot.Types.DescribeProvisioningTemplateRequest, callback?: (err: AWSError, data: Iot.Types.DescribeProvisioningTemplateResponse) => void): Request<Iot.Types.DescribeProvisioningTemplateResponse, AWSError>;
|
|
778
802
|
/**
|
|
779
|
-
* Returns information about a fleet provisioning template.
|
|
803
|
+
* Returns information about a fleet provisioning template. Requires permission to access the DescribeProvisioningTemplate action.
|
|
780
804
|
*/
|
|
781
805
|
describeProvisioningTemplate(callback?: (err: AWSError, data: Iot.Types.DescribeProvisioningTemplateResponse) => void): Request<Iot.Types.DescribeProvisioningTemplateResponse, AWSError>;
|
|
782
806
|
/**
|
|
783
|
-
* Returns information about a fleet provisioning template version.
|
|
807
|
+
* Returns information about a fleet provisioning template version. Requires permission to access the DescribeProvisioningTemplateVersion action.
|
|
784
808
|
*/
|
|
785
809
|
describeProvisioningTemplateVersion(params: Iot.Types.DescribeProvisioningTemplateVersionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeProvisioningTemplateVersionResponse) => void): Request<Iot.Types.DescribeProvisioningTemplateVersionResponse, AWSError>;
|
|
786
810
|
/**
|
|
787
|
-
* Returns information about a fleet provisioning template version.
|
|
811
|
+
* Returns information about a fleet provisioning template version. Requires permission to access the DescribeProvisioningTemplateVersion action.
|
|
788
812
|
*/
|
|
789
813
|
describeProvisioningTemplateVersion(callback?: (err: AWSError, data: Iot.Types.DescribeProvisioningTemplateVersionResponse) => void): Request<Iot.Types.DescribeProvisioningTemplateVersionResponse, AWSError>;
|
|
790
814
|
/**
|
|
791
|
-
* Describes a role alias.
|
|
815
|
+
* Describes a role alias. Requires permission to access the DescribeRoleAlias action.
|
|
792
816
|
*/
|
|
793
817
|
describeRoleAlias(params: Iot.Types.DescribeRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.DescribeRoleAliasResponse) => void): Request<Iot.Types.DescribeRoleAliasResponse, AWSError>;
|
|
794
818
|
/**
|
|
795
|
-
* Describes a role alias.
|
|
819
|
+
* Describes a role alias. Requires permission to access the DescribeRoleAlias action.
|
|
796
820
|
*/
|
|
797
821
|
describeRoleAlias(callback?: (err: AWSError, data: Iot.Types.DescribeRoleAliasResponse) => void): Request<Iot.Types.DescribeRoleAliasResponse, AWSError>;
|
|
798
822
|
/**
|
|
799
|
-
* Gets information about a scheduled audit.
|
|
823
|
+
* Gets information about a scheduled audit. Requires permission to access the DescribeScheduledAudit action.
|
|
800
824
|
*/
|
|
801
825
|
describeScheduledAudit(params: Iot.Types.DescribeScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.DescribeScheduledAuditResponse) => void): Request<Iot.Types.DescribeScheduledAuditResponse, AWSError>;
|
|
802
826
|
/**
|
|
803
|
-
* Gets information about a scheduled audit.
|
|
827
|
+
* Gets information about a scheduled audit. Requires permission to access the DescribeScheduledAudit action.
|
|
804
828
|
*/
|
|
805
829
|
describeScheduledAudit(callback?: (err: AWSError, data: Iot.Types.DescribeScheduledAuditResponse) => void): Request<Iot.Types.DescribeScheduledAuditResponse, AWSError>;
|
|
806
830
|
/**
|
|
807
|
-
* Gets information about a Device Defender security profile.
|
|
831
|
+
* Gets information about a Device Defender security profile. Requires permission to access the DescribeSecurityProfile action.
|
|
808
832
|
*/
|
|
809
833
|
describeSecurityProfile(params: Iot.Types.DescribeSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DescribeSecurityProfileResponse) => void): Request<Iot.Types.DescribeSecurityProfileResponse, AWSError>;
|
|
810
834
|
/**
|
|
811
|
-
* Gets information about a Device Defender security profile.
|
|
835
|
+
* Gets information about a Device Defender security profile. Requires permission to access the DescribeSecurityProfile action.
|
|
812
836
|
*/
|
|
813
837
|
describeSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DescribeSecurityProfileResponse) => void): Request<Iot.Types.DescribeSecurityProfileResponse, AWSError>;
|
|
814
838
|
/**
|
|
815
|
-
* Gets information about a stream.
|
|
839
|
+
* Gets information about a stream. Requires permission to access the DescribeStream action.
|
|
816
840
|
*/
|
|
817
841
|
describeStream(params: Iot.Types.DescribeStreamRequest, callback?: (err: AWSError, data: Iot.Types.DescribeStreamResponse) => void): Request<Iot.Types.DescribeStreamResponse, AWSError>;
|
|
818
842
|
/**
|
|
819
|
-
* Gets information about a stream.
|
|
843
|
+
* Gets information about a stream. Requires permission to access the DescribeStream action.
|
|
820
844
|
*/
|
|
821
845
|
describeStream(callback?: (err: AWSError, data: Iot.Types.DescribeStreamResponse) => void): Request<Iot.Types.DescribeStreamResponse, AWSError>;
|
|
822
846
|
/**
|
|
823
|
-
* Gets information about the specified thing.
|
|
847
|
+
* Gets information about the specified thing. Requires permission to access the DescribeThing action.
|
|
824
848
|
*/
|
|
825
849
|
describeThing(params: Iot.Types.DescribeThingRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingResponse) => void): Request<Iot.Types.DescribeThingResponse, AWSError>;
|
|
826
850
|
/**
|
|
827
|
-
* Gets information about the specified thing.
|
|
851
|
+
* Gets information about the specified thing. Requires permission to access the DescribeThing action.
|
|
828
852
|
*/
|
|
829
853
|
describeThing(callback?: (err: AWSError, data: Iot.Types.DescribeThingResponse) => void): Request<Iot.Types.DescribeThingResponse, AWSError>;
|
|
830
854
|
/**
|
|
831
|
-
* Describe a thing group.
|
|
855
|
+
* Describe a thing group. Requires permission to access the DescribeThingGroup action.
|
|
832
856
|
*/
|
|
833
857
|
describeThingGroup(params: Iot.Types.DescribeThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingGroupResponse) => void): Request<Iot.Types.DescribeThingGroupResponse, AWSError>;
|
|
834
858
|
/**
|
|
835
|
-
* Describe a thing group.
|
|
859
|
+
* Describe a thing group. Requires permission to access the DescribeThingGroup action.
|
|
836
860
|
*/
|
|
837
861
|
describeThingGroup(callback?: (err: AWSError, data: Iot.Types.DescribeThingGroupResponse) => void): Request<Iot.Types.DescribeThingGroupResponse, AWSError>;
|
|
838
862
|
/**
|
|
839
|
-
* Describes a bulk thing provisioning task.
|
|
863
|
+
* Describes a bulk thing provisioning task. Requires permission to access the DescribeThingRegistrationTask action.
|
|
840
864
|
*/
|
|
841
865
|
describeThingRegistrationTask(params: Iot.Types.DescribeThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingRegistrationTaskResponse) => void): Request<Iot.Types.DescribeThingRegistrationTaskResponse, AWSError>;
|
|
842
866
|
/**
|
|
843
|
-
* Describes a bulk thing provisioning task.
|
|
867
|
+
* Describes a bulk thing provisioning task. Requires permission to access the DescribeThingRegistrationTask action.
|
|
844
868
|
*/
|
|
845
869
|
describeThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.DescribeThingRegistrationTaskResponse) => void): Request<Iot.Types.DescribeThingRegistrationTaskResponse, AWSError>;
|
|
846
870
|
/**
|
|
847
|
-
* Gets information about the specified thing type.
|
|
871
|
+
* Gets information about the specified thing type. Requires permission to access the DescribeThingType action.
|
|
848
872
|
*/
|
|
849
873
|
describeThingType(params: Iot.Types.DescribeThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingTypeResponse) => void): Request<Iot.Types.DescribeThingTypeResponse, AWSError>;
|
|
850
874
|
/**
|
|
851
|
-
* Gets information about the specified thing type.
|
|
875
|
+
* Gets information about the specified thing type. Requires permission to access the DescribeThingType action.
|
|
852
876
|
*/
|
|
853
877
|
describeThingType(callback?: (err: AWSError, data: Iot.Types.DescribeThingTypeResponse) => void): Request<Iot.Types.DescribeThingTypeResponse, AWSError>;
|
|
854
878
|
/**
|
|
855
|
-
* Detaches a policy from the specified target.
|
|
879
|
+
* Detaches a policy from the specified target. Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted. Requires permission to access the DetachPolicy action.
|
|
856
880
|
*/
|
|
857
881
|
detachPolicy(params: Iot.Types.DetachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
858
882
|
/**
|
|
859
|
-
* Detaches a policy from the specified target.
|
|
883
|
+
* Detaches a policy from the specified target. Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted. Requires permission to access the DetachPolicy action.
|
|
860
884
|
*/
|
|
861
885
|
detachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
862
886
|
/**
|
|
863
|
-
* Removes the specified policy from the specified certificate.
|
|
887
|
+
* Removes the specified policy from the specified certificate. This action is deprecated. Please use DetachPolicy instead. Requires permission to access the DetachPrincipalPolicy action.
|
|
864
888
|
*/
|
|
865
889
|
detachPrincipalPolicy(params: Iot.Types.DetachPrincipalPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
866
890
|
/**
|
|
867
|
-
* Removes the specified policy from the specified certificate.
|
|
891
|
+
* Removes the specified policy from the specified certificate. This action is deprecated. Please use DetachPolicy instead. Requires permission to access the DetachPrincipalPolicy action.
|
|
868
892
|
*/
|
|
869
893
|
detachPrincipalPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
870
894
|
/**
|
|
871
|
-
* Disassociates a Device Defender security profile from a thing group or from this account.
|
|
895
|
+
* Disassociates a Device Defender security profile from a thing group or from this account. Requires permission to access the DetachSecurityProfile action.
|
|
872
896
|
*/
|
|
873
897
|
detachSecurityProfile(params: Iot.Types.DetachSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DetachSecurityProfileResponse) => void): Request<Iot.Types.DetachSecurityProfileResponse, AWSError>;
|
|
874
898
|
/**
|
|
875
|
-
* Disassociates a Device Defender security profile from a thing group or from this account.
|
|
899
|
+
* Disassociates a Device Defender security profile from a thing group or from this account. Requires permission to access the DetachSecurityProfile action.
|
|
876
900
|
*/
|
|
877
901
|
detachSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DetachSecurityProfileResponse) => void): Request<Iot.Types.DetachSecurityProfileResponse, AWSError>;
|
|
878
902
|
/**
|
|
879
|
-
* 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.
|
|
903
|
+
* 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. Requires permission to access the DetachThingPrincipal action.
|
|
880
904
|
*/
|
|
881
905
|
detachThingPrincipal(params: Iot.Types.DetachThingPrincipalRequest, callback?: (err: AWSError, data: Iot.Types.DetachThingPrincipalResponse) => void): Request<Iot.Types.DetachThingPrincipalResponse, AWSError>;
|
|
882
906
|
/**
|
|
883
|
-
* 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.
|
|
907
|
+
* 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. Requires permission to access the DetachThingPrincipal action.
|
|
884
908
|
*/
|
|
885
909
|
detachThingPrincipal(callback?: (err: AWSError, data: Iot.Types.DetachThingPrincipalResponse) => void): Request<Iot.Types.DetachThingPrincipalResponse, AWSError>;
|
|
886
910
|
/**
|
|
887
|
-
* Disables the rule.
|
|
911
|
+
* Disables the rule. Requires permission to access the DisableTopicRule action.
|
|
888
912
|
*/
|
|
889
913
|
disableTopicRule(params: Iot.Types.DisableTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
890
914
|
/**
|
|
891
|
-
* Disables the rule.
|
|
915
|
+
* Disables the rule. Requires permission to access the DisableTopicRule action.
|
|
892
916
|
*/
|
|
893
917
|
disableTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
894
918
|
/**
|
|
895
|
-
* Enables the rule.
|
|
919
|
+
* Enables the rule. Requires permission to access the EnableTopicRule action.
|
|
896
920
|
*/
|
|
897
921
|
enableTopicRule(params: Iot.Types.EnableTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
898
922
|
/**
|
|
899
|
-
* Enables the rule.
|
|
923
|
+
* Enables the rule. Requires permission to access the EnableTopicRule action.
|
|
900
924
|
*/
|
|
901
925
|
enableTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
902
926
|
/**
|
|
903
|
-
* Returns a Device Defender's ML Detect Security Profile training model's status.
|
|
927
|
+
* Returns a Device Defender's ML Detect Security Profile training model's status. Requires permission to access the GetBehaviorModelTrainingSummaries action.
|
|
904
928
|
*/
|
|
905
929
|
getBehaviorModelTrainingSummaries(params: Iot.Types.GetBehaviorModelTrainingSummariesRequest, callback?: (err: AWSError, data: Iot.Types.GetBehaviorModelTrainingSummariesResponse) => void): Request<Iot.Types.GetBehaviorModelTrainingSummariesResponse, AWSError>;
|
|
906
930
|
/**
|
|
907
|
-
* Returns a Device Defender's ML Detect Security Profile training model's status.
|
|
931
|
+
* Returns a Device Defender's ML Detect Security Profile training model's status. Requires permission to access the GetBehaviorModelTrainingSummaries action.
|
|
908
932
|
*/
|
|
909
933
|
getBehaviorModelTrainingSummaries(callback?: (err: AWSError, data: Iot.Types.GetBehaviorModelTrainingSummariesResponse) => void): Request<Iot.Types.GetBehaviorModelTrainingSummariesResponse, AWSError>;
|
|
910
934
|
/**
|
|
911
|
-
*
|
|
935
|
+
* Aggregates on indexed data with search queries pertaining to particular fields. Requires permission to access the GetBucketsAggregation action.
|
|
936
|
+
*/
|
|
937
|
+
getBucketsAggregation(params: Iot.Types.GetBucketsAggregationRequest, callback?: (err: AWSError, data: Iot.Types.GetBucketsAggregationResponse) => void): Request<Iot.Types.GetBucketsAggregationResponse, AWSError>;
|
|
938
|
+
/**
|
|
939
|
+
* Aggregates on indexed data with search queries pertaining to particular fields. Requires permission to access the GetBucketsAggregation action.
|
|
940
|
+
*/
|
|
941
|
+
getBucketsAggregation(callback?: (err: AWSError, data: Iot.Types.GetBucketsAggregationResponse) => void): Request<Iot.Types.GetBucketsAggregationResponse, AWSError>;
|
|
942
|
+
/**
|
|
943
|
+
* Returns the approximate count of unique values that match the query. Requires permission to access the GetCardinality action.
|
|
912
944
|
*/
|
|
913
945
|
getCardinality(params: Iot.Types.GetCardinalityRequest, callback?: (err: AWSError, data: Iot.Types.GetCardinalityResponse) => void): Request<Iot.Types.GetCardinalityResponse, AWSError>;
|
|
914
946
|
/**
|
|
915
|
-
* Returns the approximate count of unique values that match the query.
|
|
947
|
+
* Returns the approximate count of unique values that match the query. Requires permission to access the GetCardinality action.
|
|
916
948
|
*/
|
|
917
949
|
getCardinality(callback?: (err: AWSError, data: Iot.Types.GetCardinalityResponse) => void): Request<Iot.Types.GetCardinalityResponse, AWSError>;
|
|
918
950
|
/**
|
|
919
|
-
* Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the
|
|
951
|
+
* Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway. Requires permission to access the GetEffectivePolicies action.
|
|
920
952
|
*/
|
|
921
953
|
getEffectivePolicies(params: Iot.Types.GetEffectivePoliciesRequest, callback?: (err: AWSError, data: Iot.Types.GetEffectivePoliciesResponse) => void): Request<Iot.Types.GetEffectivePoliciesResponse, AWSError>;
|
|
922
954
|
/**
|
|
923
|
-
* Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the
|
|
955
|
+
* Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway. Requires permission to access the GetEffectivePolicies action.
|
|
924
956
|
*/
|
|
925
957
|
getEffectivePolicies(callback?: (err: AWSError, data: Iot.Types.GetEffectivePoliciesResponse) => void): Request<Iot.Types.GetEffectivePoliciesResponse, AWSError>;
|
|
926
958
|
/**
|
|
927
|
-
* Gets the indexing configuration.
|
|
959
|
+
* Gets the indexing configuration. Requires permission to access the GetIndexingConfiguration action.
|
|
928
960
|
*/
|
|
929
961
|
getIndexingConfiguration(params: Iot.Types.GetIndexingConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.GetIndexingConfigurationResponse) => void): Request<Iot.Types.GetIndexingConfigurationResponse, AWSError>;
|
|
930
962
|
/**
|
|
931
|
-
* Gets the indexing configuration.
|
|
963
|
+
* Gets the indexing configuration. Requires permission to access the GetIndexingConfiguration action.
|
|
932
964
|
*/
|
|
933
965
|
getIndexingConfiguration(callback?: (err: AWSError, data: Iot.Types.GetIndexingConfigurationResponse) => void): Request<Iot.Types.GetIndexingConfigurationResponse, AWSError>;
|
|
934
966
|
/**
|
|
935
|
-
* Gets a job document.
|
|
967
|
+
* Gets a job document. Requires permission to access the GetJobDocument action.
|
|
936
968
|
*/
|
|
937
969
|
getJobDocument(params: Iot.Types.GetJobDocumentRequest, callback?: (err: AWSError, data: Iot.Types.GetJobDocumentResponse) => void): Request<Iot.Types.GetJobDocumentResponse, AWSError>;
|
|
938
970
|
/**
|
|
939
|
-
* Gets a job document.
|
|
971
|
+
* Gets a job document. Requires permission to access the GetJobDocument action.
|
|
940
972
|
*/
|
|
941
973
|
getJobDocument(callback?: (err: AWSError, data: Iot.Types.GetJobDocumentResponse) => void): Request<Iot.Types.GetJobDocumentResponse, AWSError>;
|
|
942
974
|
/**
|
|
943
|
-
* Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
|
|
975
|
+
* Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead. Requires permission to access the GetLoggingOptions action.
|
|
944
976
|
*/
|
|
945
977
|
getLoggingOptions(params: Iot.Types.GetLoggingOptionsRequest, callback?: (err: AWSError, data: Iot.Types.GetLoggingOptionsResponse) => void): Request<Iot.Types.GetLoggingOptionsResponse, AWSError>;
|
|
946
978
|
/**
|
|
947
|
-
* Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
|
|
979
|
+
* Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead. Requires permission to access the GetLoggingOptions action.
|
|
948
980
|
*/
|
|
949
981
|
getLoggingOptions(callback?: (err: AWSError, data: Iot.Types.GetLoggingOptionsResponse) => void): Request<Iot.Types.GetLoggingOptionsResponse, AWSError>;
|
|
950
982
|
/**
|
|
951
|
-
* Gets an OTA update.
|
|
983
|
+
* Gets an OTA update. Requires permission to access the GetOTAUpdate action.
|
|
952
984
|
*/
|
|
953
985
|
getOTAUpdate(params: Iot.Types.GetOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.GetOTAUpdateResponse) => void): Request<Iot.Types.GetOTAUpdateResponse, AWSError>;
|
|
954
986
|
/**
|
|
955
|
-
* Gets an OTA update.
|
|
987
|
+
* Gets an OTA update. Requires permission to access the GetOTAUpdate action.
|
|
956
988
|
*/
|
|
957
989
|
getOTAUpdate(callback?: (err: AWSError, data: Iot.Types.GetOTAUpdateResponse) => void): Request<Iot.Types.GetOTAUpdateResponse, AWSError>;
|
|
958
990
|
/**
|
|
959
|
-
* 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.
|
|
991
|
+
* 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. Requires permission to access the GetPercentiles action.
|
|
960
992
|
*/
|
|
961
993
|
getPercentiles(params: Iot.Types.GetPercentilesRequest, callback?: (err: AWSError, data: Iot.Types.GetPercentilesResponse) => void): Request<Iot.Types.GetPercentilesResponse, AWSError>;
|
|
962
994
|
/**
|
|
963
|
-
* 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.
|
|
995
|
+
* 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. Requires permission to access the GetPercentiles action.
|
|
964
996
|
*/
|
|
965
997
|
getPercentiles(callback?: (err: AWSError, data: Iot.Types.GetPercentilesResponse) => void): Request<Iot.Types.GetPercentilesResponse, AWSError>;
|
|
966
998
|
/**
|
|
967
|
-
* Gets information about the specified policy with the policy document of the default version.
|
|
999
|
+
* Gets information about the specified policy with the policy document of the default version. Requires permission to access the GetPolicy action.
|
|
968
1000
|
*/
|
|
969
1001
|
getPolicy(params: Iot.Types.GetPolicyRequest, callback?: (err: AWSError, data: Iot.Types.GetPolicyResponse) => void): Request<Iot.Types.GetPolicyResponse, AWSError>;
|
|
970
1002
|
/**
|
|
971
|
-
* Gets information about the specified policy with the policy document of the default version.
|
|
1003
|
+
* Gets information about the specified policy with the policy document of the default version. Requires permission to access the GetPolicy action.
|
|
972
1004
|
*/
|
|
973
1005
|
getPolicy(callback?: (err: AWSError, data: Iot.Types.GetPolicyResponse) => void): Request<Iot.Types.GetPolicyResponse, AWSError>;
|
|
974
1006
|
/**
|
|
975
|
-
* Gets information about the specified policy version.
|
|
1007
|
+
* Gets information about the specified policy version. Requires permission to access the GetPolicyVersion action.
|
|
976
1008
|
*/
|
|
977
1009
|
getPolicyVersion(params: Iot.Types.GetPolicyVersionRequest, callback?: (err: AWSError, data: Iot.Types.GetPolicyVersionResponse) => void): Request<Iot.Types.GetPolicyVersionResponse, AWSError>;
|
|
978
1010
|
/**
|
|
979
|
-
* Gets information about the specified policy version.
|
|
1011
|
+
* Gets information about the specified policy version. Requires permission to access the GetPolicyVersion action.
|
|
980
1012
|
*/
|
|
981
1013
|
getPolicyVersion(callback?: (err: AWSError, data: Iot.Types.GetPolicyVersionResponse) => void): Request<Iot.Types.GetPolicyVersionResponse, AWSError>;
|
|
982
1014
|
/**
|
|
983
|
-
* Gets a registration code used to register a CA certificate with
|
|
1015
|
+
* Gets a registration code used to register a CA certificate with IoT. Requires permission to access the GetRegistrationCode action.
|
|
984
1016
|
*/
|
|
985
1017
|
getRegistrationCode(params: Iot.Types.GetRegistrationCodeRequest, callback?: (err: AWSError, data: Iot.Types.GetRegistrationCodeResponse) => void): Request<Iot.Types.GetRegistrationCodeResponse, AWSError>;
|
|
986
1018
|
/**
|
|
987
|
-
* Gets a registration code used to register a CA certificate with
|
|
1019
|
+
* Gets a registration code used to register a CA certificate with IoT. Requires permission to access the GetRegistrationCode action.
|
|
988
1020
|
*/
|
|
989
1021
|
getRegistrationCode(callback?: (err: AWSError, data: Iot.Types.GetRegistrationCodeResponse) => void): Request<Iot.Types.GetRegistrationCodeResponse, AWSError>;
|
|
990
1022
|
/**
|
|
991
|
-
* 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.
|
|
1023
|
+
* 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. Requires permission to access the GetStatistics action.
|
|
992
1024
|
*/
|
|
993
1025
|
getStatistics(params: Iot.Types.GetStatisticsRequest, callback?: (err: AWSError, data: Iot.Types.GetStatisticsResponse) => void): Request<Iot.Types.GetStatisticsResponse, AWSError>;
|
|
994
1026
|
/**
|
|
995
|
-
* 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.
|
|
1027
|
+
* 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. Requires permission to access the GetStatistics action.
|
|
996
1028
|
*/
|
|
997
1029
|
getStatistics(callback?: (err: AWSError, data: Iot.Types.GetStatisticsResponse) => void): Request<Iot.Types.GetStatisticsResponse, AWSError>;
|
|
998
1030
|
/**
|
|
999
|
-
* Gets information about the rule.
|
|
1031
|
+
* Gets information about the rule. Requires permission to access the GetTopicRule action.
|
|
1000
1032
|
*/
|
|
1001
1033
|
getTopicRule(params: Iot.Types.GetTopicRuleRequest, callback?: (err: AWSError, data: Iot.Types.GetTopicRuleResponse) => void): Request<Iot.Types.GetTopicRuleResponse, AWSError>;
|
|
1002
1034
|
/**
|
|
1003
|
-
* Gets information about the rule.
|
|
1035
|
+
* Gets information about the rule. Requires permission to access the GetTopicRule action.
|
|
1004
1036
|
*/
|
|
1005
1037
|
getTopicRule(callback?: (err: AWSError, data: Iot.Types.GetTopicRuleResponse) => void): Request<Iot.Types.GetTopicRuleResponse, AWSError>;
|
|
1006
1038
|
/**
|
|
1007
|
-
* Gets information about a topic rule destination.
|
|
1039
|
+
* Gets information about a topic rule destination. Requires permission to access the GetTopicRuleDestination action.
|
|
1008
1040
|
*/
|
|
1009
1041
|
getTopicRuleDestination(params: Iot.Types.GetTopicRuleDestinationRequest, callback?: (err: AWSError, data: Iot.Types.GetTopicRuleDestinationResponse) => void): Request<Iot.Types.GetTopicRuleDestinationResponse, AWSError>;
|
|
1010
1042
|
/**
|
|
1011
|
-
* Gets information about a topic rule destination.
|
|
1043
|
+
* Gets information about a topic rule destination. Requires permission to access the GetTopicRuleDestination action.
|
|
1012
1044
|
*/
|
|
1013
1045
|
getTopicRuleDestination(callback?: (err: AWSError, data: Iot.Types.GetTopicRuleDestinationResponse) => void): Request<Iot.Types.GetTopicRuleDestinationResponse, AWSError>;
|
|
1014
1046
|
/**
|
|
1015
|
-
* Gets the fine grained logging options.
|
|
1047
|
+
* Gets the fine grained logging options. Requires permission to access the GetV2LoggingOptions action.
|
|
1016
1048
|
*/
|
|
1017
1049
|
getV2LoggingOptions(params: Iot.Types.GetV2LoggingOptionsRequest, callback?: (err: AWSError, data: Iot.Types.GetV2LoggingOptionsResponse) => void): Request<Iot.Types.GetV2LoggingOptionsResponse, AWSError>;
|
|
1018
1050
|
/**
|
|
1019
|
-
* Gets the fine grained logging options.
|
|
1051
|
+
* Gets the fine grained logging options. Requires permission to access the GetV2LoggingOptions action.
|
|
1020
1052
|
*/
|
|
1021
1053
|
getV2LoggingOptions(callback?: (err: AWSError, data: Iot.Types.GetV2LoggingOptionsResponse) => void): Request<Iot.Types.GetV2LoggingOptionsResponse, AWSError>;
|
|
1022
1054
|
/**
|
|
1023
|
-
* Lists the active violations for a given Device Defender security profile.
|
|
1055
|
+
* Lists the active violations for a given Device Defender security profile. Requires permission to access the ListActiveViolations action.
|
|
1024
1056
|
*/
|
|
1025
1057
|
listActiveViolations(params: Iot.Types.ListActiveViolationsRequest, callback?: (err: AWSError, data: Iot.Types.ListActiveViolationsResponse) => void): Request<Iot.Types.ListActiveViolationsResponse, AWSError>;
|
|
1026
1058
|
/**
|
|
1027
|
-
* Lists the active violations for a given Device Defender security profile.
|
|
1059
|
+
* Lists the active violations for a given Device Defender security profile. Requires permission to access the ListActiveViolations action.
|
|
1028
1060
|
*/
|
|
1029
1061
|
listActiveViolations(callback?: (err: AWSError, data: Iot.Types.ListActiveViolationsResponse) => void): Request<Iot.Types.ListActiveViolationsResponse, AWSError>;
|
|
1030
1062
|
/**
|
|
1031
|
-
* Lists the policies attached to the specified thing group.
|
|
1063
|
+
* Lists the policies attached to the specified thing group. Requires permission to access the ListAttachedPolicies action.
|
|
1032
1064
|
*/
|
|
1033
1065
|
listAttachedPolicies(params: Iot.Types.ListAttachedPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListAttachedPoliciesResponse) => void): Request<Iot.Types.ListAttachedPoliciesResponse, AWSError>;
|
|
1034
1066
|
/**
|
|
1035
|
-
* Lists the policies attached to the specified thing group.
|
|
1067
|
+
* Lists the policies attached to the specified thing group. Requires permission to access the ListAttachedPolicies action.
|
|
1036
1068
|
*/
|
|
1037
1069
|
listAttachedPolicies(callback?: (err: AWSError, data: Iot.Types.ListAttachedPoliciesResponse) => void): Request<Iot.Types.ListAttachedPoliciesResponse, AWSError>;
|
|
1038
1070
|
/**
|
|
1039
|
-
* Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)
|
|
1071
|
+
* Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.) Requires permission to access the ListAuditFindings action.
|
|
1040
1072
|
*/
|
|
1041
1073
|
listAuditFindings(params: Iot.Types.ListAuditFindingsRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditFindingsResponse) => void): Request<Iot.Types.ListAuditFindingsResponse, AWSError>;
|
|
1042
1074
|
/**
|
|
1043
|
-
* Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)
|
|
1075
|
+
* Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.) Requires permission to access the ListAuditFindings action.
|
|
1044
1076
|
*/
|
|
1045
1077
|
listAuditFindings(callback?: (err: AWSError, data: Iot.Types.ListAuditFindingsResponse) => void): Request<Iot.Types.ListAuditFindingsResponse, AWSError>;
|
|
1046
1078
|
/**
|
|
1047
|
-
* Gets the status of audit mitigation action tasks that were executed.
|
|
1079
|
+
* Gets the status of audit mitigation action tasks that were executed. Requires permission to access the ListAuditMitigationActionsExecutions action.
|
|
1048
1080
|
*/
|
|
1049
1081
|
listAuditMitigationActionsExecutions(params: Iot.Types.ListAuditMitigationActionsExecutionsRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsExecutionsResponse) => void): Request<Iot.Types.ListAuditMitigationActionsExecutionsResponse, AWSError>;
|
|
1050
1082
|
/**
|
|
1051
|
-
* Gets the status of audit mitigation action tasks that were executed.
|
|
1083
|
+
* Gets the status of audit mitigation action tasks that were executed. Requires permission to access the ListAuditMitigationActionsExecutions action.
|
|
1052
1084
|
*/
|
|
1053
1085
|
listAuditMitigationActionsExecutions(callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsExecutionsResponse) => void): Request<Iot.Types.ListAuditMitigationActionsExecutionsResponse, AWSError>;
|
|
1054
1086
|
/**
|
|
1055
|
-
* Gets a list of audit mitigation action tasks that match the specified filters.
|
|
1087
|
+
* Gets a list of audit mitigation action tasks that match the specified filters. Requires permission to access the ListAuditMitigationActionsTasks action.
|
|
1056
1088
|
*/
|
|
1057
1089
|
listAuditMitigationActionsTasks(params: Iot.Types.ListAuditMitigationActionsTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsTasksResponse) => void): Request<Iot.Types.ListAuditMitigationActionsTasksResponse, AWSError>;
|
|
1058
1090
|
/**
|
|
1059
|
-
* Gets a list of audit mitigation action tasks that match the specified filters.
|
|
1091
|
+
* Gets a list of audit mitigation action tasks that match the specified filters. Requires permission to access the ListAuditMitigationActionsTasks action.
|
|
1060
1092
|
*/
|
|
1061
1093
|
listAuditMitigationActionsTasks(callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsTasksResponse) => void): Request<Iot.Types.ListAuditMitigationActionsTasksResponse, AWSError>;
|
|
1062
1094
|
/**
|
|
1063
|
-
* Lists your Device Defender audit listings.
|
|
1095
|
+
* Lists your Device Defender audit listings. Requires permission to access the ListAuditSuppressions action.
|
|
1064
1096
|
*/
|
|
1065
1097
|
listAuditSuppressions(params: Iot.Types.ListAuditSuppressionsRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditSuppressionsResponse) => void): Request<Iot.Types.ListAuditSuppressionsResponse, AWSError>;
|
|
1066
1098
|
/**
|
|
1067
|
-
* Lists your Device Defender audit listings.
|
|
1099
|
+
* Lists your Device Defender audit listings. Requires permission to access the ListAuditSuppressions action.
|
|
1068
1100
|
*/
|
|
1069
1101
|
listAuditSuppressions(callback?: (err: AWSError, data: Iot.Types.ListAuditSuppressionsResponse) => void): Request<Iot.Types.ListAuditSuppressionsResponse, AWSError>;
|
|
1070
1102
|
/**
|
|
1071
|
-
* Lists the Device Defender audits that have been performed during a given time period.
|
|
1103
|
+
* Lists the Device Defender audits that have been performed during a given time period. Requires permission to access the ListAuditTasks action.
|
|
1072
1104
|
*/
|
|
1073
1105
|
listAuditTasks(params: Iot.Types.ListAuditTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditTasksResponse) => void): Request<Iot.Types.ListAuditTasksResponse, AWSError>;
|
|
1074
1106
|
/**
|
|
1075
|
-
* Lists the Device Defender audits that have been performed during a given time period.
|
|
1107
|
+
* Lists the Device Defender audits that have been performed during a given time period. Requires permission to access the ListAuditTasks action.
|
|
1076
1108
|
*/
|
|
1077
1109
|
listAuditTasks(callback?: (err: AWSError, data: Iot.Types.ListAuditTasksResponse) => void): Request<Iot.Types.ListAuditTasksResponse, AWSError>;
|
|
1078
1110
|
/**
|
|
1079
|
-
* Lists the authorizers registered in your account.
|
|
1111
|
+
* Lists the authorizers registered in your account. Requires permission to access the ListAuthorizers action.
|
|
1080
1112
|
*/
|
|
1081
1113
|
listAuthorizers(params: Iot.Types.ListAuthorizersRequest, callback?: (err: AWSError, data: Iot.Types.ListAuthorizersResponse) => void): Request<Iot.Types.ListAuthorizersResponse, AWSError>;
|
|
1082
1114
|
/**
|
|
1083
|
-
* Lists the authorizers registered in your account.
|
|
1115
|
+
* Lists the authorizers registered in your account. Requires permission to access the ListAuthorizers action.
|
|
1084
1116
|
*/
|
|
1085
1117
|
listAuthorizers(callback?: (err: AWSError, data: Iot.Types.ListAuthorizersResponse) => void): Request<Iot.Types.ListAuthorizersResponse, AWSError>;
|
|
1086
1118
|
/**
|
|
1087
|
-
* Lists the billing groups you have created.
|
|
1119
|
+
* Lists the billing groups you have created. Requires permission to access the ListBillingGroups action.
|
|
1088
1120
|
*/
|
|
1089
1121
|
listBillingGroups(params: Iot.Types.ListBillingGroupsRequest, callback?: (err: AWSError, data: Iot.Types.ListBillingGroupsResponse) => void): Request<Iot.Types.ListBillingGroupsResponse, AWSError>;
|
|
1090
1122
|
/**
|
|
1091
|
-
* Lists the billing groups you have created.
|
|
1123
|
+
* Lists the billing groups you have created. Requires permission to access the ListBillingGroups action.
|
|
1092
1124
|
*/
|
|
1093
1125
|
listBillingGroups(callback?: (err: AWSError, data: Iot.Types.ListBillingGroupsResponse) => void): Request<Iot.Types.ListBillingGroupsResponse, AWSError>;
|
|
1094
1126
|
/**
|
|
1095
|
-
* Lists the CA certificates registered for your
|
|
1127
|
+
* Lists the CA certificates registered for your Amazon Web Services account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. Requires permission to access the ListCACertificates action.
|
|
1096
1128
|
*/
|
|
1097
1129
|
listCACertificates(params: Iot.Types.ListCACertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListCACertificatesResponse) => void): Request<Iot.Types.ListCACertificatesResponse, AWSError>;
|
|
1098
1130
|
/**
|
|
1099
|
-
* Lists the CA certificates registered for your
|
|
1131
|
+
* Lists the CA certificates registered for your Amazon Web Services account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. Requires permission to access the ListCACertificates action.
|
|
1100
1132
|
*/
|
|
1101
1133
|
listCACertificates(callback?: (err: AWSError, data: Iot.Types.ListCACertificatesResponse) => void): Request<Iot.Types.ListCACertificatesResponse, AWSError>;
|
|
1102
1134
|
/**
|
|
1103
|
-
* Lists the certificates registered in your
|
|
1135
|
+
* Lists the certificates registered in your Amazon Web Services account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. Requires permission to access the ListCertificates action.
|
|
1104
1136
|
*/
|
|
1105
1137
|
listCertificates(params: Iot.Types.ListCertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListCertificatesResponse) => void): Request<Iot.Types.ListCertificatesResponse, AWSError>;
|
|
1106
1138
|
/**
|
|
1107
|
-
* Lists the certificates registered in your
|
|
1139
|
+
* Lists the certificates registered in your Amazon Web Services account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. Requires permission to access the ListCertificates action.
|
|
1108
1140
|
*/
|
|
1109
1141
|
listCertificates(callback?: (err: AWSError, data: Iot.Types.ListCertificatesResponse) => void): Request<Iot.Types.ListCertificatesResponse, AWSError>;
|
|
1110
1142
|
/**
|
|
1111
|
-
* List the device certificates signed by the specified CA certificate.
|
|
1143
|
+
* List the device certificates signed by the specified CA certificate. Requires permission to access the ListCertificatesByCA action.
|
|
1112
1144
|
*/
|
|
1113
1145
|
listCertificatesByCA(params: Iot.Types.ListCertificatesByCARequest, callback?: (err: AWSError, data: Iot.Types.ListCertificatesByCAResponse) => void): Request<Iot.Types.ListCertificatesByCAResponse, AWSError>;
|
|
1114
1146
|
/**
|
|
1115
|
-
* List the device certificates signed by the specified CA certificate.
|
|
1147
|
+
* List the device certificates signed by the specified CA certificate. Requires permission to access the ListCertificatesByCA action.
|
|
1116
1148
|
*/
|
|
1117
1149
|
listCertificatesByCA(callback?: (err: AWSError, data: Iot.Types.ListCertificatesByCAResponse) => void): Request<Iot.Types.ListCertificatesByCAResponse, AWSError>;
|
|
1118
1150
|
/**
|
|
1119
|
-
* Lists your Device Defender detect custom metrics.
|
|
1151
|
+
* Lists your Device Defender detect custom metrics. Requires permission to access the ListCustomMetrics action.
|
|
1120
1152
|
*/
|
|
1121
1153
|
listCustomMetrics(params: Iot.Types.ListCustomMetricsRequest, callback?: (err: AWSError, data: Iot.Types.ListCustomMetricsResponse) => void): Request<Iot.Types.ListCustomMetricsResponse, AWSError>;
|
|
1122
1154
|
/**
|
|
1123
|
-
* Lists your Device Defender detect custom metrics.
|
|
1155
|
+
* Lists your Device Defender detect custom metrics. Requires permission to access the ListCustomMetrics action.
|
|
1124
1156
|
*/
|
|
1125
1157
|
listCustomMetrics(callback?: (err: AWSError, data: Iot.Types.ListCustomMetricsResponse) => void): Request<Iot.Types.ListCustomMetricsResponse, AWSError>;
|
|
1126
1158
|
/**
|
|
1127
|
-
* Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
|
|
1159
|
+
* Lists mitigation actions executions for a Device Defender ML Detect Security Profile. Requires permission to access the ListDetectMitigationActionsExecutions action.
|
|
1128
1160
|
*/
|
|
1129
1161
|
listDetectMitigationActionsExecutions(params: Iot.Types.ListDetectMitigationActionsExecutionsRequest, callback?: (err: AWSError, data: Iot.Types.ListDetectMitigationActionsExecutionsResponse) => void): Request<Iot.Types.ListDetectMitigationActionsExecutionsResponse, AWSError>;
|
|
1130
1162
|
/**
|
|
1131
|
-
* Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
|
|
1163
|
+
* Lists mitigation actions executions for a Device Defender ML Detect Security Profile. Requires permission to access the ListDetectMitigationActionsExecutions action.
|
|
1132
1164
|
*/
|
|
1133
1165
|
listDetectMitigationActionsExecutions(callback?: (err: AWSError, data: Iot.Types.ListDetectMitigationActionsExecutionsResponse) => void): Request<Iot.Types.ListDetectMitigationActionsExecutionsResponse, AWSError>;
|
|
1134
1166
|
/**
|
|
1135
|
-
* List of Device Defender ML Detect mitigation actions tasks.
|
|
1167
|
+
* List of Device Defender ML Detect mitigation actions tasks. Requires permission to access the ListDetectMitigationActionsTasks action.
|
|
1136
1168
|
*/
|
|
1137
1169
|
listDetectMitigationActionsTasks(params: Iot.Types.ListDetectMitigationActionsTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListDetectMitigationActionsTasksResponse) => void): Request<Iot.Types.ListDetectMitigationActionsTasksResponse, AWSError>;
|
|
1138
1170
|
/**
|
|
1139
|
-
* List of Device Defender ML Detect mitigation actions tasks.
|
|
1171
|
+
* List of Device Defender ML Detect mitigation actions tasks. Requires permission to access the ListDetectMitigationActionsTasks action.
|
|
1140
1172
|
*/
|
|
1141
1173
|
listDetectMitigationActionsTasks(callback?: (err: AWSError, data: Iot.Types.ListDetectMitigationActionsTasksResponse) => void): Request<Iot.Types.ListDetectMitigationActionsTasksResponse, AWSError>;
|
|
1142
1174
|
/**
|
|
1143
|
-
* List the set of dimensions that are defined for your
|
|
1175
|
+
* List the set of dimensions that are defined for your Amazon Web Services accounts. Requires permission to access the ListDimensions action.
|
|
1144
1176
|
*/
|
|
1145
1177
|
listDimensions(params: Iot.Types.ListDimensionsRequest, callback?: (err: AWSError, data: Iot.Types.ListDimensionsResponse) => void): Request<Iot.Types.ListDimensionsResponse, AWSError>;
|
|
1146
1178
|
/**
|
|
1147
|
-
* List the set of dimensions that are defined for your
|
|
1179
|
+
* List the set of dimensions that are defined for your Amazon Web Services accounts. Requires permission to access the ListDimensions action.
|
|
1148
1180
|
*/
|
|
1149
1181
|
listDimensions(callback?: (err: AWSError, data: Iot.Types.ListDimensionsResponse) => void): Request<Iot.Types.ListDimensionsResponse, AWSError>;
|
|
1150
1182
|
/**
|
|
1151
|
-
* Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.
|
|
1183
|
+
* Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. Requires permission to access the ListDomainConfigurations action.
|
|
1152
1184
|
*/
|
|
1153
1185
|
listDomainConfigurations(params: Iot.Types.ListDomainConfigurationsRequest, callback?: (err: AWSError, data: Iot.Types.ListDomainConfigurationsResponse) => void): Request<Iot.Types.ListDomainConfigurationsResponse, AWSError>;
|
|
1154
1186
|
/**
|
|
1155
|
-
* Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.
|
|
1187
|
+
* Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. Requires permission to access the ListDomainConfigurations action.
|
|
1156
1188
|
*/
|
|
1157
1189
|
listDomainConfigurations(callback?: (err: AWSError, data: Iot.Types.ListDomainConfigurationsResponse) => void): Request<Iot.Types.ListDomainConfigurationsResponse, AWSError>;
|
|
1158
1190
|
/**
|
|
1159
|
-
* Lists the
|
|
1191
|
+
* Lists all your fleet metrics. Requires permission to access the ListFleetMetrics action.
|
|
1192
|
+
*/
|
|
1193
|
+
listFleetMetrics(params: Iot.Types.ListFleetMetricsRequest, callback?: (err: AWSError, data: Iot.Types.ListFleetMetricsResponse) => void): Request<Iot.Types.ListFleetMetricsResponse, AWSError>;
|
|
1194
|
+
/**
|
|
1195
|
+
* Lists all your fleet metrics. Requires permission to access the ListFleetMetrics action.
|
|
1196
|
+
*/
|
|
1197
|
+
listFleetMetrics(callback?: (err: AWSError, data: Iot.Types.ListFleetMetricsResponse) => void): Request<Iot.Types.ListFleetMetricsResponse, AWSError>;
|
|
1198
|
+
/**
|
|
1199
|
+
* Lists the search indices. Requires permission to access the ListIndices action.
|
|
1160
1200
|
*/
|
|
1161
1201
|
listIndices(params: Iot.Types.ListIndicesRequest, callback?: (err: AWSError, data: Iot.Types.ListIndicesResponse) => void): Request<Iot.Types.ListIndicesResponse, AWSError>;
|
|
1162
1202
|
/**
|
|
1163
|
-
* Lists the search indices.
|
|
1203
|
+
* Lists the search indices. Requires permission to access the ListIndices action.
|
|
1164
1204
|
*/
|
|
1165
1205
|
listIndices(callback?: (err: AWSError, data: Iot.Types.ListIndicesResponse) => void): Request<Iot.Types.ListIndicesResponse, AWSError>;
|
|
1166
1206
|
/**
|
|
1167
|
-
* Lists the job executions for a job.
|
|
1207
|
+
* Lists the job executions for a job. Requires permission to access the ListJobExecutionsForJob action.
|
|
1168
1208
|
*/
|
|
1169
1209
|
listJobExecutionsForJob(params: Iot.Types.ListJobExecutionsForJobRequest, callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForJobResponse) => void): Request<Iot.Types.ListJobExecutionsForJobResponse, AWSError>;
|
|
1170
1210
|
/**
|
|
1171
|
-
* Lists the job executions for a job.
|
|
1211
|
+
* Lists the job executions for a job. Requires permission to access the ListJobExecutionsForJob action.
|
|
1172
1212
|
*/
|
|
1173
1213
|
listJobExecutionsForJob(callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForJobResponse) => void): Request<Iot.Types.ListJobExecutionsForJobResponse, AWSError>;
|
|
1174
1214
|
/**
|
|
1175
|
-
* Lists the job executions for the specified thing.
|
|
1215
|
+
* Lists the job executions for the specified thing. Requires permission to access the ListJobExecutionsForThing action.
|
|
1176
1216
|
*/
|
|
1177
1217
|
listJobExecutionsForThing(params: Iot.Types.ListJobExecutionsForThingRequest, callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForThingResponse) => void): Request<Iot.Types.ListJobExecutionsForThingResponse, AWSError>;
|
|
1178
1218
|
/**
|
|
1179
|
-
* Lists the job executions for the specified thing.
|
|
1219
|
+
* Lists the job executions for the specified thing. Requires permission to access the ListJobExecutionsForThing action.
|
|
1180
1220
|
*/
|
|
1181
1221
|
listJobExecutionsForThing(callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForThingResponse) => void): Request<Iot.Types.ListJobExecutionsForThingResponse, AWSError>;
|
|
1182
1222
|
/**
|
|
1183
|
-
* Returns a list of job templates.
|
|
1223
|
+
* Returns a list of job templates. Requires permission to access the ListJobTemplates action.
|
|
1184
1224
|
*/
|
|
1185
1225
|
listJobTemplates(params: Iot.Types.ListJobTemplatesRequest, callback?: (err: AWSError, data: Iot.Types.ListJobTemplatesResponse) => void): Request<Iot.Types.ListJobTemplatesResponse, AWSError>;
|
|
1186
1226
|
/**
|
|
1187
|
-
* Returns a list of job templates.
|
|
1227
|
+
* Returns a list of job templates. Requires permission to access the ListJobTemplates action.
|
|
1188
1228
|
*/
|
|
1189
1229
|
listJobTemplates(callback?: (err: AWSError, data: Iot.Types.ListJobTemplatesResponse) => void): Request<Iot.Types.ListJobTemplatesResponse, AWSError>;
|
|
1190
1230
|
/**
|
|
1191
|
-
* Lists jobs.
|
|
1231
|
+
* Lists jobs. Requires permission to access the ListJobs action.
|
|
1192
1232
|
*/
|
|
1193
1233
|
listJobs(params: Iot.Types.ListJobsRequest, callback?: (err: AWSError, data: Iot.Types.ListJobsResponse) => void): Request<Iot.Types.ListJobsResponse, AWSError>;
|
|
1194
1234
|
/**
|
|
1195
|
-
* Lists jobs.
|
|
1235
|
+
* Lists jobs. Requires permission to access the ListJobs action.
|
|
1196
1236
|
*/
|
|
1197
1237
|
listJobs(callback?: (err: AWSError, data: Iot.Types.ListJobsResponse) => void): Request<Iot.Types.ListJobsResponse, AWSError>;
|
|
1198
1238
|
/**
|
|
1199
|
-
* Gets a list of all mitigation actions that match the specified filter criteria.
|
|
1239
|
+
* Gets a list of all mitigation actions that match the specified filter criteria. Requires permission to access the ListMitigationActions action.
|
|
1200
1240
|
*/
|
|
1201
1241
|
listMitigationActions(params: Iot.Types.ListMitigationActionsRequest, callback?: (err: AWSError, data: Iot.Types.ListMitigationActionsResponse) => void): Request<Iot.Types.ListMitigationActionsResponse, AWSError>;
|
|
1202
1242
|
/**
|
|
1203
|
-
* Gets a list of all mitigation actions that match the specified filter criteria.
|
|
1243
|
+
* Gets a list of all mitigation actions that match the specified filter criteria. Requires permission to access the ListMitigationActions action.
|
|
1204
1244
|
*/
|
|
1205
1245
|
listMitigationActions(callback?: (err: AWSError, data: Iot.Types.ListMitigationActionsResponse) => void): Request<Iot.Types.ListMitigationActionsResponse, AWSError>;
|
|
1206
1246
|
/**
|
|
1207
|
-
* Lists OTA updates.
|
|
1247
|
+
* Lists OTA updates. Requires permission to access the ListOTAUpdates action.
|
|
1208
1248
|
*/
|
|
1209
1249
|
listOTAUpdates(params: Iot.Types.ListOTAUpdatesRequest, callback?: (err: AWSError, data: Iot.Types.ListOTAUpdatesResponse) => void): Request<Iot.Types.ListOTAUpdatesResponse, AWSError>;
|
|
1210
1250
|
/**
|
|
1211
|
-
* Lists OTA updates.
|
|
1251
|
+
* Lists OTA updates. Requires permission to access the ListOTAUpdates action.
|
|
1212
1252
|
*/
|
|
1213
1253
|
listOTAUpdates(callback?: (err: AWSError, data: Iot.Types.ListOTAUpdatesResponse) => void): Request<Iot.Types.ListOTAUpdatesResponse, AWSError>;
|
|
1214
1254
|
/**
|
|
1215
|
-
* Lists certificates that are being transferred but not yet accepted.
|
|
1255
|
+
* Lists certificates that are being transferred but not yet accepted. Requires permission to access the ListOutgoingCertificates action.
|
|
1216
1256
|
*/
|
|
1217
1257
|
listOutgoingCertificates(params: Iot.Types.ListOutgoingCertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListOutgoingCertificatesResponse) => void): Request<Iot.Types.ListOutgoingCertificatesResponse, AWSError>;
|
|
1218
1258
|
/**
|
|
1219
|
-
* Lists certificates that are being transferred but not yet accepted.
|
|
1259
|
+
* Lists certificates that are being transferred but not yet accepted. Requires permission to access the ListOutgoingCertificates action.
|
|
1220
1260
|
*/
|
|
1221
1261
|
listOutgoingCertificates(callback?: (err: AWSError, data: Iot.Types.ListOutgoingCertificatesResponse) => void): Request<Iot.Types.ListOutgoingCertificatesResponse, AWSError>;
|
|
1222
1262
|
/**
|
|
1223
|
-
* Lists your policies.
|
|
1263
|
+
* Lists your policies. Requires permission to access the ListPolicies action.
|
|
1224
1264
|
*/
|
|
1225
1265
|
listPolicies(params: Iot.Types.ListPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListPoliciesResponse) => void): Request<Iot.Types.ListPoliciesResponse, AWSError>;
|
|
1226
1266
|
/**
|
|
1227
|
-
* Lists your policies.
|
|
1267
|
+
* Lists your policies. Requires permission to access the ListPolicies action.
|
|
1228
1268
|
*/
|
|
1229
1269
|
listPolicies(callback?: (err: AWSError, data: Iot.Types.ListPoliciesResponse) => void): Request<Iot.Types.ListPoliciesResponse, AWSError>;
|
|
1230
1270
|
/**
|
|
1231
|
-
* Lists the principals associated with the specified policy. Note: This
|
|
1271
|
+
* Lists the principals associated with the specified policy. Note: This action is deprecated. Please use ListTargetsForPolicy instead. Requires permission to access the ListPolicyPrincipals action.
|
|
1232
1272
|
*/
|
|
1233
1273
|
listPolicyPrincipals(params: Iot.Types.ListPolicyPrincipalsRequest, callback?: (err: AWSError, data: Iot.Types.ListPolicyPrincipalsResponse) => void): Request<Iot.Types.ListPolicyPrincipalsResponse, AWSError>;
|
|
1234
1274
|
/**
|
|
1235
|
-
* Lists the principals associated with the specified policy. Note: This
|
|
1275
|
+
* Lists the principals associated with the specified policy. Note: This action is deprecated. Please use ListTargetsForPolicy instead. Requires permission to access the ListPolicyPrincipals action.
|
|
1236
1276
|
*/
|
|
1237
1277
|
listPolicyPrincipals(callback?: (err: AWSError, data: Iot.Types.ListPolicyPrincipalsResponse) => void): Request<Iot.Types.ListPolicyPrincipalsResponse, AWSError>;
|
|
1238
1278
|
/**
|
|
1239
|
-
* Lists the versions of the specified policy and identifies the default version.
|
|
1279
|
+
* Lists the versions of the specified policy and identifies the default version. Requires permission to access the ListPolicyVersions action.
|
|
1240
1280
|
*/
|
|
1241
1281
|
listPolicyVersions(params: Iot.Types.ListPolicyVersionsRequest, callback?: (err: AWSError, data: Iot.Types.ListPolicyVersionsResponse) => void): Request<Iot.Types.ListPolicyVersionsResponse, AWSError>;
|
|
1242
1282
|
/**
|
|
1243
|
-
* Lists the versions of the specified policy and identifies the default version.
|
|
1283
|
+
* Lists the versions of the specified policy and identifies the default version. Requires permission to access the ListPolicyVersions action.
|
|
1244
1284
|
*/
|
|
1245
1285
|
listPolicyVersions(callback?: (err: AWSError, data: Iot.Types.ListPolicyVersionsResponse) => void): Request<Iot.Types.ListPolicyVersionsResponse, AWSError>;
|
|
1246
1286
|
/**
|
|
1247
|
-
* Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This
|
|
1287
|
+
* Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This action is deprecated. Please use ListAttachedPolicies instead. Requires permission to access the ListPrincipalPolicies action.
|
|
1248
1288
|
*/
|
|
1249
1289
|
listPrincipalPolicies(params: Iot.Types.ListPrincipalPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListPrincipalPoliciesResponse) => void): Request<Iot.Types.ListPrincipalPoliciesResponse, AWSError>;
|
|
1250
1290
|
/**
|
|
1251
|
-
* Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This
|
|
1291
|
+
* Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This action is deprecated. Please use ListAttachedPolicies instead. Requires permission to access the ListPrincipalPolicies action.
|
|
1252
1292
|
*/
|
|
1253
1293
|
listPrincipalPolicies(callback?: (err: AWSError, data: Iot.Types.ListPrincipalPoliciesResponse) => void): Request<Iot.Types.ListPrincipalPoliciesResponse, AWSError>;
|
|
1254
1294
|
/**
|
|
1255
|
-
* 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.
|
|
1295
|
+
* 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. Requires permission to access the ListPrincipalThings action.
|
|
1256
1296
|
*/
|
|
1257
1297
|
listPrincipalThings(params: Iot.Types.ListPrincipalThingsRequest, callback?: (err: AWSError, data: Iot.Types.ListPrincipalThingsResponse) => void): Request<Iot.Types.ListPrincipalThingsResponse, AWSError>;
|
|
1258
1298
|
/**
|
|
1259
|
-
* 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.
|
|
1299
|
+
* 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. Requires permission to access the ListPrincipalThings action.
|
|
1260
1300
|
*/
|
|
1261
1301
|
listPrincipalThings(callback?: (err: AWSError, data: Iot.Types.ListPrincipalThingsResponse) => void): Request<Iot.Types.ListPrincipalThingsResponse, AWSError>;
|
|
1262
1302
|
/**
|
|
1263
|
-
* A list of fleet provisioning template versions.
|
|
1303
|
+
* A list of fleet provisioning template versions. Requires permission to access the ListProvisioningTemplateVersions action.
|
|
1264
1304
|
*/
|
|
1265
1305
|
listProvisioningTemplateVersions(params: Iot.Types.ListProvisioningTemplateVersionsRequest, callback?: (err: AWSError, data: Iot.Types.ListProvisioningTemplateVersionsResponse) => void): Request<Iot.Types.ListProvisioningTemplateVersionsResponse, AWSError>;
|
|
1266
1306
|
/**
|
|
1267
|
-
* A list of fleet provisioning template versions.
|
|
1307
|
+
* A list of fleet provisioning template versions. Requires permission to access the ListProvisioningTemplateVersions action.
|
|
1268
1308
|
*/
|
|
1269
1309
|
listProvisioningTemplateVersions(callback?: (err: AWSError, data: Iot.Types.ListProvisioningTemplateVersionsResponse) => void): Request<Iot.Types.ListProvisioningTemplateVersionsResponse, AWSError>;
|
|
1270
1310
|
/**
|
|
1271
|
-
* Lists the fleet provisioning templates in your
|
|
1311
|
+
* Lists the fleet provisioning templates in your Amazon Web Services account. Requires permission to access the ListProvisioningTemplates action.
|
|
1272
1312
|
*/
|
|
1273
1313
|
listProvisioningTemplates(params: Iot.Types.ListProvisioningTemplatesRequest, callback?: (err: AWSError, data: Iot.Types.ListProvisioningTemplatesResponse) => void): Request<Iot.Types.ListProvisioningTemplatesResponse, AWSError>;
|
|
1274
1314
|
/**
|
|
1275
|
-
* Lists the fleet provisioning templates in your
|
|
1315
|
+
* Lists the fleet provisioning templates in your Amazon Web Services account. Requires permission to access the ListProvisioningTemplates action.
|
|
1276
1316
|
*/
|
|
1277
1317
|
listProvisioningTemplates(callback?: (err: AWSError, data: Iot.Types.ListProvisioningTemplatesResponse) => void): Request<Iot.Types.ListProvisioningTemplatesResponse, AWSError>;
|
|
1278
1318
|
/**
|
|
1279
|
-
* Lists the role aliases registered in your account.
|
|
1319
|
+
* Lists the role aliases registered in your account. Requires permission to access the ListRoleAliases action.
|
|
1280
1320
|
*/
|
|
1281
1321
|
listRoleAliases(params: Iot.Types.ListRoleAliasesRequest, callback?: (err: AWSError, data: Iot.Types.ListRoleAliasesResponse) => void): Request<Iot.Types.ListRoleAliasesResponse, AWSError>;
|
|
1282
1322
|
/**
|
|
1283
|
-
* Lists the role aliases registered in your account.
|
|
1323
|
+
* Lists the role aliases registered in your account. Requires permission to access the ListRoleAliases action.
|
|
1284
1324
|
*/
|
|
1285
1325
|
listRoleAliases(callback?: (err: AWSError, data: Iot.Types.ListRoleAliasesResponse) => void): Request<Iot.Types.ListRoleAliasesResponse, AWSError>;
|
|
1286
1326
|
/**
|
|
1287
|
-
* Lists all of your scheduled audits.
|
|
1327
|
+
* Lists all of your scheduled audits. Requires permission to access the ListScheduledAudits action.
|
|
1288
1328
|
*/
|
|
1289
1329
|
listScheduledAudits(params: Iot.Types.ListScheduledAuditsRequest, callback?: (err: AWSError, data: Iot.Types.ListScheduledAuditsResponse) => void): Request<Iot.Types.ListScheduledAuditsResponse, AWSError>;
|
|
1290
1330
|
/**
|
|
1291
|
-
* Lists all of your scheduled audits.
|
|
1331
|
+
* Lists all of your scheduled audits. Requires permission to access the ListScheduledAudits action.
|
|
1292
1332
|
*/
|
|
1293
1333
|
listScheduledAudits(callback?: (err: AWSError, data: Iot.Types.ListScheduledAuditsResponse) => void): Request<Iot.Types.ListScheduledAuditsResponse, AWSError>;
|
|
1294
1334
|
/**
|
|
1295
|
-
* Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric. dimensionName and metricName cannot be used in the same request.
|
|
1335
|
+
* Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric. Requires permission to access the ListSecurityProfiles action. dimensionName and metricName cannot be used in the same request.
|
|
1296
1336
|
*/
|
|
1297
1337
|
listSecurityProfiles(params: Iot.Types.ListSecurityProfilesRequest, callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesResponse) => void): Request<Iot.Types.ListSecurityProfilesResponse, AWSError>;
|
|
1298
1338
|
/**
|
|
1299
|
-
* Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric. dimensionName and metricName cannot be used in the same request.
|
|
1339
|
+
* Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric. Requires permission to access the ListSecurityProfiles action. dimensionName and metricName cannot be used in the same request.
|
|
1300
1340
|
*/
|
|
1301
1341
|
listSecurityProfiles(callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesResponse) => void): Request<Iot.Types.ListSecurityProfilesResponse, AWSError>;
|
|
1302
1342
|
/**
|
|
1303
|
-
* Lists the Device Defender security profiles attached to a target (thing group).
|
|
1343
|
+
* Lists the Device Defender security profiles attached to a target (thing group). Requires permission to access the ListSecurityProfilesForTarget action.
|
|
1304
1344
|
*/
|
|
1305
1345
|
listSecurityProfilesForTarget(params: Iot.Types.ListSecurityProfilesForTargetRequest, callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesForTargetResponse) => void): Request<Iot.Types.ListSecurityProfilesForTargetResponse, AWSError>;
|
|
1306
1346
|
/**
|
|
1307
|
-
* Lists the Device Defender security profiles attached to a target (thing group).
|
|
1347
|
+
* Lists the Device Defender security profiles attached to a target (thing group). Requires permission to access the ListSecurityProfilesForTarget action.
|
|
1308
1348
|
*/
|
|
1309
1349
|
listSecurityProfilesForTarget(callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesForTargetResponse) => void): Request<Iot.Types.ListSecurityProfilesForTargetResponse, AWSError>;
|
|
1310
1350
|
/**
|
|
1311
|
-
* Lists all of the streams in your
|
|
1351
|
+
* Lists all of the streams in your Amazon Web Services account. Requires permission to access the ListStreams action.
|
|
1312
1352
|
*/
|
|
1313
1353
|
listStreams(params: Iot.Types.ListStreamsRequest, callback?: (err: AWSError, data: Iot.Types.ListStreamsResponse) => void): Request<Iot.Types.ListStreamsResponse, AWSError>;
|
|
1314
1354
|
/**
|
|
1315
|
-
* Lists all of the streams in your
|
|
1355
|
+
* Lists all of the streams in your Amazon Web Services account. Requires permission to access the ListStreams action.
|
|
1316
1356
|
*/
|
|
1317
1357
|
listStreams(callback?: (err: AWSError, data: Iot.Types.ListStreamsResponse) => void): Request<Iot.Types.ListStreamsResponse, AWSError>;
|
|
1318
1358
|
/**
|
|
1319
|
-
* Lists the tags (metadata) you have assigned to the resource.
|
|
1359
|
+
* Lists the tags (metadata) you have assigned to the resource. Requires permission to access the ListTagsForResource action.
|
|
1320
1360
|
*/
|
|
1321
1361
|
listTagsForResource(params: Iot.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Iot.Types.ListTagsForResourceResponse) => void): Request<Iot.Types.ListTagsForResourceResponse, AWSError>;
|
|
1322
1362
|
/**
|
|
1323
|
-
* Lists the tags (metadata) you have assigned to the resource.
|
|
1363
|
+
* Lists the tags (metadata) you have assigned to the resource. Requires permission to access the ListTagsForResource action.
|
|
1324
1364
|
*/
|
|
1325
1365
|
listTagsForResource(callback?: (err: AWSError, data: Iot.Types.ListTagsForResourceResponse) => void): Request<Iot.Types.ListTagsForResourceResponse, AWSError>;
|
|
1326
1366
|
/**
|
|
1327
|
-
* List targets for the specified policy.
|
|
1367
|
+
* List targets for the specified policy. Requires permission to access the ListTargetsForPolicy action.
|
|
1328
1368
|
*/
|
|
1329
1369
|
listTargetsForPolicy(params: Iot.Types.ListTargetsForPolicyRequest, callback?: (err: AWSError, data: Iot.Types.ListTargetsForPolicyResponse) => void): Request<Iot.Types.ListTargetsForPolicyResponse, AWSError>;
|
|
1330
1370
|
/**
|
|
1331
|
-
* List targets for the specified policy.
|
|
1371
|
+
* List targets for the specified policy. Requires permission to access the ListTargetsForPolicy action.
|
|
1332
1372
|
*/
|
|
1333
1373
|
listTargetsForPolicy(callback?: (err: AWSError, data: Iot.Types.ListTargetsForPolicyResponse) => void): Request<Iot.Types.ListTargetsForPolicyResponse, AWSError>;
|
|
1334
1374
|
/**
|
|
1335
|
-
* Lists the targets (thing groups) associated with a given Device Defender security profile.
|
|
1375
|
+
* Lists the targets (thing groups) associated with a given Device Defender security profile. Requires permission to access the ListTargetsForSecurityProfile action.
|
|
1336
1376
|
*/
|
|
1337
1377
|
listTargetsForSecurityProfile(params: Iot.Types.ListTargetsForSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.ListTargetsForSecurityProfileResponse) => void): Request<Iot.Types.ListTargetsForSecurityProfileResponse, AWSError>;
|
|
1338
1378
|
/**
|
|
1339
|
-
* Lists the targets (thing groups) associated with a given Device Defender security profile.
|
|
1379
|
+
* Lists the targets (thing groups) associated with a given Device Defender security profile. Requires permission to access the ListTargetsForSecurityProfile action.
|
|
1340
1380
|
*/
|
|
1341
1381
|
listTargetsForSecurityProfile(callback?: (err: AWSError, data: Iot.Types.ListTargetsForSecurityProfileResponse) => void): Request<Iot.Types.ListTargetsForSecurityProfileResponse, AWSError>;
|
|
1342
1382
|
/**
|
|
1343
|
-
* List the thing groups in your account.
|
|
1383
|
+
* List the thing groups in your account. Requires permission to access the ListThingGroups action.
|
|
1344
1384
|
*/
|
|
1345
1385
|
listThingGroups(params: Iot.Types.ListThingGroupsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingGroupsResponse) => void): Request<Iot.Types.ListThingGroupsResponse, AWSError>;
|
|
1346
1386
|
/**
|
|
1347
|
-
* List the thing groups in your account.
|
|
1387
|
+
* List the thing groups in your account. Requires permission to access the ListThingGroups action.
|
|
1348
1388
|
*/
|
|
1349
1389
|
listThingGroups(callback?: (err: AWSError, data: Iot.Types.ListThingGroupsResponse) => void): Request<Iot.Types.ListThingGroupsResponse, AWSError>;
|
|
1350
1390
|
/**
|
|
1351
|
-
* List the thing groups to which the specified thing belongs.
|
|
1391
|
+
* List the thing groups to which the specified thing belongs. Requires permission to access the ListThingGroupsForThing action.
|
|
1352
1392
|
*/
|
|
1353
1393
|
listThingGroupsForThing(params: Iot.Types.ListThingGroupsForThingRequest, callback?: (err: AWSError, data: Iot.Types.ListThingGroupsForThingResponse) => void): Request<Iot.Types.ListThingGroupsForThingResponse, AWSError>;
|
|
1354
1394
|
/**
|
|
1355
|
-
* List the thing groups to which the specified thing belongs.
|
|
1395
|
+
* List the thing groups to which the specified thing belongs. Requires permission to access the ListThingGroupsForThing action.
|
|
1356
1396
|
*/
|
|
1357
1397
|
listThingGroupsForThing(callback?: (err: AWSError, data: Iot.Types.ListThingGroupsForThingResponse) => void): Request<Iot.Types.ListThingGroupsForThingResponse, AWSError>;
|
|
1358
1398
|
/**
|
|
1359
|
-
* 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.
|
|
1399
|
+
* 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. Requires permission to access the ListThingPrincipals action.
|
|
1360
1400
|
*/
|
|
1361
1401
|
listThingPrincipals(params: Iot.Types.ListThingPrincipalsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingPrincipalsResponse) => void): Request<Iot.Types.ListThingPrincipalsResponse, AWSError>;
|
|
1362
1402
|
/**
|
|
1363
|
-
* 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.
|
|
1403
|
+
* 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. Requires permission to access the ListThingPrincipals action.
|
|
1364
1404
|
*/
|
|
1365
1405
|
listThingPrincipals(callback?: (err: AWSError, data: Iot.Types.ListThingPrincipalsResponse) => void): Request<Iot.Types.ListThingPrincipalsResponse, AWSError>;
|
|
1366
1406
|
/**
|
|
@@ -1372,91 +1412,91 @@ declare class Iot extends Service {
|
|
|
1372
1412
|
*/
|
|
1373
1413
|
listThingRegistrationTaskReports(callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTaskReportsResponse) => void): Request<Iot.Types.ListThingRegistrationTaskReportsResponse, AWSError>;
|
|
1374
1414
|
/**
|
|
1375
|
-
* List bulk thing provisioning tasks.
|
|
1415
|
+
* List bulk thing provisioning tasks. Requires permission to access the ListThingRegistrationTasks action.
|
|
1376
1416
|
*/
|
|
1377
1417
|
listThingRegistrationTasks(params: Iot.Types.ListThingRegistrationTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTasksResponse) => void): Request<Iot.Types.ListThingRegistrationTasksResponse, AWSError>;
|
|
1378
1418
|
/**
|
|
1379
|
-
* List bulk thing provisioning tasks.
|
|
1419
|
+
* List bulk thing provisioning tasks. Requires permission to access the ListThingRegistrationTasks action.
|
|
1380
1420
|
*/
|
|
1381
1421
|
listThingRegistrationTasks(callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTasksResponse) => void): Request<Iot.Types.ListThingRegistrationTasksResponse, AWSError>;
|
|
1382
1422
|
/**
|
|
1383
|
-
* Lists the existing thing types.
|
|
1423
|
+
* Lists the existing thing types. Requires permission to access the ListThingTypes action.
|
|
1384
1424
|
*/
|
|
1385
1425
|
listThingTypes(params: Iot.Types.ListThingTypesRequest, callback?: (err: AWSError, data: Iot.Types.ListThingTypesResponse) => void): Request<Iot.Types.ListThingTypesResponse, AWSError>;
|
|
1386
1426
|
/**
|
|
1387
|
-
* Lists the existing thing types.
|
|
1427
|
+
* Lists the existing thing types. Requires permission to access the ListThingTypes action.
|
|
1388
1428
|
*/
|
|
1389
1429
|
listThingTypes(callback?: (err: AWSError, data: Iot.Types.ListThingTypesResponse) => void): Request<Iot.Types.ListThingTypesResponse, AWSError>;
|
|
1390
1430
|
/**
|
|
1391
|
-
* 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.
|
|
1431
|
+
* 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. Requires permission to access the ListThings action. You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.
|
|
1392
1432
|
*/
|
|
1393
1433
|
listThings(params: Iot.Types.ListThingsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsResponse) => void): Request<Iot.Types.ListThingsResponse, AWSError>;
|
|
1394
1434
|
/**
|
|
1395
|
-
* 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.
|
|
1435
|
+
* 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. Requires permission to access the ListThings action. You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.
|
|
1396
1436
|
*/
|
|
1397
1437
|
listThings(callback?: (err: AWSError, data: Iot.Types.ListThingsResponse) => void): Request<Iot.Types.ListThingsResponse, AWSError>;
|
|
1398
1438
|
/**
|
|
1399
|
-
* Lists the things you have added to the given billing group.
|
|
1439
|
+
* Lists the things you have added to the given billing group. Requires permission to access the ListThingsInBillingGroup action.
|
|
1400
1440
|
*/
|
|
1401
1441
|
listThingsInBillingGroup(params: Iot.Types.ListThingsInBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsInBillingGroupResponse) => void): Request<Iot.Types.ListThingsInBillingGroupResponse, AWSError>;
|
|
1402
1442
|
/**
|
|
1403
|
-
* Lists the things you have added to the given billing group.
|
|
1443
|
+
* Lists the things you have added to the given billing group. Requires permission to access the ListThingsInBillingGroup action.
|
|
1404
1444
|
*/
|
|
1405
1445
|
listThingsInBillingGroup(callback?: (err: AWSError, data: Iot.Types.ListThingsInBillingGroupResponse) => void): Request<Iot.Types.ListThingsInBillingGroupResponse, AWSError>;
|
|
1406
1446
|
/**
|
|
1407
|
-
* Lists the things in the specified group.
|
|
1447
|
+
* Lists the things in the specified group. Requires permission to access the ListThingsInThingGroup action.
|
|
1408
1448
|
*/
|
|
1409
1449
|
listThingsInThingGroup(params: Iot.Types.ListThingsInThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsInThingGroupResponse) => void): Request<Iot.Types.ListThingsInThingGroupResponse, AWSError>;
|
|
1410
1450
|
/**
|
|
1411
|
-
* Lists the things in the specified group.
|
|
1451
|
+
* Lists the things in the specified group. Requires permission to access the ListThingsInThingGroup action.
|
|
1412
1452
|
*/
|
|
1413
1453
|
listThingsInThingGroup(callback?: (err: AWSError, data: Iot.Types.ListThingsInThingGroupResponse) => void): Request<Iot.Types.ListThingsInThingGroupResponse, AWSError>;
|
|
1414
1454
|
/**
|
|
1415
|
-
* Lists all the topic rule destinations in your
|
|
1455
|
+
* Lists all the topic rule destinations in your Amazon Web Services account. Requires permission to access the ListTopicRuleDestinations action.
|
|
1416
1456
|
*/
|
|
1417
1457
|
listTopicRuleDestinations(params: Iot.Types.ListTopicRuleDestinationsRequest, callback?: (err: AWSError, data: Iot.Types.ListTopicRuleDestinationsResponse) => void): Request<Iot.Types.ListTopicRuleDestinationsResponse, AWSError>;
|
|
1418
1458
|
/**
|
|
1419
|
-
* Lists all the topic rule destinations in your
|
|
1459
|
+
* Lists all the topic rule destinations in your Amazon Web Services account. Requires permission to access the ListTopicRuleDestinations action.
|
|
1420
1460
|
*/
|
|
1421
1461
|
listTopicRuleDestinations(callback?: (err: AWSError, data: Iot.Types.ListTopicRuleDestinationsResponse) => void): Request<Iot.Types.ListTopicRuleDestinationsResponse, AWSError>;
|
|
1422
1462
|
/**
|
|
1423
|
-
* Lists the rules for the specific topic.
|
|
1463
|
+
* Lists the rules for the specific topic. Requires permission to access the ListTopicRules action.
|
|
1424
1464
|
*/
|
|
1425
1465
|
listTopicRules(params: Iot.Types.ListTopicRulesRequest, callback?: (err: AWSError, data: Iot.Types.ListTopicRulesResponse) => void): Request<Iot.Types.ListTopicRulesResponse, AWSError>;
|
|
1426
1466
|
/**
|
|
1427
|
-
* Lists the rules for the specific topic.
|
|
1467
|
+
* Lists the rules for the specific topic. Requires permission to access the ListTopicRules action.
|
|
1428
1468
|
*/
|
|
1429
1469
|
listTopicRules(callback?: (err: AWSError, data: Iot.Types.ListTopicRulesResponse) => void): Request<Iot.Types.ListTopicRulesResponse, AWSError>;
|
|
1430
1470
|
/**
|
|
1431
|
-
* Lists logging levels.
|
|
1471
|
+
* Lists logging levels. Requires permission to access the ListV2LoggingLevels action.
|
|
1432
1472
|
*/
|
|
1433
1473
|
listV2LoggingLevels(params: Iot.Types.ListV2LoggingLevelsRequest, callback?: (err: AWSError, data: Iot.Types.ListV2LoggingLevelsResponse) => void): Request<Iot.Types.ListV2LoggingLevelsResponse, AWSError>;
|
|
1434
1474
|
/**
|
|
1435
|
-
* Lists logging levels.
|
|
1475
|
+
* Lists logging levels. Requires permission to access the ListV2LoggingLevels action.
|
|
1436
1476
|
*/
|
|
1437
1477
|
listV2LoggingLevels(callback?: (err: AWSError, data: Iot.Types.ListV2LoggingLevelsResponse) => void): Request<Iot.Types.ListV2LoggingLevelsResponse, AWSError>;
|
|
1438
1478
|
/**
|
|
1439
|
-
* 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).
|
|
1479
|
+
* 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). Requires permission to access the ListViolationEvents action.
|
|
1440
1480
|
*/
|
|
1441
1481
|
listViolationEvents(params: Iot.Types.ListViolationEventsRequest, callback?: (err: AWSError, data: Iot.Types.ListViolationEventsResponse) => void): Request<Iot.Types.ListViolationEventsResponse, AWSError>;
|
|
1442
1482
|
/**
|
|
1443
|
-
* 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).
|
|
1483
|
+
* 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). Requires permission to access the ListViolationEvents action.
|
|
1444
1484
|
*/
|
|
1445
1485
|
listViolationEvents(callback?: (err: AWSError, data: Iot.Types.ListViolationEventsResponse) => void): Request<Iot.Types.ListViolationEventsResponse, AWSError>;
|
|
1446
1486
|
/**
|
|
1447
|
-
* Registers a CA certificate with
|
|
1487
|
+
* Registers a CA certificate with IoT. This CA certificate can then be used to sign device certificates, which can be then registered with IoT. You can register up to 10 CA certificates per Amazon Web Services 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 action. Requires permission to access the RegisterCACertificate action.
|
|
1448
1488
|
*/
|
|
1449
1489
|
registerCACertificate(params: Iot.Types.RegisterCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.RegisterCACertificateResponse) => void): Request<Iot.Types.RegisterCACertificateResponse, AWSError>;
|
|
1450
1490
|
/**
|
|
1451
|
-
* Registers a CA certificate with
|
|
1491
|
+
* Registers a CA certificate with IoT. This CA certificate can then be used to sign device certificates, which can be then registered with IoT. You can register up to 10 CA certificates per Amazon Web Services 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 action. Requires permission to access the RegisterCACertificate action.
|
|
1452
1492
|
*/
|
|
1453
1493
|
registerCACertificate(callback?: (err: AWSError, data: Iot.Types.RegisterCACertificateResponse) => void): Request<Iot.Types.RegisterCACertificateResponse, AWSError>;
|
|
1454
1494
|
/**
|
|
1455
|
-
* Registers a device certificate with
|
|
1495
|
+
* Registers a device certificate with 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. Requires permission to access the RegisterCertificate action.
|
|
1456
1496
|
*/
|
|
1457
1497
|
registerCertificate(params: Iot.Types.RegisterCertificateRequest, callback?: (err: AWSError, data: Iot.Types.RegisterCertificateResponse) => void): Request<Iot.Types.RegisterCertificateResponse, AWSError>;
|
|
1458
1498
|
/**
|
|
1459
|
-
* Registers a device certificate with
|
|
1499
|
+
* Registers a device certificate with 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. Requires permission to access the RegisterCertificate action.
|
|
1460
1500
|
*/
|
|
1461
1501
|
registerCertificate(callback?: (err: AWSError, data: Iot.Types.RegisterCertificateResponse) => void): Request<Iot.Types.RegisterCertificateResponse, AWSError>;
|
|
1462
1502
|
/**
|
|
@@ -1468,179 +1508,179 @@ declare class Iot extends Service {
|
|
|
1468
1508
|
*/
|
|
1469
1509
|
registerCertificateWithoutCA(callback?: (err: AWSError, data: Iot.Types.RegisterCertificateWithoutCAResponse) => void): Request<Iot.Types.RegisterCertificateWithoutCAResponse, AWSError>;
|
|
1470
1510
|
/**
|
|
1471
|
-
* Provisions a thing in the device registry. RegisterThing calls other
|
|
1511
|
+
* Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary. Requires permission to access the RegisterThing action.
|
|
1472
1512
|
*/
|
|
1473
1513
|
registerThing(params: Iot.Types.RegisterThingRequest, callback?: (err: AWSError, data: Iot.Types.RegisterThingResponse) => void): Request<Iot.Types.RegisterThingResponse, AWSError>;
|
|
1474
1514
|
/**
|
|
1475
|
-
* Provisions a thing in the device registry. RegisterThing calls other
|
|
1515
|
+
* Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary. Requires permission to access the RegisterThing action.
|
|
1476
1516
|
*/
|
|
1477
1517
|
registerThing(callback?: (err: AWSError, data: Iot.Types.RegisterThingResponse) => void): Request<Iot.Types.RegisterThingResponse, AWSError>;
|
|
1478
1518
|
/**
|
|
1479
|
-
* Rejects a pending certificate transfer. After
|
|
1519
|
+
* Rejects a pending certificate transfer. After 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. Requires permission to access the RejectCertificateTransfer action.
|
|
1480
1520
|
*/
|
|
1481
1521
|
rejectCertificateTransfer(params: Iot.Types.RejectCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1482
1522
|
/**
|
|
1483
|
-
* Rejects a pending certificate transfer. After
|
|
1523
|
+
* Rejects a pending certificate transfer. After 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. Requires permission to access the RejectCertificateTransfer action.
|
|
1484
1524
|
*/
|
|
1485
1525
|
rejectCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1486
1526
|
/**
|
|
1487
|
-
* Removes the given thing from the billing group.
|
|
1527
|
+
* Removes the given thing from the billing group. Requires permission to access the RemoveThingFromBillingGroup action.
|
|
1488
1528
|
*/
|
|
1489
1529
|
removeThingFromBillingGroup(params: Iot.Types.RemoveThingFromBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.RemoveThingFromBillingGroupResponse) => void): Request<Iot.Types.RemoveThingFromBillingGroupResponse, AWSError>;
|
|
1490
1530
|
/**
|
|
1491
|
-
* Removes the given thing from the billing group.
|
|
1531
|
+
* Removes the given thing from the billing group. Requires permission to access the RemoveThingFromBillingGroup action.
|
|
1492
1532
|
*/
|
|
1493
1533
|
removeThingFromBillingGroup(callback?: (err: AWSError, data: Iot.Types.RemoveThingFromBillingGroupResponse) => void): Request<Iot.Types.RemoveThingFromBillingGroupResponse, AWSError>;
|
|
1494
1534
|
/**
|
|
1495
|
-
* Remove the specified thing from the specified group. You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.
|
|
1535
|
+
* Remove the specified thing from the specified group. You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group. Requires permission to access the RemoveThingFromThingGroup action.
|
|
1496
1536
|
*/
|
|
1497
1537
|
removeThingFromThingGroup(params: Iot.Types.RemoveThingFromThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.RemoveThingFromThingGroupResponse) => void): Request<Iot.Types.RemoveThingFromThingGroupResponse, AWSError>;
|
|
1498
1538
|
/**
|
|
1499
|
-
* Remove the specified thing from the specified group. You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.
|
|
1539
|
+
* Remove the specified thing from the specified group. You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group. Requires permission to access the RemoveThingFromThingGroup action.
|
|
1500
1540
|
*/
|
|
1501
1541
|
removeThingFromThingGroup(callback?: (err: AWSError, data: Iot.Types.RemoveThingFromThingGroupResponse) => void): Request<Iot.Types.RemoveThingFromThingGroupResponse, AWSError>;
|
|
1502
1542
|
/**
|
|
1503
|
-
* 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.
|
|
1543
|
+
* 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. Requires permission to access the ReplaceTopicRule action.
|
|
1504
1544
|
*/
|
|
1505
1545
|
replaceTopicRule(params: Iot.Types.ReplaceTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1506
1546
|
/**
|
|
1507
|
-
* 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.
|
|
1547
|
+
* 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. Requires permission to access the ReplaceTopicRule action.
|
|
1508
1548
|
*/
|
|
1509
1549
|
replaceTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1510
1550
|
/**
|
|
1511
|
-
* The query search index.
|
|
1551
|
+
* The query search index. Requires permission to access the SearchIndex action.
|
|
1512
1552
|
*/
|
|
1513
1553
|
searchIndex(params: Iot.Types.SearchIndexRequest, callback?: (err: AWSError, data: Iot.Types.SearchIndexResponse) => void): Request<Iot.Types.SearchIndexResponse, AWSError>;
|
|
1514
1554
|
/**
|
|
1515
|
-
* The query search index.
|
|
1555
|
+
* The query search index. Requires permission to access the SearchIndex action.
|
|
1516
1556
|
*/
|
|
1517
1557
|
searchIndex(callback?: (err: AWSError, data: Iot.Types.SearchIndexResponse) => void): Request<Iot.Types.SearchIndexResponse, AWSError>;
|
|
1518
1558
|
/**
|
|
1519
|
-
* Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
|
|
1559
|
+
* Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. Requires permission to access the SetDefaultAuthorizer action.
|
|
1520
1560
|
*/
|
|
1521
1561
|
setDefaultAuthorizer(params: Iot.Types.SetDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.SetDefaultAuthorizerResponse) => void): Request<Iot.Types.SetDefaultAuthorizerResponse, AWSError>;
|
|
1522
1562
|
/**
|
|
1523
|
-
* Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
|
|
1563
|
+
* Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. Requires permission to access the SetDefaultAuthorizer action.
|
|
1524
1564
|
*/
|
|
1525
1565
|
setDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.SetDefaultAuthorizerResponse) => void): Request<Iot.Types.SetDefaultAuthorizerResponse, AWSError>;
|
|
1526
1566
|
/**
|
|
1527
|
-
* 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
|
|
1567
|
+
* 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 ListPrincipalPolicies action. Requires permission to access the SetDefaultPolicyVersion action.
|
|
1528
1568
|
*/
|
|
1529
1569
|
setDefaultPolicyVersion(params: Iot.Types.SetDefaultPolicyVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1530
1570
|
/**
|
|
1531
|
-
* 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
|
|
1571
|
+
* 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 ListPrincipalPolicies action. Requires permission to access the SetDefaultPolicyVersion action.
|
|
1532
1572
|
*/
|
|
1533
1573
|
setDefaultPolicyVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1534
1574
|
/**
|
|
1535
|
-
* Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
|
|
1575
|
+
* Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead. Requires permission to access the SetLoggingOptions action.
|
|
1536
1576
|
*/
|
|
1537
1577
|
setLoggingOptions(params: Iot.Types.SetLoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1538
1578
|
/**
|
|
1539
|
-
* Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
|
|
1579
|
+
* Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead. Requires permission to access the SetLoggingOptions action.
|
|
1540
1580
|
*/
|
|
1541
1581
|
setLoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1542
1582
|
/**
|
|
1543
|
-
* Sets the logging level.
|
|
1583
|
+
* Sets the logging level. Requires permission to access the SetV2LoggingLevel action.
|
|
1544
1584
|
*/
|
|
1545
1585
|
setV2LoggingLevel(params: Iot.Types.SetV2LoggingLevelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1546
1586
|
/**
|
|
1547
|
-
* Sets the logging level.
|
|
1587
|
+
* Sets the logging level. Requires permission to access the SetV2LoggingLevel action.
|
|
1548
1588
|
*/
|
|
1549
1589
|
setV2LoggingLevel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1550
1590
|
/**
|
|
1551
|
-
* Sets the logging options for the V2 logging service.
|
|
1591
|
+
* Sets the logging options for the V2 logging service. Requires permission to access the SetV2LoggingOptions action.
|
|
1552
1592
|
*/
|
|
1553
1593
|
setV2LoggingOptions(params: Iot.Types.SetV2LoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1554
1594
|
/**
|
|
1555
|
-
* Sets the logging options for the V2 logging service.
|
|
1595
|
+
* Sets the logging options for the V2 logging service. Requires permission to access the SetV2LoggingOptions action.
|
|
1556
1596
|
*/
|
|
1557
1597
|
setV2LoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1558
1598
|
/**
|
|
1559
|
-
* Starts a task that applies a set of mitigation actions to the specified target.
|
|
1599
|
+
* Starts a task that applies a set of mitigation actions to the specified target. Requires permission to access the StartAuditMitigationActionsTask action.
|
|
1560
1600
|
*/
|
|
1561
1601
|
startAuditMitigationActionsTask(params: Iot.Types.StartAuditMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.StartAuditMitigationActionsTaskResponse, AWSError>;
|
|
1562
1602
|
/**
|
|
1563
|
-
* Starts a task that applies a set of mitigation actions to the specified target.
|
|
1603
|
+
* Starts a task that applies a set of mitigation actions to the specified target. Requires permission to access the StartAuditMitigationActionsTask action.
|
|
1564
1604
|
*/
|
|
1565
1605
|
startAuditMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.StartAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.StartAuditMitigationActionsTaskResponse, AWSError>;
|
|
1566
1606
|
/**
|
|
1567
|
-
* Starts a Device Defender ML Detect mitigation actions task.
|
|
1607
|
+
* Starts a Device Defender ML Detect mitigation actions task. Requires permission to access the StartDetectMitigationActionsTask action.
|
|
1568
1608
|
*/
|
|
1569
1609
|
startDetectMitigationActionsTask(params: Iot.Types.StartDetectMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.StartDetectMitigationActionsTaskResponse, AWSError>;
|
|
1570
1610
|
/**
|
|
1571
|
-
* Starts a Device Defender ML Detect mitigation actions task.
|
|
1611
|
+
* Starts a Device Defender ML Detect mitigation actions task. Requires permission to access the StartDetectMitigationActionsTask action.
|
|
1572
1612
|
*/
|
|
1573
1613
|
startDetectMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.StartDetectMitigationActionsTaskResponse) => void): Request<Iot.Types.StartDetectMitigationActionsTaskResponse, AWSError>;
|
|
1574
1614
|
/**
|
|
1575
|
-
* Starts an on-demand Device Defender audit.
|
|
1615
|
+
* Starts an on-demand Device Defender audit. Requires permission to access the StartOnDemandAuditTask action.
|
|
1576
1616
|
*/
|
|
1577
1617
|
startOnDemandAuditTask(params: Iot.Types.StartOnDemandAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartOnDemandAuditTaskResponse) => void): Request<Iot.Types.StartOnDemandAuditTaskResponse, AWSError>;
|
|
1578
1618
|
/**
|
|
1579
|
-
* Starts an on-demand Device Defender audit.
|
|
1619
|
+
* Starts an on-demand Device Defender audit. Requires permission to access the StartOnDemandAuditTask action.
|
|
1580
1620
|
*/
|
|
1581
1621
|
startOnDemandAuditTask(callback?: (err: AWSError, data: Iot.Types.StartOnDemandAuditTaskResponse) => void): Request<Iot.Types.StartOnDemandAuditTaskResponse, AWSError>;
|
|
1582
1622
|
/**
|
|
1583
|
-
* Creates a bulk thing provisioning task.
|
|
1623
|
+
* Creates a bulk thing provisioning task. Requires permission to access the StartThingRegistrationTask action.
|
|
1584
1624
|
*/
|
|
1585
1625
|
startThingRegistrationTask(params: Iot.Types.StartThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartThingRegistrationTaskResponse) => void): Request<Iot.Types.StartThingRegistrationTaskResponse, AWSError>;
|
|
1586
1626
|
/**
|
|
1587
|
-
* Creates a bulk thing provisioning task.
|
|
1627
|
+
* Creates a bulk thing provisioning task. Requires permission to access the StartThingRegistrationTask action.
|
|
1588
1628
|
*/
|
|
1589
1629
|
startThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.StartThingRegistrationTaskResponse) => void): Request<Iot.Types.StartThingRegistrationTaskResponse, AWSError>;
|
|
1590
1630
|
/**
|
|
1591
|
-
* Cancels a bulk thing provisioning task.
|
|
1631
|
+
* Cancels a bulk thing provisioning task. Requires permission to access the StopThingRegistrationTask action.
|
|
1592
1632
|
*/
|
|
1593
1633
|
stopThingRegistrationTask(params: Iot.Types.StopThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.StopThingRegistrationTaskResponse) => void): Request<Iot.Types.StopThingRegistrationTaskResponse, AWSError>;
|
|
1594
1634
|
/**
|
|
1595
|
-
* Cancels a bulk thing provisioning task.
|
|
1635
|
+
* Cancels a bulk thing provisioning task. Requires permission to access the StopThingRegistrationTask action.
|
|
1596
1636
|
*/
|
|
1597
1637
|
stopThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.StopThingRegistrationTaskResponse) => void): Request<Iot.Types.StopThingRegistrationTaskResponse, AWSError>;
|
|
1598
1638
|
/**
|
|
1599
|
-
* Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
|
|
1639
|
+
* Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. Requires permission to access the TagResource action.
|
|
1600
1640
|
*/
|
|
1601
1641
|
tagResource(params: Iot.Types.TagResourceRequest, callback?: (err: AWSError, data: Iot.Types.TagResourceResponse) => void): Request<Iot.Types.TagResourceResponse, AWSError>;
|
|
1602
1642
|
/**
|
|
1603
|
-
* Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
|
|
1643
|
+
* Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. Requires permission to access the TagResource action.
|
|
1604
1644
|
*/
|
|
1605
1645
|
tagResource(callback?: (err: AWSError, data: Iot.Types.TagResourceResponse) => void): Request<Iot.Types.TagResourceResponse, AWSError>;
|
|
1606
1646
|
/**
|
|
1607
|
-
* Tests if a specified principal is authorized to perform an
|
|
1647
|
+
* Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway. Requires permission to access the TestAuthorization action.
|
|
1608
1648
|
*/
|
|
1609
1649
|
testAuthorization(params: Iot.Types.TestAuthorizationRequest, callback?: (err: AWSError, data: Iot.Types.TestAuthorizationResponse) => void): Request<Iot.Types.TestAuthorizationResponse, AWSError>;
|
|
1610
1650
|
/**
|
|
1611
|
-
* Tests if a specified principal is authorized to perform an
|
|
1651
|
+
* Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway. Requires permission to access the TestAuthorization action.
|
|
1612
1652
|
*/
|
|
1613
1653
|
testAuthorization(callback?: (err: AWSError, data: Iot.Types.TestAuthorizationResponse) => void): Request<Iot.Types.TestAuthorizationResponse, AWSError>;
|
|
1614
1654
|
/**
|
|
1615
|
-
* 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
|
|
1655
|
+
* 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 IoT device gateway. Requires permission to access the TestInvokeAuthorizer action.
|
|
1616
1656
|
*/
|
|
1617
1657
|
testInvokeAuthorizer(params: Iot.Types.TestInvokeAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.TestInvokeAuthorizerResponse) => void): Request<Iot.Types.TestInvokeAuthorizerResponse, AWSError>;
|
|
1618
1658
|
/**
|
|
1619
|
-
* 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
|
|
1659
|
+
* 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 IoT device gateway. Requires permission to access the TestInvokeAuthorizer action.
|
|
1620
1660
|
*/
|
|
1621
1661
|
testInvokeAuthorizer(callback?: (err: AWSError, data: Iot.Types.TestInvokeAuthorizerResponse) => void): Request<Iot.Types.TestInvokeAuthorizerResponse, AWSError>;
|
|
1622
1662
|
/**
|
|
1623
|
-
* Transfers the specified certificate to the specified
|
|
1663
|
+
* Transfers the specified certificate to the specified Amazon Web Services account. Requires permission to access the TransferCertificate action. 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 action to deactivate it. The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.
|
|
1624
1664
|
*/
|
|
1625
1665
|
transferCertificate(params: Iot.Types.TransferCertificateRequest, callback?: (err: AWSError, data: Iot.Types.TransferCertificateResponse) => void): Request<Iot.Types.TransferCertificateResponse, AWSError>;
|
|
1626
1666
|
/**
|
|
1627
|
-
* Transfers the specified certificate to the specified
|
|
1667
|
+
* Transfers the specified certificate to the specified Amazon Web Services account. Requires permission to access the TransferCertificate action. 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 action to deactivate it. The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.
|
|
1628
1668
|
*/
|
|
1629
1669
|
transferCertificate(callback?: (err: AWSError, data: Iot.Types.TransferCertificateResponse) => void): Request<Iot.Types.TransferCertificateResponse, AWSError>;
|
|
1630
1670
|
/**
|
|
1631
|
-
* Removes the given tags (metadata) from the resource.
|
|
1671
|
+
* Removes the given tags (metadata) from the resource. Requires permission to access the UntagResource action.
|
|
1632
1672
|
*/
|
|
1633
1673
|
untagResource(params: Iot.Types.UntagResourceRequest, callback?: (err: AWSError, data: Iot.Types.UntagResourceResponse) => void): Request<Iot.Types.UntagResourceResponse, AWSError>;
|
|
1634
1674
|
/**
|
|
1635
|
-
* Removes the given tags (metadata) from the resource.
|
|
1675
|
+
* Removes the given tags (metadata) from the resource. Requires permission to access the UntagResource action.
|
|
1636
1676
|
*/
|
|
1637
1677
|
untagResource(callback?: (err: AWSError, data: Iot.Types.UntagResourceResponse) => void): Request<Iot.Types.UntagResourceResponse, AWSError>;
|
|
1638
1678
|
/**
|
|
1639
|
-
* 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.
|
|
1679
|
+
* 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. Requires permission to access the UpdateAccountAuditConfiguration action.
|
|
1640
1680
|
*/
|
|
1641
1681
|
updateAccountAuditConfiguration(params: Iot.Types.UpdateAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateAccountAuditConfigurationResponse) => void): Request<Iot.Types.UpdateAccountAuditConfigurationResponse, AWSError>;
|
|
1642
1682
|
/**
|
|
1643
|
-
* 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.
|
|
1683
|
+
* 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. Requires permission to access the UpdateAccountAuditConfiguration action.
|
|
1644
1684
|
*/
|
|
1645
1685
|
updateAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.UpdateAccountAuditConfigurationResponse) => void): Request<Iot.Types.UpdateAccountAuditConfigurationResponse, AWSError>;
|
|
1646
1686
|
/**
|
|
@@ -1652,179 +1692,187 @@ declare class Iot extends Service {
|
|
|
1652
1692
|
*/
|
|
1653
1693
|
updateAuditSuppression(callback?: (err: AWSError, data: Iot.Types.UpdateAuditSuppressionResponse) => void): Request<Iot.Types.UpdateAuditSuppressionResponse, AWSError>;
|
|
1654
1694
|
/**
|
|
1655
|
-
* Updates an authorizer.
|
|
1695
|
+
* Updates an authorizer. Requires permission to access the UpdateAuthorizer action.
|
|
1656
1696
|
*/
|
|
1657
1697
|
updateAuthorizer(params: Iot.Types.UpdateAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.UpdateAuthorizerResponse) => void): Request<Iot.Types.UpdateAuthorizerResponse, AWSError>;
|
|
1658
1698
|
/**
|
|
1659
|
-
* Updates an authorizer.
|
|
1699
|
+
* Updates an authorizer. Requires permission to access the UpdateAuthorizer action.
|
|
1660
1700
|
*/
|
|
1661
1701
|
updateAuthorizer(callback?: (err: AWSError, data: Iot.Types.UpdateAuthorizerResponse) => void): Request<Iot.Types.UpdateAuthorizerResponse, AWSError>;
|
|
1662
1702
|
/**
|
|
1663
|
-
* Updates information about the billing group.
|
|
1703
|
+
* Updates information about the billing group. Requires permission to access the UpdateBillingGroup action.
|
|
1664
1704
|
*/
|
|
1665
1705
|
updateBillingGroup(params: Iot.Types.UpdateBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateBillingGroupResponse) => void): Request<Iot.Types.UpdateBillingGroupResponse, AWSError>;
|
|
1666
1706
|
/**
|
|
1667
|
-
* Updates information about the billing group.
|
|
1707
|
+
* Updates information about the billing group. Requires permission to access the UpdateBillingGroup action.
|
|
1668
1708
|
*/
|
|
1669
1709
|
updateBillingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateBillingGroupResponse) => void): Request<Iot.Types.UpdateBillingGroupResponse, AWSError>;
|
|
1670
1710
|
/**
|
|
1671
|
-
* Updates a registered CA certificate.
|
|
1711
|
+
* Updates a registered CA certificate. Requires permission to access the UpdateCACertificate action.
|
|
1672
1712
|
*/
|
|
1673
1713
|
updateCACertificate(params: Iot.Types.UpdateCACertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1674
1714
|
/**
|
|
1675
|
-
* Updates a registered CA certificate.
|
|
1715
|
+
* Updates a registered CA certificate. Requires permission to access the UpdateCACertificate action.
|
|
1676
1716
|
*/
|
|
1677
1717
|
updateCACertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1678
1718
|
/**
|
|
1679
|
-
* Updates the status of the specified certificate. This operation is idempotent. Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to
|
|
1719
|
+
* Updates the status of the specified certificate. This operation is idempotent. Requires permission to access the UpdateCertificate action. Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT. Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.
|
|
1680
1720
|
*/
|
|
1681
1721
|
updateCertificate(params: Iot.Types.UpdateCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1682
1722
|
/**
|
|
1683
|
-
* Updates the status of the specified certificate. This operation is idempotent. Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to
|
|
1723
|
+
* Updates the status of the specified certificate. This operation is idempotent. Requires permission to access the UpdateCertificate action. Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT. Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.
|
|
1684
1724
|
*/
|
|
1685
1725
|
updateCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1686
1726
|
/**
|
|
1687
|
-
* Updates a Device Defender detect custom metric.
|
|
1727
|
+
* Updates a Device Defender detect custom metric. Requires permission to access the UpdateCustomMetric action.
|
|
1688
1728
|
*/
|
|
1689
1729
|
updateCustomMetric(params: Iot.Types.UpdateCustomMetricRequest, callback?: (err: AWSError, data: Iot.Types.UpdateCustomMetricResponse) => void): Request<Iot.Types.UpdateCustomMetricResponse, AWSError>;
|
|
1690
1730
|
/**
|
|
1691
|
-
* Updates a Device Defender detect custom metric.
|
|
1731
|
+
* Updates a Device Defender detect custom metric. Requires permission to access the UpdateCustomMetric action.
|
|
1692
1732
|
*/
|
|
1693
1733
|
updateCustomMetric(callback?: (err: AWSError, data: Iot.Types.UpdateCustomMetricResponse) => void): Request<Iot.Types.UpdateCustomMetricResponse, AWSError>;
|
|
1694
1734
|
/**
|
|
1695
|
-
* Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).
|
|
1735
|
+
* Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it). Requires permission to access the UpdateDimension action.
|
|
1696
1736
|
*/
|
|
1697
1737
|
updateDimension(params: Iot.Types.UpdateDimensionRequest, callback?: (err: AWSError, data: Iot.Types.UpdateDimensionResponse) => void): Request<Iot.Types.UpdateDimensionResponse, AWSError>;
|
|
1698
1738
|
/**
|
|
1699
|
-
* Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).
|
|
1739
|
+
* Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it). Requires permission to access the UpdateDimension action.
|
|
1700
1740
|
*/
|
|
1701
1741
|
updateDimension(callback?: (err: AWSError, data: Iot.Types.UpdateDimensionResponse) => void): Request<Iot.Types.UpdateDimensionResponse, AWSError>;
|
|
1702
1742
|
/**
|
|
1703
|
-
* Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
|
|
1743
|
+
* Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action.
|
|
1704
1744
|
*/
|
|
1705
1745
|
updateDomainConfiguration(params: Iot.Types.UpdateDomainConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateDomainConfigurationResponse) => void): Request<Iot.Types.UpdateDomainConfigurationResponse, AWSError>;
|
|
1706
1746
|
/**
|
|
1707
|
-
* Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
|
|
1747
|
+
* Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action.
|
|
1708
1748
|
*/
|
|
1709
1749
|
updateDomainConfiguration(callback?: (err: AWSError, data: Iot.Types.UpdateDomainConfigurationResponse) => void): Request<Iot.Types.UpdateDomainConfigurationResponse, AWSError>;
|
|
1710
1750
|
/**
|
|
1711
|
-
* Updates a dynamic thing group.
|
|
1751
|
+
* Updates a dynamic thing group. Requires permission to access the UpdateDynamicThingGroup action.
|
|
1712
1752
|
*/
|
|
1713
1753
|
updateDynamicThingGroup(params: Iot.Types.UpdateDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateDynamicThingGroupResponse) => void): Request<Iot.Types.UpdateDynamicThingGroupResponse, AWSError>;
|
|
1714
1754
|
/**
|
|
1715
|
-
* Updates a dynamic thing group.
|
|
1755
|
+
* Updates a dynamic thing group. Requires permission to access the UpdateDynamicThingGroup action.
|
|
1716
1756
|
*/
|
|
1717
1757
|
updateDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateDynamicThingGroupResponse) => void): Request<Iot.Types.UpdateDynamicThingGroupResponse, AWSError>;
|
|
1718
1758
|
/**
|
|
1719
|
-
* Updates the event configurations.
|
|
1759
|
+
* Updates the event configurations. Requires permission to access the UpdateEventConfigurations action.
|
|
1720
1760
|
*/
|
|
1721
1761
|
updateEventConfigurations(params: Iot.Types.UpdateEventConfigurationsRequest, callback?: (err: AWSError, data: Iot.Types.UpdateEventConfigurationsResponse) => void): Request<Iot.Types.UpdateEventConfigurationsResponse, AWSError>;
|
|
1722
1762
|
/**
|
|
1723
|
-
* Updates the event configurations.
|
|
1763
|
+
* Updates the event configurations. Requires permission to access the UpdateEventConfigurations action.
|
|
1724
1764
|
*/
|
|
1725
1765
|
updateEventConfigurations(callback?: (err: AWSError, data: Iot.Types.UpdateEventConfigurationsResponse) => void): Request<Iot.Types.UpdateEventConfigurationsResponse, AWSError>;
|
|
1726
1766
|
/**
|
|
1727
|
-
* Updates the
|
|
1767
|
+
* Updates the data for a fleet metric. Requires permission to access the UpdateFleetMetric action.
|
|
1768
|
+
*/
|
|
1769
|
+
updateFleetMetric(params: Iot.Types.UpdateFleetMetricRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1770
|
+
/**
|
|
1771
|
+
* Updates the data for a fleet metric. Requires permission to access the UpdateFleetMetric action.
|
|
1772
|
+
*/
|
|
1773
|
+
updateFleetMetric(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1774
|
+
/**
|
|
1775
|
+
* Updates the search configuration. Requires permission to access the UpdateIndexingConfiguration action.
|
|
1728
1776
|
*/
|
|
1729
1777
|
updateIndexingConfiguration(params: Iot.Types.UpdateIndexingConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateIndexingConfigurationResponse) => void): Request<Iot.Types.UpdateIndexingConfigurationResponse, AWSError>;
|
|
1730
1778
|
/**
|
|
1731
|
-
* Updates the search configuration.
|
|
1779
|
+
* Updates the search configuration. Requires permission to access the UpdateIndexingConfiguration action.
|
|
1732
1780
|
*/
|
|
1733
1781
|
updateIndexingConfiguration(callback?: (err: AWSError, data: Iot.Types.UpdateIndexingConfigurationResponse) => void): Request<Iot.Types.UpdateIndexingConfigurationResponse, AWSError>;
|
|
1734
1782
|
/**
|
|
1735
|
-
* Updates supported fields of the specified job.
|
|
1783
|
+
* Updates supported fields of the specified job. Requires permission to access the UpdateJob action.
|
|
1736
1784
|
*/
|
|
1737
1785
|
updateJob(params: Iot.Types.UpdateJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1738
1786
|
/**
|
|
1739
|
-
* Updates supported fields of the specified job.
|
|
1787
|
+
* Updates supported fields of the specified job. Requires permission to access the UpdateJob action.
|
|
1740
1788
|
*/
|
|
1741
1789
|
updateJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1742
1790
|
/**
|
|
1743
|
-
* Updates the definition for the specified mitigation action.
|
|
1791
|
+
* Updates the definition for the specified mitigation action. Requires permission to access the UpdateMitigationAction action.
|
|
1744
1792
|
*/
|
|
1745
1793
|
updateMitigationAction(params: Iot.Types.UpdateMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.UpdateMitigationActionResponse) => void): Request<Iot.Types.UpdateMitigationActionResponse, AWSError>;
|
|
1746
1794
|
/**
|
|
1747
|
-
* Updates the definition for the specified mitigation action.
|
|
1795
|
+
* Updates the definition for the specified mitigation action. Requires permission to access the UpdateMitigationAction action.
|
|
1748
1796
|
*/
|
|
1749
1797
|
updateMitigationAction(callback?: (err: AWSError, data: Iot.Types.UpdateMitigationActionResponse) => void): Request<Iot.Types.UpdateMitigationActionResponse, AWSError>;
|
|
1750
1798
|
/**
|
|
1751
|
-
* Updates a fleet provisioning template.
|
|
1799
|
+
* Updates a fleet provisioning template. Requires permission to access the UpdateProvisioningTemplate action.
|
|
1752
1800
|
*/
|
|
1753
1801
|
updateProvisioningTemplate(params: Iot.Types.UpdateProvisioningTemplateRequest, callback?: (err: AWSError, data: Iot.Types.UpdateProvisioningTemplateResponse) => void): Request<Iot.Types.UpdateProvisioningTemplateResponse, AWSError>;
|
|
1754
1802
|
/**
|
|
1755
|
-
* Updates a fleet provisioning template.
|
|
1803
|
+
* Updates a fleet provisioning template. Requires permission to access the UpdateProvisioningTemplate action.
|
|
1756
1804
|
*/
|
|
1757
1805
|
updateProvisioningTemplate(callback?: (err: AWSError, data: Iot.Types.UpdateProvisioningTemplateResponse) => void): Request<Iot.Types.UpdateProvisioningTemplateResponse, AWSError>;
|
|
1758
1806
|
/**
|
|
1759
|
-
* Updates a role alias.
|
|
1807
|
+
* Updates a role alias. Requires permission to access the UpdateRoleAlias action.
|
|
1760
1808
|
*/
|
|
1761
1809
|
updateRoleAlias(params: Iot.Types.UpdateRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.UpdateRoleAliasResponse) => void): Request<Iot.Types.UpdateRoleAliasResponse, AWSError>;
|
|
1762
1810
|
/**
|
|
1763
|
-
* Updates a role alias.
|
|
1811
|
+
* Updates a role alias. Requires permission to access the UpdateRoleAlias action.
|
|
1764
1812
|
*/
|
|
1765
1813
|
updateRoleAlias(callback?: (err: AWSError, data: Iot.Types.UpdateRoleAliasResponse) => void): Request<Iot.Types.UpdateRoleAliasResponse, AWSError>;
|
|
1766
1814
|
/**
|
|
1767
|
-
* Updates a scheduled audit, including which checks are performed and how often the audit takes place.
|
|
1815
|
+
* Updates a scheduled audit, including which checks are performed and how often the audit takes place. Requires permission to access the UpdateScheduledAudit action.
|
|
1768
1816
|
*/
|
|
1769
1817
|
updateScheduledAudit(params: Iot.Types.UpdateScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.UpdateScheduledAuditResponse) => void): Request<Iot.Types.UpdateScheduledAuditResponse, AWSError>;
|
|
1770
1818
|
/**
|
|
1771
|
-
* Updates a scheduled audit, including which checks are performed and how often the audit takes place.
|
|
1819
|
+
* Updates a scheduled audit, including which checks are performed and how often the audit takes place. Requires permission to access the UpdateScheduledAudit action.
|
|
1772
1820
|
*/
|
|
1773
1821
|
updateScheduledAudit(callback?: (err: AWSError, data: Iot.Types.UpdateScheduledAuditResponse) => void): Request<Iot.Types.UpdateScheduledAuditResponse, AWSError>;
|
|
1774
1822
|
/**
|
|
1775
|
-
* Updates a Device Defender security profile.
|
|
1823
|
+
* Updates a Device Defender security profile. Requires permission to access the UpdateSecurityProfile action.
|
|
1776
1824
|
*/
|
|
1777
1825
|
updateSecurityProfile(params: Iot.Types.UpdateSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.UpdateSecurityProfileResponse) => void): Request<Iot.Types.UpdateSecurityProfileResponse, AWSError>;
|
|
1778
1826
|
/**
|
|
1779
|
-
* Updates a Device Defender security profile.
|
|
1827
|
+
* Updates a Device Defender security profile. Requires permission to access the UpdateSecurityProfile action.
|
|
1780
1828
|
*/
|
|
1781
1829
|
updateSecurityProfile(callback?: (err: AWSError, data: Iot.Types.UpdateSecurityProfileResponse) => void): Request<Iot.Types.UpdateSecurityProfileResponse, AWSError>;
|
|
1782
1830
|
/**
|
|
1783
|
-
* Updates an existing stream. The stream version will be incremented by one.
|
|
1831
|
+
* Updates an existing stream. The stream version will be incremented by one. Requires permission to access the UpdateStream action.
|
|
1784
1832
|
*/
|
|
1785
1833
|
updateStream(params: Iot.Types.UpdateStreamRequest, callback?: (err: AWSError, data: Iot.Types.UpdateStreamResponse) => void): Request<Iot.Types.UpdateStreamResponse, AWSError>;
|
|
1786
1834
|
/**
|
|
1787
|
-
* Updates an existing stream. The stream version will be incremented by one.
|
|
1835
|
+
* Updates an existing stream. The stream version will be incremented by one. Requires permission to access the UpdateStream action.
|
|
1788
1836
|
*/
|
|
1789
1837
|
updateStream(callback?: (err: AWSError, data: Iot.Types.UpdateStreamResponse) => void): Request<Iot.Types.UpdateStreamResponse, AWSError>;
|
|
1790
1838
|
/**
|
|
1791
|
-
* Updates the data for a thing.
|
|
1839
|
+
* Updates the data for a thing. Requires permission to access the UpdateThing action.
|
|
1792
1840
|
*/
|
|
1793
1841
|
updateThing(params: Iot.Types.UpdateThingRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingResponse) => void): Request<Iot.Types.UpdateThingResponse, AWSError>;
|
|
1794
1842
|
/**
|
|
1795
|
-
* Updates the data for a thing.
|
|
1843
|
+
* Updates the data for a thing. Requires permission to access the UpdateThing action.
|
|
1796
1844
|
*/
|
|
1797
1845
|
updateThing(callback?: (err: AWSError, data: Iot.Types.UpdateThingResponse) => void): Request<Iot.Types.UpdateThingResponse, AWSError>;
|
|
1798
1846
|
/**
|
|
1799
|
-
* Update a thing group.
|
|
1847
|
+
* Update a thing group. Requires permission to access the UpdateThingGroup action.
|
|
1800
1848
|
*/
|
|
1801
1849
|
updateThingGroup(params: Iot.Types.UpdateThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupResponse) => void): Request<Iot.Types.UpdateThingGroupResponse, AWSError>;
|
|
1802
1850
|
/**
|
|
1803
|
-
* Update a thing group.
|
|
1851
|
+
* Update a thing group. Requires permission to access the UpdateThingGroup action.
|
|
1804
1852
|
*/
|
|
1805
1853
|
updateThingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupResponse) => void): Request<Iot.Types.UpdateThingGroupResponse, AWSError>;
|
|
1806
1854
|
/**
|
|
1807
|
-
* Updates the groups to which the thing belongs.
|
|
1855
|
+
* Updates the groups to which the thing belongs. Requires permission to access the UpdateThingGroupsForThing action.
|
|
1808
1856
|
*/
|
|
1809
1857
|
updateThingGroupsForThing(params: Iot.Types.UpdateThingGroupsForThingRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupsForThingResponse) => void): Request<Iot.Types.UpdateThingGroupsForThingResponse, AWSError>;
|
|
1810
1858
|
/**
|
|
1811
|
-
* Updates the groups to which the thing belongs.
|
|
1859
|
+
* Updates the groups to which the thing belongs. Requires permission to access the UpdateThingGroupsForThing action.
|
|
1812
1860
|
*/
|
|
1813
1861
|
updateThingGroupsForThing(callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupsForThingResponse) => void): Request<Iot.Types.UpdateThingGroupsForThingResponse, AWSError>;
|
|
1814
1862
|
/**
|
|
1815
|
-
* Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
|
|
1863
|
+
* Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination. Requires permission to access the UpdateTopicRuleDestination action.
|
|
1816
1864
|
*/
|
|
1817
1865
|
updateTopicRuleDestination(params: Iot.Types.UpdateTopicRuleDestinationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateTopicRuleDestinationResponse) => void): Request<Iot.Types.UpdateTopicRuleDestinationResponse, AWSError>;
|
|
1818
1866
|
/**
|
|
1819
|
-
* Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
|
|
1867
|
+
* Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination. Requires permission to access the UpdateTopicRuleDestination action.
|
|
1820
1868
|
*/
|
|
1821
1869
|
updateTopicRuleDestination(callback?: (err: AWSError, data: Iot.Types.UpdateTopicRuleDestinationResponse) => void): Request<Iot.Types.UpdateTopicRuleDestinationResponse, AWSError>;
|
|
1822
1870
|
/**
|
|
1823
|
-
* Validates a Device Defender security profile behaviors specification.
|
|
1871
|
+
* Validates a Device Defender security profile behaviors specification. Requires permission to access the ValidateSecurityProfileBehaviors action.
|
|
1824
1872
|
*/
|
|
1825
1873
|
validateSecurityProfileBehaviors(params: Iot.Types.ValidateSecurityProfileBehaviorsRequest, callback?: (err: AWSError, data: Iot.Types.ValidateSecurityProfileBehaviorsResponse) => void): Request<Iot.Types.ValidateSecurityProfileBehaviorsResponse, AWSError>;
|
|
1826
1874
|
/**
|
|
1827
|
-
* Validates a Device Defender security profile behaviors specification.
|
|
1875
|
+
* Validates a Device Defender security profile behaviors specification. Requires permission to access the ValidateSecurityProfileBehaviors action.
|
|
1828
1876
|
*/
|
|
1829
1877
|
validateSecurityProfileBehaviors(callback?: (err: AWSError, data: Iot.Types.ValidateSecurityProfileBehaviorsResponse) => void): Request<Iot.Types.ValidateSecurityProfileBehaviorsResponse, AWSError>;
|
|
1830
1878
|
}
|
|
@@ -1846,7 +1894,7 @@ declare namespace Iot {
|
|
|
1846
1894
|
*/
|
|
1847
1895
|
action: AbortAction;
|
|
1848
1896
|
/**
|
|
1849
|
-
* The minimum percentage of job execution failures that must occur to initiate the job abort.
|
|
1897
|
+
* The minimum percentage of job execution failures that must occur to initiate the job abort. Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
|
|
1850
1898
|
*/
|
|
1851
1899
|
thresholdPercentage: AbortThresholdPercentage;
|
|
1852
1900
|
/**
|
|
@@ -1925,15 +1973,15 @@ declare namespace Iot {
|
|
|
1925
1973
|
*/
|
|
1926
1974
|
salesforce?: SalesforceAction;
|
|
1927
1975
|
/**
|
|
1928
|
-
* Sends message data to an
|
|
1976
|
+
* Sends message data to an IoT Analytics channel.
|
|
1929
1977
|
*/
|
|
1930
1978
|
iotAnalytics?: IotAnalyticsAction;
|
|
1931
1979
|
/**
|
|
1932
|
-
* Sends an input to an
|
|
1980
|
+
* Sends an input to an IoT Events detector.
|
|
1933
1981
|
*/
|
|
1934
1982
|
iotEvents?: IotEventsAction;
|
|
1935
1983
|
/**
|
|
1936
|
-
* Sends data from the MQTT message that triggered the rule to
|
|
1984
|
+
* Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.
|
|
1937
1985
|
*/
|
|
1938
1986
|
iotSiteWise?: IotSiteWiseAction;
|
|
1939
1987
|
/**
|
|
@@ -2048,6 +2096,19 @@ declare namespace Iot {
|
|
|
2048
2096
|
export type AdditionalMetricsToRetainV2List = MetricToRetain[];
|
|
2049
2097
|
export type AdditionalParameterMap = {[key: string]: Value};
|
|
2050
2098
|
export type AggregationField = string;
|
|
2099
|
+
export interface AggregationType {
|
|
2100
|
+
/**
|
|
2101
|
+
* The name of the aggregation type.
|
|
2102
|
+
*/
|
|
2103
|
+
name: AggregationTypeName;
|
|
2104
|
+
/**
|
|
2105
|
+
* A list of the values of aggregation types.
|
|
2106
|
+
*/
|
|
2107
|
+
values?: AggregationTypeValues;
|
|
2108
|
+
}
|
|
2109
|
+
export type AggregationTypeName = "Statistics"|"Percentiles"|"Cardinality"|string;
|
|
2110
|
+
export type AggregationTypeValue = string;
|
|
2111
|
+
export type AggregationTypeValues = AggregationTypeValue[];
|
|
2051
2112
|
export type AlarmName = string;
|
|
2052
2113
|
export interface AlertTarget {
|
|
2053
2114
|
/**
|
|
@@ -2140,7 +2201,7 @@ declare namespace Iot {
|
|
|
2140
2201
|
*/
|
|
2141
2202
|
comment?: Comment;
|
|
2142
2203
|
/**
|
|
2143
|
-
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter,
|
|
2204
|
+
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
|
|
2144
2205
|
*/
|
|
2145
2206
|
namespaceId?: NamespaceId;
|
|
2146
2207
|
}
|
|
@@ -2511,7 +2572,7 @@ declare namespace Iot {
|
|
|
2511
2572
|
*/
|
|
2512
2573
|
lastModifiedDate?: DateType;
|
|
2513
2574
|
/**
|
|
2514
|
-
* Specifies whether
|
|
2575
|
+
* Specifies whether IoT validates the token signature in an authorization request.
|
|
2515
2576
|
*/
|
|
2516
2577
|
signingDisabled?: BooleanKey;
|
|
2517
2578
|
}
|
|
@@ -2552,7 +2613,7 @@ declare namespace Iot {
|
|
|
2552
2613
|
*/
|
|
2553
2614
|
action: AwsJobAbortCriteriaAbortAction;
|
|
2554
2615
|
/**
|
|
2555
|
-
* The minimum percentage of job execution failures that must occur to initiate the job abort.
|
|
2616
|
+
* The minimum percentage of job execution failures that must occur to initiate the job abort. Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
|
|
2556
2617
|
*/
|
|
2557
2618
|
thresholdPercentage: AwsJobAbortCriteriaAbortThresholdPercentage;
|
|
2558
2619
|
/**
|
|
@@ -2585,7 +2646,7 @@ declare namespace Iot {
|
|
|
2585
2646
|
*/
|
|
2586
2647
|
incrementFactor: AwsJobRolloutIncrementFactor;
|
|
2587
2648
|
/**
|
|
2588
|
-
* The criteria to initiate the increase in rate of rollout for a job.
|
|
2649
|
+
* The criteria to initiate the increase in rate of rollout for a job. Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).
|
|
2589
2650
|
*/
|
|
2590
2651
|
rateIncreaseCriteria: AwsJobRateIncreaseCriteria;
|
|
2591
2652
|
}
|
|
@@ -2718,7 +2779,25 @@ declare namespace Iot {
|
|
|
2718
2779
|
}
|
|
2719
2780
|
export type Boolean = boolean;
|
|
2720
2781
|
export type BooleanKey = boolean;
|
|
2782
|
+
export interface Bucket {
|
|
2783
|
+
/**
|
|
2784
|
+
* The value counted for the particular bucket.
|
|
2785
|
+
*/
|
|
2786
|
+
keyValue?: BucketKeyValue;
|
|
2787
|
+
/**
|
|
2788
|
+
* The number of documents that have the value counted for the particular bucket.
|
|
2789
|
+
*/
|
|
2790
|
+
count?: Count;
|
|
2791
|
+
}
|
|
2792
|
+
export type BucketKeyValue = string;
|
|
2721
2793
|
export type BucketName = string;
|
|
2794
|
+
export type Buckets = Bucket[];
|
|
2795
|
+
export interface BucketsAggregationType {
|
|
2796
|
+
/**
|
|
2797
|
+
* Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.
|
|
2798
|
+
*/
|
|
2799
|
+
termsAggregation?: TermsAggregation;
|
|
2800
|
+
}
|
|
2722
2801
|
export interface CACertificate {
|
|
2723
2802
|
/**
|
|
2724
2803
|
* The ARN of the CA certificate.
|
|
@@ -2919,11 +2998,11 @@ declare namespace Iot {
|
|
|
2919
2998
|
*/
|
|
2920
2999
|
certificatePem?: CertificatePem;
|
|
2921
3000
|
/**
|
|
2922
|
-
* The ID of the
|
|
3001
|
+
* The ID of the Amazon Web Services account that owns the certificate.
|
|
2923
3002
|
*/
|
|
2924
3003
|
ownedBy?: AwsAccountId;
|
|
2925
3004
|
/**
|
|
2926
|
-
* The ID of the
|
|
3005
|
+
* The ID of the Amazon Web Services account of the previous owner of the certificate.
|
|
2927
3006
|
*/
|
|
2928
3007
|
previousOwnedBy?: AwsAccountId;
|
|
2929
3008
|
/**
|
|
@@ -3141,7 +3220,7 @@ declare namespace Iot {
|
|
|
3141
3220
|
*/
|
|
3142
3221
|
tags?: TagList;
|
|
3143
3222
|
/**
|
|
3144
|
-
* Specifies whether
|
|
3223
|
+
* Specifies whether IoT validates the token signature in an authorization request.
|
|
3145
3224
|
*/
|
|
3146
3225
|
signingDisabled?: BooleanKey;
|
|
3147
3226
|
}
|
|
@@ -3225,7 +3304,7 @@ declare namespace Iot {
|
|
|
3225
3304
|
*/
|
|
3226
3305
|
tags?: TagList;
|
|
3227
3306
|
/**
|
|
3228
|
-
* Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value,
|
|
3307
|
+
* Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
|
|
3229
3308
|
*/
|
|
3230
3309
|
clientRequestToken: ClientRequestToken;
|
|
3231
3310
|
}
|
|
@@ -3257,7 +3336,7 @@ declare namespace Iot {
|
|
|
3257
3336
|
*/
|
|
3258
3337
|
tags?: TagList;
|
|
3259
3338
|
/**
|
|
3260
|
-
* 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,
|
|
3339
|
+
* 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, Amazon Web Services SDKs will automatically generate a unique client request.
|
|
3261
3340
|
*/
|
|
3262
3341
|
clientRequestToken: ClientRequestToken;
|
|
3263
3342
|
}
|
|
@@ -3281,11 +3360,11 @@ declare namespace Iot {
|
|
|
3281
3360
|
*/
|
|
3282
3361
|
domainName?: DomainName;
|
|
3283
3362
|
/**
|
|
3284
|
-
* The ARNs of the certificates that
|
|
3363
|
+
* The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.
|
|
3285
3364
|
*/
|
|
3286
3365
|
serverCertificateArns?: ServerCertificateArns;
|
|
3287
3366
|
/**
|
|
3288
|
-
* 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
|
|
3367
|
+
* 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 Amazon Web Services-managed domains.
|
|
3289
3368
|
*/
|
|
3290
3369
|
validationCertificateArn?: AcmCertificateArn;
|
|
3291
3370
|
/**
|
|
@@ -3293,7 +3372,7 @@ declare namespace Iot {
|
|
|
3293
3372
|
*/
|
|
3294
3373
|
authorizerConfig?: AuthorizerConfig;
|
|
3295
3374
|
/**
|
|
3296
|
-
* The type of service delivered by the endpoint.
|
|
3375
|
+
* The type of service delivered by the endpoint. Amazon Web Services IoT Core currently supports only the DATA service type.
|
|
3297
3376
|
*/
|
|
3298
3377
|
serviceType?: ServiceType;
|
|
3299
3378
|
/**
|
|
@@ -3321,7 +3400,7 @@ declare namespace Iot {
|
|
|
3321
3400
|
*/
|
|
3322
3401
|
thingGroupProperties?: ThingGroupProperties;
|
|
3323
3402
|
/**
|
|
3324
|
-
* The dynamic thing group index name. Currently one index is supported:
|
|
3403
|
+
* The dynamic thing group index name. Currently one index is supported: AWS_Things.
|
|
3325
3404
|
*/
|
|
3326
3405
|
indexName?: IndexName;
|
|
3327
3406
|
/**
|
|
@@ -3363,9 +3442,61 @@ declare namespace Iot {
|
|
|
3363
3442
|
*/
|
|
3364
3443
|
queryVersion?: QueryVersion;
|
|
3365
3444
|
}
|
|
3445
|
+
export interface CreateFleetMetricRequest {
|
|
3446
|
+
/**
|
|
3447
|
+
* The name of the fleet metric to create.
|
|
3448
|
+
*/
|
|
3449
|
+
metricName: FleetMetricName;
|
|
3450
|
+
/**
|
|
3451
|
+
* The search query string.
|
|
3452
|
+
*/
|
|
3453
|
+
queryString: QueryString;
|
|
3454
|
+
/**
|
|
3455
|
+
* The type of the aggregation query.
|
|
3456
|
+
*/
|
|
3457
|
+
aggregationType: AggregationType;
|
|
3458
|
+
/**
|
|
3459
|
+
* The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
|
|
3460
|
+
*/
|
|
3461
|
+
period: FleetMetricPeriod;
|
|
3462
|
+
/**
|
|
3463
|
+
* The field to aggregate.
|
|
3464
|
+
*/
|
|
3465
|
+
aggregationField: AggregationField;
|
|
3466
|
+
/**
|
|
3467
|
+
* The fleet metric description.
|
|
3468
|
+
*/
|
|
3469
|
+
description?: FleetMetricDescription;
|
|
3470
|
+
/**
|
|
3471
|
+
* The query version.
|
|
3472
|
+
*/
|
|
3473
|
+
queryVersion?: QueryVersion;
|
|
3474
|
+
/**
|
|
3475
|
+
* The name of the index to search.
|
|
3476
|
+
*/
|
|
3477
|
+
indexName?: IndexName;
|
|
3478
|
+
/**
|
|
3479
|
+
* Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.
|
|
3480
|
+
*/
|
|
3481
|
+
unit?: FleetMetricUnit;
|
|
3482
|
+
/**
|
|
3483
|
+
* Metadata, which can be used to manage the fleet metric.
|
|
3484
|
+
*/
|
|
3485
|
+
tags?: TagList;
|
|
3486
|
+
}
|
|
3487
|
+
export interface CreateFleetMetricResponse {
|
|
3488
|
+
/**
|
|
3489
|
+
* The name of the fleet metric to create.
|
|
3490
|
+
*/
|
|
3491
|
+
metricName?: FleetMetricName;
|
|
3492
|
+
/**
|
|
3493
|
+
* The Amazon Resource Name (ARN) of the new fleet metric.
|
|
3494
|
+
*/
|
|
3495
|
+
metricArn?: FleetMetricArn;
|
|
3496
|
+
}
|
|
3366
3497
|
export interface CreateJobRequest {
|
|
3367
3498
|
/**
|
|
3368
|
-
* A job identifier which must be unique for your
|
|
3499
|
+
* A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
|
|
3369
3500
|
*/
|
|
3370
3501
|
jobId: JobId;
|
|
3371
3502
|
/**
|
|
@@ -3409,7 +3540,7 @@ declare namespace Iot {
|
|
|
3409
3540
|
*/
|
|
3410
3541
|
tags?: TagList;
|
|
3411
3542
|
/**
|
|
3412
|
-
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter,
|
|
3543
|
+
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
|
|
3413
3544
|
*/
|
|
3414
3545
|
namespaceId?: NamespaceId;
|
|
3415
3546
|
/**
|
|
@@ -3483,7 +3614,7 @@ declare namespace Iot {
|
|
|
3483
3614
|
*/
|
|
3484
3615
|
certificateArn?: CertificateArn;
|
|
3485
3616
|
/**
|
|
3486
|
-
* The ID of the certificate.
|
|
3617
|
+
* The ID of the certificate. IoT issues a default subject name for the certificate (for example, IoT Certificate).
|
|
3487
3618
|
*/
|
|
3488
3619
|
certificateId?: CertificateId;
|
|
3489
3620
|
/**
|
|
@@ -3565,7 +3696,7 @@ declare namespace Iot {
|
|
|
3565
3696
|
*/
|
|
3566
3697
|
files: OTAUpdateFiles;
|
|
3567
3698
|
/**
|
|
3568
|
-
* The IAM role that grants
|
|
3699
|
+
* The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
|
|
3569
3700
|
*/
|
|
3570
3701
|
roleArn: RoleArn;
|
|
3571
3702
|
/**
|
|
@@ -3583,7 +3714,7 @@ declare namespace Iot {
|
|
|
3583
3714
|
*/
|
|
3584
3715
|
otaUpdateId?: OTAUpdateId;
|
|
3585
3716
|
/**
|
|
3586
|
-
* The
|
|
3717
|
+
* The IoT job ID associated with the OTA update.
|
|
3587
3718
|
*/
|
|
3588
3719
|
awsIotJobId?: AwsIotJobId;
|
|
3589
3720
|
/**
|
|
@@ -3591,7 +3722,7 @@ declare namespace Iot {
|
|
|
3591
3722
|
*/
|
|
3592
3723
|
otaUpdateArn?: OTAUpdateArn;
|
|
3593
3724
|
/**
|
|
3594
|
-
* The
|
|
3725
|
+
* The IoT job ARN associated with the OTA update.
|
|
3595
3726
|
*/
|
|
3596
3727
|
awsIotJobArn?: AwsIotJobArn;
|
|
3597
3728
|
/**
|
|
@@ -3773,7 +3904,7 @@ declare namespace Iot {
|
|
|
3773
3904
|
*/
|
|
3774
3905
|
roleArn: RoleArn;
|
|
3775
3906
|
/**
|
|
3776
|
-
* How long (in seconds) the credentials will be valid.
|
|
3907
|
+
* How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.
|
|
3777
3908
|
*/
|
|
3778
3909
|
credentialDurationSeconds?: CredentialDurationSeconds;
|
|
3779
3910
|
/**
|
|
@@ -4141,6 +4272,16 @@ declare namespace Iot {
|
|
|
4141
4272
|
}
|
|
4142
4273
|
export interface DeleteDynamicThingGroupResponse {
|
|
4143
4274
|
}
|
|
4275
|
+
export interface DeleteFleetMetricRequest {
|
|
4276
|
+
/**
|
|
4277
|
+
* The name of the fleet metric to delete.
|
|
4278
|
+
*/
|
|
4279
|
+
metricName: FleetMetricName;
|
|
4280
|
+
/**
|
|
4281
|
+
* The expected version of the fleet metric to delete.
|
|
4282
|
+
*/
|
|
4283
|
+
expectedVersion?: OptionalVersion;
|
|
4284
|
+
}
|
|
4144
4285
|
export interface DeleteJobExecutionRequest {
|
|
4145
4286
|
/**
|
|
4146
4287
|
* The ID of the job whose execution on a particular device will be deleted.
|
|
@@ -4159,7 +4300,7 @@ declare namespace Iot {
|
|
|
4159
4300
|
*/
|
|
4160
4301
|
force?: ForceFlag;
|
|
4161
4302
|
/**
|
|
4162
|
-
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter,
|
|
4303
|
+
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
|
|
4163
4304
|
*/
|
|
4164
4305
|
namespaceId?: NamespaceId;
|
|
4165
4306
|
}
|
|
@@ -4173,7 +4314,7 @@ declare namespace Iot {
|
|
|
4173
4314
|
*/
|
|
4174
4315
|
force?: ForceFlag;
|
|
4175
4316
|
/**
|
|
4176
|
-
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter,
|
|
4317
|
+
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
|
|
4177
4318
|
*/
|
|
4178
4319
|
namespaceId?: NamespaceId;
|
|
4179
4320
|
}
|
|
@@ -4201,7 +4342,7 @@ declare namespace Iot {
|
|
|
4201
4342
|
*/
|
|
4202
4343
|
deleteStream?: DeleteStream;
|
|
4203
4344
|
/**
|
|
4204
|
-
* When true, deletes the
|
|
4345
|
+
* When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.
|
|
4205
4346
|
*/
|
|
4206
4347
|
forceDeleteAWSJob?: ForceDeleteAWSJob;
|
|
4207
4348
|
}
|
|
@@ -4369,7 +4510,7 @@ declare namespace Iot {
|
|
|
4369
4510
|
}
|
|
4370
4511
|
export interface DescribeAccountAuditConfigurationResponse {
|
|
4371
4512
|
/**
|
|
4372
|
-
* The ARN of the role that grants permission to
|
|
4513
|
+
* The ARN of the role that grants permission to 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.
|
|
4373
4514
|
*/
|
|
4374
4515
|
roleArn?: RoleArn;
|
|
4375
4516
|
/**
|
|
@@ -4680,7 +4821,7 @@ declare namespace Iot {
|
|
|
4680
4821
|
}
|
|
4681
4822
|
export interface DescribeEndpointRequest {
|
|
4682
4823
|
/**
|
|
4683
|
-
* 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
|
|
4824
|
+
* 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 IoT credentials provider API endpoint. iot:Jobs - Returns an 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.
|
|
4684
4825
|
*/
|
|
4685
4826
|
endpointType?: EndpointType;
|
|
4686
4827
|
}
|
|
@@ -4706,6 +4847,66 @@ declare namespace Iot {
|
|
|
4706
4847
|
*/
|
|
4707
4848
|
lastModifiedDate?: LastModifiedDate;
|
|
4708
4849
|
}
|
|
4850
|
+
export interface DescribeFleetMetricRequest {
|
|
4851
|
+
/**
|
|
4852
|
+
* The name of the fleet metric to describe.
|
|
4853
|
+
*/
|
|
4854
|
+
metricName: FleetMetricName;
|
|
4855
|
+
}
|
|
4856
|
+
export interface DescribeFleetMetricResponse {
|
|
4857
|
+
/**
|
|
4858
|
+
* The name of the fleet metric to describe.
|
|
4859
|
+
*/
|
|
4860
|
+
metricName?: FleetMetricName;
|
|
4861
|
+
/**
|
|
4862
|
+
* The search query string.
|
|
4863
|
+
*/
|
|
4864
|
+
queryString?: QueryString;
|
|
4865
|
+
/**
|
|
4866
|
+
* The type of the aggregation query.
|
|
4867
|
+
*/
|
|
4868
|
+
aggregationType?: AggregationType;
|
|
4869
|
+
/**
|
|
4870
|
+
* The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
|
|
4871
|
+
*/
|
|
4872
|
+
period?: FleetMetricPeriod;
|
|
4873
|
+
/**
|
|
4874
|
+
* The field to aggregate.
|
|
4875
|
+
*/
|
|
4876
|
+
aggregationField?: AggregationField;
|
|
4877
|
+
/**
|
|
4878
|
+
* The fleet metric description.
|
|
4879
|
+
*/
|
|
4880
|
+
description?: FleetMetricDescription;
|
|
4881
|
+
/**
|
|
4882
|
+
* The query version.
|
|
4883
|
+
*/
|
|
4884
|
+
queryVersion?: QueryVersion;
|
|
4885
|
+
/**
|
|
4886
|
+
* The name of the index to search.
|
|
4887
|
+
*/
|
|
4888
|
+
indexName?: IndexName;
|
|
4889
|
+
/**
|
|
4890
|
+
* The date when the fleet metric is created.
|
|
4891
|
+
*/
|
|
4892
|
+
creationDate?: CreationDate;
|
|
4893
|
+
/**
|
|
4894
|
+
* The date when the fleet metric is last modified.
|
|
4895
|
+
*/
|
|
4896
|
+
lastModifiedDate?: LastModifiedDate;
|
|
4897
|
+
/**
|
|
4898
|
+
* Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
|
|
4899
|
+
*/
|
|
4900
|
+
unit?: FleetMetricUnit;
|
|
4901
|
+
/**
|
|
4902
|
+
* The version of the fleet metric.
|
|
4903
|
+
*/
|
|
4904
|
+
version?: Version;
|
|
4905
|
+
/**
|
|
4906
|
+
* The ARN of the fleet metric to describe.
|
|
4907
|
+
*/
|
|
4908
|
+
metricArn?: FleetMetricArn;
|
|
4909
|
+
}
|
|
4709
4910
|
export interface DescribeIndexRequest {
|
|
4710
4911
|
/**
|
|
4711
4912
|
* The index name.
|
|
@@ -4830,7 +5031,7 @@ declare namespace Iot {
|
|
|
4830
5031
|
*/
|
|
4831
5032
|
actionParams?: MitigationActionParams;
|
|
4832
5033
|
/**
|
|
4833
|
-
* The date and time when the mitigation action was added to your
|
|
5034
|
+
* The date and time when the mitigation action was added to your Amazon Web Services accounts.
|
|
4834
5035
|
*/
|
|
4835
5036
|
creationDate?: Timestamp;
|
|
4836
5037
|
/**
|
|
@@ -5130,7 +5331,7 @@ declare namespace Iot {
|
|
|
5130
5331
|
}
|
|
5131
5332
|
export interface DescribeThingResponse {
|
|
5132
5333
|
/**
|
|
5133
|
-
* The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service. This lets you better organize your
|
|
5334
|
+
* The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service. This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
|
|
5134
5335
|
*/
|
|
5135
5336
|
defaultClientId?: ClientId;
|
|
5136
5337
|
/**
|
|
@@ -5374,6 +5575,7 @@ declare namespace Iot {
|
|
|
5374
5575
|
*/
|
|
5375
5576
|
ruleName: RuleName;
|
|
5376
5577
|
}
|
|
5578
|
+
export type DisconnectReason = string;
|
|
5377
5579
|
export type DomainConfigurationArn = string;
|
|
5378
5580
|
export type DomainConfigurationName = string;
|
|
5379
5581
|
export type DomainConfigurationStatus = "ENABLED"|"DISABLED"|string;
|
|
@@ -5542,7 +5744,7 @@ declare namespace Iot {
|
|
|
5542
5744
|
*/
|
|
5543
5745
|
baseRatePerMinute: RolloutRatePerMinute;
|
|
5544
5746
|
/**
|
|
5545
|
-
* The exponential factor to increase the rate of rollout for a job.
|
|
5747
|
+
* The exponential factor to increase the rate of rollout for a job. Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).
|
|
5546
5748
|
*/
|
|
5547
5749
|
incrementFactor: IncrementFactor;
|
|
5548
5750
|
/**
|
|
@@ -5559,7 +5761,7 @@ declare namespace Iot {
|
|
|
5559
5761
|
*/
|
|
5560
5762
|
name?: FieldName;
|
|
5561
5763
|
/**
|
|
5562
|
-
* The
|
|
5764
|
+
* The data type of the field.
|
|
5563
5765
|
*/
|
|
5564
5766
|
type?: FieldType;
|
|
5565
5767
|
}
|
|
@@ -5601,6 +5803,22 @@ declare namespace Iot {
|
|
|
5601
5803
|
}
|
|
5602
5804
|
export type FirehoseSeparator = string;
|
|
5603
5805
|
export type Flag = boolean;
|
|
5806
|
+
export type FleetMetricArn = string;
|
|
5807
|
+
export type FleetMetricDescription = string;
|
|
5808
|
+
export type FleetMetricName = string;
|
|
5809
|
+
export interface FleetMetricNameAndArn {
|
|
5810
|
+
/**
|
|
5811
|
+
* The fleet metric name.
|
|
5812
|
+
*/
|
|
5813
|
+
metricName?: FleetMetricName;
|
|
5814
|
+
/**
|
|
5815
|
+
* The fleet metric ARN.
|
|
5816
|
+
*/
|
|
5817
|
+
metricArn?: FleetMetricArn;
|
|
5818
|
+
}
|
|
5819
|
+
export type FleetMetricNameAndArnList = FleetMetricNameAndArn[];
|
|
5820
|
+
export type FleetMetricPeriod = number;
|
|
5821
|
+
export type FleetMetricUnit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"|string;
|
|
5604
5822
|
export type ForceDelete = boolean;
|
|
5605
5823
|
export type ForceDeleteAWSJob = boolean;
|
|
5606
5824
|
export type ForceFlag = boolean;
|
|
@@ -5632,13 +5850,45 @@ declare namespace Iot {
|
|
|
5632
5850
|
*/
|
|
5633
5851
|
nextToken?: NextToken;
|
|
5634
5852
|
}
|
|
5853
|
+
export interface GetBucketsAggregationRequest {
|
|
5854
|
+
/**
|
|
5855
|
+
* The name of the index to search.
|
|
5856
|
+
*/
|
|
5857
|
+
indexName?: IndexName;
|
|
5858
|
+
/**
|
|
5859
|
+
* The search query string.
|
|
5860
|
+
*/
|
|
5861
|
+
queryString: QueryString;
|
|
5862
|
+
/**
|
|
5863
|
+
* The aggregation field.
|
|
5864
|
+
*/
|
|
5865
|
+
aggregationField: AggregationField;
|
|
5866
|
+
/**
|
|
5867
|
+
* The version of the query.
|
|
5868
|
+
*/
|
|
5869
|
+
queryVersion?: QueryVersion;
|
|
5870
|
+
/**
|
|
5871
|
+
* The basic control of the response shape and the bucket aggregation type to perform.
|
|
5872
|
+
*/
|
|
5873
|
+
bucketsAggregationType: BucketsAggregationType;
|
|
5874
|
+
}
|
|
5875
|
+
export interface GetBucketsAggregationResponse {
|
|
5876
|
+
/**
|
|
5877
|
+
* The total number of documents that fit the query string criteria and contain a value for the Aggregation field targeted in the request.
|
|
5878
|
+
*/
|
|
5879
|
+
totalCount?: Count;
|
|
5880
|
+
/**
|
|
5881
|
+
* The main part of the response with a list of buckets. Each bucket contains a keyValue and a count. keyValue: The aggregation field value counted for the particular bucket. count: The number of documents that have that value.
|
|
5882
|
+
*/
|
|
5883
|
+
buckets?: Buckets;
|
|
5884
|
+
}
|
|
5635
5885
|
export interface GetCardinalityRequest {
|
|
5636
5886
|
/**
|
|
5637
5887
|
* The name of the index to search.
|
|
5638
5888
|
*/
|
|
5639
5889
|
indexName?: IndexName;
|
|
5640
5890
|
/**
|
|
5641
|
-
* The search query.
|
|
5891
|
+
* The search query string.
|
|
5642
5892
|
*/
|
|
5643
5893
|
queryString: QueryString;
|
|
5644
5894
|
/**
|
|
@@ -5730,7 +5980,7 @@ declare namespace Iot {
|
|
|
5730
5980
|
*/
|
|
5731
5981
|
indexName?: IndexName;
|
|
5732
5982
|
/**
|
|
5733
|
-
* The query string.
|
|
5983
|
+
* The search query string.
|
|
5734
5984
|
*/
|
|
5735
5985
|
queryString: QueryString;
|
|
5736
5986
|
/**
|
|
@@ -5846,7 +6096,7 @@ declare namespace Iot {
|
|
|
5846
6096
|
*/
|
|
5847
6097
|
indexName?: IndexName;
|
|
5848
6098
|
/**
|
|
5849
|
-
* The query used to search. You can specify "*" for the query string to get the count of all indexed things in your
|
|
6099
|
+
* The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.
|
|
5850
6100
|
*/
|
|
5851
6101
|
queryString: QueryString;
|
|
5852
6102
|
/**
|
|
@@ -5896,7 +6146,7 @@ declare namespace Iot {
|
|
|
5896
6146
|
}
|
|
5897
6147
|
export interface GetV2LoggingOptionsResponse {
|
|
5898
6148
|
/**
|
|
5899
|
-
* The IAM role ARN
|
|
6149
|
+
* The IAM role ARN IoT uses to write to your CloudWatch logs.
|
|
5900
6150
|
*/
|
|
5901
6151
|
roleArn?: AwsArn;
|
|
5902
6152
|
/**
|
|
@@ -5930,7 +6180,7 @@ declare namespace Iot {
|
|
|
5930
6180
|
*/
|
|
5931
6181
|
url: Url;
|
|
5932
6182
|
/**
|
|
5933
|
-
* The URL to which
|
|
6183
|
+
* The URL to which 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 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.
|
|
5934
6184
|
*/
|
|
5935
6185
|
confirmationUrl?: Url;
|
|
5936
6186
|
/**
|
|
@@ -5974,7 +6224,7 @@ declare namespace Iot {
|
|
|
5974
6224
|
export type HttpQueryString = string;
|
|
5975
6225
|
export interface HttpUrlDestinationConfiguration {
|
|
5976
6226
|
/**
|
|
5977
|
-
* The URL
|
|
6227
|
+
* The URL IoT uses to confirm ownership of or access to the topic rule destination URL.
|
|
5978
6228
|
*/
|
|
5979
6229
|
confirmationUrl: Url;
|
|
5980
6230
|
}
|
|
@@ -6016,7 +6266,7 @@ declare namespace Iot {
|
|
|
6016
6266
|
*/
|
|
6017
6267
|
channelName?: ChannelName;
|
|
6018
6268
|
/**
|
|
6019
|
-
* Whether to process the action as a batch. The default value is false. When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the
|
|
6269
|
+
* Whether to process the action as a batch. The default value is false. When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the IoT Analytics channel. The resulting array can't have more than 100 messages.
|
|
6020
6270
|
*/
|
|
6021
6271
|
batchMode?: BatchMode;
|
|
6022
6272
|
/**
|
|
@@ -6026,19 +6276,19 @@ declare namespace Iot {
|
|
|
6026
6276
|
}
|
|
6027
6277
|
export interface IotEventsAction {
|
|
6028
6278
|
/**
|
|
6029
|
-
* The name of the
|
|
6279
|
+
* The name of the IoT Events input.
|
|
6030
6280
|
*/
|
|
6031
6281
|
inputName: InputName;
|
|
6032
6282
|
/**
|
|
6033
|
-
* The ID of the message. The default messageId is a new UUID value. When batchMode is true, you can't specify a messageId--a new UUID value will be assigned. Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an
|
|
6283
|
+
* The ID of the message. The default messageId is a new UUID value. When batchMode is true, you can't specify a messageId--a new UUID value will be assigned. Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.
|
|
6034
6284
|
*/
|
|
6035
6285
|
messageId?: MessageId;
|
|
6036
6286
|
/**
|
|
6037
|
-
* Whether to process the event actions as a batch. The default value is false. When batchMode is true, you can't specify a messageId. When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to
|
|
6287
|
+
* Whether to process the event actions as a batch. The default value is false. When batchMode is true, you can't specify a messageId. When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.
|
|
6038
6288
|
*/
|
|
6039
6289
|
batchMode?: BatchMode;
|
|
6040
6290
|
/**
|
|
6041
|
-
* The ARN of the role that grants
|
|
6291
|
+
* The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").
|
|
6042
6292
|
*/
|
|
6043
6293
|
roleArn: AwsArn;
|
|
6044
6294
|
}
|
|
@@ -6048,7 +6298,7 @@ declare namespace Iot {
|
|
|
6048
6298
|
*/
|
|
6049
6299
|
putAssetPropertyValueEntries: PutAssetPropertyValueEntryList;
|
|
6050
6300
|
/**
|
|
6051
|
-
* The ARN of the role that grants
|
|
6301
|
+
* The ARN of the role that grants IoT permission to send an asset property value to IoT SiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue"). The trust policy can restrict access to specific asset hierarchy paths.
|
|
6052
6302
|
*/
|
|
6053
6303
|
roleArn: AwsArn;
|
|
6054
6304
|
}
|
|
@@ -6126,7 +6376,7 @@ declare namespace Iot {
|
|
|
6126
6376
|
*/
|
|
6127
6377
|
timeoutConfig?: TimeoutConfig;
|
|
6128
6378
|
/**
|
|
6129
|
-
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter,
|
|
6379
|
+
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
|
|
6130
6380
|
*/
|
|
6131
6381
|
namespaceId?: NamespaceId;
|
|
6132
6382
|
/**
|
|
@@ -6712,7 +6962,7 @@ declare namespace Iot {
|
|
|
6712
6962
|
}
|
|
6713
6963
|
export interface ListCACertificatesResponse {
|
|
6714
6964
|
/**
|
|
6715
|
-
* The CA certificates registered in your
|
|
6965
|
+
* The CA certificates registered in your Amazon Web Services account.
|
|
6716
6966
|
*/
|
|
6717
6967
|
certificates?: CACertificates;
|
|
6718
6968
|
/**
|
|
@@ -6904,6 +7154,26 @@ declare namespace Iot {
|
|
|
6904
7154
|
*/
|
|
6905
7155
|
nextMarker?: Marker;
|
|
6906
7156
|
}
|
|
7157
|
+
export interface ListFleetMetricsRequest {
|
|
7158
|
+
/**
|
|
7159
|
+
* To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
|
|
7160
|
+
*/
|
|
7161
|
+
nextToken?: NextToken;
|
|
7162
|
+
/**
|
|
7163
|
+
* The maximum number of results to return in this operation.
|
|
7164
|
+
*/
|
|
7165
|
+
maxResults?: MaxResults;
|
|
7166
|
+
}
|
|
7167
|
+
export interface ListFleetMetricsResponse {
|
|
7168
|
+
/**
|
|
7169
|
+
* The list of fleet metrics objects.
|
|
7170
|
+
*/
|
|
7171
|
+
fleetMetrics?: FleetMetricNameAndArnList;
|
|
7172
|
+
/**
|
|
7173
|
+
* The token for the next set of results. Will not be returned if the operation has returned all results.
|
|
7174
|
+
*/
|
|
7175
|
+
nextToken?: NextToken;
|
|
7176
|
+
}
|
|
6907
7177
|
export interface ListIndicesRequest {
|
|
6908
7178
|
/**
|
|
6909
7179
|
* The token used to get the next set of results, or null if there are no additional results.
|
|
@@ -6962,7 +7232,7 @@ declare namespace Iot {
|
|
|
6962
7232
|
*/
|
|
6963
7233
|
status?: JobExecutionStatus;
|
|
6964
7234
|
/**
|
|
6965
|
-
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter,
|
|
7235
|
+
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
|
|
6966
7236
|
*/
|
|
6967
7237
|
namespaceId?: NamespaceId;
|
|
6968
7238
|
/**
|
|
@@ -7030,7 +7300,7 @@ declare namespace Iot {
|
|
|
7030
7300
|
*/
|
|
7031
7301
|
thingGroupId?: ThingGroupId;
|
|
7032
7302
|
/**
|
|
7033
|
-
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter,
|
|
7303
|
+
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
|
|
7034
7304
|
*/
|
|
7035
7305
|
namespaceId?: NamespaceId;
|
|
7036
7306
|
}
|
|
@@ -7876,6 +8146,7 @@ declare namespace Iot {
|
|
|
7876
8146
|
confidenceLevel: ConfidenceLevel;
|
|
7877
8147
|
}
|
|
7878
8148
|
export type Marker = string;
|
|
8149
|
+
export type MaxBuckets = number;
|
|
7879
8150
|
export type MaxJobExecutionsPerMin = number;
|
|
7880
8151
|
export type MaxResults = number;
|
|
7881
8152
|
export type Maximum = number;
|
|
@@ -7991,7 +8262,7 @@ declare namespace Iot {
|
|
|
7991
8262
|
*/
|
|
7992
8263
|
replaceDefaultPolicyVersionParams?: ReplaceDefaultPolicyVersionParams;
|
|
7993
8264
|
/**
|
|
7994
|
-
* Parameters to define a mitigation action that enables
|
|
8265
|
+
* Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.
|
|
7995
8266
|
*/
|
|
7996
8267
|
enableIoTLoggingParams?: EnableIoTLoggingParams;
|
|
7997
8268
|
/**
|
|
@@ -8123,11 +8394,11 @@ declare namespace Iot {
|
|
|
8123
8394
|
*/
|
|
8124
8395
|
otaUpdateStatus?: OTAUpdateStatus;
|
|
8125
8396
|
/**
|
|
8126
|
-
* The
|
|
8397
|
+
* The IoT job ID associated with the OTA update.
|
|
8127
8398
|
*/
|
|
8128
8399
|
awsIotJobId?: AwsIotJobId;
|
|
8129
8400
|
/**
|
|
8130
|
-
* The
|
|
8401
|
+
* The IoT job ARN associated with the OTA update.
|
|
8131
8402
|
*/
|
|
8132
8403
|
awsIotJobArn?: AwsIotJobArn;
|
|
8133
8404
|
/**
|
|
@@ -8166,7 +8437,7 @@ declare namespace Iot {
|
|
|
8166
8437
|
*/
|
|
8167
8438
|
certificateId?: CertificateId;
|
|
8168
8439
|
/**
|
|
8169
|
-
* The
|
|
8440
|
+
* The Amazon Web Services account to which the transfer was made.
|
|
8170
8441
|
*/
|
|
8171
8442
|
transferredTo?: AwsAccountId;
|
|
8172
8443
|
/**
|
|
@@ -8340,7 +8611,7 @@ declare namespace Iot {
|
|
|
8340
8611
|
*/
|
|
8341
8612
|
entryId?: AssetPropertyEntryId;
|
|
8342
8613
|
/**
|
|
8343
|
-
* The ID of the
|
|
8614
|
+
* The ID of the IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.
|
|
8344
8615
|
*/
|
|
8345
8616
|
assetId?: AssetId;
|
|
8346
8617
|
/**
|
|
@@ -8997,7 +9268,7 @@ declare namespace Iot {
|
|
|
8997
9268
|
*/
|
|
8998
9269
|
target: AuditMitigationActionsTaskTarget;
|
|
8999
9270
|
/**
|
|
9000
|
-
* For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your
|
|
9271
|
+
* For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.
|
|
9001
9272
|
*/
|
|
9002
9273
|
auditCheckToActionsMapping: AuditCheckToActionsMapping;
|
|
9003
9274
|
/**
|
|
@@ -9037,7 +9308,7 @@ declare namespace Iot {
|
|
|
9037
9308
|
*/
|
|
9038
9309
|
includeSuppressedAlerts?: NullableBoolean;
|
|
9039
9310
|
/**
|
|
9040
|
-
* Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value,
|
|
9311
|
+
* Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
|
|
9041
9312
|
*/
|
|
9042
9313
|
clientRequestToken: ClientRequestToken;
|
|
9043
9314
|
}
|
|
@@ -9218,7 +9489,7 @@ declare namespace Iot {
|
|
|
9218
9489
|
*/
|
|
9219
9490
|
lastUpdatedAt?: DateType;
|
|
9220
9491
|
/**
|
|
9221
|
-
* An IAM role
|
|
9492
|
+
* An IAM role IoT assumes to access your S3 files.
|
|
9222
9493
|
*/
|
|
9223
9494
|
roleArn?: RoleArn;
|
|
9224
9495
|
}
|
|
@@ -9347,6 +9618,12 @@ declare namespace Iot {
|
|
|
9347
9618
|
export type TemplateDescription = string;
|
|
9348
9619
|
export type TemplateName = string;
|
|
9349
9620
|
export type TemplateVersionId = number;
|
|
9621
|
+
export interface TermsAggregation {
|
|
9622
|
+
/**
|
|
9623
|
+
* The number of buckets to return in the response. Default to 10.
|
|
9624
|
+
*/
|
|
9625
|
+
maxBuckets?: MaxBuckets;
|
|
9626
|
+
}
|
|
9350
9627
|
export interface TestAuthorizationRequest {
|
|
9351
9628
|
/**
|
|
9352
9629
|
* The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
|
|
@@ -9453,13 +9730,17 @@ declare namespace Iot {
|
|
|
9453
9730
|
export type ThingAttributeList = ThingAttribute[];
|
|
9454
9731
|
export interface ThingConnectivity {
|
|
9455
9732
|
/**
|
|
9456
|
-
* True if the thing is connected to the
|
|
9733
|
+
* True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.
|
|
9457
9734
|
*/
|
|
9458
9735
|
connected?: Boolean;
|
|
9459
9736
|
/**
|
|
9460
|
-
* The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for
|
|
9737
|
+
* The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for approximately an hour, the time value might be missing.
|
|
9461
9738
|
*/
|
|
9462
9739
|
timestamp?: ConnectivityTimestamp;
|
|
9740
|
+
/**
|
|
9741
|
+
* The reason why the client is disconnected.
|
|
9742
|
+
*/
|
|
9743
|
+
disconnectReason?: DisconnectReason;
|
|
9463
9744
|
}
|
|
9464
9745
|
export type ThingConnectivityIndexingMode = "OFF"|"STATUS"|string;
|
|
9465
9746
|
export interface ThingDocument {
|
|
@@ -9488,7 +9769,7 @@ declare namespace Iot {
|
|
|
9488
9769
|
*/
|
|
9489
9770
|
shadow?: JsonDocument;
|
|
9490
9771
|
/**
|
|
9491
|
-
* Indicates whether the thing is connected to the
|
|
9772
|
+
* Indicates whether the thing is connected to the Amazon Web Services IoT Core service.
|
|
9492
9773
|
*/
|
|
9493
9774
|
connectivity?: ThingConnectivity;
|
|
9494
9775
|
}
|
|
@@ -9834,7 +10115,7 @@ declare namespace Iot {
|
|
|
9834
10115
|
export type TopicRuleMaxResults = number;
|
|
9835
10116
|
export interface TopicRulePayload {
|
|
9836
10117
|
/**
|
|
9837
|
-
* The SQL statement used to query the topic. For more information, see
|
|
10118
|
+
* The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.
|
|
9838
10119
|
*/
|
|
9839
10120
|
sql: SQL;
|
|
9840
10121
|
/**
|
|
@@ -9867,7 +10148,7 @@ declare namespace Iot {
|
|
|
9867
10148
|
*/
|
|
9868
10149
|
certificateId: CertificateId;
|
|
9869
10150
|
/**
|
|
9870
|
-
* The
|
|
10151
|
+
* The Amazon Web Services account.
|
|
9871
10152
|
*/
|
|
9872
10153
|
targetAwsAccount: AwsAccountId;
|
|
9873
10154
|
/**
|
|
@@ -9919,7 +10200,7 @@ declare namespace Iot {
|
|
|
9919
10200
|
}
|
|
9920
10201
|
export interface UpdateAccountAuditConfigurationRequest {
|
|
9921
10202
|
/**
|
|
9922
|
-
* The Amazon Resource Name (ARN) of the role that grants permission to
|
|
10203
|
+
* The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.
|
|
9923
10204
|
*/
|
|
9924
10205
|
roleArn?: RoleArn;
|
|
9925
10206
|
/**
|
|
@@ -10037,7 +10318,7 @@ declare namespace Iot {
|
|
|
10037
10318
|
*/
|
|
10038
10319
|
certificateId: CertificateId;
|
|
10039
10320
|
/**
|
|
10040
|
-
* 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
|
|
10321
|
+
* 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 IoT. They are not intended for developer use. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
|
|
10041
10322
|
*/
|
|
10042
10323
|
newStatus: CertificateStatus;
|
|
10043
10324
|
}
|
|
@@ -10161,7 +10442,7 @@ declare namespace Iot {
|
|
|
10161
10442
|
*/
|
|
10162
10443
|
expectedVersion?: OptionalVersion;
|
|
10163
10444
|
/**
|
|
10164
|
-
* The dynamic thing group index to update. Currently one index is supported:
|
|
10445
|
+
* The dynamic thing group index to update. Currently one index is supported: AWS_Things.
|
|
10165
10446
|
*/
|
|
10166
10447
|
indexName?: IndexName;
|
|
10167
10448
|
/**
|
|
@@ -10187,6 +10468,48 @@ declare namespace Iot {
|
|
|
10187
10468
|
}
|
|
10188
10469
|
export interface UpdateEventConfigurationsResponse {
|
|
10189
10470
|
}
|
|
10471
|
+
export interface UpdateFleetMetricRequest {
|
|
10472
|
+
/**
|
|
10473
|
+
* The name of the fleet metric to update.
|
|
10474
|
+
*/
|
|
10475
|
+
metricName: FleetMetricName;
|
|
10476
|
+
/**
|
|
10477
|
+
* The search query string.
|
|
10478
|
+
*/
|
|
10479
|
+
queryString?: QueryString;
|
|
10480
|
+
/**
|
|
10481
|
+
* The type of the aggregation query.
|
|
10482
|
+
*/
|
|
10483
|
+
aggregationType?: AggregationType;
|
|
10484
|
+
/**
|
|
10485
|
+
* The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
|
|
10486
|
+
*/
|
|
10487
|
+
period?: FleetMetricPeriod;
|
|
10488
|
+
/**
|
|
10489
|
+
* The field to aggregate.
|
|
10490
|
+
*/
|
|
10491
|
+
aggregationField?: AggregationField;
|
|
10492
|
+
/**
|
|
10493
|
+
* The description of the fleet metric.
|
|
10494
|
+
*/
|
|
10495
|
+
description?: FleetMetricDescription;
|
|
10496
|
+
/**
|
|
10497
|
+
* The version of the query.
|
|
10498
|
+
*/
|
|
10499
|
+
queryVersion?: QueryVersion;
|
|
10500
|
+
/**
|
|
10501
|
+
* The name of the index to search.
|
|
10502
|
+
*/
|
|
10503
|
+
indexName: IndexName;
|
|
10504
|
+
/**
|
|
10505
|
+
* Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
|
|
10506
|
+
*/
|
|
10507
|
+
unit?: FleetMetricUnit;
|
|
10508
|
+
/**
|
|
10509
|
+
* The expected version of the fleet metric record in the registry.
|
|
10510
|
+
*/
|
|
10511
|
+
expectedVersion?: OptionalVersion;
|
|
10512
|
+
}
|
|
10190
10513
|
export interface UpdateIndexingConfigurationRequest {
|
|
10191
10514
|
/**
|
|
10192
10515
|
* Thing indexing configuration.
|
|
@@ -10225,7 +10548,7 @@ declare namespace Iot {
|
|
|
10225
10548
|
*/
|
|
10226
10549
|
timeoutConfig?: TimeoutConfig;
|
|
10227
10550
|
/**
|
|
10228
|
-
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter,
|
|
10551
|
+
* The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is in public preview.
|
|
10229
10552
|
*/
|
|
10230
10553
|
namespaceId?: NamespaceId;
|
|
10231
10554
|
}
|