aws-sdk 2.1378.0 → 2.1380.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/clients/ecs.d.ts CHANGED
@@ -761,7 +761,7 @@ declare namespace ECS {
761
761
  */
762
762
  image?: String;
763
763
  /**
764
- * The container image manifest digest. The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.
764
+ * The container image manifest digest.
765
765
  */
766
766
  imageDigest?: String;
767
767
  /**
@@ -1217,7 +1217,7 @@ declare namespace ECS {
1217
1217
  */
1218
1218
  serviceRegistries?: ServiceRegistries;
1219
1219
  /**
1220
- * The number of instantiations of the specified task definition to place and keep running on your cluster. This is required if schedulingStrategy is REPLICA or isn't specified. If schedulingStrategy is DAEMON then this isn't required.
1220
+ * The number of instantiations of the specified task definition to place and keep running in your service. This is required if schedulingStrategy is REPLICA or isn't specified. If schedulingStrategy is DAEMON then this isn't required.
1221
1221
  */
1222
1222
  desiredCount?: BoxedInteger;
1223
1223
  /**
package/clients/glue.d.ts CHANGED
@@ -3717,6 +3717,10 @@ declare namespace Glue {
3717
3717
  * 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. If no context words are passed only a regular expression is checked.
3718
3718
  */
3719
3719
  ContextWords?: ContextWords;
3720
+ /**
3721
+ * A list of tags applied to the custom entity type.
3722
+ */
3723
+ Tags?: TagsMap;
3720
3724
  }
3721
3725
  export interface CreateCustomEntityTypeResponse {
3722
3726
  /**
@@ -8871,6 +8875,10 @@ declare namespace Glue {
8871
8875
  * The maximum number of results to return.
8872
8876
  */
8873
8877
  MaxResults?: PageSize;
8878
+ /**
8879
+ * A list of key-value pair tags.
8880
+ */
8881
+ Tags?: TagsMap;
8874
8882
  }
