@aws-sdk/client-rekognition 3.78.0 → 3.79.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.
Files changed (42) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +198 -1
  3. package/dist-cjs/Rekognition.js +15 -0
  4. package/dist-cjs/commands/UpdateStreamProcessorCommand.js +36 -0
  5. package/dist-cjs/commands/index.js +1 -0
  6. package/dist-cjs/models/models_0.js +89 -17
  7. package/dist-cjs/protocols/Aws_json1_1.js +291 -3
  8. package/dist-es/Rekognition.js +15 -0
  9. package/dist-es/commands/UpdateStreamProcessorCommand.js +39 -0
  10. package/dist-es/commands/index.js +1 -0
  11. package/dist-es/models/models_0.js +58 -8
  12. package/dist-es/protocols/Aws_json1_1.js +277 -9
  13. package/dist-types/Rekognition.d.ts +247 -24
  14. package/dist-types/RekognitionClient.d.ts +205 -3
  15. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +17 -6
  16. package/dist-types/commands/DeleteCollectionCommand.d.ts +1 -1
  17. package/dist-types/commands/DetectLabelsCommand.d.ts +1 -1
  18. package/dist-types/commands/DetectTextCommand.d.ts +1 -1
  19. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +1 -1
  20. package/dist-types/commands/GetContentModerationCommand.d.ts +1 -1
  21. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +1 -1
  22. package/dist-types/commands/IndexFacesCommand.d.ts +2 -2
  23. package/dist-types/commands/ListCollectionsCommand.d.ts +1 -1
  24. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +2 -2
  25. package/dist-types/commands/SearchFacesCommand.d.ts +1 -1
  26. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +1 -1
  27. package/dist-types/commands/StartContentModerationCommand.d.ts +1 -1
  28. package/dist-types/commands/StartFaceDetectionCommand.d.ts +1 -1
  29. package/dist-types/commands/StartFaceSearchCommand.d.ts +2 -1
  30. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +1 -1
  31. package/dist-types/commands/StartStreamProcessorCommand.d.ts +1 -0
  32. package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +37 -0
  33. package/dist-types/commands/index.d.ts +1 -0
  34. package/dist-types/models/models_0.d.ts +450 -84
  35. package/dist-types/protocols/Aws_json1_1.d.ts +3 -0
  36. package/dist-types/ts3.4/Rekognition.d.ts +5 -0
  37. package/dist-types/ts3.4/RekognitionClient.d.ts +3 -2
  38. package/dist-types/ts3.4/commands/UpdateStreamProcessorCommand.d.ts +17 -0
  39. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  40. package/dist-types/ts3.4/models/models_0.d.ts +165 -21
  41. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +3 -0
  42. package/package.json +8 -8
