@aws-sdk/client-rekognition 3.78.0 → 3.79.0

package/dist-types/commands/CreateStreamProcessorCommand.d.ts

@@ -7,15 +7,26 @@ export interface CreateStreamProcessorCommandInput extends CreateStreamProcessor
 export interface CreateStreamProcessorCommandOutput extends CreateStreamProcessorResponse, __MetadataBearer {
 }
 /**
- * <p>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.</p>
- *         <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.</p>
- *         <p>You provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the
- *             face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize.
+ * <p>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.</p>
+ *         <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.</p>
+ *         <ul>
+ *             <li>
+ *                <p>If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the
+ *                 face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
+ *                 stop processing.</p>
+ *             </li>
+ *             <li>
+ *                <p>If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (<code>Input</code>), Amazon S3 bucket information (<code>Output</code>), and an
+ *                 Amazon SNS topic ARN (<code>NotificationChannel</code>). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket.
+ *                 You specify what you want to detect in <code>ConnectedHomeSettings</code>, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor with <code>RegionsOfInterest</code>.
+ *                 When you run the <a>StartStreamProcessor</a> operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.</p>
+ *             </li>
+ *          </ul>
+ *
+ *         <p>
  *             Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code>
  *             to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with
  *             the <code>Name</code> field. </p>
- *         <p>After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
- *         stop processing. You can delete the stream processor by calling <a>DeleteStreamProcessor</a>.</p>
  *         <p>This operation requires permissions to perform the
  *             <code>rekognition:CreateStreamProcessor</code> action. If you want to tag your stream processor, you also require permission to perform the <code>rekognition:TagResource</code> operation.</p>
  * @example

package/dist-types/commands/DeleteCollectionCommand.d.ts

@@ -8,7 +8,7 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
 }
 /**
  * <p>Deletes the specified collection. Note that this operation
- *       removes all faces in the collection. For an example, see <a>delete-collection-procedure</a>.</p>
+ *       removes all faces in the collection. For an example, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html">Deleting a collection</a>.</p>
  *
  *          <p>This operation requires permissions to perform the
  *         <code>rekognition:DeleteCollection</code> action.</p>

package/dist-types/commands/DetectLabelsCommand.d.ts

@@ -12,7 +12,7 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
  *        wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
  *      </p>
  *
- *          <p>For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.</p>
+ *          <p>For an example, see Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition Developer Guide.</p>
  *          <note>
  *             <p>
  *                <code>DetectLabels</code> does not support the detection of activities. However, activity detection

package/dist-types/commands/DetectTextCommand.d.ts

@@ -28,7 +28,7 @@ export interface DetectTextCommandOutput extends DetectTextResponse, __MetadataB
  *       use the <code>TextDetection</code> object <code>Type</code> field. </p>
  *          <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.</p>
  *
- *          <p>For more information, see DetectText in the Amazon Rekognition Developer Guide.</p>
+ *          <p>For more information, see Detecting text in the Amazon Rekognition Developer Guide.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/GetCelebrityInfoCommand.d.ts

@@ -11,7 +11,7 @@ export interface GetCelebrityInfoCommandOutput extends GetCelebrityInfoResponse,
  *       The additional information is returned as an array of URLs. If there is no additional
  *       information about the celebrity, this list is empty.</p>
  *
- *          <p>For more information, see Recognizing Celebrities in an Image in
+ *          <p>For more information, see Getting information about a celebrity in
  *       the Amazon Rekognition Developer Guide.</p>
  *          <p>This operation requires permissions to perform the
  *         <code>rekognition:GetCelebrityInfo</code> action. </p>

package/dist-types/commands/GetContentModerationCommand.d.ts

@@ -36,7 +36,7 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR
  *        and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code>
  *        returned from the previous call to <code>GetContentModeration</code>.</p>
  *
- *          <p>For more information, see Content moderation in the Amazon Rekognition Developer Guide.</p>
+ *          <p>For more information, see moderating content in the Amazon Rekognition Developer Guide.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/GetSegmentDetectionCommand.d.ts

@@ -29,7 +29,7 @@ export interface GetSegmentDetectionCommandOutput extends GetSegmentDetectionRes
  *       and populate the <code>NextToken</code> request parameter with the token value returned from the previous
  *       call to <code>GetSegmentDetection</code>.</p>
  *
- *          <p>For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.</p>
+ *          <p>For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/IndexFacesCommand.d.ts

@@ -15,7 +15,7 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
  *         <a>SearchFaces</a> and <a>SearchFacesByImage</a>
  *       operations.</p>
  *
- *          <p>For more information, see Adding Faces to a Collection in the Amazon Rekognition
+ *          <p>For more information, see Adding faces to a collection in the Amazon Rekognition
  *       Developer Guide.</p>
  *          <p>To get the number of faces in a collection, call <a>DescribeCollection</a>. </p>
  *
@@ -95,7 +95,7 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
  *          <p>If you request all facial attributes (by using the <code>detectionAttributes</code>
  *       parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for
  *       example, location of eye and mouth) and other facial attributes. If you provide
- *       the same image, specify the same collection, use the same external ID, and use the same model version in the
+ *       the same image, specify the same collection, and use the same external ID in the
  *         <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata.</p>
  *
  *

package/dist-types/commands/ListCollectionsCommand.d.ts

@@ -11,7 +11,7 @@ export interface ListCollectionsCommandOutput extends ListCollectionsResponse, _
  *     If the result is truncated, the response also provides a <code>NextToken</code>
  *     that you can use in the subsequent request to fetch the next set of collection IDs.</p>
  *
- *          <p>For an example, see Listing Collections in the Amazon Rekognition Developer Guide.</p>
+ *          <p>For an example, see Listing collections in the Amazon Rekognition Developer Guide.</p>
  *          <p>This operation requires permissions to perform the <code>rekognition:ListCollections</code> action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/RecognizeCelebritiesCommand.d.ts

@@ -7,7 +7,7 @@ export interface RecognizeCelebritiesCommandInput extends RecognizeCelebritiesRe
 export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesResponse, __MetadataBearer {
 }
 /**
- * <p>Returns an array of celebrities recognized in the input image.  For more information, see Recognizing Celebrities
+ * <p>Returns an array of celebrities recognized in the input image.  For more information, see Recognizing celebrities
  *     in the Amazon Rekognition Developer Guide. </p>
  *          <p>
  *             <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists the
@@ -35,7 +35,7 @@ export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesR
  *
  *
  *
- *          <p>For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.</p>
+ *          <p>For an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer Guide.</p>
  *          <p>This operation requires permissions to perform the
  *         <code>rekognition:RecognizeCelebrities</code> operation.</p>
  * @example

package/dist-types/commands/SearchFacesCommand.d.ts

@@ -24,7 +24,7 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat
  *       that the specific face matches the input face.
  *     </p>
  *
- *          <p>For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.</p>
+ *          <p>For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide.</p>
  *
  *          <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code>
  *       action.</p>

package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts

@@ -18,7 +18,7 @@ export interface StartCelebrityRecognitionCommandOutput extends StartCelebrityRe
  *       topic is <code>SUCCEEDED</code>. If so, call  <a>GetCelebrityRecognition</a> and pass the job identifier
  *       (<code>JobId</code>) from the initial call to <code>StartCelebrityRecognition</code>. </p>
  *
- *          <p>For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.</p>
+ *          <p>For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartContentModerationCommand.d.ts

@@ -18,7 +18,7 @@ export interface StartContentModerationCommandOutput extends StartContentModerat
  *         topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier
  *         (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
  *
- *          <p>For more information, see Content moderation in the Amazon Rekognition Developer Guide.</p>
+ *          <p>For more information, see Moderating content in the Amazon Rekognition Developer Guide.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartFaceDetectionCommand.d.ts

@@ -18,7 +18,7 @@ export interface StartFaceDetectionCommandOutput extends StartFaceDetectionRespo
  *        topic is <code>SUCCEEDED</code>. If so, call  <a>GetFaceDetection</a> and pass the job identifier
  *       (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>
  *
- *          <p>For more information, see Detecting Faces in a Stored Video in the
+ *          <p>For more information, see Detecting faces in a stored video in the
  *      Amazon Rekognition Developer Guide.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/StartFaceSearchCommand.d.ts

@@ -16,7 +16,8 @@ export interface StartFaceSearchCommandOutput extends StartFaceSearchResponse, _
  *       To get the search results, first check that the status value published to the Amazon SNS
  *       topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceSearch</a> and pass the job identifier
  *       (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. For more information, see
- *       <a>procedure-person-search-videos</a>.</p>
+ *       <a href="https://docs.aws.amazon.com/rekognition/latest/dg/procedure-person-search-videos.html">Searching stored videos for faces</a>.
+ *     </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartSegmentDetectionCommand.d.ts

@@ -22,7 +22,7 @@ export interface StartSegmentDetectionCommandOutput extends StartSegmentDetectio
  *       from the initial call to <code>StartSegmentDetection</code>. </p>
  *
  *
- *          <p>For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.</p>
+ *          <p>For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartStreamProcessorCommand.d.ts

@@ -10,6 +10,7 @@ export interface StartStreamProcessorCommandOutput extends StartStreamProcessorR
  * <p>Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>.
  *             To tell <code>StartStreamProcessor</code> which stream processor to start, use the value of the <code>Name</code> field specified in the call to
  *             <code>CreateStreamProcessor</code>.</p>
+ *         <p>If you are using a label detection stream processor to detect labels, you need to provide a <code>Start selector</code> and a <code>Stop selector</code> to determine the length of the stream processing time.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateStreamProcessorCommand.d.ts

@@ -0,0 +1,37 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { UpdateStreamProcessorRequest, UpdateStreamProcessorResponse } from "../models/models_0";
+import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
+export interface UpdateStreamProcessorCommandInput extends UpdateStreamProcessorRequest {
+}
+export interface UpdateStreamProcessorCommandOutput extends UpdateStreamProcessorResponse, __MetadataBearer {
+}
+/**
+ * <p>
+ *             Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.
+ *         </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RekognitionClient, UpdateStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
+ * // const { RekognitionClient, UpdateStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
+ * const client = new RekognitionClient(config);
+ * const command = new UpdateStreamProcessorCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdateStreamProcessorCommandInput} for command's `input` shape.
+ * @see {@link UpdateStreamProcessorCommandOutput} for command's `response` shape.
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
+ *
+ */
+export declare class UpdateStreamProcessorCommand extends $Command<UpdateStreamProcessorCommandInput, UpdateStreamProcessorCommandOutput, RekognitionClientResolvedConfig> {
+    readonly input: UpdateStreamProcessorCommandInput;
+    constructor(input: UpdateStreamProcessorCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateStreamProcessorCommandInput, UpdateStreamProcessorCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -56,3 +56,4 @@ export * from "./StopStreamProcessorCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateDatasetEntriesCommand";
+export * from "./UpdateStreamProcessorCommand";