8875
8883
  export interface ListCustomEntityTypesResponse {
8876
8884
  /**
@@ -256,7 +256,7 @@ declare namespace MediaConvert {
256
256
  */
257
257
  CodecProfile?: AacCodecProfile;
258
258
  /**
259
- * The Coding mode that you specify determines the number of audio channels and the audio channel layout metadata in your AAC output. Valid coding modes depend on the Rate control mode and Profile that you select. The following list shows the number of audio channels and channel layout for each coding mode. * 1.0 Audio Description (Receiver Mix): One channel, C. Includes audio description data from your stereo input. For more information see ETSI TS 101 154 Annex E. * 1.0 Mono: One channel, C. * 2.0 Stereo: Two channels, L, R. * 5.1 Surround: Five channels, C, L, R, Ls, Rs, LFE.
259
+ * The Coding mode that you specify determines the number of audio channels and the audio channel layout metadata in your AAC output. Valid coding modes depend on the Rate control mode and Profile that you select. The following list shows the number of audio channels and channel layout for each coding mode. * 1.0 Audio Description (Receiver Mix): One channel, C. Includes audio description data from your stereo input. For more information see ETSI TS 101 154 Annex E. * 1.0 Mono: One channel, C. * 2.0 Stereo: Two channels, L, R. * 5.1 Surround: Six channels, C, L, R, Ls, Rs, LFE.
260
260
  */
261
261
  CodingMode?: AacCodingMode;
262
262
  /**
@@ -3043,7 +3043,7 @@ Within your job settings, all of your DVB-Sub settings must be identical.
3043
3043
  */
3044
3044
  SegmentLengthControl?: HlsSegmentLengthControl;
3045
3045
  /**
3046
- * Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.
3046
+ * Specify the number of segments to write to a subdirectory before starting a new one. You must also set Directory structure to Subdirectory per stream for this setting to have an effect.
3047
3047
  */
3048
3048
  SegmentsPerSubdirectory?: __integerMin1Max2147483647;
3049
3049
  /**
@@ -3200,7 +3200,7 @@ Within your job settings, all of your DVB-Sub settings must be identical.
3200
3200
  export type ImscStylePassthrough = "ENABLED"|"DISABLED"|string;
3201
3201
  export interface Input {
3202
3202
  /**
3203
- * Use to remove noise, blocking, blurriness, or ringing from your input as a pre-filter step before encoding. The Advanced input filter removes more types of compression artifacts and is an improvement when compared to basic Deblock and Denoise filters. To remove video compression artifacts from your input and improve the video quality: Choose Enabled. Additionally, this filter can help increase the video quality of your output relative to its bitrate, since noisy inputs are more complex and require more bits to encode. To help restore loss of detail after applying the filter, you can optionally add texture or sharpening as an additional step.Jobs that use this feature incur pro-tier pricing. To not apply advanced input filtering: Choose Disabled. Note that you can still apply basic filtering with Deblock and Denoise.
3203
+ * Use to remove noise, blocking, blurriness, or ringing from your input as a pre-filter step before encoding. The Advanced input filter removes more types of compression artifacts and is an improvement when compared to basic Deblock and Denoise filters. To remove video compression artifacts from your input and improve the video quality: Choose Enabled. Additionally, this filter can help increase the video quality of your output relative to its bitrate, since noisy inputs are more complex and require more bits to encode. To help restore loss of detail after applying the filter, you can optionally add texture or sharpening as an additional step. Jobs that use this feature incur pro-tier pricing. To not apply advanced input filtering: Choose Disabled. Note that you can still apply basic filtering with Deblock and Denoise.
3204
3204
  */
3205
3205
  AdvancedInputFilter?: AdvancedInputFilter;
3206
3206
  /**
@@ -3334,7 +3334,7 @@ Within your job settings, all of your DVB-Sub settings must be identical.
3334
3334
  export type InputScanType = "AUTO"|"PSF"|string;
3335
3335
  export interface InputTemplate {
3336
3336
  /**
3337
- * Use to remove noise, blocking, blurriness, or ringing from your input as a pre-filter step before encoding. The Advanced input filter removes more types of compression artifacts and is an improvement when compared to basic Deblock and Denoise filters. To remove video compression artifacts from your input and improve the video quality: Choose Enabled. Additionally, this filter can help increase the video quality of your output relative to its bitrate, since noisy inputs are more complex and require more bits to encode. To help restore loss of detail after applying the filter, you can optionally add texture or sharpening as an additional step.Jobs that use this feature incur pro-tier pricing. To not apply advanced input filtering: Choose Disabled. Note that you can still apply basic filtering with Deblock and Denoise.
3337
+ * Use to remove noise, blocking, blurriness, or ringing from your input as a pre-filter step before encoding. The Advanced input filter removes more types of compression artifacts and is an improvement when compared to basic Deblock and Denoise filters. To remove video compression artifacts from your input and improve the video quality: Choose Enabled. Additionally, this filter can help increase the video quality of your output relative to its bitrate, since noisy inputs are more complex and require more bits to encode. To help restore loss of detail after applying the filter, you can optionally add texture or sharpening as an additional step. Jobs that use this feature incur pro-tier pricing. To not apply advanced input filtering: Choose Disabled. Note that you can still apply basic filtering with Deblock and Denoise.
3338
3338
  */
3339
3339
  AdvancedInputFilter?: AdvancedInputFilter;
3340
3340
  /**
@@ -3768,7 +3768,7 @@ Within your job settings, all of your DVB-Sub settings must be identical.
3768
3768
  /**
3769
3769
  * Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.
3770
3770
  */
3771
- KantarServerUrl?: __stringPatternHttpsKantarmediaComFr;
3771
+ KantarServerUrl?: __stringPatternHttpsKantarmedia;
3772
3772
  /**
3773
3773
  * Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
3774
3774
  */
@@ -4623,7 +4623,7 @@ When you specify Version 1, you must also set ID3 metadata (timedMetadata) to Pa
4623
4623
  }
