Skip to content

Commit c954e13

Browse files
author
awstools
committed
docs(client-securityhub): Documentation updates for AWS Security Hub
1 parent 8490ecd commit c954e13

File tree

2 files changed

+67
-8
lines changed

2 files changed

+67
-8
lines changed

clients/client-securityhub/src/models/models_1.ts

Lines changed: 63 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4383,7 +4383,7 @@ export interface AwsWafRegionalRuleDetails {
43834383
}
43844384

43854385
/**
4386-
* <p>Describes the action that AWS WAF should take on a web request when it matches the criteria defined in the rule.
4386+
* <p>Describes the action that WAF should take on a web request when it matches the criteria defined in the rule.
43874387
* </p>
43884388
*/
43894389
export interface AwsWafRegionalRuleGroupRulesActionDetails {
@@ -4486,7 +4486,7 @@ export interface AwsWafRegionalWebAclRulesListOverrideActionDetails {
44864486
*/
44874487
export interface AwsWafRegionalWebAclRulesListDetails {
44884488
/**
4489-
* <p>The action that AWS WAF takes when a web request matches all conditions in the rule, such as allow,
4489+
* <p>The action that WAF takes when a web request matches all conditions in the rule, such as allow,
44904490
* block, or count the request.
44914491
* </p>
44924492
*/
@@ -7349,12 +7349,71 @@ export interface BatchUpdateFindingsUnprocessedFinding {
73497349
FindingIdentifier: AwsSecurityFindingIdentifier | undefined;
73507350

73517351
/**
7352-
* <p>The code associated with the error.</p>
7352+
* <p>The code associated with the error. Possible values are:</p>
7353+
* <ul>
7354+
* <li>
7355+
* <p>
7356+
* <code>ConcurrentUpdateError</code> - Another process or request attempted to update the finding while this request was being processed</p>
7357+
* </li>
7358+
* <li>
7359+
* <p>
7360+
* <code>DuplicatedFindingIdentifier</code> - The request included two or more findings with the same <code>FindingIdentifier</code>
7361+
* </p>
7362+
* </li>
7363+
* <li>
7364+
* <p>
7365+
* <code>FindingNotFound</code> - The <code>FindingIdentifier</code> included in the request did not match an existing finding</p>
7366+
* </li>
7367+
* <li>
7368+
* <p>
7369+
* <code>FindingSizeExceeded</code> - The finding size was greater than the permissible value of 240 KB</p>
7370+
* </li>
7371+
* <li>
7372+
* <p>
7373+
* <code>InternalFailure</code> - An internal service failure occurred when updating the finding</p>
7374+
* </li>
7375+
* <li>
7376+
* <p>
7377+
* <code>InvalidInput</code> - The finding update contained an invalid value that did not satisfy the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html">Amazon Web Services Security Finding Format</a> syntax</p>
7378+
* </li>
7379+
* </ul>
73537380
*/
73547381
ErrorCode: string | undefined;
73557382

73567383
/**
7357-
* <p>The message associated with the error.</p>
7384+
* <p>The message associated with the error. Possible values are:</p>
7385+
* <ul>
7386+
* <li>
7387+
* <p>
7388+
* <code>Concurrent finding updates detected</code>
7389+
* </p>
7390+
* </li>
7391+
* <li>
7392+
* <p>
7393+
* <code>Finding Identifier is duplicated</code>
7394+
* </p>
7395+
* </li>
7396+
* <li>
7397+
* <p>
7398+
* <code>Finding Not Found</code>
7399+
* </p>
7400+
* </li>
7401+
* <li>
7402+
* <p>
7403+
* <code>Finding size exceeded 240 KB</code>
7404+
* </p>
7405+
* </li>
7406+
* <li>
7407+
* <p>
7408+
* <code>Internal service failure</code>
7409+
* </p>
7410+
* </li>
7411+
* <li>
7412+
* <p>
7413+
* <code>Invalid Input</code>
7414+
* </p>
7415+
* </li>
7416+
* </ul>
73587417
*/
73597418
ErrorMessage: string | undefined;
73607419
}

codegen/sdk-codegen/aws-models/securityhub.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14814,7 +14814,7 @@
1481414814
}
1481514815
},
1481614816
"traits": {
14817-
"smithy.api#documentation": "<p>Describes the action that AWS WAF should take on a web request when it matches the criteria defined in the rule.\n </p>"
14817+
"smithy.api#documentation": "<p>Describes the action that WAF should take on a web request when it matches the criteria defined in the rule.\n </p>"
1481814818
}
1481914819
},
1482014820
"com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails": {
@@ -14951,7 +14951,7 @@
1495114951
"Action": {
1495214952
"target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails",
1495314953
"traits": {
14954-
"smithy.api#documentation": "<p>The action that AWS WAF takes when a web request matches all conditions in the rule, such as allow, \n block, or count the request.\n </p>"
14954+
"smithy.api#documentation": "<p>The action that WAF takes when a web request matches all conditions in the rule, such as allow, \n block, or count the request.\n </p>"
1495514955
}
1495614956
},
1495714957
"OverrideAction": {
@@ -15567,14 +15567,14 @@
1556715567
"ErrorCode": {
1556815568
"target": "com.amazonaws.securityhub#NonEmptyString",
1556915569
"traits": {
15570-
"smithy.api#documentation": "<p>The code associated with the error.</p>",
15570+
"smithy.api#documentation": "<p>The code associated with the error. Possible values are:</p>\n <ul>\n <li>\n <p>\n <code>ConcurrentUpdateError</code> - Another process or request attempted to update the finding while this request was being processed</p>\n </li>\n <li>\n <p>\n <code>DuplicatedFindingIdentifier</code> - The request included two or more findings with the same <code>FindingIdentifier</code>\n </p>\n </li>\n <li>\n <p>\n <code>FindingNotFound</code> - The <code>FindingIdentifier</code> included in the request did not match an existing finding</p>\n </li>\n <li>\n <p>\n <code>FindingSizeExceeded</code> - The finding size was greater than the permissible value of 240 KB</p>\n </li>\n <li>\n <p>\n <code>InternalFailure</code> - An internal service failure occurred when updating the finding</p>\n </li>\n <li>\n <p>\n <code>InvalidInput</code> - The finding update contained an invalid value that did not satisfy the <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html\">Amazon Web Services Security Finding Format</a> syntax</p>\n </li>\n </ul>",
1557115571
"smithy.api#required": {}
1557215572
}
1557315573
},
1557415574
"ErrorMessage": {
1557515575
"target": "com.amazonaws.securityhub#NonEmptyString",
1557615576
"traits": {
15577-
"smithy.api#documentation": "<p>The message associated with the error.</p>",
15577+
"smithy.api#documentation": "<p>The message associated with the error. Possible values are:</p>\n <ul>\n <li>\n <p>\n <code>Concurrent finding updates detected</code>\n </p>\n </li>\n <li>\n <p>\n <code>Finding Identifier is duplicated</code>\n </p>\n </li>\n <li>\n <p>\n <code>Finding Not Found</code>\n </p>\n </li>\n <li>\n <p>\n <code>Finding size exceeded 240 KB</code>\n </p>\n </li>\n <li>\n <p>\n <code>Internal service failure</code>\n </p> \n </li>\n <li>\n <p>\n <code>Invalid Input</code>\n </p>\n </li>\n </ul>",
1557815578
"smithy.api#required": {}
1557915579
}
1558015580
}

0 commit comments

Comments
 (0)