From c2a4f1a4735669f774953a09a609f8e67e46f427 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Tue, 16 May 2023 18:08:47 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/detective.json | 342 +++++++++++++----- .../aws-models/direct-connect.json | 4 +- codegen/sdk-codegen/aws-models/glue.json | 12 + .../aws-models/secrets-manager.json | 6 +- codegen/sdk-codegen/aws-models/wafv2.json | 270 +++++++++++++- 5 files changed, 528 insertions(+), 106 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/detective.json b/codegen/sdk-codegen/aws-models/detective.json index 7b6f7b11ffa..1867234c9c5 100644 --- a/codegen/sdk-codegen/aws-models/detective.json +++ b/codegen/sdk-codegen/aws-models/detective.json @@ -73,6 +73,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#AccessDeniedException": { @@ -664,8 +667,8 @@ }, "params": { "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -677,8 +680,8 @@ }, "params": { "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -690,8 +693,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -703,8 +706,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -716,8 +719,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -729,8 +732,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -742,8 +745,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -755,8 +758,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -768,8 +771,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -781,8 +784,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -794,8 +797,8 @@ }, "params": { "Region": "eu-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -807,8 +810,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -820,8 +823,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -833,8 +836,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -846,8 +849,8 @@ }, "params": { "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -859,8 +862,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -872,8 +875,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -885,8 +888,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -898,8 +901,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -911,8 +914,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -924,8 +927,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -937,8 +940,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -950,8 +953,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -963,8 +966,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -976,8 +979,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -989,8 +992,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1002,8 +1005,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1015,8 +1018,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1028,8 +1031,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1041,8 +1044,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1054,8 +1057,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1067,8 +1070,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1080,8 +1083,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1093,8 +1096,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1106,8 +1109,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1119,8 +1122,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1132,8 +1146,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1145,8 +1170,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1158,8 +1194,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1171,8 +1218,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1184,8 +1231,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1197,8 +1244,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1209,8 +1256,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1221,10 +1268,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -1279,6 +1332,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#BatchGetGraphMemberDatasourcesResponse": { @@ -1296,6 +1352,9 @@ "smithy.api#documentation": "

Accounts that data source package information could not be retrieved for.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#BatchGetMembershipDatasources": { @@ -1339,6 +1398,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#BatchGetMembershipDatasourcesResponse": { @@ -1356,6 +1418,9 @@ "smithy.api#documentation": "

Graphs that data source package information could not be retrieved for.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#Boolean": { @@ -1420,6 +1485,9 @@ "smithy.api#documentation": "

The tags to assign to the new behavior graph. You can add up to 50 tags. For each tag,\n you provide the tag key and the tag value. Each tag key can contain up to 128 characters.\n Each tag value can contain up to 256 characters.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#CreateGraphResponse": { @@ -1431,6 +1499,9 @@ "smithy.api#documentation": "

The ARN of the new behavior graph.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#CreateMembers": { @@ -1497,6 +1568,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#CreateMembersResponse": { @@ -1514,6 +1588,9 @@ "smithy.api#documentation": "

The list of accounts for which Detective was unable to process the invitation\n or enablement request. For each account, the list provides the reason why the request could\n not be processed. The list includes accounts that are already member accounts in the\n behavior graph.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#DatasourcePackage": { @@ -1530,6 +1607,12 @@ "traits": { "smithy.api#enumValue": "EKS_AUDIT" } + }, + "ASFF_SECURITYHUB_FINDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASFF_SECURITYHUB_FINDING" + } } } }, @@ -1676,6 +1759,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#DeleteMembers": { @@ -1729,6 +1815,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#DeleteMembersResponse": { @@ -1746,6 +1835,9 @@ "smithy.api#documentation": "

The list of member accounts that Detective was not able to remove from the\n behavior graph. For each member account, provides the reason that the deletion could not be\n processed.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#DescribeOrganizationConfiguration": { @@ -1789,6 +1881,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#DescribeOrganizationConfigurationResponse": { @@ -1801,6 +1896,9 @@ "smithy.api#documentation": "