4624
4624
  export type MsSmoothManifestEncoding = "UTF8"|"UTF16"|string;
4625
4625
  export type MxfAfdSignaling = "NO_COPY"|"COPY_FROM_VIDEO"|string;
4626
- export type MxfProfile = "D_10"|"XDCAM"|"OP1A"|"XAVC"|string;
4626
+ export type MxfProfile = "D_10"|"XDCAM"|"OP1A"|"XAVC"|"XDCAM_RDD9"|string;
4627
4627
  export interface MxfSettings {
4628
4628
  /**
4629
4629
  * Optional. When you have AFD signaling set up in your output video stream, use this setting to choose whether to also include it in the MXF wrapper. Choose Don't copy (NO_COPY) to exclude AFD signaling from the MXF wrapper. Choose Copy from video stream (COPY_FROM_VIDEO) to copy the AFD values from the video stream for this output to the MXF wrapper. Regardless of which option you choose, the AFD values remain in the video stream. Related settings: To set up your output to include or exclude AFD values, see AfdSignaling, under VideoDescription. On the console, find AFD signaling under the output's video encoding settings.
@@ -5657,7 +5657,7 @@ When you specify Version 1, you must also set ID3 metadata (timedMetadata) to Pa
5657
5657
  */
5658
5658
  FixedAfd?: __integerMin0Max15;
5659
5659
  /**
5660
- * Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.
5660
+ * Use Height to define the video resolution height, in pixels, for this output. To use the same resolution as your input: Leave both Width and Height blank. To evenly scale from your input resolution: Leave Height blank and enter a value for Width. For example, if your input is 1920x1080 and you set Width to 1280, your output will be 1280x720.
5661
5661
  */
5662
5662
  Height?: __integerMin32Max8192;
5663
5663
  /**
@@ -5685,7 +5685,7 @@ When you specify Version 1, you must also set ID3 metadata (timedMetadata) to Pa
5685
5685
  */
5686
5686
  VideoPreprocessors?: VideoPreprocessor;
5687
5687
  /**
5688
- * Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.
5688
+ * Use Width to define the video resolution width, in pixels, for this output. To use the same resolution as your input: Leave both Width and Height blank. To evenly scale from your input resolution: Leave Width blank and enter a value for Height. For example, if your input is 1920x1080 and you set Height to 720, your output will be 1280x720.
5689
5689
  */
5690
5690
  Width?: __integerMin32Max8192;
5691
5691
  }
@@ -6334,7 +6334,7 @@ When you specify Version 1, you must also set ID3 metadata (timedMetadata) to Pa
6334
6334
  export type __stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912MrkAFAF0932 = string;
6335
6335
  export type __stringPatternDD = string;
6336
6336
  export type __stringPatternHttps = string;
6337
- export type __stringPatternHttpsKantarmediaComFr = string;
6337
+ export type __stringPatternHttpsKantarmedia = string;
6338
6338
  export type __stringPatternIdentityAZaZ26AZaZ09163 = string;
6339
6339
  export type __stringPatternS3 = string;
6340
6340
  export type __stringPatternS3ASSETMAPXml = string;
package/clients/rds.d.ts CHANGED
@@ -6707,7 +6707,7 @@ declare namespace RDS {
6707
6707
  */
6708
6708
  DBSnapshotIdentifier: String;
6709
6709
  /**
6710
- * The engine version to upgrade the DB snapshot to. The following are the database engines and engine versions that are available when you upgrade a DB snapshot. MySQL 5.5.46 (supported for 5.1 DB snapshots) Oracle 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots) 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots) 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots) PostgreSQL For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
6710
+ * The engine version to upgrade the DB snapshot to. The following are the database engines and engine versions that are available when you upgrade a DB snapshot. MySQL 5.5.46 (supported for 5.1 DB snapshots) Oracle 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots) 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots) 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots) 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots) 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots) PostgreSQL For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
6711
6711
  */
6712
6712
  EngineVersion?: String;
6713
6713
  /**
@@ -274,12 +274,6 @@ declare namespace SageMakerGeospatial {
274
274
  */
275
275
  UpperBound: Float;
276
276
  }
