Blame: javascriptv3/example_code/rekognition/README.md - awsdocs/aws-doc-sdk-examples

awsdocs / aws-doc-sdk-examples UNCLAIMED

Welcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.

0 0 0 Java

Normal View History Raw

Tools: WRITEME for javascriptv3 (#5840) * Tools: WRITEME for javascriptv3 * Add Java ALLOW words 2024-01-04 12:50:33 -05:00			`# Amazon Rekognition code examples for the SDK for JavaScript (v3)`

			`## Overview`

			`Shows how to use the AWS SDK for JavaScript (v3) to work with Amazon Rekognition.`

			`<!--custom.overview.start-->`
			`<!--custom.overview.end-->`

			`_Amazon Rekognition makes it easy to add image and video analysis to your applications._`

			`## ⚠ Important`

Tools: enforce writeme (#5880) * Tools: Enforce project-wide WRITEME 2024-01-09 12:33:12 -05:00			`* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).`
Tools: WRITEME for javascriptv3 (#5840) * Tools: WRITEME for javascriptv3 * Add Java ALLOW words 2024-01-04 12:50:33 -05:00			`* Running the tests might result in charges to your AWS account.`
			`* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).`
			`* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).`

			`<!--custom.important.start-->`
			`<!--custom.important.end-->`

			`## Code examples`

			`### Prerequisites`

			For prerequisites, see the [README](../../README.md#Prerequisites) in the `javascriptv3` folder.


			`<!--custom.prerequisites.start-->`
			`<!--custom.prerequisites.end-->`

			`<!--custom.examples.start-->`
			`<!--custom.examples.end-->`

			`## Run the examples`

			`### Instructions`

			`Note: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see`
			`[JavaScript ES6/CommonJS syntax](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sdk-examples-javascript-syntax.html).`

			`Run a single action`

			```bash
			`node ./actions/<fileName>`
			```

			`Run a scenario`
			`Most scenarios can be run with the following command:`
			```bash
			`node ./scenarios/<fileName>`
			```

			`<!--custom.instructions.start-->`
			`<!--custom.instructions.end-->`



			`### Tests`

			`⚠ Running tests might result in charges to your AWS account.`


			`To find instructions for running these tests, see the [README](../../README.md#Tests)`
			in the `javascriptv3` folder.



			`<!--custom.tests.start-->`
			`<!--custom.tests.end-->`

			`## Additional resources`

			`- [Amazon Rekognition Developer Guide](https://docs.aws.amazon.com/rekognition/latest/dg/what-is.html)`
			`- [Amazon Rekognition API Reference](https://docs.aws.amazon.com/rekognition/latest/APIReference/Welcome.html)`
			`- [SDK for JavaScript (v3) Amazon Rekognition reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/rekognition)`

			`<!--custom.resources.start-->`
			`<!--custom.resources.end-->`

			`---`

			`Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.`

			`SPDX-License-Identifier: Apache-2.0`