Indicates whether to automatically enable new organization accounts as member accounts\n in the organization behavior graph.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#DisableOrganizationAdminAccount": { @@ -1878,6 +1976,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#EmailAddress": { @@ -1940,6 +2041,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#ErrorCode": { @@ -2019,6 +2123,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#GetMembersResponse": { @@ -2036,6 +2143,9 @@ "smithy.api#documentation": "

The requested member accounts for which Detective was unable to return member\n details.

\n

For each account, provides the reason why the request could not be processed.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#Graph": { @@ -2179,6 +2289,9 @@ "smithy.api#documentation": "

The maximum number of results to return.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#ListDatasourcePackagesResponse": { @@ -2196,6 +2309,9 @@ "smithy.api#documentation": "

For requests to get the next page of results, the pagination token that was returned\n with the previous set of results. The initial request does not include a pagination\n token.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#ListGraphs": { @@ -2246,6 +2362,9 @@ "smithy.api#documentation": "

The maximum number of graphs to return at a time. The total must be less than the\n overall limit on the number of results to return, which is currently 200.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#ListGraphsResponse": { @@ -2263,6 +2382,9 @@ "smithy.api#documentation": "

If there are more behavior graphs remaining in the results, then this is the pagination\n token to use to request the next page of behavior graphs.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#ListInvitations": { @@ -2313,6 +2435,9 @@ "smithy.api#documentation": "

The maximum number of behavior graph invitations to return in the response. The total\n must be less than the overall limit on the number of results to return, which is currently\n 200.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#ListInvitationsResponse": { @@ -2330,6 +2455,9 @@ "smithy.api#documentation": "

If there are more behavior graphs remaining in the results, then this is the pagination\n token to use to request the next page of behavior graphs.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#ListMembers": { @@ -2390,6 +2518,9 @@ "smithy.api#documentation": "

The maximum number of member accounts to include in the response. The total must be less\n than the overall limit on the number of results to return, which is currently 200.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#ListMembersResponse": { @@ -2407,6 +2538,9 @@ "smithy.api#documentation": "

If there are more member accounts remaining in the results, then use this pagination\n token to request the next page of member accounts.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#ListOrganizationAdminAccounts": { @@ -2460,6 +2594,9 @@ "smithy.api#documentation": "

The maximum number of results to return.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#ListOrganizationAdminAccountsResponse": { @@ -2477,6 +2614,9 @@ "smithy.api#documentation": "

If there are more accounts remaining in the results, then this is the pagination token\n to use to request the next page of accounts.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#ListTagsForResource": { @@ -2521,6 +2661,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#ListTagsForResourceResponse": { @@ -2532,6 +2675,9 @@ "smithy.api#documentation": "

The tag values that are assigned to the behavior graph. The request returns up to 50 tag\n values.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.detective#MemberDetail": { @@ -2808,6 +2954,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#Resource": { @@ -2917,6 +3066,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#TagKey": { @@ -3005,11 +3157,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.detective#TagValue": { "type": "string", @@ -3158,11 +3316,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.detective#UpdateDatasourcePackages": { "type": "operation", @@ -3215,6 +3379,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#UpdateOrganizationConfiguration": { @@ -3265,6 +3432,9 @@ "smithy.api#documentation": "

Indicates whether to automatically enable new organization accounts as member accounts\n in the organization behavior graph.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.detective#ValidationException": { diff --git a/codegen/sdk-codegen/aws-models/direct-connect.json b/codegen/sdk-codegen/aws-models/direct-connect.json index 200c506f3b2..c27846f13fb 100644 --- a/codegen/sdk-codegen/aws-models/direct-connect.json +++ b/codegen/sdk-codegen/aws-models/direct-connect.json @@ -4907,7 +4907,7 @@ "mtu": { "target": "com.amazonaws.directconnect#MTU", "traits": { - "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

