aws-sdk 2.871.0 → 2.875.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/CHANGELOG.md +26 -1
- package/README.md +1 -1
- package/apis/alexaforbusiness-2017-11-09.min.json +9 -0
- package/apis/customer-profiles-2020-08-15.min.json +164 -6
- package/apis/docdb-2014-10-31.min.json +298 -114
- package/apis/docdb-2014-10-31.paginators.json +6 -0
- package/apis/eventbridge-2015-10-07.min.json +22 -3
- package/apis/events-2015-10-07.min.json +22 -3
- package/apis/glue-2017-03-31.min.json +20 -10
- package/apis/iotwireless-2020-11-22.min.json +3 -0
- package/apis/location-2020-11-19.min.json +23 -1
- package/apis/lookoutmetrics-2017-07-25.examples.json +5 -0
- package/apis/lookoutmetrics-2017-07-25.min.json +1179 -0
- package/apis/lookoutmetrics-2017-07-25.paginators.json +39 -0
- package/apis/medialive-2017-10-14.min.json +189 -176
- package/apis/metadata.json +3 -0
- package/apis/rekognition-2016-06-27.min.json +181 -109
- package/apis/sagemaker-2017-07-24.min.json +213 -199
- package/apis/wafv2-2019-07-29.min.json +172 -81
- package/clients/alexaforbusiness.d.ts +12 -0
- package/clients/all.d.ts +1 -0
- package/clients/all.js +2 -1
- package/clients/cloudwatchevents.d.ts +25 -2
- package/clients/customerprofiles.d.ts +102 -1
- package/clients/docdb.d.ts +213 -0
- package/clients/eventbridge.d.ts +25 -2
- package/clients/glue.d.ts +21 -6
- package/clients/iotwireless.d.ts +13 -9
- package/clients/location.d.ts +100 -44
- package/clients/lookoutmetrics.d.ts +1497 -0
- package/clients/lookoutmetrics.js +19 -0
- package/clients/medialive.d.ts +8 -1
- package/clients/rekognition.d.ts +80 -3
- package/clients/sagemaker.d.ts +26 -11
- package/clients/sqs.d.ts +2 -2
- package/clients/transcribeservice.d.ts +2 -2
- package/clients/wafv2.d.ts +94 -3
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +83 -17
- package/dist/aws-sdk.js +209 -115
- package/dist/aws-sdk.min.js +47 -47
- package/lib/config_service_placeholders.d.ts +2 -0
- package/lib/core.js +1 -1
- package/lib/services/lookoutmetrics.js +22 -0
- package/package.json +1 -1
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
require('../lib/node_loader');
|
|
2
|
+
var AWS = require('../lib/core');
|
|
3
|
+
var Service = AWS.Service;
|
|
4
|
+
var apiLoader = AWS.apiLoader;
|
|
5
|
+
|
|
6
|
+
apiLoader.services['lookoutmetrics'] = {};
|
|
7
|
+
AWS.LookoutMetrics = Service.defineService('lookoutmetrics', ['2017-07-25']);
|
|
8
|
+
require('../lib/services/lookoutmetrics');
|
|
9
|
+
Object.defineProperty(apiLoader.services['lookoutmetrics'], '2017-07-25', {
|
|
10
|
+
get: function get() {
|
|
11
|
+
var model = require('../apis/lookoutmetrics-2017-07-25.min.json');
|
|
12
|
+
model.paginators = require('../apis/lookoutmetrics-2017-07-25.paginators.json').pagination;
|
|
13
|
+
return model;
|
|
14
|
+
},
|
|
15
|
+
enumerable: true,
|
|
16
|
+
configurable: true
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
module.exports = AWS.LookoutMetrics;
|
package/clients/medialive.d.ts
CHANGED
|
@@ -6541,6 +6541,10 @@ NONE: MediaLive does not clip the input video and does not include the AFD value
|
|
|
6541
6541
|
* Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
|
|
6542
6542
|
*/
|
|
6543
6543
|
ColorSpace?: VideoSelectorColorSpace;
|
|
6544
|
+
/**
|
|
6545
|
+
* Color space settings
|
|
6546
|
+
*/
|
|
6547
|
+
ColorSpaceSettings?: VideoSelectorColorSpaceSettings;
|
|
6544
6548
|
/**
|
|
6545
6549
|
* Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
|
|
6546
6550
|
*/
|
|
@@ -6550,7 +6554,10 @@ NONE: MediaLive does not clip the input video and does not include the AFD value
|
|
|
6550
6554
|
*/
|
|
6551
6555
|
SelectorSettings?: VideoSelectorSettings;
|
|
6552
6556
|
}
|
|
6553
|
-
export type VideoSelectorColorSpace = "FOLLOW"|"REC_601"|"REC_709"|string;
|
|
6557
|
+
export type VideoSelectorColorSpace = "FOLLOW"|"HDR10"|"HLG_2020"|"REC_601"|"REC_709"|string;
|
|
6558
|
+
export interface VideoSelectorColorSpaceSettings {
|
|
6559
|
+
Hdr10Settings?: Hdr10Settings;
|
|
6560
|
+
}
|
|
6554
6561
|
export type VideoSelectorColorSpaceUsage = "FALLBACK"|"FORCE"|string;
|
|
6555
6562
|
export interface VideoSelectorPid {
|
|
6556
6563
|
/**
|
package/clients/rekognition.d.ts
CHANGED
|
@@ -13,11 +13,11 @@ declare class Rekognition extends Service {
|
|
|
13
13
|
constructor(options?: Rekognition.Types.ClientConfiguration)
|
|
14
14
|
config: Config & Rekognition.Types.ClientConfiguration;
|
|
15
15
|
/**
|
|
16
|
-
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image.
|
|
16
|
+
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. CompareFaces uses machine learning algorithms, which are probabilistic. A false negative is an incorrect prediction that a face in the target image has a low similarity confidence score when compared to the face in the source image. To reduce the probability of false negatives, we recommend that you compare the target image against multiple source images. If you plan to use CompareFaces to make a decision that impacts an individual's rights, privacy, or access to services, we recommend that you pass the result to a human for review and further validation before taking action. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action.
|
|
17
17
|
*/
|
|
18
18
|
compareFaces(params: Rekognition.Types.CompareFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request<Rekognition.Types.CompareFacesResponse, AWSError>;
|
|
19
19
|
/**
|
|
20
|
-
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image.
|
|
20
|
+
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. CompareFaces uses machine learning algorithms, which are probabilistic. A false negative is an incorrect prediction that a face in the target image has a low similarity confidence score when compared to the face in the source image. To reduce the probability of false negatives, we recommend that you compare the target image against multiple source images. If you plan to use CompareFaces to make a decision that impacts an individual's rights, privacy, or access to services, we recommend that you pass the result to a human for review and further validation before taking action. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action.
|
|
21
21
|
*/
|
|
22
22
|
compareFaces(callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request<Rekognition.Types.CompareFacesResponse, AWSError>;
|
|
23
23
|
/**
|
|
@@ -276,6 +276,14 @@ declare class Rekognition extends Service {
|
|
|
276
276
|
* Gets a list of stream processors that you have created with CreateStreamProcessor.
|
|
277
277
|
*/
|
|
278
278
|
listStreamProcessors(callback?: (err: AWSError, data: Rekognition.Types.ListStreamProcessorsResponse) => void): Request<Rekognition.Types.ListStreamProcessorsResponse, AWSError>;
|
|
279
|
+
/**
|
|
280
|
+
* Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.
|
|
281
|
+
*/
|
|
282
|
+
listTagsForResource(params: Rekognition.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Rekognition.Types.ListTagsForResourceResponse) => void): Request<Rekognition.Types.ListTagsForResourceResponse, AWSError>;
|
|
283
|
+
/**
|
|
284
|
+
* Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.
|
|
285
|
+
*/
|
|
286
|
+
listTagsForResource(callback?: (err: AWSError, data: Rekognition.Types.ListTagsForResourceResponse) => void): Request<Rekognition.Types.ListTagsForResourceResponse, AWSError>;
|
|
279
287
|
/**
|
|
280
288
|
* Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities returns the 64 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64 faces in the image. For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image. Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.
|
|
281
289
|
*/
|
|
@@ -396,6 +404,22 @@ declare class Rekognition extends Service {
|
|
|
396
404
|
* Stops a running stream processor that was created by CreateStreamProcessor.
|
|
397
405
|
*/
|
|
398
406
|
stopStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.StopStreamProcessorResponse) => void): Request<Rekognition.Types.StopStreamProcessorResponse, AWSError>;
|
|
407
|
+
/**
|
|
408
|
+
* Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources.
|
|
409
|
+
*/
|
|
410
|
+
tagResource(params: Rekognition.Types.TagResourceRequest, callback?: (err: AWSError, data: Rekognition.Types.TagResourceResponse) => void): Request<Rekognition.Types.TagResourceResponse, AWSError>;
|
|
411
|
+
/**
|
|
412
|
+
* Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources.
|
|
413
|
+
*/
|
|
414
|
+
tagResource(callback?: (err: AWSError, data: Rekognition.Types.TagResourceResponse) => void): Request<Rekognition.Types.TagResourceResponse, AWSError>;
|
|
415
|
+
/**
|
|
416
|
+
* Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.
|
|
417
|
+
*/
|
|
418
|
+
untagResource(params: Rekognition.Types.UntagResourceRequest, callback?: (err: AWSError, data: Rekognition.Types.UntagResourceResponse) => void): Request<Rekognition.Types.UntagResourceResponse, AWSError>;
|
|
419
|
+
/**
|
|
420
|
+
* Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.
|
|
421
|
+
*/
|
|
422
|
+
untagResource(callback?: (err: AWSError, data: Rekognition.Types.UntagResourceResponse) => void): Request<Rekognition.Types.UntagResourceResponse, AWSError>;
|
|
399
423
|
/**
|
|
400
424
|
* Waits for the projectVersionTrainingCompleted state by periodically calling the underlying Rekognition.describeProjectVersionsoperation every 120 seconds (at most 360 times). Wait until the ProjectVersion training completes.
|
|
401
425
|
*/
|
|
@@ -660,6 +684,10 @@ declare namespace Rekognition {
|
|
|
660
684
|
* ID for the collection that you are creating.
|
|
661
685
|
*/
|
|
662
686
|
CollectionId: CollectionId;
|
|
687
|
+
/**
|
|
688
|
+
* A set of tags (key-value pairs) that you want to attach to the collection.
|
|
689
|
+
*/
|
|
690
|
+
Tags?: TagMap;
|
|
663
691
|
}
|
|
664
692
|
export interface CreateCollectionResponse {
|
|
665
693
|
/**
|
|
@@ -708,6 +736,10 @@ declare namespace Rekognition {
|
|
|
708
736
|
* The dataset to use for testing.
|
|
709
737
|
*/
|
|
710
738
|
TestingData: TestingData;
|
|
739
|
+
/**
|
|
740
|
+
* A set of tags (key-value pairs) that you want to attach to the model.
|
|
741
|
+
*/
|
|
742
|
+
Tags?: TagMap;
|
|
711
743
|
}
|
|
712
744
|
export interface CreateProjectVersionResponse {
|
|
713
745
|
/**
|
|
@@ -736,6 +768,10 @@ declare namespace Rekognition {
|
|
|
736
768
|
* ARN of the IAM role that allows access to the stream processor.
|
|
737
769
|
*/
|
|
738
770
|
RoleArn: RoleArn;
|
|
771
|
+
/**
|
|
772
|
+
* A set of tags (key-value pairs) that you want to attach to the stream processor.
|
|
773
|
+
*/
|
|
774
|
+
Tags?: TagMap;
|
|
739
775
|
}
|
|
740
776
|
export interface CreateStreamProcessorResponse {
|
|
741
777
|
/**
|
|
@@ -1090,7 +1126,7 @@ declare namespace Rekognition {
|
|
|
1090
1126
|
}
|
|
1091
1127
|
export interface DetectionFilter {
|
|
1092
1128
|
/**
|
|
1093
|
-
* Sets confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between
|
|
1129
|
+
* Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 50 and 100 as Text in Video will not return any result below 50.
|
|
1094
1130
|
*/
|
|
1095
1131
|
MinConfidence?: Percent;
|
|
1096
1132
|
/**
|
|
@@ -1918,6 +1954,18 @@ declare namespace Rekognition {
|
|
|
1918
1954
|
*/
|
|
1919
1955
|
StreamProcessors?: StreamProcessorList;
|
|
1920
1956
|
}
|
|
1957
|
+
export interface ListTagsForResourceRequest {
|
|
1958
|
+
/**
|
|
1959
|
+
* Amazon Resource Name (ARN) of the model, collection, or stream processor that contains the tags that you want a list of.
|
|
1960
|
+
*/
|
|
1961
|
+
ResourceArn: ResourceArn;
|
|
1962
|
+
}
|
|
1963
|
+
export interface ListTagsForResourceResponse {
|
|
1964
|
+
/**
|
|
1965
|
+
* A list of key-value tags assigned to the resource.
|
|
1966
|
+
*/
|
|
1967
|
+
Tags?: TagMap;
|
|
1968
|
+
}
|
|
1921
1969
|
export type MaxFaces = number;
|
|
1922
1970
|
export type MaxFacesToIndex = number;
|
|
1923
1971
|
export type MaxResults = number;
|
|
@@ -2218,6 +2266,7 @@ declare namespace Rekognition {
|
|
|
2218
2266
|
}
|
|
2219
2267
|
export type RegionsOfInterest = RegionOfInterest[];
|
|
2220
2268
|
export type RekognitionUniqueId = string;
|
|
2269
|
+
export type ResourceArn = string;
|
|
2221
2270
|
export type RoleArn = string;
|
|
2222
2271
|
export type S3Bucket = string;
|
|
2223
2272
|
export type S3KeyPrefix = string;
|
|
@@ -2721,6 +2770,22 @@ declare namespace Rekognition {
|
|
|
2721
2770
|
*/
|
|
2722
2771
|
Confidence?: Percent;
|
|
2723
2772
|
}
|
|
2773
|
+
export type TagKey = string;
|
|
2774
|
+
export type TagKeyList = TagKey[];
|
|
2775
|
+
export type TagMap = {[key: string]: TagValue};
|
|
2776
|
+
export interface TagResourceRequest {
|
|
2777
|
+
/**
|
|
2778
|
+
* Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to assign the tags to.
|
|
2779
|
+
*/
|
|
2780
|
+
ResourceArn: ResourceArn;
|
|
2781
|
+
/**
|
|
2782
|
+
* The key-value tags to assign to the resource.
|
|
2783
|
+
*/
|
|
2784
|
+
Tags: TagMap;
|
|
2785
|
+
}
|
|
2786
|
+
export interface TagResourceResponse {
|
|
2787
|
+
}
|
|
2788
|
+
export type TagValue = string;
|
|
2724
2789
|
export interface TechnicalCueSegment {
|
|
2725
2790
|
/**
|
|
2726
2791
|
* The type of the technical cue.
|
|
@@ -2830,6 +2895,18 @@ declare namespace Rekognition {
|
|
|
2830
2895
|
FaceDetail?: FaceDetail;
|
|
2831
2896
|
}
|
|
2832
2897
|
export type UnindexedFaces = UnindexedFace[];
|
|
2898
|
+
export interface UntagResourceRequest {
|
|
2899
|
+
/**
|
|
2900
|
+
* Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to remove the tags from.
|
|
2901
|
+
*/
|
|
2902
|
+
ResourceArn: ResourceArn;
|
|
2903
|
+
/**
|
|
2904
|
+
* A list of the tags that you want to remove.
|
|
2905
|
+
*/
|
|
2906
|
+
TagKeys: TagKeyList;
|
|
2907
|
+
}
|
|
2908
|
+
export interface UntagResourceResponse {
|
|
2909
|
+
}
|
|
2833
2910
|
export type Url = string;
|
|
2834
2911
|
export type Urls = Url[];
|
|
2835
2912
|
export interface ValidationData {
|
package/clients/sagemaker.d.ts
CHANGED
|
@@ -333,11 +333,11 @@ declare class SageMaker extends Service {
|
|
|
333
333
|
*/
|
|
334
334
|
createProject(callback?: (err: AWSError, data: SageMaker.Types.CreateProjectOutput) => void): Request<SageMaker.Types.CreateProjectOutput, AWSError>;
|
|
335
335
|
/**
|
|
336
|
-
* Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inference. In the request body, you provide the following: AlgorithmSpecification - Identifies the training algorithm to use. HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored. OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training. ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training. RoleArn - The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training. StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to wait for a managed spot training job to complete. For more information about Amazon SageMaker, see How It Works.
|
|
336
|
+
* Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inference. In the request body, you provide the following: AlgorithmSpecification - Identifies the training algorithm to use. HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored. OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training. ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training. RoleArn - The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training. StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to wait for a managed spot training job to complete. Environment - The environment variables to set in the Docker container. For more information about Amazon SageMaker, see How It Works.
|
|
337
337
|
*/
|
|
338
338
|
createTrainingJob(params: SageMaker.Types.CreateTrainingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateTrainingJobResponse) => void): Request<SageMaker.Types.CreateTrainingJobResponse, AWSError>;
|
|
339
339
|
/**
|
|
340
|
-
* Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inference. In the request body, you provide the following: AlgorithmSpecification - Identifies the training algorithm to use. HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored. OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training. ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training. RoleArn - The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training. StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to wait for a managed spot training job to complete. For more information about Amazon SageMaker, see How It Works.
|
|
340
|
+
* Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inference. In the request body, you provide the following: AlgorithmSpecification - Identifies the training algorithm to use. HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored. OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training. ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training. RoleArn - The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training. StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to wait for a managed spot training job to complete. Environment - The environment variables to set in the Docker container. For more information about Amazon SageMaker, see How It Works.
|
|
341
341
|
*/
|
|
342
342
|
createTrainingJob(callback?: (err: AWSError, data: SageMaker.Types.CreateTrainingJobResponse) => void): Request<SageMaker.Types.CreateTrainingJobResponse, AWSError>;
|
|
343
343
|
/**
|
|
@@ -2502,7 +2502,7 @@ declare namespace SageMaker {
|
|
|
2502
2502
|
MetricName: AutoMLMetricEnum;
|
|
2503
2503
|
}
|
|
2504
2504
|
export type AutoMLJobObjectiveType = "Maximize"|"Minimize"|string;
|
|
2505
|
-
export type AutoMLJobSecondaryStatus = "Starting"|"AnalyzingData"|"FeatureEngineering"|"ModelTuning"|"MaxCandidatesReached"|"Failed"|"Stopped"|"MaxAutoMLJobRuntimeReached"|"Stopping"|"CandidateDefinitionsGenerated"|string;
|
|
2505
|
+
export type AutoMLJobSecondaryStatus = "Starting"|"AnalyzingData"|"FeatureEngineering"|"ModelTuning"|"MaxCandidatesReached"|"Failed"|"Stopped"|"MaxAutoMLJobRuntimeReached"|"Stopping"|"CandidateDefinitionsGenerated"|"GeneratingExplainabilityReport"|"Completed"|"ExplainabilityError"|string;
|
|
2506
2506
|
export type AutoMLJobStatus = "Completed"|"InProgress"|"Failed"|"Stopped"|"Stopping"|string;
|
|
2507
2507
|
export type AutoMLJobSummaries = AutoMLJobSummary[];
|
|
2508
2508
|
export interface AutoMLJobSummary {
|
|
@@ -3350,7 +3350,7 @@ declare namespace SageMaker {
|
|
|
3350
3350
|
*/
|
|
3351
3351
|
AuthMode: AuthMode;
|
|
3352
3352
|
/**
|
|
3353
|
-
* The default user settings.
|
|
3353
|
+
* The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API. SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.
|
|
3354
3354
|
*/
|
|
3355
3355
|
DefaultUserSettings: UserSettings;
|
|
3356
3356
|
/**
|
|
@@ -4272,6 +4272,10 @@ declare namespace SageMaker {
|
|
|
4272
4272
|
* Configuration information for Debugger rules for profiling system and framework metrics.
|
|
4273
4273
|
*/
|
|
4274
4274
|
ProfilerRuleConfigurations?: ProfilerRuleConfigurations;
|
|
4275
|
+
/**
|
|
4276
|
+
* The environment variables to set in the Docker container.
|
|
4277
|
+
*/
|
|
4278
|
+
Environment?: TrainingEnvironmentMap;
|
|
4275
4279
|
}
|
|
4276
4280
|
export interface CreateTrainingJobResponse {
|
|
4277
4281
|
/**
|
|
@@ -5728,7 +5732,7 @@ declare namespace SageMaker {
|
|
|
5728
5732
|
*/
|
|
5729
5733
|
AuthMode?: AuthMode;
|
|
5730
5734
|
/**
|
|
5731
|
-
* Settings which are applied to
|
|
5735
|
+
* Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
|
|
5732
5736
|
*/
|
|
5733
5737
|
DefaultUserSettings?: UserSettings;
|
|
5734
5738
|
/**
|
|
@@ -7157,6 +7161,10 @@ declare namespace SageMaker {
|
|
|
7157
7161
|
* Profiling status of a training job.
|
|
7158
7162
|
*/
|
|
7159
7163
|
ProfilingStatus?: ProfilingStatus;
|
|
7164
|
+
/**
|
|
7165
|
+
* The environment variables to set in the Docker container.
|
|
7166
|
+
*/
|
|
7167
|
+
Environment?: TrainingEnvironmentMap;
|
|
7160
7168
|
}
|
|
7161
7169
|
export interface DescribeTransformJobRequest {
|
|
7162
7170
|
/**
|
|
@@ -8938,7 +8946,7 @@ declare namespace SageMaker {
|
|
|
8938
8946
|
*/
|
|
8939
8947
|
S3DataSource?: LabelingJobS3DataSource;
|
|
8940
8948
|
/**
|
|
8941
|
-
* An Amazon SNS data source used for streaming labeling jobs.
|
|
8949
|
+
* An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.
|
|
8942
8950
|
*/
|
|
8943
8951
|
SnsDataSource?: LabelingJobSnsDataSource;
|
|
8944
8952
|
}
|
|
@@ -8996,17 +9004,17 @@ declare namespace SageMaker {
|
|
|
8996
9004
|
*/
|
|
8997
9005
|
S3OutputPath: S3Uri;
|
|
8998
9006
|
/**
|
|
8999
|
-
* The AWS Key Management Service ID of the key used to encrypt the output data, if any. If you
|
|
9007
|
+
* The AWS Key Management Service ID of the key used to encrypt the output data, if any. If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with AWS KMS. If you don't provide a KMS key ID, Amazon SageMaker uses the default AWS KMS key for Amazon S3 for your role's account to encrypt your output data. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
|
|
9000
9008
|
*/
|
|
9001
9009
|
KmsKeyId?: KmsKeyId;
|
|
9002
9010
|
/**
|
|
9003
|
-
* An Amazon Simple Notification Service (Amazon SNS) output topic ARN.
|
|
9011
|
+
* An Amazon Simple Notification Service (Amazon SNS) output topic ARN. If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here. To learn more, see Receive Output Data from a Streaming Labeling Job.
|
|
9004
9012
|
*/
|
|
9005
9013
|
SnsTopicArn?: SnsTopicArn;
|
|
9006
9014
|
}
|
|
9007
9015
|
export interface LabelingJobResourceConfig {
|
|
9008
9016
|
/**
|
|
9009
|
-
* The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:
|
|
9017
|
+
* The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling. You can only specify a VolumeKmsKeyId when you create a labeling job with automated data labeling enabled using the API operation CreateLabelingJob. You cannot specify an AWS KMS customer managed CMK to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see Output Data and Storage Volume Encryption. The VolumeKmsKeyId can be any of the following formats: KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
9010
9018
|
*/
|
|
9011
9019
|
VolumeKmsKeyId?: KmsKeyId;
|
|
9012
9020
|
}
|
|
@@ -9018,7 +9026,7 @@ declare namespace SageMaker {
|
|
|
9018
9026
|
}
|
|
9019
9027
|
export interface LabelingJobSnsDataSource {
|
|
9020
9028
|
/**
|
|
9021
|
-
* The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.
|
|
9029
|
+
* The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.
|
|
9022
9030
|
*/
|
|
9023
9031
|
SnsTopicArn: SnsTopicArn;
|
|
9024
9032
|
}
|
|
@@ -13954,6 +13962,9 @@ declare namespace SageMaker {
|
|
|
13954
13962
|
CanarySize?: CapacitySize;
|
|
13955
13963
|
}
|
|
13956
13964
|
export type TrafficRoutingConfigType = "ALL_AT_ONCE"|"CANARY"|string;
|
|
13965
|
+
export type TrainingEnvironmentKey = string;
|
|
13966
|
+
export type TrainingEnvironmentMap = {[key: string]: TrainingEnvironmentValue};
|
|
13967
|
+
export type TrainingEnvironmentValue = string;
|
|
13957
13968
|
export type TrainingInputMode = "Pipe"|"File"|string;
|
|
13958
13969
|
export type TrainingInstanceCount = number;
|
|
13959
13970
|
export type TrainingInstanceType = "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"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.p3dn.24xlarge"|"ml.p4d.24xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5n.xlarge"|"ml.c5n.2xlarge"|"ml.c5n.4xlarge"|"ml.c5n.9xlarge"|"ml.c5n.18xlarge"|string;
|
|
@@ -14083,6 +14094,10 @@ declare namespace SageMaker {
|
|
|
14083
14094
|
* Information about the evaluation status of the rules for the training job.
|
|
14084
14095
|
*/
|
|
14085
14096
|
DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatuses;
|
|
14097
|
+
/**
|
|
14098
|
+
* The environment variables to set in the Docker container.
|
|
14099
|
+
*/
|
|
14100
|
+
Environment?: TrainingEnvironmentMap;
|
|
14086
14101
|
/**
|
|
14087
14102
|
* An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
|
|
14088
14103
|
*/
|
|
@@ -15377,7 +15392,7 @@ declare namespace SageMaker {
|
|
|
15377
15392
|
*/
|
|
15378
15393
|
SecurityGroups?: SecurityGroupIds;
|
|
15379
15394
|
/**
|
|
15380
|
-
*
|
|
15395
|
+
* Specifies options for sharing SageMaker Studio notebooks.
|
|
15381
15396
|
*/
|
|
15382
15397
|
SharingSettings?: SharingSettings;
|
|
15383
15398
|
/**
|
package/clients/sqs.d.ts
CHANGED
|
@@ -638,7 +638,7 @@ declare namespace SQS {
|
|
|
638
638
|
*/
|
|
639
639
|
MessageId: String;
|
|
640
640
|
/**
|
|
641
|
-
* An MD5 digest of the non-URL-encoded message
|
|
641
|
+
* An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
|
|
642
642
|
*/
|
|
643
643
|
MD5OfMessageBody: String;
|
|
644
644
|
/**
|
|
@@ -687,7 +687,7 @@ declare namespace SQS {
|
|
|
687
687
|
}
|
|
688
688
|
export interface SendMessageResult {
|
|
689
689
|
/**
|
|
690
|
-
* An MD5 digest of the non-URL-encoded message
|
|
690
|
+
* An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
|
|
691
691
|
*/
|
|
692
692
|
MD5OfMessageBody?: String;
|
|
693
693
|
/**
|
|
@@ -987,7 +987,7 @@ declare namespace TranscribeService {
|
|
|
987
987
|
*/
|
|
988
988
|
VocabularyFilterName?: VocabularyFilterName;
|
|
989
989
|
/**
|
|
990
|
-
* Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text.
|
|
990
|
+
* Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
|
|
991
991
|
*/
|
|
992
992
|
VocabularyFilterMethod?: VocabularyFilterMethod;
|
|
993
993
|
}
|
|
@@ -1352,7 +1352,7 @@ declare namespace TranscribeService {
|
|
|
1352
1352
|
*/
|
|
1353
1353
|
LastModifiedTime?: DateTime;
|
|
1354
1354
|
}
|
|
1355
|
-
export type VocabularyFilterMethod = "remove"|"mask"|string;
|
|
1355
|
+
export type VocabularyFilterMethod = "remove"|"mask"|"tag"|string;
|
|
1356
1356
|
export type VocabularyFilterName = string;
|
|
1357
1357
|
export type VocabularyFilters = VocabularyFilterInfo[];
|
|
1358
1358
|
export interface VocabularyInfo {
|
package/clients/wafv2.d.ts
CHANGED
|
@@ -300,11 +300,11 @@ declare class WAFV2 extends Service {
|
|
|
300
300
|
*/
|
|
301
301
|
untagResource(callback?: (err: AWSError, data: WAFV2.Types.UntagResourceResponse) => void): Request<WAFV2.Types.UntagResourceResponse, AWSError>;
|
|
302
302
|
/**
|
|
303
|
-
* Updates the specified IPSet.
|
|
303
|
+
* Updates the specified IPSet.
|
|
304
304
|
*/
|
|
305
305
|
updateIPSet(params: WAFV2.Types.UpdateIPSetRequest, callback?: (err: AWSError, data: WAFV2.Types.UpdateIPSetResponse) => void): Request<WAFV2.Types.UpdateIPSetResponse, AWSError>;
|
|
306
306
|
/**
|
|
307
|
-
* Updates the specified IPSet.
|
|
307
|
+
* Updates the specified IPSet.
|
|
308
308
|
*/
|
|
309
309
|
updateIPSet(callback?: (err: AWSError, data: WAFV2.Types.UpdateIPSetResponse) => void): Request<WAFV2.Types.UpdateIPSetResponse, AWSError>;
|
|
310
310
|
/**
|
|
@@ -339,6 +339,10 @@ declare namespace WAFV2 {
|
|
|
339
339
|
export interface AllQueryArguments {
|
|
340
340
|
}
|
|
341
341
|
export interface AllowAction {
|
|
342
|
+
/**
|
|
343
|
+
* Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.
|
|
344
|
+
*/
|
|
345
|
+
CustomRequestHandling?: CustomRequestHandling;
|
|
342
346
|
}
|
|
343
347
|
export interface AndStatement {
|
|
344
348
|
/**
|
|
@@ -359,6 +363,10 @@ declare namespace WAFV2 {
|
|
|
359
363
|
export interface AssociateWebACLResponse {
|
|
360
364
|
}
|
|
361
365
|
export interface BlockAction {
|
|
366
|
+
/**
|
|
367
|
+
* Defines a custom response for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.
|
|
368
|
+
*/
|
|
369
|
+
CustomResponse?: CustomResponse;
|
|
362
370
|
}
|
|
363
371
|
export interface Body {
|
|
364
372
|
}
|
|
@@ -402,6 +410,10 @@ declare namespace WAFV2 {
|
|
|
402
410
|
export type ComparisonOperator = "EQ"|"NE"|"LE"|"LT"|"GE"|"GT"|string;
|
|
403
411
|
export type ConsumedCapacity = number;
|
|
404
412
|
export interface CountAction {
|
|
413
|
+
/**
|
|
414
|
+
* Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.
|
|
415
|
+
*/
|
|
416
|
+
CustomRequestHandling?: CustomRequestHandling;
|
|
405
417
|
}
|
|
406
418
|
export type Country = string;
|
|
407
419
|
export type CountryCode = "AF"|"AX"|"AL"|"DZ"|"AS"|"AD"|"AO"|"AI"|"AQ"|"AG"|"AR"|"AM"|"AW"|"AU"|"AT"|"AZ"|"BS"|"BH"|"BD"|"BB"|"BY"|"BE"|"BZ"|"BJ"|"BM"|"BT"|"BO"|"BQ"|"BA"|"BW"|"BV"|"BR"|"IO"|"BN"|"BG"|"BF"|"BI"|"KH"|"CM"|"CA"|"CV"|"KY"|"CF"|"TD"|"CL"|"CN"|"CX"|"CC"|"CO"|"KM"|"CG"|"CD"|"CK"|"CR"|"CI"|"HR"|"CU"|"CW"|"CY"|"CZ"|"DK"|"DJ"|"DM"|"DO"|"EC"|"EG"|"SV"|"GQ"|"ER"|"EE"|"ET"|"FK"|"FO"|"FJ"|"FI"|"FR"|"GF"|"PF"|"TF"|"GA"|"GM"|"GE"|"DE"|"GH"|"GI"|"GR"|"GL"|"GD"|"GP"|"GU"|"GT"|"GG"|"GN"|"GW"|"GY"|"HT"|"HM"|"VA"|"HN"|"HK"|"HU"|"IS"|"IN"|"ID"|"IR"|"IQ"|"IE"|"IM"|"IL"|"IT"|"JM"|"JP"|"JE"|"JO"|"KZ"|"KE"|"KI"|"KP"|"KR"|"KW"|"KG"|"LA"|"LV"|"LB"|"LS"|"LR"|"LY"|"LI"|"LT"|"LU"|"MO"|"MK"|"MG"|"MW"|"MY"|"MV"|"ML"|"MT"|"MH"|"MQ"|"MR"|"MU"|"YT"|"MX"|"FM"|"MD"|"MC"|"MN"|"ME"|"MS"|"MA"|"MZ"|"MM"|"NA"|"NR"|"NP"|"NL"|"NC"|"NZ"|"NI"|"NE"|"NG"|"NU"|"NF"|"MP"|"NO"|"OM"|"PK"|"PW"|"PS"|"PA"|"PG"|"PY"|"PE"|"PH"|"PN"|"PL"|"PT"|"PR"|"QA"|"RE"|"RO"|"RU"|"RW"|"BL"|"SH"|"KN"|"LC"|"MF"|"PM"|"VC"|"WS"|"SM"|"ST"|"SA"|"SN"|"RS"|"SC"|"SL"|"SG"|"SX"|"SK"|"SI"|"SB"|"SO"|"ZA"|"GS"|"SS"|"ES"|"LK"|"SD"|"SR"|"SJ"|"SZ"|"SE"|"CH"|"SY"|"TW"|"TJ"|"TZ"|"TH"|"TL"|"TG"|"TK"|"TO"|"TT"|"TN"|"TR"|"TM"|"TC"|"TV"|"UG"|"UA"|"AE"|"GB"|"US"|"UM"|"UY"|"UZ"|"VU"|"VE"|"VN"|"VG"|"VI"|"WF"|"EH"|"YE"|"ZM"|"ZW"|string;
|
|
@@ -495,6 +507,10 @@ declare namespace WAFV2 {
|
|
|
495
507
|
* An array of key:value pairs to associate with the resource.
|
|
496
508
|
*/
|
|
497
509
|
Tags?: TagList;
|
|
510
|
+
/**
|
|
511
|
+
* 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 rule group, and then use them in the rules that you define in the rule group. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.
|
|
512
|
+
*/
|
|
513
|
+
CustomResponseBodies?: CustomResponseBodies;
|
|
498
514
|
}
|
|
499
515
|
export interface CreateRuleGroupResponse {
|
|
500
516
|
/**
|
|
@@ -531,6 +547,10 @@ declare namespace WAFV2 {
|
|
|
531
547
|
* An array of key:value pairs to associate with the resource.
|
|
532
548
|
*/
|
|
533
549
|
Tags?: TagList;
|
|
550
|
+
/**
|
|
551
|
+
* 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 AWS WAF in the AWS WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.
|
|
552
|
+
*/
|
|
553
|
+
CustomResponseBodies?: CustomResponseBodies;
|
|
534
554
|
}
|
|
535
555
|
export interface CreateWebACLResponse {
|
|
536
556
|
/**
|
|
@@ -538,6 +558,50 @@ declare namespace WAFV2 {
|
|
|
538
558
|
*/
|
|
539
559
|
Summary?: WebACLSummary;
|
|
540
560
|
}
|
|
561
|
+
export interface CustomHTTPHeader {
|
|
562
|
+
/**
|
|
563
|
+
* The name of the custom header. For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, AWS WAF inserts the header x-amzn-waf-sample.
|
|
564
|
+
*/
|
|
565
|
+
Name: CustomHTTPHeaderName;
|
|
566
|
+
/**
|
|
567
|
+
* The value of the custom header.
|
|
568
|
+
*/
|
|
569
|
+
Value: CustomHTTPHeaderValue;
|
|
570
|
+
}
|
|
571
|
+
export type CustomHTTPHeaderName = string;
|
|
572
|
+
export type CustomHTTPHeaderValue = string;
|
|
573
|
+
export type CustomHTTPHeaders = CustomHTTPHeader[];
|
|
574
|
+
export interface CustomRequestHandling {
|
|
575
|
+
/**
|
|
576
|
+
* The HTTP headers to insert into the request. Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.
|
|
577
|
+
*/
|
|
578
|
+
InsertHeaders: CustomHTTPHeaders;
|
|
579
|
+
}
|
|
580
|
+
export interface CustomResponse {
|
|
581
|
+
/**
|
|
582
|
+
* The HTTP status code to return to the client. For a list of status codes that you can use in your custom reqponses, see Supported status codes for custom response in the AWS WAF Developer Guide.
|
|
583
|
+
*/
|
|
584
|
+
ResponseCode: ResponseStatusCode;
|
|
585
|
+
/**
|
|
586
|
+
* References the response body that you want AWS WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.
|
|
587
|
+
*/
|
|
588
|
+
CustomResponseBodyKey?: EntityName;
|
|
589
|
+
/**
|
|
590
|
+
* The HTTP headers to use in the response. Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.
|
|
591
|
+
*/
|
|
592
|
+
ResponseHeaders?: CustomHTTPHeaders;
|
|
593
|
+
}
|
|
594
|
+
export type CustomResponseBodies = {[key: string]: CustomResponseBody};
|
|
595
|
+
export interface CustomResponseBody {
|
|
596
|
+
/**
|
|
597
|
+
* The type of content in the payload that you are defining in the Content string.
|
|
598
|
+
*/
|
|
599
|
+
ContentType: ResponseContentType;
|
|
600
|
+
/**
|
|
601
|
+
* The payload of the custom response. You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.
|
|
602
|
+
*/
|
|
603
|
+
Content: ResponseContent;
|
|
604
|
+
}
|
|
541
605
|
export interface DefaultAction {
|
|
542
606
|
/**
|
|
543
607
|
* Specifies that AWS WAF should block requests by default.
|
|
@@ -1105,7 +1169,7 @@ declare namespace WAFV2 {
|
|
|
1105
1169
|
*/
|
|
1106
1170
|
MatchScope: JsonMatchScope;
|
|
1107
1171
|
/**
|
|
1108
|
-
*
|
|
1172
|
+
* The inspection behavior to fall back to if the JSON in the request body is invalid. For AWS WAF, invalid JSON is any content that isn't complete syntactical JSON, content whose root node isn't an object or an array, and duplicate keys in the content. You can specify the following fallback behaviors: MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. NO_MATCH - Treat the web request as not matching the rule statement. EVALUATE_AS_STRING - Inspect the body as plain text. This option applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string. If you don't provide this setting, when AWS WAF encounters invalid JSON, it parses and inspects what it can, up to the first invalid JSON that it encounters.
|
|
1109
1173
|
*/
|
|
1110
1174
|
InvalidFallbackBehavior?: BodyParsingFallbackBehavior;
|
|
1111
1175
|
}
|
|
@@ -1513,6 +1577,9 @@ declare namespace WAFV2 {
|
|
|
1513
1577
|
export type ResourceArn = string;
|
|
1514
1578
|
export type ResourceArns = ResourceArn[];
|
|
1515
1579
|
export type ResourceType = "APPLICATION_LOAD_BALANCER"|"API_GATEWAY"|"APPSYNC"|string;
|
|
1580
|
+
export type ResponseContent = string;
|
|
1581
|
+
export type ResponseContentType = "TEXT_PLAIN"|"TEXT_HTML"|"APPLICATION_JSON"|string;
|
|
1582
|
+
export type ResponseStatusCode = number;
|
|
1516
1583
|
export interface Rule {
|
|
1517
1584
|
/**
|
|
1518
1585
|
* The name of the rule. You can't change the name of a Rule after you create it.
|
|
@@ -1582,6 +1649,10 @@ declare namespace WAFV2 {
|
|
|
1582
1649
|
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
|
|
1583
1650
|
*/
|
|
1584
1651
|
VisibilityConfig: VisibilityConfig;
|
|
1652
|
+
/**
|
|
1653
|
+
* 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 rule group, and then use them in the rules that you define in the rule group. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.
|
|
1654
|
+
*/
|
|
1655
|
+
CustomResponseBodies?: CustomResponseBodies;
|
|
1585
1656
|
}
|
|
1586
1657
|
export interface RuleGroupReferenceStatement {
|
|
1587
1658
|
/**
|
|
@@ -1648,6 +1719,14 @@ declare namespace WAFV2 {
|
|
|
1648
1719
|
* The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.
|
|
1649
1720
|
*/
|
|
1650
1721
|
RuleNameWithinRuleGroup?: EntityName;
|
|
1722
|
+
/**
|
|
1723
|
+
* Custom request headers inserted by AWS WAF into the request, according to the custom request configuration for the matching rule action.
|
|
1724
|
+
*/
|
|
1725
|
+
RequestHeadersInserted?: HTTPHeaders;
|
|
1726
|
+
/**
|
|
1727
|
+
* The response code that was sent for the request.
|
|
1728
|
+
*/
|
|
1729
|
+
ResponseCodeSent?: ResponseStatusCode;
|
|
1651
1730
|
}
|
|
1652
1731
|
export type SampledHTTPRequests = SampledHTTPRequest[];
|
|
1653
1732
|
export type Scope = "CLOUDFRONT"|"REGIONAL"|string;
|
|
@@ -1914,6 +1993,10 @@ declare namespace WAFV2 {
|
|
|
1914
1993
|
* A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
|
|
1915
1994
|
*/
|
|
1916
1995
|
LockToken: LockToken;
|
|
1996
|
+
/**
|
|
1997
|
+
* 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 rule group, and then use them in the rules that you define in the rule group. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.
|
|
1998
|
+
*/
|
|
1999
|
+
CustomResponseBodies?: CustomResponseBodies;
|
|
1917
2000
|
}
|
|
1918
2001
|
export interface UpdateRuleGroupResponse {
|
|
1919
2002
|
/**
|
|
@@ -1954,6 +2037,10 @@ declare namespace WAFV2 {
|
|
|
1954
2037
|
* A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
|
|
1955
2038
|
*/
|
|
1956
2039
|
LockToken: LockToken;
|
|
2040
|
+
/**
|
|
2041
|
+
* 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 AWS WAF in the AWS WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.
|
|
2042
|
+
*/
|
|
2043
|
+
CustomResponseBodies?: CustomResponseBodies;
|
|
1957
2044
|
}
|
|
1958
2045
|
export interface UpdateWebACLResponse {
|
|
1959
2046
|
/**
|
|
@@ -2023,6 +2110,10 @@ declare namespace WAFV2 {
|
|
|
2023
2110
|
* Indicates whether this web ACL is managed by AWS Firewall Manager. If true, then only AWS Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.
|
|
2024
2111
|
*/
|
|
2025
2112
|
ManagedByFirewallManager?: Boolean;
|
|
2113
|
+
/**
|
|
2114
|
+
* 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 AWS WAF in the AWS WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.
|
|
2115
|
+
*/
|
|
2116
|
+
CustomResponseBodies?: CustomResponseBodies;
|
|
2026
2117
|
}
|
|
2027
2118
|
export type WebACLSummaries = WebACLSummary[];
|
|
2028
2119
|
export interface WebACLSummary {
|