@@ -45,7 +45,7 @@ export declare namespace AgeRange {
45
45
  * Amazon Rekognition operations.</p>
46
46
  *
47
47
  * <p>For Amazon Rekognition to process an S3 object, the user must have permission to
48
- * access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition
48
+ * access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition
49
49
  * Developer Guide. </p>
50
50
  */
51
51
  export interface S3Object {
@@ -79,7 +79,7 @@ export interface GroundTruthManifest {
79
79
  * Amazon Rekognition operations.</p>
80
80
  *
81
81
  * <p>For Amazon Rekognition to process an S3 object, the user must have permission to
82
- * access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition
82
+ * access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition
83
83
  * Developer Guide. </p>
84
84
  */
85
85
  S3Object?: S3Object;
@@ -203,7 +203,7 @@ export declare enum BodyPart {
203
203
  RIGHT_HAND = "RIGHT_HAND"
204
204
  }
205
205
  /**
206
- * <p>Identifies the bounding box around the label, face, text or personal protective equipment.
206
+ * <p>Identifies the bounding box around the label, face, text, object of interest, or personal protective equipment.
207
207
  * The <code>left</code> (x-coordinate) and <code>top</code> (y-coordinate) are coordinates representing the top and
208
208
  * left sides of the bounding box. Note that the upper-left corner of the image is the origin
209
209
  * (0,0). </p>
@@ -634,8 +634,7 @@ export declare enum GenderType {
634
634
  * <p>Using Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be
635
635
  * analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform. </p>
636
636
  *
637
- * <p>We don't recommend using gender binary predictions to make decisions that impact
638
- an individual's rights, privacy, or access to services.</p>
637
+ * <p>We don't recommend using gender binary predictions to make decisions that impact an individual's rights, privacy, or access to services.</p>
639
638
  */
640
639
  export interface Gender {
641
640
  /**
@@ -933,7 +932,7 @@ export declare enum QualityFilter {
933
932
  * call the operation using the S3Object property.</p>
934
933
  *
935
934
  * <p>For Amazon Rekognition to process an S3 object, the user must have permission to access the S3
936
- * object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
935
+ * object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.
937
936
  * </p>
938
937
  */
939
938
  export interface Image {
@@ -1081,7 +1080,7 @@ export declare namespace CompareFacesResponse {
1081
1080
  /**
1082
1081
  * <p>The input image size exceeds the allowed limit. If you are calling
1083
1082
  * DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see
1084
- * Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
1083
+ * Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
1085
1084
  */
1086
1085
  export declare class ImageTooLargeException extends __BaseException {
1087
1086
  readonly name: "ImageTooLargeException";
@@ -1201,6 +1200,60 @@ export declare class ThrottlingException extends __BaseException {
1201
1200
  */
1202
1201
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
1203
1202
  }
1203
+ /**
1204
+ * <p>
1205
+ * Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for <a>CreateStreamProcessor</a>.
1206
+ * Including this setting in the <code>CreateStreamProcessor</code> request enables you to use the stream processor for label detection.
1207
+ * You can then select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification
1208
+ * is sent for each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is detected
1209
+ * and one SNS notification is published the first time a pet is detected, as well as an end-of-session summary.
1210
+ * </p>
1211
+ */
1212
+ export interface ConnectedHomeSettings {
1213
+ /**
1214
+ * <p>
1215
+ * Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".
1216
+ * </p>
1217
+ */
1218
+ Labels: string[] | undefined;
1219
+ /**
1220
+ * <p>
1221
+ * The minimum confidence required to label an object in the video.
1222
+ * </p>
1223
+ */
1224
+ MinConfidence?: number;
1225
+ }
1226
+ export declare namespace ConnectedHomeSettings {
1227
+ /**
1228
+ * @internal
1229
+ */
1230
+ const filterSensitiveLog: (obj: ConnectedHomeSettings) => any;
1231
+ }
1232
+ /**
1233
+ * <p>
1234
+ * The label detection settings you want to use in your stream processor. This includes the labels you want the stream processor to detect and the minimum confidence level allowed to label objects.
1235
+ * </p>
1236
+ */
1237
+ export interface ConnectedHomeSettingsForUpdate {
1238
+ /**
1239
+ * <p>
1240
+ * Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".
1241
+ * </p>
1242
+ */
1243
+ Labels?: string[];
1244
+ /**
1245
+ * <p>
1246
+ * The minimum confidence required to label an object in the video.
1247
+ * </p>
1248
+ */
1249
+ MinConfidence?: number;
1250
+ }
1251
+ export declare namespace ConnectedHomeSettingsForUpdate {
1252
+ /**
1253
+ * @internal
1254
+ */
1255
+ const filterSensitiveLog: (obj: ConnectedHomeSettingsForUpdate) => any;
1256
+ }
1204
1257
  export declare enum ContentClassifier {
1205
1258
  FREE_OF_ADULT_CONTENT = "FreeOfAdultContent",
1206
1259
  FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION = "FreeOfPersonallyIdentifiableInformation"
@@ -1289,7 +1342,7 @@ export interface CreateCollectionResponse {
1289
1342
  */
1290
1343
  CollectionArn?: string;
1291
1344
  /**
1292
- * <p>Latest face model being used with the collection. For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html">Model versioning</a>.</p>
1345
+ * <p>Version number of the face detection model associated with the collection you are creating.</p>
1293
1346
  */
1294
1347
  FaceModelVersion?: string;
1295
1348
  }
@@ -1321,7 +1374,7 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
1321
1374
  *
1322
1375
  *
1323
1376
  * <p>The size of the collection exceeds the allowed limit. For more information, see
1324
- * Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
1377
+ * Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
1325
1378
  */
1326
1379
  export declare class ServiceQuotaExceededException extends __BaseException {
1327
1380
  readonly name: "ServiceQuotaExceededException";
@@ -1632,6 +1685,27 @@ export declare namespace CreateProjectVersionResponse {
1632
1685
  */
1633
1686
  const filterSensitiveLog: (obj: CreateProjectVersionResponse) => any;
1634
1687
  }
1688
+ /**
1689
+ * <p>
1690
+ * Allows you to opt in or opt out to share data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.
1691
+ * Note that if you opt out at the account level this setting is ignored on individual streams.
1692
+ *
1693
+ * </p>
1694
+ */
1695
+ export interface StreamProcessorDataSharingPreference {
1696
+ /**
1697
+ * <p>
1698
+ * If this option is set to true, you choose to share data with Rekognition to improve model performance.
1699
+ * </p>
1700
+ */
1701
+ OptIn: boolean | undefined;
1702
+ }
1703
+ export declare namespace StreamProcessorDataSharingPreference {
1704
+ /**
1705
+ * @internal
1706
+ */
1707
+ const filterSensitiveLog: (obj: StreamProcessorDataSharingPreference) => any;
1708
+ }
1635
1709
  /**
1636
1710
  * <p>Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see
1637
1711
  * CreateStreamProcessor in the Amazon Rekognition Developer Guide.</p>
@@ -1663,6 +1737,27 @@ export declare namespace StreamProcessorInput {
1663
1737
  */
1664
1738
  const filterSensitiveLog: (obj: StreamProcessorInput) => any;
1665
1739
  }
1740
+ /**
1741
+ * <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.</p>
1742
+ * <p>Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition
1743
+ * detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications,
1744
+ * one for a person at second 2 and one for a pet at second 4.</p>
1745
+ * <p>Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.</p>
1746
+ */
1747
+ export interface StreamProcessorNotificationChannel {
1748
+ /**
1749
+ * <p>
1750
+ * The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status.
1751
+ * </p>
1752
+ */
1753
+ SNSTopicArn: string | undefined;
1754
+ }
1755
+ export declare namespace StreamProcessorNotificationChannel {
1756
+ /**
1757
+ * @internal
1758
+ */
1759
+ const filterSensitiveLog: (obj: StreamProcessorNotificationChannel) => any;
1760
+ }
1666
1761
  /**
1667
1762
  * <p>The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see
1668
1763
  * CreateStreamProcessor in the Amazon Rekognition Developer Guide.</p>
@@ -1679,6 +1774,34 @@ export declare namespace KinesisDataStream {
1679
1774
  */
1680
1775
  const filterSensitiveLog: (obj: KinesisDataStream) => any;
1681
1776
  }
1777
+ /**
1778
+ * <p>
1779
+ * The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.
1780
+ * These results include the name of the stream processor resource, the session ID of the stream processing session,
1781
+ * and labeled timestamps and bounding boxes for detected labels.
1782
+ * </p>
1783
+ */
1784
+ export interface S3Destination {
1785
+ /**
1786
+ * <p>
1787
+ * The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be the owner of the Amazon S3 bucket.
1788
+ * </p>
1789
+ */
1790
+ Bucket?: string;
1791
+ /**
1792
+ * <p>
1793
+ * The prefix value of the location within the bucket that you want the information to be published to.
1794
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Using prefixes</a>.
1795
+ * </p>
1796
+ */
1797
+ KeyPrefix?: string;
1798
+ }
1799
+ export declare namespace S3Destination {
1800
+ /**
1801
+ * @internal
1802
+ */
1803
+ const filterSensitiveLog: (obj: S3Destination) => any;
1804
+ }
1682
1805
  /**
1683
1806
  * <p>Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more
1684
1807
  * information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.</p>
@@ -1688,6 +1811,12 @@ export interface StreamProcessorOutput {
1688
1811
  * <p>The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.</p>
1689
1812
  */
1690
1813
  KinesisDataStream?: KinesisDataStream;
1814
+ /**
1815
+ * <p>
1816
+ * The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.
1817
+ * </p>
1818
+ */
1819
+ S3Destination?: S3Destination;
1691
1820
  }
1692
1821
  export declare namespace StreamProcessorOutput {
1693
1822
  /**
@@ -1696,8 +1825,61 @@ export declare namespace StreamProcessorOutput {
1696
1825
  const filterSensitiveLog: (obj: StreamProcessorOutput) => any;
1697
1826
  }
1698
1827
  /**
1699
- * <p>Input face recognition parameters for an Amazon Rekognition stream processor. <code>FaceRecognitionSettings</code> is a request
1700
- * parameter for <a>CreateStreamProcessor</a>.</p>
1828
+ * <p>The X and Y coordinates of a point on an image or video frame. The X and Y values are ratios
1829
+ * of the overall image size or video resolution. For example, if an input image is 700x200 and the
1830
+ * values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.</p>
1831
+ *
1832
+ * <p>An array of <code>Point</code> objects makes up a <code>Polygon</code>.
1833
+ * A <code>Polygon</code> is returned by <a>DetectText</a> and by <a>DetectCustomLabels</a>
1834
+ * <code>Polygon</code>
1835
+ * represents a fine-grained polygon around a detected item. For more information, see Geometry in the
1836
+ * Amazon Rekognition Developer Guide. </p>
1837
+ */
1838
+ export interface Point {
1839
+ /**
1840
+ * <p>The value of the X coordinate for a point on a <code>Polygon</code>.</p>
1841
+ */
1842
+ X?: number;
1843
+ /**
1844
+ * <p>The value of the Y coordinate for a point on a <code>Polygon</code>.</p>
1845
+ */
1846
+ Y?: number;
1847
+ }
1848
+ export declare namespace Point {
1849
+ /**
1850
+ * @internal
1851
+ */
1852
+ const filterSensitiveLog: (obj: Point) => any;
1853
+ }
1854
+ /**
1855
+ * <p>Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a <code>BoundingBox</code>
1856
+ * or object or <code>Polygon</code> to set a region of the screen.</p>
1857
+ * <p>A word, face, or label is included in the region if it is more than half in that region. If there is more than
1858
+ * one region, the word, face, or label is compared with all regions of the screen. Any object of interest that is more than half in a region
1859
+ * is kept in the results.</p>
1860
+ */
1861
+ export interface RegionOfInterest {
1862
+ /**
1863
+ * <p>The box representing a region of interest on screen.</p>
1864
+ */
1865
+ BoundingBox?: BoundingBox;
1866
+ /**
1867
+ * <p>
1868
+ * Specifies a shape made up of up to 10 <code>Point</code> objects to define a region of interest.
1869
+ * </p>
1870
+ */
1871
+ Polygon?: Point[];
1872
+ }
1873
+ export declare namespace RegionOfInterest {
1874
+ /**
1875
+ * @internal
1876
+ */
1877
+ const filterSensitiveLog: (obj: RegionOfInterest) => any;
1878
+ }
1879
+ /**
1880
+ * <p>Input face recognition parameters for an Amazon Rekognition stream processor.
1881
+ * Includes the collection to use for face recognition and the face attributes to detect.
1882
+ * Defining the settings is required in the request parameter for <a>CreateStreamProcessor</a>.</p>
1701
1883
  */
1702
1884
  export interface FaceSearchSettings {
1703
1885
  /**
@@ -1717,13 +1899,24 @@ export declare namespace FaceSearchSettings {
1717
1899
  const filterSensitiveLog: (obj: FaceSearchSettings) => any;
1718
1900
  }
1719
1901
  /**
1720
- * <p>Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.</p>
1902
+ * <p>Input parameters used in a streaming video analyzed by a Amazon Rekognition stream processor.
1903
+ * You can use <code>FaceSearch</code> to recognize faces in a streaming video, or you can use <code>ConnectedHome</code> to detect labels. </p>
1721
1904
  */
1722
1905
  export interface StreamProcessorSettings {
1723
1906
  /**
1724
1907
  * <p>Face search settings to use on a streaming video. </p>
1725
1908
  */
1726
1909
  FaceSearch?: FaceSearchSettings;
1910
+ /**
1911
+ * <p>
1912
+ * Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for <a>CreateStreamProcessor</a>.
1913
+ * Including this setting in the <code>CreateStreamProcessor</code> request enables you to use the stream processor for label detection.
1914
+ * You can then select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification
1915
+ * is sent for each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is detected
1916
+ * and one SNS notification is published the first time a pet is detected, as well as an end-of-session summary.
1917
+ * </p>
1918
+ */
1919
+ ConnectedHome?: ConnectedHomeSettings;
1727
1920
  }
1728
1921
  export declare namespace StreamProcessorSettings {
1729
1922
  /**
@@ -1733,27 +1926,29 @@ export declare namespace StreamProcessorSettings {
1733
1926
  }
1734
1927
  export interface CreateStreamProcessorRequest {
1735
1928
  /**
1736
- * <p>Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is <code>StreamProcessorInput</code>.</p>
1929
+ * <p>Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is <code>StreamProcessorInput</code>. This is required for both face search and label detection stream processors.</p>
1737
1930
  */
1738
1931
  Input: StreamProcessorInput | undefined;
1739
1932
  /**
1740
- * <p>Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is <code>StreamProcessorOutput</code>.</p>
1933
+ * <p>Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is <code>StreamProcessorOutput</code>.
1934
+ * This must be a <a>S3Destination</a> of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.</p>
1741
1935
  */
1742
1936
  Output: StreamProcessorOutput | undefined;
1743
1937
  /**
1744
1938
  * <p>An identifier you assign to the stream processor. You can use <code>Name</code> to
1745
1939
  * manage the stream processor. For example, you can get the current status of the stream processor by calling <a>DescribeStreamProcessor</a>.
1746
- * <code>Name</code> is idempotent.
1940
+ * <code>Name</code> is idempotent. This is required for both face search and label detection stream processors.
1747
1941
  * </p>
1748
1942
  */
1749
1943
  Name: string | undefined;
1750
1944
  /**
1751
- * <p>Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face
1752
- * attributes to detect.</p>
1945
+ * <p>Input parameters used in a streaming video analyzed by a stream processor. You can use <code>FaceSearch</code> to recognize faces in a streaming video, or you can use <code>ConnectedHome</code> to detect labels.</p>
1753
1946
  */
1754
1947
  Settings: StreamProcessorSettings | undefined;
1755
1948
  /**
1756
- * <p>ARN of the IAM role that allows access to the stream processor.</p>
1949
+ * <p>The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor.
1950
+ * The IAM role provides Rekognition read permissions for a Kinesis stream.
1951
+ * It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.</p>
1757
1952
  */
1758
1953
  RoleArn: string | undefined;
1759
1954
  /**
@@ -1764,6 +1959,37 @@ export interface CreateStreamProcessorRequest {
1764
1959
  Tags?: {
1765
1960
  [key: string]: string;
1766
1961
  };
1962
+ /**
1963
+ * <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.</p>
1964
+ * <p>Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition
1965
+ * detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications,
1966
+ * one for a person at second 2 and one for a pet at second 4.</p>
1967
+ * <p>Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.</p>
1968
+ */
1969
+ NotificationChannel?: StreamProcessorNotificationChannel;
1970
+ /**
1971
+ * <p>
1972
+ * The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.
1973
+ * You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN.
1974
+ * The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.
1975
+ * </p>
1976
+ * <p>
1977
+ * </p>
1978
+ */
1979
+ KmsKeyId?: string;
1980
+ /**
1981
+ * <p>
1982
+ * Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.
1983
+ * </p>
1984
+ */
1985
+ RegionsOfInterest?: RegionOfInterest[];
1986
+ /**
1987
+ * <p>
1988
+ * Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.
1989
+ * Note that if you opt out at the account level this setting is ignored on individual streams.
1990
+ * </p>
1991
+ */
1992
+ DataSharingPreference?: StreamProcessorDataSharingPreference;
1767
1993
  }
1768
1994
  export declare namespace CreateStreamProcessorRequest {
1769
1995
  /**
@@ -1773,7 +1999,7 @@ export declare namespace CreateStreamProcessorRequest {
1773
1999
  }
1774
2000
  export interface CreateStreamProcessorResponse {
1775
2001
  /**
1776
- * <p>ARN for the newly create stream processor.</p>
2002
+ * <p>Amazon Resource Number for the newly created stream processor.</p>
1777
2003
  */
1778
2004
  StreamProcessorArn?: string;
1779
2005
  }
@@ -1783,32 +2009,6 @@ export declare namespace CreateStreamProcessorResponse {
1783
2009
  */
1784
2010
  const filterSensitiveLog: (obj: CreateStreamProcessorResponse) => any;
1785
2011
  }
1786
- /**
1787
- * <p>The X and Y coordinates of a point on an image. The X and Y values returned are ratios
1788
- * of the overall image size. For example, if the input image is 700x200 and the
1789
- * operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.</p>
1790
- *
1791
- * <p>An array of <code>Point</code> objects,
1792
- * <code>Polygon</code>, is returned by <a>DetectText</a> and by <a>DetectCustomLabels</a>. <code>Polygon</code>
1793
- * represents a fine-grained polygon around a detected item. For more information, see Geometry in the
1794
- * Amazon Rekognition Developer Guide. </p>
1795
- */
1796
- export interface Point {
1797
- /**
1798
- * <p>The value of the X coordinate for a point on a <code>Polygon</code>.</p>
1799
- */
1800
- X?: number;
1801
- /**
1802
- * <p>The value of the Y coordinate for a point on a <code>Polygon</code>.</p>
1803
- */
1804
- Y?: number;
1805
- }
1806
- export declare namespace Point {
1807
- /**
1808
- * @internal
1809
- */
1810
- const filterSensitiveLog: (obj: Point) => any;
1811
- }
1812
2012
  /**
1813
2013
  * <p>Information about where an object (<a>DetectCustomLabels</a>) or text (<a>DetectText</a>) is located on
1814
2014
  * an image.</p>
@@ -2271,7 +2471,7 @@ export interface DescribeCollectionResponse {
2271
2471
  /**
2272
2472
  * <p>The version of the face model that's used by the collection for face detection.</p>
2273
2473
  *
2274
- * <p>For more information, see Model Versioning in the
2474
+ * <p>For more information, see Model versioning in the
2275
2475
  * Amazon Rekognition Developer Guide.</p>
2276
2476
  */
2277
2477
  FaceModelVersion?: string;
@@ -2453,7 +2653,7 @@ export interface Summary {
2453
2653
  * Amazon Rekognition operations.</p>
2454
2654
  *
2455
2655
  * <p>For Amazon Rekognition to process an S3 object, the user must have permission to
2456
- * access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition
2656
+ * access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition
2457
2657
  * Developer Guide. </p>
2458
2658
  */
2459
2659
  S3Object?: S3Object;
@@ -2661,7 +2861,8 @@ export declare enum StreamProcessorStatus {
2661
2861
  RUNNING = "RUNNING",
2662
2862
  STARTING = "STARTING",
2663
2863
  STOPPED = "STOPPED",
2664
- STOPPING = "STOPPING"
2864
+ STOPPING = "STOPPING",
2865
+ UPDATING = "UPDATING"
2665
2866
  }
2666
2867
  export interface DescribeStreamProcessorResponse {
2667
2868
  /**
@@ -2702,11 +2903,37 @@ export interface DescribeStreamProcessorResponse {
2702
2903
  */
2703
2904
  RoleArn?: string;
2704
2905
  /**
2705
- * <p>Face recognition input parameters that are being used by the stream processor.
2706
- * Includes the collection to use for face recognition and the face
2707
- * attributes to detect.</p>
2906
+ * <p>Input parameters used in a streaming video analyzed by a stream processor. You can use <code>FaceSearch</code> to recognize faces
2907
+ * in a streaming video, or you can use <code>ConnectedHome</code> to detect labels.</p>
2708
2908
  */
2709
2909
  Settings?: StreamProcessorSettings;
2910
+ /**
2911
+ * <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.</p>
2912
+ * <p>Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition
2913
+ * detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications,
2914
+ * one for a person at second 2 and one for a pet at second 4.</p>
2915
+ * <p>Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.</p>
2916
+ */
2917
+ NotificationChannel?: StreamProcessorNotificationChannel;
2918
+ /**
2919
+ * <p>
2920
+ * The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.
2921
+ * </p>
2922
+ */
2923
+ KmsKeyId?: string;
2924
+ /**
2925
+ * <p>
2926
+ * Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.
2927
+ * </p>
2928
+ */
2929
+ RegionsOfInterest?: RegionOfInterest[];
2930
+ /**
2931
+ * <p>
2932
+ * Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.
2933
+ * Note that if you opt out at the account level this setting is ignored on individual streams.
2934
+ * </p>
2935
+ */
2936
+ DataSharingPreference?: StreamProcessorDataSharingPreference;
2710
2937
  }
2711
2938
  export declare namespace DescribeStreamProcessorResponse {
2712
2939
  /**
@@ -2741,7 +2968,7 @@ export interface DetectCustomLabelsRequest {
2741
2968
  * call the operation using the S3Object property.</p>
2742
2969
  *
2743
2970
  * <p>For Amazon Rekognition to process an S3 object, the user must have permission to access the S3
2744
- * object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.
2971
+ * object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.
2745
2972
  * </p>
2746
2973
  */
2747
2974
  Image: Image | undefined;
@@ -2856,9 +3083,9 @@ export declare namespace DetectFacesResponse {
2856
3083
  */
2857
3084
  export interface DetectionFilter {
2858
3085
  /**
2859
- * <p>Sets the confidence of word detection. Words with detection confidence below this will be excluded
2860
- * from the result. Values should be between 50 and 100 as Text in Video will not return any result below
2861
- * 50.</p>
3086
+ * <p>Sets the confidence of word detection. Words with detection confidence below this will be
3087
+ * excluded from the result. Values should be between 0 and 100. The default MinConfidence is
3088
+ * 80.</p>
2862
3089
  */
2863
3090
  MinConfidence?: number;
2864
3091
  /**
@@ -3294,25 +3521,6 @@ export declare namespace DetectProtectiveEquipmentResponse {
3294
3521
  */
3295
3522
  const filterSensitiveLog: (obj: DetectProtectiveEquipmentResponse) => any;
3296
3523
  }
3297
- /**
3298
- * <p>Specifies a location within the frame that Rekognition checks for text. Uses a <code>BoundingBox</code>
3299
- * object to set a region of the screen.</p>
3300
- * <p>A word is included in the region if the word is more than half in that region. If there is more than
3301
- * one region, the word will be compared with all regions of the screen. Any word more than half in a region
3302
- * is kept in the results.</p>
3303
- */
3304
- export interface RegionOfInterest {
3305
- /**
3306
- * <p>The box representing a region of interest on screen.</p>
3307
- */
3308
- BoundingBox?: BoundingBox;
3309
- }
3310
- export declare namespace RegionOfInterest {
3311
- /**
3312
- * @internal
3313
- */
3314
- const filterSensitiveLog: (obj: RegionOfInterest) => any;
3315
- }
3316
3524
  /**
3317
3525
  * <p>A set of optional parameters that you can use to set the criteria that the text must meet to be included in your response.
3318
3526
  * <code>WordFilter</code> looks at a word’s height, width, and minimum confidence. <code>RegionOfInterest</code>
@@ -3369,7 +3577,7 @@ export declare enum TextTypes {
3369
3577
  * the word appears. The word <code>Id</code> is also an index for the word within a line of
3370
3578
  * words. </p>
3371
3579
  *
3372
- * <p>For more information, see Detecting Text in the Amazon Rekognition Developer Guide.</p>
3580
+ * <p>For more information, see Detecting text in the Amazon Rekognition Developer Guide.</p>
3373
3581
  */
3374
3582
  export interface TextDetection {
3375
3583
  /**
@@ -4600,7 +4808,8 @@ export interface IndexFacesResponse {
4600
4808
  */
4601
4809
  OrientationCorrection?: OrientationCorrection | string;
4602
4810
  /**
4603
- * <p>Latest face model being used with the collection. For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html">Model versioning</a>.</p>
4811
+ * <p>The version number of the face detection model that's associated with the input
4812
+ * collection (<code>CollectionId</code>).</p>
4604
4813
  */
4605
4814
  FaceModelVersion?: string;
4606
4815
  /**
@@ -4617,6 +4826,33 @@ export declare namespace IndexFacesResponse {
4617
4826
  */
4618
4827
  const filterSensitiveLog: (obj: IndexFacesResponse) => any;
4619
4828
  }
4829
+ /**
4830
+ * <p>
4831
+ * Specifies the starting point in a Kinesis stream to start processing.
4832
+ * You can use the producer timestamp or the fragment number.
4833
+ * For more information, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html">Fragment</a>.
4834
+ * </p>
4835
+ */
4836
+ export interface KinesisVideoStreamStartSelector {
4837
+ /**
4838
+ * <p>
4839
+ * The timestamp from the producer corresponding to the fragment.
4840
+ * </p>
4841
+ */
4842
+ ProducerTimestamp?: number;
4843
+ /**
4844
+ * <p>
4845
+ * The unique identifier of the fragment. This value monotonically increases based on the ingestion order.
4846
+ * </p>
4847
+ */
4848
+ FragmentNumber?: string;
4849
+ }
4850
+ export declare namespace KinesisVideoStreamStartSelector {
4851
+ /**
4852
+ * @internal
4853
+ */
4854
+ const filterSensitiveLog: (obj: KinesisVideoStreamStartSelector) => any;
4855
+ }
4620
4856
  export interface ListCollectionsRequest {
4621
4857
  /**
4622
4858
  * <p>Pagination token from the previous response.</p>
@@ -4644,7 +4880,7 @@ export interface ListCollectionsResponse {
4644
4880
  */
4645
4881
  NextToken?: string;
4646
4882
  /**
4647
- * <p>Latest face models being used with the corresponding collections in the array. For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html">Model versioning</a>.
4883
+ * <p>Version numbers of the face detection models associated with the collections in the array <code>CollectionIds</code>.
4648
4884
  * For example, the value of <code>FaceModelVersions[2]</code> is the version number for the face detection model used
4649
4885
  * by the collection in <code>CollectionId[2]</code>.</p>
4650
4886
  */
@@ -4806,7 +5042,7 @@ export interface ListFacesResponse {
4806
5042
  */
4807
5043
  NextToken?: string;
4808
5044
  /**
4809
- * <p>Latest face model being used with the collection. For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html">Model versioning</a>.</p>
5045
+ * <p>Version number of the face detection model associated with the input collection (<code>CollectionId</code>).</p>
4810
5046
  */
4811
5047
  FaceModelVersion?: string;
4812
5048
  }
@@ -4834,7 +5070,7 @@ export declare namespace ListStreamProcessorsRequest {
4834
5070
  const filterSensitiveLog: (obj: ListStreamProcessorsRequest) => any;
4835
5071
  }
4836
5072
  /**
4837
- * <p>An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to <a>CreateStreamProcessor</a>. The request
5073
+ * <p>An object that recognizes faces or labels in a streaming video. An Amazon Rekognition stream processor is created by a call to <a>CreateStreamProcessor</a>. The request
4838
5074
  * parameters for <code>CreateStreamProcessor</code> describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.
4839
5075
  *
4840
5076
  * </p>
@@ -4904,12 +5140,12 @@ export declare namespace ListTagsForResourceResponse {
4904
5140
  }
4905
5141
  /**
4906
5142
  * <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see
4907
- * <a>api-video</a>. Note that the Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
5143
+ * <a href="https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html">Calling Amazon Rekognition Video operations</a>. Note that the Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
4908
5144
  * For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics">Giving access to multiple Amazon SNS topics</a>.</p>
4909
5145
  */
4910
5146
  export interface NotificationChannel {
4911
5147
  /**
4912
- * <p>The Amazon SNS topic to which Amazon Rekognition to posts the completion status.</p>
5148
+ * <p>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</p>
4913
5149
  */
4914
5150
  SNSTopicArn: string | undefined;
4915
5151
  /**
@@ -5018,7 +5254,7 @@ export interface SearchFacesResponse {
5018
5254
  */
5019
5255
  FaceMatches?: FaceMatch[];
5020
5256
  /**
5021
- * <p>Latest face model being used with the collection. For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html">Model versioning</a>.</p>
5257
+ * <p>Version number of the face detection model associated with the input collection (<code>CollectionId</code>).</p>
5022
5258
  */
5023
5259
  FaceModelVersion?: string;
5024
5260
  }
@@ -5093,7 +5329,7 @@ export interface SearchFacesByImageResponse {
5093
5329
  */
5094
5330
  FaceMatches?: FaceMatch[];
5095
5331
  /**
5096
- * <p>Latest face model being used with the collection. For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html">Model versioning</a>.</p>
5332
+ * <p>Version number of the face detection model associated with the input collection (<code>CollectionId</code>).</p>
5097
5333
  */
5098
5334
  FaceModelVersion?: string;
5099
5335
  }
@@ -5572,11 +5808,65 @@ export declare namespace StartSegmentDetectionResponse {
5572
5808
  */
5573
5809
  const filterSensitiveLog: (obj: StartSegmentDetectionResponse) => any;
5574
5810
  }
5811
+ /**
5812
+ * <p></p>
5813
+ */
5814
+ export interface StreamProcessingStartSelector {
5815
+ /**
5816
+ * <p>
5817
+ * Specifies the starting point in the stream to start processing. This can be done with a timestamp or a fragment number in a Kinesis stream.
5818
+ * </p>
5819
+ */
5820
+ KVSStreamStartSelector?: KinesisVideoStreamStartSelector;
5821
+ }
5822
+ export declare namespace StreamProcessingStartSelector {
5823
+ /**
5824
+ * @internal
5825
+ */
5826
+ const filterSensitiveLog: (obj: StreamProcessingStartSelector) => any;
5827
+ }
5828
+ /**
5829
+ * <p>
5830
+ * Specifies when to stop processing the stream. You can specify a maximum amount
5831
+ * of time to process the video.
5832
+ * </p>
5833
+ */
5834
+ export interface StreamProcessingStopSelector {
5835
+ /**
5836
+ * <p>
5837
+ * Specifies the maximum amount of time in seconds that you want the stream to be processed. The largest amount of time is 2 minutes. The default is 10 seconds.
5838
+ * </p>
5839
+ */
5840
+ MaxDurationInSeconds?: number;
5841
+ }
5842
+ export declare namespace StreamProcessingStopSelector {
5843
+ /**
5844
+ * @internal
5845
+ */
5846
+ const filterSensitiveLog: (obj: StreamProcessingStopSelector) => any;
5847
+ }
5575
5848
  export interface StartStreamProcessorRequest {
5576
5849
  /**
5577
5850
  * <p>The name of the stream processor to start processing.</p>
5578
5851
  */
5579
5852
  Name: string | undefined;
5853
+ /**
5854
+ * <p>
5855
+ * Specifies the starting point in the Kinesis stream to start processing.
5856
+ * You can use the producer timestamp or the fragment number.
5857
+ * For more information, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html">Fragment</a>.
5858
+ * </p>
5859
+ * <p>This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.</p>
5860
+ */
5861
+ StartSelector?: StreamProcessingStartSelector;
5862
+ /**
5863
+ * <p>
5864
+ * Specifies when to stop processing the stream. You can specify a
5865
+ * maximum amount of time to process the video.
5866
+ * </p>
5867
+ * <p>This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.</p>
5868
+ */
5869
+ StopSelector?: StreamProcessingStopSelector;
5580
5870
  }
5581
5871
  export declare namespace StartStreamProcessorRequest {
5582
5872
  /**
@@ -5585,6 +5875,12 @@ export declare namespace StartStreamProcessorRequest {
5585
5875
  const filterSensitiveLog: (obj: StartStreamProcessorRequest) => any;
5586
5876
  }
5587
5877
  export interface StartStreamProcessorResponse {
5878
+ /**
5879
+ * <p>
5880
+ * A unique identifier for the stream processing session.
5881
+ * </p>
5882
+ */
5883
+ SessionId?: string;
5588
5884
  }
5589
5885
  export declare namespace StartStreamProcessorResponse {
5590
5886
  /**
@@ -5628,7 +5924,7 @@ export interface StartTextDetectionRequest {
5628
5924
  ClientRequestToken?: string;
5629
5925
  /**
5630
5926
  * <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see
5631
- * <a>api-video</a>. Note that the Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
5927
+ * <a href="https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html">Calling Amazon Rekognition Video operations</a>. Note that the Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
5632
5928
  * For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics">Giving access to multiple Amazon SNS topics</a>.</p>
5633
5929
  */
5634
5930
  NotificationChannel?: NotificationChannel;
@@ -5791,3 +6087,73 @@ export declare namespace UpdateDatasetEntriesResponse {
5791
6087
  */
5792
6088
  const filterSensitiveLog: (obj: UpdateDatasetEntriesResponse) => any;
5793
6089
  }
6090
+ export declare enum StreamProcessorParameterToDelete {
6091
+ ConnectedHomeMinConfidence = "ConnectedHomeMinConfidence",
6092
+ RegionsOfInterest = "RegionsOfInterest"
6093
+ }
6094
+ /**
6095
+ * <p>
6096
+ * The stream processor settings that you want to update. <code>ConnectedHome</code> settings can be updated to detect different labels with a different minimum confidence.
6097
+ * </p>
6098
+ */
6099
+ export interface StreamProcessorSettingsForUpdate {
6100
+ /**
6101
+ * <p>
6102
+ * The label detection settings you want to use for your stream processor.
6103
+ * </p>
6104
+ */
6105
+ ConnectedHomeForUpdate?: ConnectedHomeSettingsForUpdate;
6106
+ }
6107
+ export declare namespace StreamProcessorSettingsForUpdate {
6108
+ /**
6109
+ * @internal
6110
+ */
6111
+ const filterSensitiveLog: (obj: StreamProcessorSettingsForUpdate) => any;
6112
+ }
6113
+ export interface UpdateStreamProcessorRequest {
6114
+ /**
6115
+ * <p>
6116
+ * Name of the stream processor that you want to update.
6117
+ * </p>
6118
+ */
6119
+ Name: string | undefined;
6120
+ /**
6121
+ * <p>
6122
+ * The stream processor settings that you want to update. Label detection settings can be updated to detect different labels with a different minimum confidence.
6123
+ * </p>
6124
+ */
6125
+ SettingsForUpdate?: StreamProcessorSettingsForUpdate;
6126
+ /**
6127
+ * <p>
6128
+ * Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.
6129
+ * </p>
6130
+ */
6131
+ RegionsOfInterestForUpdate?: RegionOfInterest[];
6132
+ /**
6133
+ * <p>
6134
+ * Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.
6135
+ * Note that if you opt out at the account level this setting is ignored on individual streams.
6136
+ * </p>
6137
+ */
6138
+ DataSharingPreferenceForUpdate?: StreamProcessorDataSharingPreference;
6139
+ /**
6140
+ * <p>
6141
+ * A list of parameters you want to delete from the stream processor.
6142
+ * </p>
6143
+ */
6144
+ ParametersToDelete?: (StreamProcessorParameterToDelete | string)[];
6145
+ }
6146
+ export declare namespace UpdateStreamProcessorRequest {
6147
+ /**
6148
+ * @internal
6149
+ */
6150
+ const filterSensitiveLog: (obj: UpdateStreamProcessorRequest) => any;
6151
+ }
6152
+ export interface UpdateStreamProcessorResponse {
6153
+ }
6154
+ export declare namespace UpdateStreamProcessorResponse {
6155
+ /**
6156
+ * @internal
6157
+ */
6158
+ const filterSensitiveLog: (obj: UpdateStreamProcessorResponse) => any;
6159
+ }