" } }, "authKey": { @@ -7071,7 +7071,7 @@ "mtu": { "target": "com.amazonaws.directconnect#MTU", "traits": { - "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + "smithy.api#documentation": "

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

" } }, "jumboFrameCapable": { diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index 830b1714cf1..87e39ffaa76 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -7457,6 +7457,12 @@ "traits": { "smithy.api#documentation": "

A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

\n

If no context words are passed only a regular expression is checked.

" } + }, + "Tags": { + "target": "com.amazonaws.glue#TagsMap", + "traits": { + "smithy.api#documentation": "

A list of tags applied to the custom entity type.

" + } } }, "traits": { @@ -21917,6 +21923,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return.

" } + }, + "Tags": { + "target": "com.amazonaws.glue#TagsMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pair tags.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/secrets-manager.json b/codegen/sdk-codegen/aws-models/secrets-manager.json index b738e7ca02e..ee4adc520c0 100644 --- a/codegen/sdk-codegen/aws-models/secrets-manager.json +++ b/codegen/sdk-codegen/aws-models/secrets-manager.json @@ -396,7 +396,7 @@ "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Specifies whether to delete the secret without any recovery window. You\n can't use both this parameter and RecoveryWindowInDays in the same\n call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.

\n

Secrets Manager performs the actual deletion with an asynchronous background process, so there might \n be a short delay before the secret is permanently deleted. If you delete a secret and then \n immediately create a secret with the same name, use appropriate back off and retry logic.

\n \n

Use this parameter with caution. This parameter causes the operation to skip the normal\n recovery window before the permanent deletion that Secrets Manager would normally impose with the\n RecoveryWindowInDays parameter. If you delete a secret with the\n ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover\n the secret. You lose the secret permanently.

\n " + "smithy.api#documentation": "

Specifies whether to delete the secret without any recovery window. You\n can't use both this parameter and RecoveryWindowInDays in the same\n call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.

\n

Secrets Manager performs the actual deletion with an asynchronous background process, so there might \n be a short delay before the secret is permanently deleted. If you delete a secret and then \n immediately create a secret with the same name, use appropriate back off and retry logic.

\n

If you forcibly delete an already deleted or nonexistent secret, the operation does not return ResourceNotFoundException.

\n \n

Use this parameter with caution. This parameter causes the operation to skip the normal\n recovery window before the permanent deletion that Secrets Manager would normally impose with the\n RecoveryWindowInDays parameter. If you delete a secret with the\n ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover\n the secret. You lose the secret permanently.

\n " } } }, @@ -547,7 +547,7 @@ "NextRotationDate": { "target": "com.amazonaws.secretsmanager#NextRotationDateType", "traits": { - "smithy.api#documentation": "

The next date and time that Secrets Manager will rotate the secret, rounded to the nearest hour. If the secret isn't configured for rotation, Secrets Manager returns null.

" + "smithy.api#documentation": "

The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.

" } }, "Tags": { @@ -2175,7 +2175,7 @@ "NextRotationDate": { "target": "com.amazonaws.secretsmanager#NextRotationDateType", "traits": { - "smithy.api#documentation": "

The next date and time that Secrets Manager will attempt to rotate the secret, rounded to the nearest hour. This value is null if the secret is not set up for rotation.

" + "smithy.api#documentation": "

The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.

" } }, "Tags": { diff --git a/codegen/sdk-codegen/aws-models/wafv2.json b/codegen/sdk-codegen/aws-models/wafv2.json index b30a533234a..a89214ae8d2 100644 --- a/codegen/sdk-codegen/aws-models/wafv2.json +++ b/codegen/sdk-codegen/aws-models/wafv2.json @@ -1841,7 +1841,7 @@ "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", "smithy.api#required": {} } }, @@ -5974,10 +5974,13 @@ }, { "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFUnsupportedAggregateKeyTypeException" } ], "traits": { - "smithy.api#documentation": "

Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum\n number of managed keys that can be blocked for a single rate-based rule instance is 10,000.\n If more than 10,000 addresses exceed the rate limit, those with the highest rates are\n blocked.

