import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { RecognizeCelebritiesRequest, RecognizeCelebritiesResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link RecognizeCelebritiesCommand}. */ export interface RecognizeCelebritiesCommandInput extends RecognizeCelebritiesRequest { } /** * @public * * The output of {@link RecognizeCelebritiesCommand}. */ export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesResponse, __MetadataBearer { } declare const RecognizeCelebritiesCommand_base: { new (input: RecognizeCelebritiesCommandInput): import("@smithy/core/client").CommandImpl; new (input: RecognizeCelebritiesCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns an array of celebrities recognized in the input image. For more * information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

*

* RecognizeCelebrities returns the 64 largest faces in the image. It lists * the recognized celebrities in the CelebrityFaces array and any unrecognized faces * in the UnrecognizedFaces array. RecognizeCelebrities doesn't return * celebrities whose faces aren't among the largest 64 faces in the image.

*

For each celebrity recognized, RecognizeCelebrities returns a * Celebrity object. The Celebrity object contains the celebrity * name, ID, URL links to additional information, match confidence, and a * ComparedFace object that you can use to locate the celebrity's face on the * image.

*

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized * in. Your application must store this information and use the Celebrity ID * property as a unique identifier for the celebrity. If you don't store the celebrity name or * additional information URLs returned by RecognizeCelebrities, you will need the * ID to identify the celebrity in a call to the GetCelebrityInfo * operation.

*

You pass the input image either as base64-encoded image bytes or as a reference to an * image in an Amazon S3 bucket. If you use the * AWS * CLI to call Amazon Rekognition operations, passing image bytes is not * supported. The image must be either a PNG or JPEG formatted file.

*

For an example, see Recognizing celebrities in an image in the Amazon Rekognition * Developer Guide.

*

This operation requires permissions to perform the * rekognition:RecognizeCelebrities operation.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RekognitionClient, RecognizeCelebritiesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import * // const { RekognitionClient, RecognizeCelebritiesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import * // import type { RekognitionClientConfig } from "@aws-sdk/client-rekognition"; * const config = {}; // type is RekognitionClientConfig * const client = new RekognitionClient(config); * const input = { // RecognizeCelebritiesRequest * Image: { // Image * Bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") * S3Object: { // S3Object * Bucket: "STRING_VALUE", * Name: "STRING_VALUE", * Version: "STRING_VALUE", * }, * }, * }; * const command = new RecognizeCelebritiesCommand(input); * const response = await client.send(command); * // { // RecognizeCelebritiesResponse * // CelebrityFaces: [ // CelebrityList * // { // Celebrity * // Urls: [ // Urls * // "STRING_VALUE", * // ], * // Name: "STRING_VALUE", * // Id: "STRING_VALUE", * // Face: { // ComparedFace * // BoundingBox: { // BoundingBox * // Width: Number("float"), * // Height: Number("float"), * // Left: Number("float"), * // Top: Number("float"), * // }, * // Confidence: Number("float"), * // Landmarks: [ // Landmarks * // { // Landmark * // Type: "eyeLeft" || "eyeRight" || "nose" || "mouthLeft" || "mouthRight" || "leftEyeBrowLeft" || "leftEyeBrowRight" || "leftEyeBrowUp" || "rightEyeBrowLeft" || "rightEyeBrowRight" || "rightEyeBrowUp" || "leftEyeLeft" || "leftEyeRight" || "leftEyeUp" || "leftEyeDown" || "rightEyeLeft" || "rightEyeRight" || "rightEyeUp" || "rightEyeDown" || "noseLeft" || "noseRight" || "mouthUp" || "mouthDown" || "leftPupil" || "rightPupil" || "upperJawlineLeft" || "midJawlineLeft" || "chinBottom" || "midJawlineRight" || "upperJawlineRight", * // X: Number("float"), * // Y: Number("float"), * // }, * // ], * // Pose: { // Pose * // Roll: Number("float"), * // Yaw: Number("float"), * // Pitch: Number("float"), * // }, * // Quality: { // ImageQuality * // Brightness: Number("float"), * // Sharpness: Number("float"), * // }, * // Emotions: [ // Emotions * // { // Emotion * // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR", * // Confidence: Number("float"), * // }, * // ], * // Smile: { // Smile * // Value: true || false, * // Confidence: Number("float"), * // }, * // }, * // MatchConfidence: Number("float"), * // KnownGender: { // KnownGender * // Type: "Male" || "Female" || "Nonbinary" || "Unlisted", * // }, * // }, * // ], * // UnrecognizedFaces: [ // ComparedFaceList * // { * // BoundingBox: { * // Width: Number("float"), * // Height: Number("float"), * // Left: Number("float"), * // Top: Number("float"), * // }, * // Confidence: Number("float"), * // Landmarks: [ * // { * // Type: "eyeLeft" || "eyeRight" || "nose" || "mouthLeft" || "mouthRight" || "leftEyeBrowLeft" || "leftEyeBrowRight" || "leftEyeBrowUp" || "rightEyeBrowLeft" || "rightEyeBrowRight" || "rightEyeBrowUp" || "leftEyeLeft" || "leftEyeRight" || "leftEyeUp" || "leftEyeDown" || "rightEyeLeft" || "rightEyeRight" || "rightEyeUp" || "rightEyeDown" || "noseLeft" || "noseRight" || "mouthUp" || "mouthDown" || "leftPupil" || "rightPupil" || "upperJawlineLeft" || "midJawlineLeft" || "chinBottom" || "midJawlineRight" || "upperJawlineRight", * // X: Number("float"), * // Y: Number("float"), * // }, * // ], * // Pose: { * // Roll: Number("float"), * // Yaw: Number("float"), * // Pitch: Number("float"), * // }, * // Quality: { * // Brightness: Number("float"), * // Sharpness: Number("float"), * // }, * // Emotions: [ * // { * // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR", * // Confidence: Number("float"), * // }, * // ], * // Smile: { * // Value: true || false, * // Confidence: Number("float"), * // }, * // }, * // ], * // OrientationCorrection: "ROTATE_0" || "ROTATE_90" || "ROTATE_180" || "ROTATE_270", * // }; * * ``` * * @param RecognizeCelebritiesCommandInput - {@link RecognizeCelebritiesCommandInput} * @returns {@link RecognizeCelebritiesCommandOutput} * @see {@link RecognizeCelebritiesCommandInput} for command's `input` shape. * @see {@link RecognizeCelebritiesCommandOutput} for command's `response` shape. * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You are not authorized to perform the action.

* * @throws {@link ImageTooLargeException} (client fault) *

The input image size exceeds the allowed limit. If you are calling * DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more * information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. *

* * @throws {@link InternalServerError} (server fault) *

Amazon Rekognition experienced a service issue. Try your call again.

* * @throws {@link InvalidImageFormatException} (client fault) *

The provided image format is not supported.

* * @throws {@link InvalidParameterException} (client fault) *

Input parameter violated a constraint. Validate your parameter before calling the API * operation again.

* * @throws {@link InvalidS3ObjectException} (client fault) *

Amazon Rekognition is unable to access the S3 object specified in the request.

* * @throws {@link ProvisionedThroughputExceededException} (client fault) *

The number of requests exceeded your throughput limit. If you want to increase this * limit, contact Amazon Rekognition.

* * @throws {@link ThrottlingException} (server fault) *

Amazon Rekognition is temporarily unable to process the request. Try your call again.

* * @throws {@link RekognitionServiceException} *

Base exception class for all service exceptions from Rekognition service.

* * * @public */ export declare class RecognizeCelebritiesCommand extends RecognizeCelebritiesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: RecognizeCelebritiesRequest; output: RecognizeCelebritiesResponse; }; sdk: { input: RecognizeCelebritiesCommandInput; output: RecognizeCelebritiesCommandOutput; }; }; }