aws-sdk 2.1023.0 → 2.1024.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.
@@ -110,7 +110,7 @@ declare namespace ChimeSDKMeetings {
110
110
  /**
111
111
  * The Amazon Chime SDK attendee ID.
112
112
  */
113
- AttendeeId?: String;
113
+ AttendeeId?: GuidString;
114
114
  /**
115
115
  * The join token used by the Amazon Chime SDK attendee.
116
116
  */
@@ -122,7 +122,7 @@ declare namespace ChimeSDKMeetings {
122
122
  /**
123
123
  * The Amazon Chime SDK ID of the meeting to which you're adding attendees.
124
124
  */
125
- MeetingId: String;
125
+ MeetingId: GuidString;
126
126
  /**
127
127
  * The attendee information, including attendees' IDs and join tokens.
128
128
  */
@@ -157,7 +157,7 @@ declare namespace ChimeSDKMeetings {
157
157
  /**
158
158
  * The unique ID of the meeting.
159
159
  */
160
- MeetingId: String;
160
+ MeetingId: GuidString;
161
161
  /**
162
162
  * The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
163
163
  */
@@ -182,9 +182,9 @@ declare namespace ChimeSDKMeetings {
182
182
  */
183
183
  ClientRequestToken: ClientRequestToken;
184
184
  /**
185
- * The Region in which to create the meeting. Default: us-east-1. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
185
+ * The Region in which to create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
186
186
  */
187
- MediaRegion: String;
187
+ MediaRegion: MediaRegion;
188
188
  /**
189
189
  * Reserved.
190
190
  */
@@ -210,9 +210,9 @@ declare namespace ChimeSDKMeetings {
210
210
  */
211
211
  ClientRequestToken: ClientRequestToken;
212
212
  /**
213
- * The Region in which to create the meeting. Default: us-east-1.
213
+ * The Region in which to create the meeting.
214
214
  */
215
- MediaRegion: String;
215
+ MediaRegion: MediaRegion;
216
216
  /**
217
217
  * Reserved.
218
218
  */
@@ -249,17 +249,17 @@ declare namespace ChimeSDKMeetings {
249
249
  /**
250
250
  * The Amazon Chime SDK meeting ID.
251
251
  */
252
- MeetingId: String;
252
+ MeetingId: GuidString;
253
253
  /**
254
254
  * The Amazon Chime SDK attendee ID.
255
255
  */
256
- AttendeeId: String;
256
+ AttendeeId: GuidString;
257
257
  }
258
258
  export interface DeleteMeetingRequest {
259
259
  /**
260
260
  * The Amazon Chime SDK meeting ID.
261
261
  */
262
- MeetingId: String;
262
+ MeetingId: GuidString;
263
263
  }
264
264
  export interface EngineTranscribeMedicalSettings {
265
265
  /**
@@ -311,11 +311,11 @@ declare namespace ChimeSDKMeetings {
311
311
  /**
312
312
  * The Amazon Chime SDK meeting ID.
313
313
  */
314
- MeetingId: String;
314
+ MeetingId: GuidString;
315
315
  /**
316
316
  * The Amazon Chime SDK attendee ID.
317
317
  */
318
- AttendeeId: String;
318
+ AttendeeId: GuidString;
319
319
  }
320
320
  export interface GetAttendeeResponse {
321
321
  /**
@@ -327,7 +327,7 @@ declare namespace ChimeSDKMeetings {
327
327
  /**
328
328
  * The Amazon Chime SDK meeting ID.
329
329
  */
330
- MeetingId: String;
330
+ MeetingId: GuidString;
331
331
  }
332
332
  export interface GetMeetingResponse {
333
333
  /**
@@ -341,7 +341,7 @@ declare namespace ChimeSDKMeetings {
341
341
  /**
342
342
  * The Amazon Chime SDK meeting ID.
343
343
  */
344
- MeetingId: String;
344
+ MeetingId: GuidString;
345
345
  /**
346
346
  * The token to use to retrieve the next page of results.
347
347
  */
@@ -395,6 +395,7 @@ declare namespace ChimeSDKMeetings {
395
395
  */
396
396
  EventIngestionUrl?: String;
397
397
  }
398
+ export type MediaRegion = string;
398
399
  export interface Meeting {
399
400
  /**
400
401
  * The Amazon Chime SDK meeting ID.
@@ -411,7 +412,7 @@ declare namespace ChimeSDKMeetings {
411
412
  /**
412
413
  * The Region in which you create the meeting. Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
413
414
  */
414
- MediaRegion?: String;
415
+ MediaRegion?: MediaRegion;
415
416
  /**
416
417
  * The media placement for the meeting.
417
418
  */
@@ -436,7 +437,7 @@ declare namespace ChimeSDKMeetings {
436
437
  /**
437
438
  * The unique ID of the meeting being transcribed.
438
439
  */
439
- MeetingId: String;
440
+ MeetingId: GuidString;
440
441
  /**
441
442
  * The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
442
443
  */
@@ -446,7 +447,7 @@ declare namespace ChimeSDKMeetings {
446
447
  /**
447
448
  * The unique ID of the meeting for which you stop transcription.
448
449
  */
449
- MeetingId: String;
450
+ MeetingId: GuidString;
450
451
  }
451
452
  export type String = string;
452
453
  export type TranscribeLanguageCode = "en-US"|"en-GB"|"es-US"|"fr-CA"|"fr-FR"|"en-AU"|"it-IT"|"de-DE"|"pt-BR"|"ja-JP"|"ko-KR"|"zh-CN"|string;
package/clients/ec2.d.ts CHANGED
@@ -16431,6 +16431,7 @@ declare namespace EC2 {
16431
16431
  }
16432
16432
  export type FreeTierEligibleFlag = boolean;
16433
16433
  export type GVCDMaxResults = number;
16434
+ export type GatewayAssociationState = "associated"|"not-associated"|"associating"|"disassociating"|string;
16434
16435
  export type GatewayType = "ipsec.1"|string;
16435
16436
  export interface GetAssociatedEnclaveCertificateIamRolesRequest {
16436
16437
  /**
@@ -30281,7 +30282,7 @@ declare namespace EC2 {
30281
30282
  /**
30282
30283
  * The current state of the gateway association.
30283
30284
  */
30284
- GatewayAssociationState?: String;
30285
+ GatewayAssociationState?: GatewayAssociationState;
30285
30286
  /**
30286
30287
  * The VPN connection options.
30287
30288
  */
@@ -2157,7 +2157,7 @@ declare namespace SageMaker {
2157
2157
  export type AgentVersions = AgentVersion[];
2158
2158
  export interface Alarm {
2159
2159
  /**
2160
- *
2160
+ * The name of a CloudWatch alarm in your account.
2161
2161
  */
2162
2162
  AlarmName?: AlarmName;
2163
2163
  }
@@ -2747,7 +2747,7 @@ declare namespace SageMaker {
2747
2747
  export type AutoMLSortOrder = "Ascending"|"Descending"|string;
2748
2748
  export interface AutoRollbackConfig {
2749
2749
  /**
2750
- *
2750
+ * List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.
2751
2751
  */
2752
2752
  Alarms?: AlarmList;
2753
2753
  }
@@ -2821,15 +2821,15 @@ declare namespace SageMaker {
2821
2821
  export type BlockedReason = string;
2822
2822
  export interface BlueGreenUpdatePolicy {
2823
2823
  /**
2824
- *
2824
+ * Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.
2825
2825
  */
2826
2826
  TrafficRoutingConfiguration: TrafficRoutingConfig;
2827
2827
  /**
2828
- *
2828
+ * Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.
2829
2829
  */
2830
2830
  TerminationWaitInSeconds?: TerminationWaitInSeconds;
2831
2831
  /**
2832
- *
2832
+ * Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.
2833
2833
  */
2834
2834
  MaximumExecutionTimeoutInSeconds?: MaximumExecutionTimeoutInSeconds;
2835
2835
  }
@@ -2883,11 +2883,11 @@ declare namespace SageMaker {
2883
2883
  export type CandidateSteps = AutoMLCandidateStep[];
2884
2884
  export interface CapacitySize {
2885
2885
  /**
2886
- * This API is not supported.
2886
+ * Specifies the endpoint capacity type. INSTANCE_COUNT: The endpoint activates based on the number of instances. CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
2887
2887
  */
2888
2888
  Type: CapacitySizeType;
2889
2889
  /**
2890
- *
2890
+ * Defines the capacity size, either as a number of instances or a capacity percentage.
2891
2891
  */
2892
2892
  Value: CapacitySizeValue;
2893
2893
  }
@@ -3735,6 +3735,7 @@ declare namespace SageMaker {
3735
3735
  * The name of an endpoint configuration. For more information, see CreateEndpointConfig.
3736
3736
  */
3737
3737
  EndpointConfigName: EndpointConfigName;
3738
+ DeploymentConfig?: DeploymentConfig;
3738
3739
  /**
3739
3740
  * An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
3740
3741
  */
@@ -5408,11 +5409,11 @@ declare namespace SageMaker {
5408
5409
  export type DeployedImages = DeployedImage[];
5409
5410
  export interface DeploymentConfig {
5410
5411
  /**
5411
- *
5412
+ * Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.
5412
5413
  */
5413
5414
  BlueGreenUpdatePolicy: BlueGreenUpdatePolicy;
5414
5415
  /**
5415
- *
5416
+ * Automatic rollback configuration for handling endpoint deployment failures and recovery.
5416
5417
  */
5417
5418
  AutoRollbackConfiguration?: AutoRollbackConfig;
5418
5419
  }
@@ -6270,6 +6271,10 @@ declare namespace SageMaker {
6270
6271
  * Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
6271
6272
  */
6272
6273
  AsyncInferenceConfig?: AsyncInferenceConfig;
6274
+ /**
6275
+ * Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.
6276
+ */
6277
+ PendingDeploymentSummary?: PendingDeploymentSummary;
6273
6278
  }
6274
6279
  export interface DescribeExperimentRequest {
6275
6280
  /**
@@ -8842,11 +8847,11 @@ declare namespace SageMaker {
8842
8847
  */
8843
8848
  NumberOfHumanWorkersPerDataObject: NumberOfHumanWorkersPerDataObject;
8844
8849
  /**
8845
- * The amount of time that a worker has to complete a task. If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds). If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use: For image and text labeling jobs, the maximum is 8 hours (28,800 seconds). For 3D point cloud and video frame labeling jobs, the maximum is 7 days (604,800 seconds). If you want to change these limits, contact Amazon Web Services Support.
8850
+ * The amount of time that a worker has to complete a task. If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds). If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use: For image and text labeling jobs, the maximum is 8 hours (28,800 seconds). For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days. If you want to change these limits, contact Amazon Web Services Support.
8846
8851
  */
8847
8852
  TaskTimeLimitInSeconds: TaskTimeLimitInSeconds;
8848
8853
  /**
8849
- * The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds). If you choose a private or vendor workforce, the default value is 10 days (864,000 seconds). For most users, the maximum is also 10 days. If you want to change this limit, contact Amazon Web Services Support.
8854
+ * The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds). If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days. If you want to change this limit, contact Amazon Web Services Support.
8850
8855
  */
8851
8856
  TaskAvailabilityLifetimeInSeconds?: TaskAvailabilityLifetimeInSeconds;
8852
8857
  /**
@@ -13223,6 +13228,59 @@ declare namespace SageMaker {
13223
13228
  }
13224
13229
  export type ParentHyperParameterTuningJobs = ParentHyperParameterTuningJob[];
13225
13230
  export type Parents = Parent[];
13231
+ export interface PendingDeploymentSummary {
13232
+ /**
13233
+ * The name of the endpoint configuration used in the deployment.
13234
+ */
13235
+ EndpointConfigName: EndpointConfigName;
13236
+ /**
13237
+ * List of PendingProductionVariantSummary objects.
13238
+ */
13239
+ ProductionVariants?: PendingProductionVariantSummaryList;
13240
+ /**
13241
+ * The start time of the deployment.
13242
+ */
13243
+ StartTime?: Timestamp;
13244
+ }
13245
+ export interface PendingProductionVariantSummary {
13246
+ /**
13247
+ * The name of the variant.
13248
+ */
13249
+ VariantName: VariantName;
13250
+ /**
13251
+ * An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
13252
+ */
13253
+ DeployedImages?: DeployedImages;
13254
+ /**
13255
+ * The weight associated with the variant.
13256
+ */
13257
+ CurrentWeight?: VariantWeight;
13258
+ /**
13259
+ * The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
13260
+ */
13261
+ DesiredWeight?: VariantWeight;
13262
+ /**
13263
+ * The number of instances associated with the variant.
13264
+ */
13265
+ CurrentInstanceCount?: TaskCount;
13266
+ /**
13267
+ * The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.
13268
+ */
13269
+ DesiredInstanceCount?: TaskCount;
13270
+ /**
13271
+ * The type of instances associated with the variant.
13272
+ */
13273
+ InstanceType?: ProductionVariantInstanceType;
13274
+ /**
13275
+ * The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.
13276
+ */
13277
+ AcceleratorType?: ProductionVariantAcceleratorType;
13278
+ /**
13279
+ * The endpoint variant status which describes the current deployment stage status or operational status.
13280
+ */
13281
+ VariantStatus?: ProductionVariantStatusList;
13282
+ }
13283
+ export type PendingProductionVariantSummaryList = PendingProductionVariantSummary[];
13226
13284
  export interface Pipeline {
13227
13285
  /**
13228
13286
  * The Amazon Resource Name (ARN) of the pipeline.
@@ -13759,6 +13817,21 @@ declare namespace SageMaker {
13759
13817
  }
13760
13818
  export type ProductionVariantInstanceType = "ml.t2.medium"|"ml.t2.large"|"ml.t2.xlarge"|"ml.t2.2xlarge"|"ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.m5d.large"|"ml.m5d.xlarge"|"ml.m5d.2xlarge"|"ml.m5d.4xlarge"|"ml.m5d.12xlarge"|"ml.m5d.24xlarge"|"ml.c4.large"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5d.large"|"ml.c5d.xlarge"|"ml.c5d.2xlarge"|"ml.c5d.4xlarge"|"ml.c5d.9xlarge"|"ml.c5d.18xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.r5.large"|"ml.r5.xlarge"|"ml.r5.2xlarge"|"ml.r5.4xlarge"|"ml.r5.12xlarge"|"ml.r5.24xlarge"|"ml.r5d.large"|"ml.r5d.xlarge"|"ml.r5d.2xlarge"|"ml.r5d.4xlarge"|"ml.r5d.12xlarge"|"ml.r5d.24xlarge"|"ml.inf1.xlarge"|"ml.inf1.2xlarge"|"ml.inf1.6xlarge"|"ml.inf1.24xlarge"|string;
13761
13819
  export type ProductionVariantList = ProductionVariant[];
13820
+ export interface ProductionVariantStatus {
13821
+ /**
13822
+ * The endpoint variant status which describes the current deployment stage status or operational status. Creating: Creating inference resources for the production variant. Deleting: Terminating inference resources for the production variant. Updating: Updating capacity for the production variant. ActivatingTraffic: Turning on traffic for the production variant. Baking: Waiting period to monitor the CloudWatch alarms in the automatic rollback configuration.
13823
+ */
13824
+ Status: VariantStatus;
13825
+ /**
13826
+ * A message that describes the status of the production variant.
13827
+ */
13828
+ StatusMessage?: VariantStatusMessage;
13829
+ /**
13830
+ * The start time of the current status change.
13831
+ */
13832
+ StartTime?: Timestamp;
13833
+ }
13834
+ export type ProductionVariantStatusList = ProductionVariantStatus[];
13762
13835
  export interface ProductionVariantSummary {
13763
13836
  /**
13764
13837
  * The name of the variant.
@@ -13784,6 +13857,10 @@ declare namespace SageMaker {
13784
13857
  * The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
13785
13858
  */
13786
13859
  DesiredInstanceCount?: TaskCount;
13860
+ /**
13861
+ * The endpoint variant status which describes the current deployment stage status or operational status.
13862
+ */
13863
+ VariantStatus?: ProductionVariantStatusList;
13787
13864
  }
13788
13865
  export type ProductionVariantSummaryList = ProductionVariantSummary[];
13789
13866
  export interface ProfilerConfig {
@@ -14788,19 +14865,23 @@ declare namespace SageMaker {
14788
14865
  export type Timestamp = Date;
14789
14866
  export interface TrafficRoutingConfig {
14790
14867
  /**
14791
- *
14868
+ * Traffic routing strategy type. ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step. CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic. LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.
14792
14869
  */
14793
14870
  Type: TrafficRoutingConfigType;
14794
14871
  /**
14795
- *
14872
+ * The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
14796
14873
  */
14797
14874
  WaitIntervalInSeconds: WaitIntervalInSeconds;
14798
14875
  /**
14799
- *
14876
+ * Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.
14800
14877
  */
14801
14878
  CanarySize?: CapacitySize;
14879
+ /**
14880
+ * Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.
14881
+ */
14882
+ LinearStepSize?: CapacitySize;
14802
14883
  }
14803
- export type TrafficRoutingConfigType = "ALL_AT_ONCE"|"CANARY"|string;
14884
+ export type TrafficRoutingConfigType = "ALL_AT_ONCE"|"CANARY"|"LINEAR"|string;
14804
14885
  export type TrainingEnvironmentKey = string;
14805
14886
  export type TrainingEnvironmentMap = {[key: string]: TrainingEnvironmentValue};
14806
14887
  export type TrainingEnvironmentValue = string;
@@ -15818,9 +15899,13 @@ declare namespace SageMaker {
15818
15899
  */
15819
15900
  ExcludeRetainedVariantProperties?: VariantPropertyList;
15820
15901
  /**
15821
- * The deployment configuration for the endpoint to be updated.
15902
+ * The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
15822
15903
  */
15823
15904
  DeploymentConfig?: DeploymentConfig;
15905
+ /**
15906
+ * Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
15907
+ */
15908
+ RetainDeploymentConfig?: Boolean;
15824
15909
  }
15825
15910
  export interface UpdateEndpointOutput {
15826
15911
  /**
@@ -16317,6 +16402,8 @@ declare namespace SageMaker {
16317
16402
  }
16318
16403
  export type VariantPropertyList = VariantProperty[];
16319
16404
  export type VariantPropertyType = "DesiredInstanceCount"|"DesiredWeight"|"DataCaptureConfig"|string;
16405
+ export type VariantStatus = "Creating"|"Updating"|"Deleting"|"ActivatingTraffic"|"Baking"|string;
16406
+ export type VariantStatusMessage = string;
16320
16407
  export type VariantWeight = number;
16321
16408
  export type VersionedArnOrName = string;
16322
16409
  export type VolumeSizeInGB = number;
@@ -380,7 +380,7 @@ declare namespace WAFV2 {
380
380
  */
381
381
  Action: ActionValue;
382
382
  }
383
- export type ActionValue = "ALLOW"|"BLOCK"|"COUNT"|string;
383
+ export type ActionValue = "ALLOW"|"BLOCK"|"COUNT"|"CAPTCHA"|"EXCLUDED_AS_COUNT"|string;
384
384
  export interface All {
385
385
  }
386
386
  export interface AllQueryArguments {
@@ -438,6 +438,32 @@ declare namespace WAFV2 {
438
438
  PositionalConstraint: PositionalConstraint;
439
439
  }
440
440
  export type CapacityUnit = number;
441
+ export interface CaptchaAction {
442
+ /**
443
+ * Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
444
+ */
445
+ CustomRequestHandling?: CustomRequestHandling;
446
+ }
447
+ export interface CaptchaConfig {
448
+ /**
449
+ * Determines how long a CAPTCHA token remains valid after the client successfully solves a CAPTCHA puzzle.
450
+ */
451
+ ImmunityTimeProperty?: ImmunityTimeProperty;
452
+ }
453
+ export interface CaptchaResponse {
454
+ /**
455
+ * The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token is missing, invalid, or expired, this code is 405 Method Not Allowed.
456
+ */
457
+ ResponseCode?: ResponseCode;
458
+ /**
459
+ * The time that the CAPTCHA puzzle was solved for the supplied token.
460
+ */
461
+ SolveTimestamp?: SolveTimestamp;
462
+ /**
463
+ * The reason for failure, populated when the evaluation of the token fails.
464
+ */
465
+ FailureReason?: FailureReason;
466
+ }
441
467
  export interface CheckCapacityRequest {
442
468
  /**
443
469
  * Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
@@ -609,6 +635,10 @@ declare namespace WAFV2 {
609
635
  * A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
610
636
  */
611
637
  CustomResponseBodies?: CustomResponseBodies;
638
+ /**
639
+ * Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.
640
+ */
641
+ CaptchaConfig?: CaptchaConfig;
612
642
  }
613
643
  export interface CreateWebACLResponse {
614
644
  /**
@@ -843,11 +873,12 @@ declare namespace WAFV2 {
843
873
  export type EntityName = string;
844
874
  export interface ExcludedRule {
845
875
  /**
846
- * The name of the rule to exclude.
876
+ * The name of the rule whose action you want to override to Count.
847
877
  */
848
878
  Name: EntityName;
849
879
  }
850
880
  export type ExcludedRules = ExcludedRule[];
881
+ export type FailureReason = "TOKEN_MISSING"|"TOKEN_EXPIRED"|string;
851
882
  export type FallbackBehavior = "MATCH"|"NO_MATCH"|string;
852
883
  export interface FieldToMatch {
853
884
  /**
@@ -915,7 +946,7 @@ declare namespace WAFV2 {
915
946
  */
916
947
  FirewallManagerStatement: FirewallManagerStatement;
917
948
  /**
918
- * The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings. In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both: If the rule statement references a rule group, use this override action setting and not the action setting. If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.
949
+ * The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only. You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
919
950
  */
920
951
  OverrideAction: OverrideAction;
921
952
  /**
@@ -1302,6 +1333,12 @@ declare namespace WAFV2 {
1302
1333
  ARN?: ResourceArn;
1303
1334
  }
1304
1335
  export type IPString = string;
1336
+ export interface ImmunityTimeProperty {
1337
+ /**
1338
+ * The amount of time, in seconds, that a CAPTCHA token is valid. The default setting is 300.
1339
+ */
1340
+ ImmunityTime: TimeWindowSecond;
1341
+ }
1305
1342
  export interface JsonBody {
1306
1343
  /**
1307
1344
  * The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
@@ -1446,7 +1483,7 @@ declare namespace WAFV2 {
1446
1483
  /**
1447
1484
  * Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
1448
1485
  */
1449
- Scope?: Scope;
1486
+ Scope: Scope;
1450
1487
  /**
1451
1488
  * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
1452
1489
  */
@@ -1652,7 +1689,7 @@ declare namespace WAFV2 {
1652
1689
  */
1653
1690
  Version?: VersionKeyString;
1654
1691
  /**
1655
- * The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
1692
+ * The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.
1656
1693
  */
1657
1694
  ExcludedRules?: ExcludedRules;
1658
1695
  /**
@@ -1789,11 +1826,11 @@ declare namespace WAFV2 {
1789
1826
  }
1790
1827
  export interface OverrideAction {
1791
1828
  /**
1792
- * Override the rule action setting to count.
1829
+ * Override the rule group evaluation result to count only. This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
1793
1830
  */
1794
1831
  Count?: CountAction;
1795
1832
  /**
1796
- * Don't override the rule action setting.
1833
+ * Don't override the rule group evaluation result. This is the most common setting.
1797
1834
  */
1798
1835
  None?: NoneAction;
1799
1836
  }
@@ -1975,6 +2012,7 @@ declare namespace WAFV2 {
1975
2012
  export type ResourceArn = string;
1976
2013
  export type ResourceArns = ResourceArn[];
1977
2014
  export type ResourceType = "APPLICATION_LOAD_BALANCER"|"API_GATEWAY"|"APPSYNC"|string;
2015
+ export type ResponseCode = number;
1978
2016
  export type ResponseContent = string;
1979
2017
  export type ResponseContentType = "TEXT_PLAIN"|"TEXT_HTML"|"APPLICATION_JSON"|string;
1980
2018
  export type ResponseStatusCode = number;
@@ -1996,7 +2034,7 @@ declare namespace WAFV2 {
1996
2034
  */
1997
2035
  Action?: RuleAction;
1998
2036
  /**
1999
- * The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings. In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both: If the rule statement references a rule group, use this override action setting and not the action setting. If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.
2037
+ * The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only. You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
2000
2038
  */
2001
2039
  OverrideAction?: OverrideAction;
2002
2040
  /**
@@ -2007,6 +2045,10 @@ declare namespace WAFV2 {
2007
2045
  * Defines and enables Amazon CloudWatch metrics and web request sample collection.
2008
2046
  */
2009
2047
  VisibilityConfig: VisibilityConfig;
2048
+ /**
2049
+ * Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.
2050
+ */
2051
+ CaptchaConfig?: CaptchaConfig;
2010
2052
  }
2011
2053
  export interface RuleAction {
2012
2054
  /**
@@ -2021,6 +2063,10 @@ declare namespace WAFV2 {
2021
2063
  * Instructs WAF to count the web request and allow it.
2022
2064
  */
2023
2065
  Count?: CountAction;
2066
+ /**
2067
+ * Instructs WAF to run a CAPTCHA check against the web request.
2068
+ */
2069
+ Captcha?: CaptchaAction;
2024
2070
  }
2025
2071
  export interface RuleGroup {
2026
2072
  /**
@@ -2074,7 +2120,7 @@ declare namespace WAFV2 {
2074
2120
  */
2075
2121
  ARN: ResourceArn;
2076
2122
  /**
2077
- * The names of rules that are in the referenced rule group, but that you want WAF to exclude from processing for this rule statement.
2123
+ * The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.
2078
2124
  */
2079
2125
  ExcludedRules?: ExcludedRules;
2080
2126
  }
@@ -2129,7 +2175,7 @@ declare namespace WAFV2 {
2129
2175
  */
2130
2176
  Timestamp?: Timestamp;
2131
2177
  /**
2132
- * The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.
2178
+ * The action for the Rule that the request matched: Allow, Block, or Count.
2133
2179
  */
2134
2180
  Action?: Action;
2135
2181
  /**
@@ -2148,6 +2194,10 @@ declare namespace WAFV2 {
2148
2194
  * Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace. For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
2149
2195
  */
2150
2196
  Labels?: Labels;
2197
+ /**
2198
+ * The CAPTCHA response for the request.
2199
+ */
2200
+ CaptchaResponse?: CaptchaResponse;
2151
2201
  }
2152
2202
  export type SampledHTTPRequests = SampledHTTPRequest[];
2153
2203
  export type Scope = "CLOUDFRONT"|"REGIONAL"|string;
@@ -2183,6 +2233,7 @@ declare namespace WAFV2 {
2183
2233
  */
2184
2234
  TextTransformations: TextTransformations;
2185
2235
  }
2236
+ export type SolveTimestamp = number;
2186
2237
  export interface SqliMatchStatement {
2187
2238
  /**
2188
2239
  * The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.
@@ -2316,6 +2367,7 @@ declare namespace WAFV2 {
2316
2367
  EndTime: Timestamp;
2317
2368
  }
2318
2369
  export type TimeWindowDay = number;
2370
+ export type TimeWindowSecond = number;
2319
2371
  export type Timestamp = Date;
2320
2372
  export type URIString = string;
2321
2373
  export interface UntagResourceRequest {
@@ -2511,6 +2563,10 @@ declare namespace WAFV2 {
2511
2563
  * A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
2512
2564
  */
2513
2565
  CustomResponseBodies?: CustomResponseBodies;
2566
+ /**
2567
+ * Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.
2568
+ */
2569
+ CaptchaConfig?: CaptchaConfig;
2514
2570
  }
2515
2571
  export interface UpdateWebACLResponse {
2516
2572
  /**
@@ -2600,6 +2656,10 @@ declare namespace WAFV2 {
2600
2656
  * A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
2601
2657
  */
2602
2658
  CustomResponseBodies?: CustomResponseBodies;
2659
+ /**
2660
+ * Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.
2661
+ */
2662
+ CaptchaConfig?: CaptchaConfig;
2603
2663
  }
2604
2664
  export type WebACLSummaries = WebACLSummary[];
2605
2665
  export interface WebACLSummary {
@@ -83,7 +83,7 @@ return /******/ (function(modules) { // webpackBootstrap
83
83
  /**
84
84
  * @constant
85
85
  */
86
- VERSION: '2.1023.0',
86
+ VERSION: '2.1024.0',
87
87
 
88
88
  /**
89
89
  * @api private