\n

For a rate-based rule that you've defined inside a rule group, provide the name of the\n rule group reference statement in your request, in addition to the rate-based rule name and\n the web ACL name.

\n

WAF monitors web requests and manages keys independently for each unique combination\n of web ACL, optional rule group, and rate-based rule. For example, if you define a\n rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF\n monitors web requests and manages keys for that web ACL, rule group reference statement,\n and rate-based rule instance. If you use the same rule group in a second web ACL, WAF\n monitors web requests and manages keys for this second usage completely independent of your\n first.

" + "smithy.api#documentation": "

Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This\n is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP \n address.

\n

The maximum\n number of addresses that can be blocked for a single rate-based rule instance is 10,000.\n If more than 10,000 addresses exceed the rate limit, those with the highest rates are\n blocked.

\n

For a rate-based rule that you've defined inside a rule group, provide the name of the\n rule group reference statement in your request, in addition to the rate-based rule name and\n the web ACL name.

\n

WAF monitors web requests and manages keys independently for each unique combination\n of web ACL, optional rule group, and rate-based rule. For example, if you define a\n rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF\n monitors web requests and manages keys for that web ACL, rule group reference statement,\n and rate-based rule instance. If you use the same rule group in a second web ACL, WAF\n monitors web requests and manages keys for this second usage completely independent of your\n first.

" } }, "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest": { @@ -6975,6 +6978,16 @@ "smithy.api#documentation": "

A single label name condition for a Condition in a logging\n filter.

" } }, + "com.amazonaws.wafv2#LabelNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+:$" + } + }, "com.amazonaws.wafv2#LabelSummaries": { "type": "list", "member": { @@ -8889,6 +8902,18 @@ "traits": { "smithy.api#enumValue": "ASSOCIATED_RESOURCE_TYPE" } + }, + "SCOPE_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCOPE_DOWN" + } + }, + "CUSTOM_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_KEYS" + } } } }, @@ -9236,32 +9261,38 @@ "target": "com.amazonaws.wafv2#RateLimit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The limit on requests per 5-minute period for a single originating IP address. If the\n statement includes a ScopeDownStatement, this limit is applied only to the\n requests that match the statement.

", + "smithy.api#documentation": "

The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. \n If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the\n requests that match the statement.

\n

Examples:

\n ", "smithy.api#required": {} } }, "AggregateKeyType": { "target": "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType", "traits": { - "smithy.api#documentation": "

Setting that indicates how to aggregate the request counts. The options are the\n following:

\n ", + "smithy.api#documentation": "

Setting that indicates how to aggregate the request counts.

\n \n

Web requests that are missing any of the components specified in the aggregation keys\n are omitted from the rate-based rule evaluation and handling.

\n \n ", "smithy.api#required": {} } }, "ScopeDownStatement": { "target": "com.amazonaws.wafv2#Statement", "traits": { - "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are\n evaluated by the rate-based statement. Requests are only tracked by the rate-based\n statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any\n level, the same as you can for a rule statement.

" + "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are\n evaluated and managed by the rate-based statement. When you use a scope-down statement, \n the rate-based rule only tracks and rate limits \n requests that match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any\n level, the same as you can for a rule statement.

" } }, "ForwardedIPConfig": { "target": "com.amazonaws.wafv2#ForwardedIPConfig", "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This is required if AggregateKeyType is set to\n FORWARDED_IP.

" + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This is required if you specify a forwarded IP in the rule's aggregate key settings.

" + } + }, + "CustomKeys": { + "target": "com.amazonaws.wafv2#RateBasedStatementCustomKeys", + "traits": { + "smithy.api#documentation": "

