Skip to content

Commit 7002f68

Browse files
author
AWS
committed
AWS IoT Update: This release adds support for verifying, viewing and filtering AWS IoT Device Defender detect violations with four verification states.
1 parent f5ce5ff commit 7002f68

File tree

2 files changed

+97
-6
lines changed

2 files changed

+97
-6
lines changed

‎.changes/next-release/feature-AWSIoT-61ce80d.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS IoT",
4+
"contributor": "",
5+
"description": "This release adds support for verifying, viewing and filtering AWS IoT Device Defender detect violations with four verification states."
6+
}

‎services/iot/src/main/resources/codegen-resources/service-2.json

Lines changed: 91 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3141,6 +3141,21 @@
31413141
],
31423142
"documentation":"<p>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).</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">ListViolationEvents</a> action.</p>"
31433143
},
3144+
"PutVerificationStateOnViolation":{
3145+
"name":"PutVerificationStateOnViolation",
3146+
"http":{
3147+
"method":"POST",
3148+
"requestUri":"/violations/verification-state/{violationId}"
3149+
},
3150+
"input":{"shape":"PutVerificationStateOnViolationRequest"},
3151+
"output":{"shape":"PutVerificationStateOnViolationResponse"},
3152+
"errors":[
3153+
{"shape":"InvalidRequestException"},
3154+
{"shape":"ThrottlingException"},
3155+
{"shape":"InternalFailureException"}
3156+
],
3157+
"documentation":"<p>Set a verification state and provide a description of that verification state on a violation (detect alarm).</p>"
3158+
},
31443159
"RegisterCACertificate":{
31453160
"name":"RegisterCACertificate",
31463161
"http":{
@@ -4120,7 +4135,7 @@
41204135
},
41214136
"elasticsearch":{
41224137
"shape":"ElasticsearchAction",
4123-
"documentation":"<p>Write data to an Amazon Elasticsearch Service domain.</p> <note> <p>This action is deprecated. Use the <a href=\"https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html\">OpenSearch action</a> instead.</p> </note>"
4138+
"documentation":"<p>Write data to an Amazon OpenSearch Service domain.</p> <note> <p>The <code>Elasticsearch</code> action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the <code>OpenSearch</code> rule action instead. For more information, see <a href=\"https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html\">OpenSearchAction</a>.</p> </note>"
41244139
},
41254140
"salesforce":{
41264141
"shape":"SalesforceAction",
@@ -4203,6 +4218,14 @@
42034218
"shape":"ViolationEventAdditionalInfo",
42044219
"documentation":"<p> The details of a violation event. </p>"
42054220
},
4221+
"verificationState":{
4222+
"shape":"VerificationState",
4223+
"documentation":"<p>The verification state of the violation (detect alarm).</p>"
4224+
},
4225+
"verificationStateDescription":{
4226+
"shape":"VerificationStateDescription",
4227+
"documentation":"<p>The description of the verification state of the violation.</p>"
4228+
},
42064229
"lastViolationTime":{
42074230
"shape":"Timestamp",
42084231
"documentation":"<p>The time the most recent violation occurred.</p>"
@@ -6220,7 +6243,7 @@
62206243
},
62216244
"clientRequestToken":{
62226245
"shape":"ClientRequestToken",
6223-
"documentation":"<p> The epoch timestamp in seconds at which this suppression expires. </p>",
6246+
"documentation":"<p> Each audit supression must have a unique client request token. If you try to create a new audit suppression with the same token as one that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request. </p>",
62246247
"idempotencyToken":true
62256248
}
62266249
}
@@ -9936,15 +9959,15 @@
99369959
"members":{
99379960
"roleArn":{
99389961
"shape":"AwsArn",
9939-
"documentation":"<p>The IAM role ARN that has access to Elasticsearch.</p>"
9962+
"documentation":"<p>The IAM role ARN that has access to OpenSearch.</p>"
99409963
},
99419964
"endpoint":{
99429965
"shape":"ElasticsearchEndpoint",
9943-
"documentation":"<p>The endpoint of your Elasticsearch domain.</p>"
9966+
"documentation":"<p>The endpoint of your OpenSearch domain.</p>"
99449967
},
99459968
"index":{
99469969
"shape":"ElasticsearchIndex",
9947-
"documentation":"<p>The Elasticsearch index where you want to store your data.</p>"
9970+
"documentation":"<p>The index where you want to store your data.</p>"
99489971
},
99499972
"type":{
99509973
"shape":"ElasticsearchType",
@@ -9955,7 +9978,7 @@
99559978
"documentation":"<p>The unique identifier for the document you are storing.</p>"
99569979
}
99579980
},
9958-
"documentation":"<p>Describes an action that writes data to an Amazon Elasticsearch Service domain.</p> <note> <p>This action is deprecated. Use the <a href=\"https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html\">OpenSearch action</a> instead.</p> </note>"
9981+
"documentation":"<p>Describes an action that writes data to an Amazon OpenSearch Service domain.</p> <note> <p>The <code>Elasticsearch</code> action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the <code>OpenSearch</code> rule action instead. For more information, see <a href=\"https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html\">OpenSearchAction</a>.</p> </note>"
99599982
},
99609983
"ElasticsearchEndpoint":{
99619984
"type":"string",
@@ -11622,6 +11645,12 @@
1162211645
"location":"querystring",
1162311646
"locationName":"listSuppressedAlerts"
1162411647
},
11648+
"verificationState":{
11649+
"shape":"VerificationState",
11650+
"documentation":"<p>The verification state of the violation (detect alarm).</p>",
11651+
"location":"querystring",
11652+
"locationName":"verificationState"
11653+
},
1162511654
"nextToken":{
1162611655
"shape":"NextToken",
1162711656
"documentation":"<p>The token for the next set of results.</p>",
@@ -13789,6 +13818,12 @@
1378913818
"location":"querystring",
1379013819
"locationName":"listSuppressedAlerts"
1379113820
},
13821+
"verificationState":{
13822+
"shape":"VerificationState",
13823+
"documentation":"<p>The verification state of the violation (detect alarm).</p>",
13824+
"location":"querystring",
13825+
"locationName":"verificationState"
13826+
},
1379213827
"nextToken":{
1379313828
"shape":"NextToken",
1379413829
"documentation":"<p>The token for the next set of results.</p>",
@@ -14774,6 +14809,34 @@
1477414809
},
1477514810
"documentation":"<p>The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.</p>"
1477614811
},
14812+
"PutVerificationStateOnViolationRequest":{
14813+
"type":"structure",
14814+
"required":[
14815+
"violationId",
14816+
"verificationState"
14817+
],
14818+
"members":{
14819+
"violationId":{
14820+
"shape":"ViolationId",
14821+
"documentation":"<p>The violation ID.</p>",
14822+
"location":"uri",
14823+
"locationName":"violationId"
14824+
},
14825+
"verificationState":{
14826+
"shape":"VerificationState",
14827+
"documentation":"<p>The verification state of the violation.</p>"
14828+
},
14829+
"verificationStateDescription":{
14830+
"shape":"VerificationStateDescription",
14831+
"documentation":"<p>The description of the verification state of the violation (detect alarm).</p>"
14832+
}
14833+
}
14834+
},
14835+
"PutVerificationStateOnViolationResponse":{
14836+
"type":"structure",
14837+
"members":{
14838+
}
14839+
},
1477714840
"Qos":{
1477814841
"type":"integer",
1477914842
"max":1,
@@ -18332,6 +18395,20 @@
1833218395
},
1833318396
"Value":{"type":"string"},
1833418397
"Variance":{"type":"double"},
18398+
"VerificationState":{
18399+
"type":"string",
18400+
"enum":[
18401+
"FALSE_POSITIVE",
18402+
"BENIGN_POSITIVE",
18403+
"TRUE_POSITIVE",
18404+
"UNKNOWN"
18405+
]
18406+
},
18407+
"VerificationStateDescription":{
18408+
"type":"string",
18409+
"max":1000,
18410+
"pattern":"[\\p{Graph}\\x20]*"
18411+
},
1833518412
"Version":{"type":"long"},
1833618413
"VersionConflictException":{
1833718414
"type":"structure",
@@ -18389,6 +18466,14 @@
1838918466
"shape":"ViolationEventType",
1839018467
"documentation":"<p>The type of violation event.</p>"
1839118468
},
18469+
"verificationState":{
18470+
"shape":"VerificationState",
18471+
"documentation":"<p>The verification state of the violation (detect alarm).</p>"
18472+
},
18473+
"verificationStateDescription":{
18474+
"shape":"VerificationStateDescription",
18475+
"documentation":"<p>The description of the verification state of the violation.</p>"
18476+
},
1839218477
"violationEventTime":{
1839318478
"shape":"Timestamp",
1839418479
"documentation":"<p>The time the violation event occurred.</p>"

0 commit comments

Comments
 (0)