@aws-sdk/client-rekognition 3.431.0 → 3.434.0

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

@@ -0,0 +1,139 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ListMediaAnalysisJobsRequest, ListMediaAnalysisJobsResponse } from "../models/models_0";
+import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListMediaAnalysisJobsCommand}.
+ */
+export interface ListMediaAnalysisJobsCommandInput extends ListMediaAnalysisJobsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListMediaAnalysisJobsCommand}.
+ */
+export interface ListMediaAnalysisJobsCommandOutput extends ListMediaAnalysisJobsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Returns a list of media analysis jobs. Results are sorted by <code>CreationTimestamp</code> in descending order.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RekognitionClient, ListMediaAnalysisJobsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
+ * // const { RekognitionClient, ListMediaAnalysisJobsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
+ * const client = new RekognitionClient(config);
+ * const input = { // ListMediaAnalysisJobsRequest
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new ListMediaAnalysisJobsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListMediaAnalysisJobsResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   MediaAnalysisJobs: [ // MediaAnalysisJobDescriptions // required
+ * //     { // MediaAnalysisJobDescription
+ * //       JobId: "STRING_VALUE", // required
+ * //       JobName: "STRING_VALUE",
+ * //       OperationsConfig: { // MediaAnalysisOperationsConfig
+ * //         DetectModerationLabels: { // MediaAnalysisDetectModerationLabelsConfig
+ * //           MinConfidence: Number("float"),
+ * //           ProjectVersion: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       Status: "CREATED" || "QUEUED" || "IN_PROGRESS" || "SUCCEEDED" || "FAILED", // required
+ * //       FailureDetails: { // MediaAnalysisJobFailureDetails
+ * //         Code: "INTERNAL_ERROR" || "INVALID_S3_OBJECT" || "INVALID_MANIFEST" || "INVALID_OUTPUT_CONFIG" || "INVALID_KMS_KEY" || "ACCESS_DENIED" || "RESOURCE_NOT_FOUND" || "RESOURCE_NOT_READY" || "THROTTLED",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //       CreationTimestamp: new Date("TIMESTAMP"), // required
+ * //       CompletionTimestamp: new Date("TIMESTAMP"),
+ * //       Input: { // MediaAnalysisInput
+ * //         S3Object: { // S3Object
+ * //           Bucket: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //           Version: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       OutputConfig: { // MediaAnalysisOutputConfig
+ * //         S3Bucket: "STRING_VALUE", // required
+ * //         S3KeyPrefix: "STRING_VALUE",
+ * //       },
+ * //       KmsKeyId: "STRING_VALUE",
+ * //       Results: { // MediaAnalysisResults
+ * //         S3Object: {
+ * //           Bucket: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //           Version: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       ManifestSummary: { // MediaAnalysisManifestSummary
+ * //         S3Object: {
+ * //           Bucket: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //           Version: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListMediaAnalysisJobsCommandInput - {@link ListMediaAnalysisJobsCommandInput}
+ * @returns {@link ListMediaAnalysisJobsCommandOutput}
+ * @see {@link ListMediaAnalysisJobsCommandInput} for command's `input` shape.
+ * @see {@link ListMediaAnalysisJobsCommandOutput} for command's `response` shape.
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You are not authorized to perform the action.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
+ *
+ * @throws {@link InvalidPaginationTokenException} (client fault)
+ *  <p>Pagination token in the request is not valid.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>Input parameter violated a constraint. Validate your parameter before calling the API
+ *       operation again.</p>
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>The number of requests exceeded your throughput limit. If you want to increase this
+ *       limit, contact Amazon Rekognition.</p>
+ *
+ * @throws {@link ThrottlingException} (server fault)
+ *  <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
+ *
+ * @throws {@link RekognitionServiceException}
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
+ *
+ */
+export declare class ListMediaAnalysisJobsCommand extends $Command<ListMediaAnalysisJobsCommandInput, ListMediaAnalysisJobsCommandOutput, RekognitionClientResolvedConfig> {
+    readonly input: ListMediaAnalysisJobsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListMediaAnalysisJobsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListMediaAnalysisJobsCommandInput, ListMediaAnalysisJobsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,7 +1,7 @@
 import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { PutProjectPolicyRequest, PutProjectPolicyResponse } from "../models/models_0";
+import { PutProjectPolicyRequest, PutProjectPolicyResponse } from "../models/models_1";
 import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
 /**
  * @public

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

@@ -1,7 +1,7 @@
 import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { RecognizeCelebritiesRequest, RecognizeCelebritiesResponse } from "../models/models_0";
+import { RecognizeCelebritiesRequest, RecognizeCelebritiesResponse } from "../models/models_1";
 import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
 /**
  * @public

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

@@ -1,7 +1,7 @@
 import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { SearchFacesByImageRequest, SearchFacesByImageResponse } from "../models/models_0";
+import { SearchFacesByImageRequest, SearchFacesByImageResponse } from "../models/models_1";
 import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
 /**
  * @public

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

@@ -1,7 +1,7 @@
 import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { SearchFacesRequest, SearchFacesResponse } from "../models/models_0";
+import { SearchFacesRequest, SearchFacesResponse } from "../models/models_1";
 import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
 /**
  * @public

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

@@ -1,8 +1,7 @@
 import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { SearchUsersByImageRequest } from "../models/models_0";
-import { SearchUsersByImageResponse } from "../models/models_1";
+import { SearchUsersByImageRequest, SearchUsersByImageResponse } from "../models/models_1";
 import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
 /**
  * @public

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

@@ -1,7 +1,7 @@
 import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { SearchUsersRequest, SearchUsersResponse } from "../models/models_0";
+import { SearchUsersRequest, SearchUsersResponse } from "../models/models_1";
 import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
 /**
  * @public

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

@@ -0,0 +1,135 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { StartMediaAnalysisJobRequest, StartMediaAnalysisJobResponse } from "../models/models_1";
+import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartMediaAnalysisJobCommand}.
+ */
+export interface StartMediaAnalysisJobCommandInput extends StartMediaAnalysisJobRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartMediaAnalysisJobCommand}.
+ */
+export interface StartMediaAnalysisJobCommandOutput extends StartMediaAnalysisJobResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Initiates a new media analysis job. Accepts a manifest file in an Amazon S3 bucket. The
+ *             output is a manifest file and a summary of the manifest stored in the Amazon S3 bucket.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RekognitionClient, StartMediaAnalysisJobCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
+ * // const { RekognitionClient, StartMediaAnalysisJobCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
+ * const client = new RekognitionClient(config);
+ * const input = { // StartMediaAnalysisJobRequest
+ *   ClientRequestToken: "STRING_VALUE",
+ *   JobName: "STRING_VALUE",
+ *   OperationsConfig: { // MediaAnalysisOperationsConfig
+ *     DetectModerationLabels: { // MediaAnalysisDetectModerationLabelsConfig
+ *       MinConfidence: Number("float"),
+ *       ProjectVersion: "STRING_VALUE",
+ *     },
+ *   },
+ *   Input: { // MediaAnalysisInput
+ *     S3Object: { // S3Object
+ *       Bucket: "STRING_VALUE",
+ *       Name: "STRING_VALUE",
+ *       Version: "STRING_VALUE",
+ *     },
+ *   },
+ *   OutputConfig: { // MediaAnalysisOutputConfig
+ *     S3Bucket: "STRING_VALUE", // required
+ *     S3KeyPrefix: "STRING_VALUE",
+ *   },
+ *   KmsKeyId: "STRING_VALUE",
+ * };
+ * const command = new StartMediaAnalysisJobCommand(input);
+ * const response = await client.send(command);
+ * // { // StartMediaAnalysisJobResponse
+ * //   JobId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param StartMediaAnalysisJobCommandInput - {@link StartMediaAnalysisJobCommandInput}
+ * @returns {@link StartMediaAnalysisJobCommandOutput}
+ * @see {@link StartMediaAnalysisJobCommandInput} for command's `input` shape.
+ * @see {@link StartMediaAnalysisJobCommandOutput} for command's `response` shape.
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You are not authorized to perform the action.</p>
+ *
+ * @throws {@link IdempotentParameterMismatchException} (client fault)
+ *  <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
+ *         parameters is different from the previous call to the operation.</p>
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
+ *
+ * @throws {@link InvalidManifestException} (client fault)
+ *  <p>Indicates that a provided manifest file is empty or larger than the allowed limit.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>Input parameter violated a constraint. Validate your parameter before calling the API
+ *       operation again.</p>
+ *
+ * @throws {@link InvalidS3ObjectException} (client fault)
+ *  <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
+ *             concurrently, subsequent calls to start operations (ex:
+ *             <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
+ *             exception (HTTP status code: 400) until the number of concurrently running jobs is below
+ *             the Amazon Rekognition service limit. </p>
+ *
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
+ *  <p>The number of requests exceeded your throughput limit. If you want to increase this
+ *       limit, contact Amazon Rekognition.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource specified in the request cannot be found.</p>
+ *
+ * @throws {@link ResourceNotReadyException} (client fault)
+ *  <p>The requested resource isn't ready. For example,
+ *          this exception occurs when you call <code>DetectCustomLabels</code> with a
+ *          model version that isn't deployed. </p>
+ *
+ * @throws {@link ThrottlingException} (server fault)
+ *  <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
+ *
+ * @throws {@link RekognitionServiceException}
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
+ *
+ */
+export declare class StartMediaAnalysisJobCommand extends $Command<StartMediaAnalysisJobCommandInput, StartMediaAnalysisJobCommandOutput, RekognitionClientResolvedConfig> {
+    readonly input: StartMediaAnalysisJobCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: StartMediaAnalysisJobCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartMediaAnalysisJobCommandInput, StartMediaAnalysisJobCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -36,6 +36,7 @@ export * from "./GetFaceDetectionCommand";
 export * from "./GetFaceLivenessSessionResultsCommand";
 export * from "./GetFaceSearchCommand";
 export * from "./GetLabelDetectionCommand";
+export * from "./GetMediaAnalysisJobCommand";
 export * from "./GetPersonTrackingCommand";
 export * from "./GetSegmentDetectionCommand";
 export * from "./GetTextDetectionCommand";
@@ -44,6 +45,7 @@ export * from "./ListCollectionsCommand";
 export * from "./ListDatasetEntriesCommand";
 export * from "./ListDatasetLabelsCommand";
 export * from "./ListFacesCommand";
+export * from "./ListMediaAnalysisJobsCommand";
 export * from "./ListProjectPoliciesCommand";
 export * from "./ListStreamProcessorsCommand";
 export * from "./ListTagsForResourceCommand";
@@ -59,6 +61,7 @@ export * from "./StartContentModerationCommand";
 export * from "./StartFaceDetectionCommand";
 export * from "./StartFaceSearchCommand";
 export * from "./StartLabelDetectionCommand";
+export * from "./StartMediaAnalysisJobCommand";
 export * from "./StartPersonTrackingCommand";
 export * from "./StartProjectVersionCommand";
 export * from "./StartSegmentDetectionCommand";