Specifies the aggregate keys to use in a rate-base rule.

" } } }, "traits": { - "smithy.api#documentation": "

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

\n

When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

\n \n

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

" + "smithy.api#documentation": "

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

\n

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

\n

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

\n

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

\n \n

The rule would create different aggregation instances according to your aggregation criteria, for example:

\n \n

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

\n

For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.

\n

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

" } }, "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType": { @@ -9278,6 +9309,86 @@ "traits": { "smithy.api#enumValue": "FORWARDED_IP" } + }, + "CUSTOM_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_KEYS" + } + }, + "CONSTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONSTANT" + } + } + } + }, + "com.amazonaws.wafv2#RateBasedStatementCustomKey": { + "type": "structure", + "members": { + "Header": { + "target": "com.amazonaws.wafv2#RateLimitHeader", + "traits": { + "smithy.api#documentation": "

Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single \n header as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "Cookie": { + "target": "com.amazonaws.wafv2#RateLimitCookie", + "traits": { + "smithy.api#documentation": "

Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\n cookie as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "QueryArgument": { + "target": "com.amazonaws.wafv2#RateLimitQueryArgument", + "traits": { + "smithy.api#documentation": "

Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you \n use a single query argument as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "QueryString": { + "target": "com.amazonaws.wafv2#RateLimitQueryString", + "traits": { + "smithy.api#documentation": "

Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the \n query string as your custom key, then each string fully defines an aggregation instance.

" + } + }, + "HTTPMethod": { + "target": "com.amazonaws.wafv2#RateLimitHTTPMethod", + "traits": { + "smithy.api#documentation": "

Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method\n as your custom key, then each method fully defines an aggregation instance.

" + } + }, + "ForwardedIP": { + "target": "com.amazonaws.wafv2#RateLimitForwardedIP", + "traits": { + "smithy.api#documentation": "

Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.

\n

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

\n

With this option, you must specify the header to use in the rate-based rule's ForwardedIPConfig property.

" + } + }, + "IP": { + "target": "com.amazonaws.wafv2#RateLimitIP", + "traits": { + "smithy.api#documentation": "

Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

\n

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#RateLimitLabelNamespace", + "traits": { + "smithy.api#documentation": "

Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

\n

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

\n

For information about label namespaces and names, see \n Label syntax and naming requirements in the WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a single custom aggregate key for a rate-base rule.

\n \n

Web requests that are missing any of the components specified in the aggregation keys\n are omitted from the rate-based rule evaluation and handling.

\n " + } + }, + "com.amazonaws.wafv2#RateBasedStatementCustomKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#RateBasedStatementCustomKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 } } }, @@ -9298,7 +9409,7 @@ } }, "traits": { - "smithy.api#documentation": "

The set of IP addresses that are currently blocked for a RateBasedStatement.

" + "smithy.api#documentation": "

The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules \n that aggregate on just the IP address, with the AggregateKeyType set to IP or FORWARDED_IP.

\n

A rate-based rule applies its rule action to requests from IP addresses that are in the rule's managed keys list and that match the rule's scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow.

\n

The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, WAF limits those with the highest rates.

" } }, "com.amazonaws.wafv2#RateLimit": { @@ -9311,6 +9422,123 @@ } } }, + "com.amazonaws.wafv2#RateLimitCookie": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the cookie to use.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single\n cookie as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RateLimitForwardedIP": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule. Each distinct forwarded IP address contributes to the aggregation instance.

\n

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement.\n When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use.\n You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

\n

This data type supports using the forwarded IP address in the web request aggregation for a rate-based rule, in RateBasedStatementCustomKey. The JSON specification for using the forwarded IP address doesn't explicitly use this data type.

\n

JSON specification: \"ForwardedIP\": {}\n

\n

When you use this specification, you must also configure the forwarded IP address in the rate-based statement's ForwardedIPConfig.

" + } + }, + "com.amazonaws.wafv2#RateLimitHTTPMethod": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the request's HTTP method as an aggregate key for a rate-based rule. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method\n as your custom key, then each method fully defines an aggregation instance.

\n

JSON specification: \"RateLimitHTTPMethod\": {}\n

" + } + }, + "com.amazonaws.wafv2#RateLimitHeader": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the header to use.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single \n header as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RateLimitIP": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the IP address in the web request as an aggregate key for a rate-based rule. Each distinct IP address contributes to the aggregation instance.

\n

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement.\n To use this in the custom key settings, you must specify at least one other key to use, along with the IP address. \n To aggregate on only the IP address, in your rate-based statement's AggregateKeyType, specify IP.

\n

JSON specification: \"RateLimitIP\": {}\n

" + } + }, + "com.amazonaws.wafv2#RateLimitLabelNamespace": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.wafv2#LabelNamespace", + "traits": { + "smithy.api#documentation": "

The namespace to use for aggregation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

\n

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

\n

For information about label namespaces and names, see \n Label syntax and naming requirements in the WAF Developer Guide.

" + } + }, + "com.amazonaws.wafv2#RateLimitQueryArgument": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#FieldToMatchData", + "traits": { + "smithy.api#documentation": "

The name of the query argument to use.

", + "smithy.api#required": {} + } + }, + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you \n use a single query argument as your custom key, then each value fully defines an aggregation instance.

" + } + }, + "com.amazonaws.wafv2#RateLimitQueryString": { + "type": "structure", + "members": { + "TextTransformations": { + "target": "com.amazonaws.wafv2#TextTransformations", + "traits": { + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the request's query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the \n query string as your custom key, then each string fully defines an aggregation instance.

" + } + }, "com.amazonaws.wafv2#RedactedFields": { "type": "list", "member": { @@ -9357,7 +9585,7 @@ "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", "smithy.api#required": {} } } @@ -9424,7 +9652,7 @@ "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", "smithy.api#required": {} } } @@ -10455,7 +10683,7 @@ "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", "smithy.api#required": {} } } @@ -10509,7 +10737,7 @@ "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", "smithy.api#required": {} } }, @@ -10578,7 +10806,7 @@ "RateBasedStatement": { "target": "com.amazonaws.wafv2#RateBasedStatement", "traits": { - "smithy.api#documentation": "

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

\n

When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

\n \n

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

" + "smithy.api#documentation": "

A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.

\n

You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.

\n

Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.

\n

For example, assume the rule evaluates web requests with the following IP address and HTTP method values:

\n \n

The rule would create different aggregation instances according to your aggregation criteria, for example:

\n \n

For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

\n

For additional information about the options, see Rate limiting web requests using rate-based rules \n in the WAF Developer Guide.

\n

If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF \n is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available\n for other aggregation configurations.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

" } }, "AndStatement": { @@ -10806,7 +11034,7 @@ "target": "com.amazonaws.wafv2#TextTransformationPriority", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Sets the relative processing order for multiple transformations that are defined for a\n rule statement. WAF processes all transformations, from lowest priority to highest,\n before inspecting the transformed content. The priorities don't need to be consecutive, but\n they must all be different.

", + "smithy.api#documentation": "

Sets the relative processing order for multiple transformations.\n WAF processes all transformations, from lowest priority to highest,\n before inspecting the transformed content. The priorities don't need to be consecutive, but\n they must all be different.

", "smithy.api#required": {} } }, @@ -12007,6 +12235,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.wafv2#WAFUnsupportedAggregateKeyTypeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The rule that you've named doesn't aggregate solely on the IP address or solely on the forwarded IP address. This call \n is only available for rate-based rules with an AggregateKeyType setting of IP or FORWARDED_IP.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.wafv2#WebACL": { "type": "structure", "members": { @@ -12181,7 +12421,7 @@ "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the component contents.

", "smithy.api#required": {} } }