@aws-sdk/client-rekognition 3.350.0 → 3.351.0

package/dist-types/models/models_1.d.ts

@@ -1,4 +1,565 @@
-import { ConnectedHomeSettingsForUpdate, DatasetChanges, RegionOfInterest, StreamProcessorDataSharingPreference } from "./models_0";
+import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
+import { BlackFrame, ConnectedHomeSettingsForUpdate, DatasetChanges, DetectionFilter, FaceAttributes, KinesisVideoStreamStartSelector, LabelDetectionFeatureName, LabelDetectionSettings, NotificationChannel, ProjectVersionStatus, RegionOfInterest, SegmentType, StreamProcessorDataSharingPreference, Video } from "./models_0";
+import { RekognitionServiceException as __BaseException } from "./RekognitionServiceException";
+/**
+ * @public
+ */
+export interface StartCelebrityRecognitionResponse {
+    /**
+     * <p>The identifier for the celebrity recognition analysis job. Use <code>JobId</code> to identify the job in
+     *       a subsequent call to <code>GetCelebrityRecognition</code>.</p>
+     */
+    JobId?: string;
+}
+/**
+ * @public
+ * <p>The file size or duration of the supplied media is too large. The maximum file size is 10GB.
+ *         The maximum duration is 6 hours. </p>
+ */
+export declare class VideoTooLargeException extends __BaseException {
+    readonly name: "VideoTooLargeException";
+    readonly $fault: "client";
+    Message?: string;
+    Code?: string;
+    /**
+     * <p>A universally unique identifier (UUID) for the request.</p>
+     */
+    Logref?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<VideoTooLargeException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface StartContentModerationRequest {
+    /**
+     * <p>The video in which you want to detect inappropriate, unwanted, or offensive content. The video must be stored
+     *       in an Amazon S3 bucket.</p>
+     */
+    Video: Video | undefined;
+    /**
+     * <p>Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence
+     *       represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence.
+     *       100 is the highest confidence.  Amazon Rekognition doesn't return any moderated content labels with a confidence level
+     *       lower than this specified value. If you don't specify <code>MinConfidence</code>, <code>GetContentModeration</code>
+     *        returns labels with confidence values greater than or equal to 50 percent.</p>
+     */
+    MinConfidence?: number;
+    /**
+     * <p>Idempotent token used to identify the start request. If you use the same token with multiple
+     *       <code>StartContentModeration</code> requests, the same <code>JobId</code> is returned. Use
+     *       <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
+     */
+    ClientRequestToken?: string;
+    /**
+     * <p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the
+     *       content analysis to. 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.</p>
+     */
+    NotificationChannel?: NotificationChannel;
+    /**
+     * <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
+     *       For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
+     */
+    JobTag?: string;
+}
+/**
+ * @public
+ */
+export interface StartContentModerationResponse {
+    /**
+     * <p>The identifier for the content analysis job. Use <code>JobId</code> to identify the job in
+     *       a subsequent call to <code>GetContentModeration</code>.</p>
+     */
+    JobId?: string;
+}
+/**
+ * @public
+ */
+export interface StartFaceDetectionRequest {
+    /**
+     * <p>The video in which you want to detect faces. The video must be stored
+     *       in an Amazon S3 bucket.</p>
+     */
+    Video: Video | undefined;
+    /**
+     * <p>Idempotent token used to identify the start request. If you use the same token with multiple
+     *       <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use
+     *       <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
+     */
+    ClientRequestToken?: string;
+    /**
+     * <p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the
+     *          face detection operation. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>
+     */
+    NotificationChannel?: NotificationChannel;
+    /**
+     * <p>The face attributes you want returned.</p>
+     *          <p>
+     *             <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. </p>
+     *          <p>
+     *             <code>ALL</code> - All facial attributes are returned.</p>
+     */
+    FaceAttributes?: FaceAttributes | string;
+    /**
+     * <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
+     *       For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
+     */
+    JobTag?: string;
+}
+/**
+ * @public
+ */
+export interface StartFaceDetectionResponse {
+    /**
+     * <p>The identifier for the face detection job. Use <code>JobId</code> to identify the job in
+     *     a subsequent call to <code>GetFaceDetection</code>.</p>
+     */
+    JobId?: string;
+}
+/**
+ * @public
+ */
+export interface StartFaceSearchRequest {
+    /**
+     * <p>The video you want to search. The video must be stored in an Amazon S3 bucket. </p>
+     */
+    Video: Video | undefined;
+    /**
+     * <p>Idempotent token used to identify the start request. If you use the same token with multiple
+     *       <code>StartFaceSearch</code> requests, the same <code>JobId</code> is returned. Use
+     *       <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
+     */
+    ClientRequestToken?: string;
+    /**
+     * <p>The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%.
+     *       The default value is 80%.</p>
+     */
+    FaceMatchThreshold?: number;
+    /**
+     * <p>ID of the collection that contains the faces you want to search for.</p>
+     */
+    CollectionId: string | undefined;
+    /**
+     * <p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. 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.</p>
+     */
+    NotificationChannel?: NotificationChannel;
+    /**
+     * <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
+     *       For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
+     */
+    JobTag?: string;
+}
+/**
+ * @public
+ */
+export interface StartFaceSearchResponse {
+    /**
+     * <p>The identifier for the search job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetFaceSearch</code>. </p>
+     */
+    JobId?: string;
+}
+/**
+ * @public
+ */
+export interface StartLabelDetectionRequest {
+    /**
+     * <p>The video in which you want to detect labels. The video must be stored
+     *       in an Amazon S3 bucket.</p>
+     */
+    Video: Video | undefined;
+    /**
+     * <p>Idempotent token used to identify the start request. If you use the same token with multiple
+     *       <code>StartLabelDetection</code> requests, the same <code>JobId</code> is returned. Use
+     *       <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
+     */
+    ClientRequestToken?: string;
+    /**
+     * <p>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence
+     *        represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence.
+     *        100 is the highest confidence.  Amazon Rekognition Video doesn't return any labels with a confidence level
+     *        lower than this specified value.</p>
+     *          <p>If you don't specify <code>MinConfidence</code>, the operation returns labels and
+     *       bounding boxes (if detected)  with confidence values greater than or equal to 50
+     *       percent.</p>
+     */
+    MinConfidence?: number;
+    /**
+     * <p>The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection
+     *         operation to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>
+     */
+    NotificationChannel?: NotificationChannel;
+    /**
+     * <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
+     *       For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
+     */
+    JobTag?: string;
+    /**
+     * <p>The features to return after video analysis. You can specify that GENERAL_LABELS are returned.</p>
+     */
+    Features?: (LabelDetectionFeatureName | string)[];
+    /**
+     * <p>The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation.
+     *       Settings can include filters for GENERAL_LABELS.</p>
+     */
+    Settings?: LabelDetectionSettings;
+}
+/**
+ * @public
+ */
+export interface StartLabelDetectionResponse {
+    /**
+     * <p>The identifier for the label detection job. Use <code>JobId</code> to identify the job in
+     *     a subsequent call to <code>GetLabelDetection</code>. </p>
+     */
+    JobId?: string;
+}
+/**
+ * @public
+ */
+export interface StartPersonTrackingRequest {
+    /**
+     * <p>The video in which you want to detect people. The video must be stored
+     *       in an Amazon S3 bucket.</p>
+     */
+    Video: Video | undefined;
+    /**
+     * <p>Idempotent token used to identify the start request. If you use the same token with multiple
+     *       <code>StartPersonTracking</code> requests, the same <code>JobId</code> is returned. Use
+     *       <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
+     */
+    ClientRequestToken?: string;
+    /**
+     * <p>The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection
+     *         operation to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>
+     */
+    NotificationChannel?: NotificationChannel;
+    /**
+     * <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
+     *       For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
+     */
+    JobTag?: string;
+}
+/**
+ * @public
+ */
+export interface StartPersonTrackingResponse {
+    /**
+     * <p>The identifier for the person detection job. Use <code>JobId</code> to identify the job in
+     *     a subsequent call to <code>GetPersonTracking</code>.</p>
+     */
+    JobId?: string;
+}
+/**
+ * @public
+ */
+export interface StartProjectVersionRequest {
+    /**
+     * <p>The Amazon Resource Name(ARN) of the model version that you want to start.</p>
+     */
+    ProjectVersionArn: string | undefined;
+    /**
+     * <p>The minimum number of inference units to use. A single
+     *       inference unit represents 1 hour of processing. </p>
+     *          <p>For information about the number
+     *             of transactions per second (TPS) that an inference unit can support, see
+     *             <i>Running a trained Amazon Rekognition Custom Labels model</i> in the
+     *             Amazon Rekognition Custom Labels Guide.
+     *          </p>
+     *          <p>Use a higher number to increase the TPS throughput of your model. You are charged for the number
+     *       of inference units that you use.
+     *     </p>
+     */
+    MinInferenceUnits: number | undefined;
+    /**
+     * <p>The maximum number of inference units to use for auto-scaling the model. If you don't
+     *          specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the model.</p>
+     */
+    MaxInferenceUnits?: number;
+}
+/**
+ * @public
+ */
+export interface StartProjectVersionResponse {
+    /**
+     * <p>The current running status of the model. </p>
+     */
+    Status?: ProjectVersionStatus | string;
+}
+/**
+ * @public
+ * <p>Filters for the shot detection segments returned by <code>GetSegmentDetection</code>.
+ *       For more information, see <a>StartSegmentDetectionFilters</a>.</p>
+ */
+export interface StartShotDetectionFilter {
+    /**
+     * <p>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence
+     *       represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence.
+     *       100 is the highest confidence.  Amazon Rekognition Video doesn't return any segments with a confidence level
+     *       lower than this specified value.</p>
+     *          <p>If you don't specify <code>MinSegmentConfidence</code>, the <code>GetSegmentDetection</code> returns
+     *         segments with confidence values greater than or equal to 50 percent.</p>
+     */
+    MinSegmentConfidence?: number;
+}
+/**
+ * @public
+ * <p>Filters for the technical segments returned by <a>GetSegmentDetection</a>. For more information,
+ *       see <a>StartSegmentDetectionFilters</a>.</p>
+ */
+export interface StartTechnicalCueDetectionFilter {
+    /**
+     * <p>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence
+     *       represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence.
+     *       100 is the highest confidence.  Amazon Rekognition Video doesn't return any segments with a confidence level
+     *       lower than this specified value.</p>
+     *          <p>If you don't specify <code>MinSegmentConfidence</code>, <code>GetSegmentDetection</code> returns
+     *       segments with confidence values greater than or equal to 50 percent.</p>
+     */
+    MinSegmentConfidence?: number;
+    /**
+     * <p>
+     *       A filter that allows you to control the black frame detection by specifying the black levels and pixel coverage of black pixels in a frame.
+     *       Videos can come from multiple sources, formats, and time periods, with different standards and varying noise levels for black frames that need to be accounted for.
+     *     </p>
+     */
+    BlackFrame?: BlackFrame;
+}
+/**
+ * @public
+ * <p>Filters applied to the technical cue or shot detection segments.
+ *       For more information, see <a>StartSegmentDetection</a>.
+ *     </p>
+ */
+export interface StartSegmentDetectionFilters {
+    /**
+     * <p>Filters that are specific to technical cues.</p>
+     */
+    TechnicalCueFilter?: StartTechnicalCueDetectionFilter;
+    /**
+     * <p>Filters that are specific to shot detections.</p>
+     */
+    ShotFilter?: StartShotDetectionFilter;
+}
+/**
+ * @public
+ */
+export interface StartSegmentDetectionRequest {
+    /**
+     * <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
+     *             specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
+     */
+    Video: Video | undefined;
+    /**
+     * <p>Idempotent token used to identify the start request. If you use the same token with multiple
+     *       <code>StartSegmentDetection</code> requests, the same <code>JobId</code> is returned. Use
+     *       <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
+     */
+    ClientRequestToken?: string;
+    /**
+     * <p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the
+     *       segment detection operation. 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.</p>
+     */
+    NotificationChannel?: NotificationChannel;
+    /**
+     * <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
+     *       For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
+     */
+    JobTag?: string;
+    /**
+     * <p>Filters for technical cue or shot detection.</p>
+     */
+    Filters?: StartSegmentDetectionFilters;
+    /**
+     * <p>An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.</p>
+     */
+    SegmentTypes: (SegmentType | string)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface StartSegmentDetectionResponse {
+    /**
+     * <p>Unique identifier for the segment detection job. The <code>JobId</code> is returned from <code>StartSegmentDetection</code>.
+     *     </p>
+     */
+    JobId?: string;
+}
+/**
+ * @public
+ * <p>This is a required parameter for label detection stream processors and should not be used
+ *             to start a face search stream processor.</p>
+ */
+export interface StreamProcessingStartSelector {
+    /**
+     * <p>
+     *             Specifies the starting point in the stream to start processing. This can be done with a producer timestamp or a fragment number in a Kinesis stream.
+     *         </p>
+     */
+    KVSStreamStartSelector?: KinesisVideoStreamStartSelector;
+}
+/**
+ * @public
+ * <p>
+ *             Specifies when to stop processing the stream. You can specify a maximum amount
+ *             of time to process the video.
+ *         </p>
+ */
+export interface StreamProcessingStopSelector {
+    /**
+     * <p>
+     *             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.
+     *         </p>
+     */
+    MaxDurationInSeconds?: number;
+}
+/**
+ * @public
+ */
+export interface StartStreamProcessorRequest {
+    /**
+     * <p>The name of the stream processor to start processing.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>
+     *             Specifies the starting point in the Kinesis stream to start processing.
+     *             You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds.
+     *             For more information about fragment numbers, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html">Fragment</a>.
+     *         </p>
+     *          <p>This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.</p>
+     */
+    StartSelector?: StreamProcessingStartSelector;
+    /**
+     * <p>
+     *             Specifies when to stop processing the stream. You can specify a
+     *             maximum amount of time to process the video.
+     *         </p>
+     *          <p>This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.</p>
+     */
+    StopSelector?: StreamProcessingStopSelector;
+}
+/**
+ * @public
+ */
+export interface StartStreamProcessorResponse {
+    /**
+     * <p>
+     *             A unique identifier for the stream processing session.
+     *         </p>
+     */
+    SessionId?: string;
+}
+/**
+ * @public
+ * <p>Set of optional parameters that let you set the criteria text must meet to be included in your response.
+ *       <code>WordFilter</code> looks at a word's height, width and minimum confidence. <code>RegionOfInterest</code>
+ *       lets you set a specific region of the screen to look for text in.</p>
+ */
+export interface StartTextDetectionFilters {
+    /**
+     * <p>Filters focusing on qualities of the text, such as confidence or size.</p>
+     */
+    WordFilter?: DetectionFilter;
+    /**
+     * <p>Filter focusing on a certain area of the frame. Uses a <code>BoundingBox</code> object to set the region
+     *       of the screen.</p>
+     */
+    RegionsOfInterest?: RegionOfInterest[];
+}
+/**
+ * @public
+ */
+export interface StartTextDetectionRequest {
+    /**
+     * <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
+     *             specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
+     */
+    Video: Video | undefined;
+    /**
+     * <p>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartTextDetection</code>
+     *       requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job
+     *         from being accidentaly started more than once.</p>
+     */
+    ClientRequestToken?: string;
+    /**
+     * <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see
+     *           <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.
+     *           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>
+     */
+    NotificationChannel?: NotificationChannel;
+    /**
+     * <p>An identifier returned in the completion status published by your Amazon Simple Notification Service topic.  For example, you can use <code>JobTag</code> to group related jobs
+     *       and identify them in the completion notification.</p>
+     */
+    JobTag?: string;
+    /**
+     * <p>Optional parameters that let you set criteria the text must meet to be included in your response.</p>
+     */
+    Filters?: StartTextDetectionFilters;
+}
+/**
+ * @public
+ */
+export interface StartTextDetectionResponse {
+    /**
+     * <p>Identifier for the text detection job.  Use <code>JobId</code> to identify the job in a subsequent call to <code>GetTextDetection</code>.</p>
+     */
+    JobId?: string;
+}
+/**
+ * @public
+ */
+export interface StopProjectVersionRequest {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the model version that you want to delete.</p>
+     *          <p>This operation requires permissions to perform the <code>rekognition:StopProjectVersion</code> action.</p>
+     */
+    ProjectVersionArn: string | undefined;
+}
+/**
+ * @public
+ */
+export interface StopProjectVersionResponse {
+    /**
+     * <p>The current status of the stop operation. </p>
+     */
+    Status?: ProjectVersionStatus | string;
+}
+/**
+ * @public
+ */
+export interface StopStreamProcessorRequest {
+    /**
+     * <p>The name of a stream processor created by <a>CreateStreamProcessor</a>.</p>
+     */
+    Name: string | undefined;
+}
+/**
+ * @public
+ */
+export interface StopStreamProcessorResponse {
+}
+/**
+ * @public
+ */
+export interface TagResourceRequest {
+    /**
+     * <p> Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to
+     *       assign the tags to. </p>
+     */
+    ResourceArn: string | undefined;
+    /**
+     * <p> The key-value tags to assign to the resource. </p>
+     */
+    Tags: Record<string, string> | undefined;
+}
+/**
+ * @public
+ */
+export interface TagResourceResponse {
+}
 /**
  * @public
  */

package/dist-types/pagination/ListUsersPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListUsersCommandInput, ListUsersCommandOutput } from "../commands/ListUsersCommand";
+import { RekognitionPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare function paginateListUsers(config: RekognitionPaginationConfiguration, input: ListUsersCommandInput, ...additionalArguments: any): Paginator<ListUsersCommandOutput>;

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

@@ -15,3 +15,4 @@ export * from "./ListDatasetLabelsPaginator";
 export * from "./ListFacesPaginator";
 export * from "./ListProjectPoliciesPaginator";
 export * from "./ListStreamProcessorsPaginator";
+export * from "./ListUsersPaginator";