@aws-sdk/client-rekognition 3.434.0 → 3.436.0

package/dist-cjs/runtimeConfig.js

@@ -4,6 +4,7 @@ exports.getRuntimeConfig = void 0;
 const tslib_1 = require("tslib");
 const package_json_1 = tslib_1.__importDefault(require("../package.json"));
 const client_sts_1 = require("@aws-sdk/client-sts");
+const core_1 = require("@aws-sdk/core");
 const credential_provider_node_1 = require("@aws-sdk/credential-provider-node");
 const util_user_agent_node_1 = require("@aws-sdk/util-user-agent-node");
 const config_resolver_1 = require("@smithy/config-resolver");
@@ -22,6 +23,7 @@ const getRuntimeConfig = (config) => {
     const defaultsMode = (0, util_defaults_mode_node_1.resolveDefaultsModeConfig)(config);
     const defaultConfigProvider = () => defaultsMode().then(smithy_client_1.loadConfigsForDefaultMode);
     const clientSharedValues = (0, runtimeConfig_shared_1.getRuntimeConfig)(config);
+    (0, core_1.emitWarningIfUnsupportedVersion)(process.version);
     return {
         ...clientSharedValues,
         ...config,

package/dist-cjs/runtimeConfig.shared.js

@@ -6,17 +6,19 @@ const url_parser_1 = require("@smithy/url-parser");
 const util_base64_1 = require("@smithy/util-base64");
 const util_utf8_1 = require("@smithy/util-utf8");
 const endpointResolver_1 = require("./endpoint/endpointResolver");
-const getRuntimeConfig = (config) => ({
-    apiVersion: "2016-06-27",
-    base64Decoder: config?.base64Decoder ?? util_base64_1.fromBase64,
-    base64Encoder: config?.base64Encoder ?? util_base64_1.toBase64,
-    disableHostPrefix: config?.disableHostPrefix ?? false,
-    endpointProvider: config?.endpointProvider ?? endpointResolver_1.defaultEndpointResolver,
-    extensions: config?.extensions ?? [],
-    logger: config?.logger ?? new smithy_client_1.NoOpLogger(),
-    serviceId: config?.serviceId ?? "Rekognition",
-    urlParser: config?.urlParser ?? url_parser_1.parseUrl,
-    utf8Decoder: config?.utf8Decoder ?? util_utf8_1.fromUtf8,
-    utf8Encoder: config?.utf8Encoder ?? util_utf8_1.toUtf8,
-});
+const getRuntimeConfig = (config) => {
+    return {
+        apiVersion: "2016-06-27",
+        base64Decoder: config?.base64Decoder ?? util_base64_1.fromBase64,
+        base64Encoder: config?.base64Encoder ?? util_base64_1.toBase64,
+        disableHostPrefix: config?.disableHostPrefix ?? false,
+        endpointProvider: config?.endpointProvider ?? endpointResolver_1.defaultEndpointResolver,
+        extensions: config?.extensions ?? [],
+        logger: config?.logger ?? new smithy_client_1.NoOpLogger(),
+        serviceId: config?.serviceId ?? "Rekognition",
+        urlParser: config?.urlParser ?? url_parser_1.parseUrl,
+        utf8Decoder: config?.utf8Decoder ?? util_utf8_1.fromUtf8,
+        utf8Encoder: config?.utf8Encoder ?? util_utf8_1.toUtf8,
+    };
+};
 exports.getRuntimeConfig = getRuntimeConfig;

package/dist-es/runtimeConfig.js

@@ -1,5 +1,6 @@
 import packageInfo from "../package.json";
 import { decorateDefaultCredentialProvider } from "@aws-sdk/client-sts";
+import { emitWarningIfUnsupportedVersion as awsCheckVersion } from "@aws-sdk/core";
 import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
 import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
 import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS, NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, } from "@smithy/config-resolver";
@@ -18,6 +19,7 @@ export const getRuntimeConfig = (config) => {
     const defaultsMode = resolveDefaultsModeConfig(config);
     const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
     const clientSharedValues = getSharedRuntimeConfig(config);
+    awsCheckVersion(process.version);
     return {
         ...clientSharedValues,
         ...config,

package/dist-es/runtimeConfig.shared.js

@@ -3,16 +3,18 @@ import { parseUrl } from "@smithy/url-parser";
 import { fromBase64, toBase64 } from "@smithy/util-base64";
 import { fromUtf8, toUtf8 } from "@smithy/util-utf8";
 import { defaultEndpointResolver } from "./endpoint/endpointResolver";
-export const getRuntimeConfig = (config) => ({
-    apiVersion: "2016-06-27",
-    base64Decoder: config?.base64Decoder ?? fromBase64,
-    base64Encoder: config?.base64Encoder ?? toBase64,
-    disableHostPrefix: config?.disableHostPrefix ?? false,
-    endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
-    extensions: config?.extensions ?? [],
-    logger: config?.logger ?? new NoOpLogger(),
-    serviceId: config?.serviceId ?? "Rekognition",
-    urlParser: config?.urlParser ?? parseUrl,
-    utf8Decoder: config?.utf8Decoder ?? fromUtf8,
-    utf8Encoder: config?.utf8Encoder ?? toUtf8,
-});
+export const getRuntimeConfig = (config) => {
+    return {
+        apiVersion: "2016-06-27",
+        base64Decoder: config?.base64Decoder ?? fromBase64,
+        base64Encoder: config?.base64Encoder ?? toBase64,
+        disableHostPrefix: config?.disableHostPrefix ?? false,
+        endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
+        extensions: config?.extensions ?? [],
+        logger: config?.logger ?? new NoOpLogger(),
+        serviceId: config?.serviceId ?? "Rekognition",
+        urlParser: config?.urlParser ?? parseUrl,
+        utf8Decoder: config?.utf8Decoder ?? fromUtf8,
+        utf8Encoder: config?.utf8Encoder ?? toUtf8,
+    };
+};

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.436.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,8 +21,9 @@
   "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.436.0",
+    "@aws-sdk/core": "3.436.0",
+    "@aws-sdk/credential-provider-node": "3.436.0",
     "@aws-sdk/middleware-host-header": "3.433.0",
     "@aws-sdk/middleware-logger": "3.433.0",
     "@aws-sdk/middleware-recursion-detection": "3.433.0",