277
- export interface EojDataSourceConfigInput {
278
- /**
279
- * The input structure for S3Data; representing the Amazon S3 location of the input data objects.
280
- */
281
- S3Data?: S3DataInput;
282
- }
283
277
  export type ExecutionRoleArn = string;
284
278
  export interface ExportEarthObservationJobInput {
285
279
  /**
@@ -675,10 +669,6 @@ declare namespace SageMakerGeospatial {
675
669
  export type GroupBy = "ALL"|"YEARLY"|string;
676
670
  export type ImageSourceBandList = String[];
677
671
  export interface InputConfigInput {
678
- /**
679
- * The location of the input data.>
680
- */
681
- DataSourceConfig?: EojDataSourceConfigInput;
682
672
  /**
683
673
  * The Amazon Resource Name (ARN) of the previous Earth Observation job.
684
674
  */
@@ -689,10 +679,6 @@ declare namespace SageMakerGeospatial {
689
679
  RasterDataCollectionQuery?: RasterDataCollectionQueryInput;
690
680
  }
691
681
  export interface InputConfigOutput {
692
- /**
693
- * The location of the input data.
694
- */
695
- DataSourceConfig?: EojDataSourceConfigInput;
696
682
  /**
697
683
  * The Amazon Resource Name (ARN) of the previous Earth Observation job.
698
684
  */
@@ -958,7 +944,6 @@ declare namespace SageMakerGeospatial {
958
944
  */
959
945
  YAttributeName: String;
960
946
  }
961
- export type MetadataProvider = "PLANET_ORDER"|string;
962
947
  export interface MultiPolygonGeometryInput {
963
948
  /**
964
949
  * The coordinates of the multipolygon geometry.
@@ -1213,20 +1198,6 @@ declare namespace SageMakerGeospatial {
1213
1198
  */
1214
1199
  YAttributeName: String;
1215
1200
  }
1216
- export interface S3DataInput {
1217
- /**
1218
- * The Key Management Service key ID for server-side encryption.
1219
- */
1220
- KmsKeyId?: KmsKey;
1221
- /**
1222
- * Metadata provider from whom the Amazon S3 data has been acquired.
1223
- */
1224
- MetadataProvider: MetadataProvider;
1225
- /**
1226
- * The URL to the Amazon S3 input.
1227
- */
1228
- S3Uri: S3Uri;
1229
- }
1230
1201
  export type S3Uri = string;
1231
1202
  export interface SearchRasterDataCollectionInput {
1232
1203
  /**
@@ -1275,7 +1246,7 @@ declare namespace SageMakerGeospatial {
1275
1246
  /**
1276
1247
  * The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
1277
1248
  */
1278
- ExecutionRoleArn?: ExecutionRoleArn;
1249
+ ExecutionRoleArn: ExecutionRoleArn;
1279
1250
  /**
1280
1251
  * Input configuration information for the Earth Observation job.
1281
1252
  */
@@ -1315,7 +1286,7 @@ declare namespace SageMakerGeospatial {
1315
1286
  /**
1316
1287
  * The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
1317
1288
  */
1318
- ExecutionRoleArn?: ExecutionRoleArn;
1289
+ ExecutionRoleArn: ExecutionRoleArn;
1319
1290
  /**
1320
1291
  * Input configuration information for the Earth Observation job.
1321
1292
  */
@@ -296,7 +296,7 @@ declare namespace SecretsManager {
296
296
  */
297
297
  RecoveryWindowInDays?: RecoveryWindowInDaysType;
298
298
  /**
299
- * Specifies whether to delete the secret without any recovery window. You can't use both this parameter and RecoveryWindowInDays in the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window. Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic. Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
299
+ * Specifies whether to delete the secret without any recovery window. You can't use both this parameter and RecoveryWindowInDays in the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window. Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic. If you forcibly delete an already deleted or nonexistent secret, the operation does not return ResourceNotFoundException. Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
300
300
  */
301
301
  ForceDeleteWithoutRecovery?: BooleanType;
302
302
  }
@@ -368,7 +368,7 @@ declare namespace SecretsManager {
368
368
  */
369
369
  DeletedDate?: DeletedDateType;
370
370
  /**
371
- * 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.
371
+ * The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.
372
372
  */
373
373
  NextRotationDate?: NextRotationDateType;
374
374
  /**
@@ -867,7 +867,7 @@ declare namespace SecretsManager {
867
867
  */
868
868
  DeletedDate?: DeletedDateType;
869
869
  /**
870
- * 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.
870
+ * The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.
871
871
  */
872
872
  NextRotationDate?: NextRotationDateType;
873
873
  /**
@@ -196,11 +196,11 @@ declare class WAFV2 extends Service {
196
196
  */
197
197
  getPermissionPolicy(callback?: (err: AWSError, data: WAFV2.Types.GetPermissionPolicyResponse) => void): Request<WAFV2.Types.GetPermissionPolicyResponse, AWSError>;
198
198
  /**
199
- * Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
199
+ * Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address. The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
200
200
  */
201
201
  getRateBasedStatementManagedKeys(params: WAFV2.Types.GetRateBasedStatementManagedKeysRequest, callback?: (err: AWSError, data: WAFV2.Types.GetRateBasedStatementManagedKeysResponse) => void): Request<WAFV2.Types.GetRateBasedStatementManagedKeysResponse, AWSError>;
202
202
  /**
203
- * Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
203
+ * Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address. The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
204
204
  */
205
205
  getRateBasedStatementManagedKeys(callback?: (err: AWSError, data: WAFV2.Types.GetRateBasedStatementManagedKeysResponse) => void): Request<WAFV2.Types.GetRateBasedStatementManagedKeysResponse, AWSError>;
206
206
  /**
@@ -530,7 +530,7 @@ declare namespace WAFV2 {
530
530
  */
531
531
  FieldToMatch: FieldToMatch;
532
532
  /**
533
- * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
533
+ * 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.
534
534
  */
535
535
  TextTransformations: TextTransformations;
536
536
  /**
@@ -1677,6 +1677,7 @@ declare namespace WAFV2 {
1677
1677
  */
1678
1678
  LabelName: LabelName;
1679
1679
  }
1680
+ export type LabelNamespace = string;
1680
1681
  export type LabelSummaries = LabelSummary[];
1681
1682
  export interface LabelSummary {
1682
1683
  /**
@@ -2310,23 +2311,62 @@ declare namespace WAFV2 {
2310
2311
  }
2311
2312
  export interface RateBasedStatement {
2312
2313
  /**
2313
- * The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.
2314
+ * The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement. Examples: If you aggregate on just the IP address, this is the limit on requests from any single IP address. If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.
2314
2315
  */
2315
2316
  Limit: RateLimit;
2316
2317
  /**
2317
- * Setting that indicates how to aggregate the request counts. The options are the following: IP - Aggregate the request counts on the IP address from the web request origin. FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.
2318
+ * Setting that indicates how to aggregate the request counts. Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling. CONSTANT - Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, WAF applies the rule action to all requests that satisfy the scope-down statement. With this option, you must configure the ScopeDownStatement property. CUSTOM_KEYS - Aggregate the request counts using one or more web request components as the aggregate keys. With this option, you must specify the aggregate keys in the CustomKeys property. To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to IP or FORWARDED_IP. FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. With this option, you must specify the header to use in the ForwardedIPConfig property. To aggregate on a combination of the forwarded IP address with other aggregate keys, use CUSTOM_KEYS. IP - Aggregate the request counts on the IP address from the web request origin. To aggregate on a combination of the IP address with other aggregate keys, use CUSTOM_KEYS.
2318
2319
  */
2319
2320
  AggregateKeyType: RateBasedStatementAggregateKeyType;
2320
2321
  /**
2321
- * An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based 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 level, the same as you can for a rule statement.
2322
+ * An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits 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 level, the same as you can for a rule statement.
2322
2323
  */
2323
2324
  ScopeDownStatement?: Statement;
2324
2325
  /**
2325
- * 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. If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all. This is required if AggregateKeyType is set to FORWARDED_IP.
2326
+ * 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. If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all. This is required if you specify a forwarded IP in the rule's aggregate key settings.
2326
2327
  */
2327
2328
  ForwardedIPConfig?: ForwardedIPConfig;
2329
+ /**
2330
+ * Specifies the aggregate keys to use in a rate-base rule.
2331
+ */
2332
+ CustomKeys?: RateBasedStatementCustomKeys;
2328
2333
  }
2329
- export type RateBasedStatementAggregateKeyType = "IP"|"FORWARDED_IP"|string;
2334
+ export type RateBasedStatementAggregateKeyType = "IP"|"FORWARDED_IP"|"CUSTOM_KEYS"|"CONSTANT"|string;
2335
+ export interface RateBasedStatementCustomKey {
2336
+ /**
2337
+ * 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 header as your custom key, then each value fully defines an aggregation instance.
2338
+ */
2339
+ Header?: RateLimitHeader;
2340
+ /**
2341
+ * 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 cookie as your custom key, then each value fully defines an aggregation instance.
2342
+ */
2343
+ Cookie?: RateLimitCookie;
2344
+ /**
2345
+ * Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
2346
+ */
2347
+ QueryArgument?: RateLimitQueryArgument;
2348
+ /**
2349
+ * Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
2350
+ */
2351
+ QueryString?: RateLimitQueryString;
2352
+ /**
2353
+ * 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 as your custom key, then each method fully defines an aggregation instance.
2354
+ */
2355
+ HTTPMethod?: RateLimitHTTPMethod;
2356
+ /**
2357
+ * Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance. When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType. With this option, you must specify the header to use in the rate-based rule's ForwardedIPConfig property.
2358
+ */
2359
+ ForwardedIP?: RateLimitForwardedIP;
2360
+ /**
2361
+ * Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance. When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType.
2362
+ */
2363
+ IP?: RateLimitIP;
2364
+ /**
2365
+ * 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. 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. For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.
2366
+ */
2367
+ LabelNamespace?: RateLimitLabelNamespace;
2368
+ }
2369
+ export type RateBasedStatementCustomKeys = RateBasedStatementCustomKey[];
2330
2370
  export interface RateBasedStatementManagedKeysIPSet {
2331
2371
  /**
2332
2372
  * The version of the IP addresses, either IPV4 or IPV6.
@@ -2338,6 +2378,54 @@ declare namespace WAFV2 {
2338
2378
  Addresses?: IPAddresses;
2339
2379
  }
2340
2380
  export type RateLimit = number;
2381
+ export interface RateLimitCookie {
2382
+ /**
2383
+ * The name of the cookie to use.
2384
+ */
2385
+ Name: FieldToMatchData;
2386
+ /**
2387
+ * 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.
2388
+ */
2389
+ TextTransformations: TextTransformations;
2390
+ }
2391
+ export interface RateLimitForwardedIP {
2392
+ }
2393
+ export interface RateLimitHTTPMethod {
2394
+ }
2395
+ export interface RateLimitHeader {
2396
+ /**
2397
+ * The name of the header to use.
2398
+ */
2399
+ Name: FieldToMatchData;
2400
+ /**
2401
+ * 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.
2402
+ */
2403
+ TextTransformations: TextTransformations;
2404
+ }
2405
+ export interface RateLimitIP {
2406
+ }
2407
+ export interface RateLimitLabelNamespace {
2408
+ /**
2409
+ * The namespace to use for aggregation.
2410
+ */
2411
+ Namespace: LabelNamespace;
2412
+ }
2413
+ export interface RateLimitQueryArgument {
2414
+ /**
2415
+ * The name of the query argument to use.
2416
+ */
2417
+ Name: FieldToMatchData;
2418
+ /**
2419
+ * 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.
2420
+ */
2421
+ TextTransformations: TextTransformations;
2422
+ }
2423
+ export interface RateLimitQueryString {
2424
+ /**
2425
+ * 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.
2426
+ */
2427
+ TextTransformations: TextTransformations;
2428
+ }
2341
2429
  export type RedactedFields = FieldToMatch[];
2342
2430
  export interface Regex {
2343
2431
  /**
@@ -2355,7 +2443,7 @@ declare namespace WAFV2 {
2355
2443
  */
2356
2444
  FieldToMatch: FieldToMatch;
2357
2445
  /**
2358
- * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
2446
+ * 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.
2359
2447
  */
2360
2448
  TextTransformations: TextTransformations;
2361
2449
  }
@@ -2391,7 +2479,7 @@ declare namespace WAFV2 {
2391
2479
  */
2392
2480
  FieldToMatch: FieldToMatch;
2393
2481
  /**
2394
- * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
2482
+ * 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.
2395
2483
  */
2396
2484
  TextTransformations: TextTransformations;
2397
2485
  }
@@ -2781,7 +2869,7 @@ declare namespace WAFV2 {
2781
2869
  */
2782
2870
  Size: Size;
2783
2871
  /**
2784
- * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
2872
+ * 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.
2785
2873
  */
2786
2874
  TextTransformations: TextTransformations;
2787
2875
  }
@@ -2793,7 +2881,7 @@ declare namespace WAFV2 {
2793
2881
  */
2794
2882
  FieldToMatch: FieldToMatch;
2795
2883
  /**
2796
- * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
2884
+ * 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.
2797
2885
  */
2798
2886
  TextTransformations: TextTransformations;
2799
2887
  /**
@@ -2835,7 +2923,7 @@ declare namespace WAFV2 {
2835
2923
  */
2836
2924
  RegexPatternSetReferenceStatement?: RegexPatternSetReferenceStatement;
2837
2925
  /**
2838
- * 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. 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. When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit. 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: An IP match statement with an IP set that specifies the address 192.0.2.44. A string match statement that searches in the User-Agent header for the string BadBot. 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. 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.
2926
+ * 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. 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. 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. For example, assume the rule evaluates web requests with the following IP address and HTTP method values: IP address 10.1.1.1, HTTP method POST IP address 10.1.1.1, HTTP method GET IP address 127.0.0.0, HTTP method POST IP address 10.1.1.1, HTTP method GET The rule would create different aggregation instances according to your aggregation criteria, for example: If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following: IP address 10.1.1.1: count 3 IP address 127.0.0.0: count 1 If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following: HTTP method POST: count 2 HTTP method GET: count 2 If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following: IP address 10.1.1.1, HTTP method POST: count 1 IP address 10.1.1.1, HTTP method GET: count 2 IP address 127.0.0.0, HTTP method POST: count 1 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. 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. 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. For additional information about the options, see Rate limiting web requests using rate-based rules in the WAF Developer Guide. If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available for other aggregation configurations. 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.
2839
2927
  */
2840
2928
  RateBasedStatement?: RateBasedStatement;
2841
2929
  /**
@@ -2905,7 +2993,7 @@ declare namespace WAFV2 {
2905
2993
  export type TagValue = string;
2906
2994
  export interface TextTransformation {
2907
2995
  /**
2908
- * Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
2996
+ * Sets the relative processing order for multiple transformations. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
2909
2997
  */
2910
2998
  Priority: TextTransformationPriority;
2911
2999
  /**
@@ -3282,7 +3370,7 @@ declare namespace WAFV2 {
3282
3370
  */
3283
3371
  FieldToMatch: FieldToMatch;
3284
3372
  /**
3285
- * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
3373
+ * 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.
3286
3374
  */
3287
3375
  TextTransformations: TextTransformations;
3288
3376
  }