@aws-sdk/client-rekognition 3.434.0 → 3.435.0

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

@@ -111,6 +111,54 @@ export interface GetMediaAnalysisJobCommandOutput extends GetMediaAnalysisJobRes
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example GetMediaAnalysisJob
+ * ```javascript
+ * // Retrieves the results for a given media analysis job.
+ * const input = {
+ *   "JobId": "861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537"
+ * };
+ * const command = new GetMediaAnalysisJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CompletionTimestamp": "2023-07-28T08:05:51.958000-07:00",
+ *   "CreationTimestamp": "2023-07-28T08:05:51.958000-06:00",
+ *   "Input": {
+ *     "S3Object": {
+ *       "Bucket": "input-bucket",
+ *       "Name": "input-manifest.json"
+ *     }
+ *   },
+ *   "JobId": "861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537",
+ *   "JobName": "job-name",
+ *   "ManifestSummary": {
+ *     "S3Object": {
+ *       "Bucket": "output-bucket",
+ *       "Name": "output-location/861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537-manifest-summary.json"
+ *     }
+ *   },
+ *   "OperationsConfig": {
+ *     "DetectModerationLabels": {
+ *       "MinConfidence": 50,
+ *       "ProjectVersion": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
+ *     }
+ *   },
+ *   "OutputConfig": {
+ *     "S3Bucket": "output-bucket",
+ *     "S3KeyPrefix": "output-location"
+ *   },
+ *   "Results": {
+ *     "S3Object": {
+ *       "Bucket": "output-bucket",
+ *       "Name": "output-location/861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537-results.jsonl"
+ *     }
+ *   },
+ *   "Status": "SUCCEEDED"
+ * }
+ * *\/
+ * // example id: getmediaanalysisjob-1697650068124
+ * ```
+ *
  */
 export declare class GetMediaAnalysisJobCommand extends $Command<GetMediaAnalysisJobCommandInput, GetMediaAnalysisJobCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: GetMediaAnalysisJobCommandInput;

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

@@ -116,6 +116,58 @@ export interface ListMediaAnalysisJobsCommandOutput extends ListMediaAnalysisJob
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example ListMediaAnalysisJobs
+ * ```javascript
+ * // Returns a list of media analysis jobs.
+ * const input = {
+ *   "MaxResults": 10
+ * };
+ * const command = new ListMediaAnalysisJobsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "MediaAnalysisJobs": [
+ *     {
+ *       "CompletionTimestamp": "2023-07-28T08:05:51.958000-07:00",
+ *       "CreationTimestamp": "2023-07-28T08:05:51.958000-06:00",
+ *       "Input": {
+ *         "S3Object": {
+ *           "Bucket": "input-bucket",
+ *           "Name": "input-manifest.json"
+ *         }
+ *       },
+ *       "JobId": "861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537",
+ *       "JobName": "job-name",
+ *       "ManifestSummary": {
+ *         "S3Object": {
+ *           "Bucket": "output-bucket",
+ *           "Name": "output-location/861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537-manifest-summary.json"
+ *         }
+ *       },
+ *       "OperationsConfig": {
+ *         "DetectModerationLabels": {
+ *           "MinConfidence": 50,
+ *           "ProjectVersion": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
+ *         }
+ *       },
+ *       "OutputConfig": {
+ *         "S3Bucket": "output-bucket",
+ *         "S3KeyPrefix": "output-location"
+ *       },
+ *       "Results": {
+ *         "S3Object": {
+ *           "Bucket": "output-bucket",
+ *           "Name": "output-location/861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537-results.jsonl"
+ *         }
+ *       },
+ *       "Status": "SUCCEEDED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: listmediaanalysisjobs-1697650653077
+ * ```
+ *
  */
 export declare class ListMediaAnalysisJobsCommand extends $Command<ListMediaAnalysisJobsCommandInput, ListMediaAnalysisJobsCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: ListMediaAnalysisJobsCommandInput;

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

@@ -112,6 +112,38 @@ export interface StartMediaAnalysisJobCommandOutput extends StartMediaAnalysisJo
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example StartMediaAnalysisJob
+ * ```javascript
+ * // Initiates a new media analysis job.
+ * const input = {
+ *   "Input": {
+ *     "S3Object": {
+ *       "Bucket": "input-bucket",
+ *       "Name": "input-manifest.json"
+ *     }
+ *   },
+ *   "JobName": "job-name",
+ *   "OperationsConfig": {
+ *     "DetectModerationLabels": {
+ *       "MinConfidence": 50,
+ *       "ProjectVersion": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
+ *     }
+ *   },
+ *   "OutputConfig": {
+ *     "S3Bucket": "output-bucket",
+ *     "S3KeyPrefix": "output-location"
+ *   }
+ * };
+ * const command = new StartMediaAnalysisJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "JobId": "861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537"
+ * }
+ * *\/
+ * // example id: startmediaanalysisjob-1697651090922
+ * ```
+ *
  */
 export declare class StartMediaAnalysisJobCommand extends $Command<StartMediaAnalysisJobCommandInput, StartMediaAnalysisJobCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: StartMediaAnalysisJobCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-rekognition",
   "description": "AWS SDK for JavaScript Rekognition Client for Node.js, Browser and React Native",
-  "version": "3.434.0",
+  "version": "3.435.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,8 +21,8 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.433.0",
-    "@aws-sdk/credential-provider-node": "3.433.0",
+    "@aws-sdk/client-sts": "3.435.0",
+    "@aws-sdk/credential-provider-node": "3.435.0",
     "@aws-sdk/middleware-host-header": "3.433.0",
     "@aws-sdk/middleware-logger": "3.433.0",
     "@aws-sdk/middleware-recursion-detection": "3.433.0",