5.0.0 • Published 7 years ago

@datafire/amazonaws_rekognition v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@datafire/amazonaws_rekognition

Client library for Amazon Rekognition

Installation and Usage

npm install --save @datafire/amazonaws_rekognition
let amazonaws_rekognition = require('@datafire/amazonaws_rekognition').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_rekognition.CompareFaces({
  "SourceImage": {},
  "TargetImage": {}
}).then(data => {
  console.log(data);
});

Description

This is the Amazon Rekognition API reference.

Actions

CompareFaces

amazonaws_rekognition.CompareFaces({
  "SourceImage": {},
  "TargetImage": {}
}, context)

Input

  • input object

Output

CreateCollection

amazonaws_rekognition.CreateCollection({
  "CollectionId": ""
}, context)

Input

Output

CreateStreamProcessor

amazonaws_rekognition.CreateStreamProcessor({
  "Input": {},
  "Output": {},
  "Name": "",
  "Settings": {},
  "RoleArn": ""
}, context)

Input

Output

DeleteCollection

amazonaws_rekognition.DeleteCollection({
  "CollectionId": ""
}, context)

Input

Output

DeleteFaces

amazonaws_rekognition.DeleteFaces({
  "CollectionId": "",
  "FaceIds": []
}, context)

Input

Output

DeleteStreamProcessor

amazonaws_rekognition.DeleteStreamProcessor({
  "Name": ""
}, context)

Input

Output

DescribeStreamProcessor

amazonaws_rekognition.DescribeStreamProcessor({
  "Name": ""
}, context)

Input

Output

DetectFaces

amazonaws_rekognition.DetectFaces({
  "Image": {}
}, context)

Input

Output

DetectLabels

amazonaws_rekognition.DetectLabels({
  "Image": {}
}, context)

Input

Output

DetectModerationLabels

amazonaws_rekognition.DetectModerationLabels({
  "Image": {}
}, context)

Input

Output

DetectText

amazonaws_rekognition.DetectText({
  "Image": {}
}, context)

Input

  • input object

Output

GetCelebrityInfo

amazonaws_rekognition.GetCelebrityInfo({
  "Id": ""
}, context)

Input

Output

GetCelebrityRecognition

amazonaws_rekognition.GetCelebrityRecognition({
  "JobId": ""
}, context)

Input

Output

GetContentModeration

amazonaws_rekognition.GetContentModeration({
  "JobId": ""
}, context)

Input

Output

GetFaceDetection

amazonaws_rekognition.GetFaceDetection({
  "JobId": ""
}, context)

Input

Output

GetFaceSearch

amazonaws_rekognition.GetFaceSearch({
  "JobId": ""
}, context)

Input

Output

GetLabelDetection

amazonaws_rekognition.GetLabelDetection({
  "JobId": ""
}, context)

Input

Output

GetPersonTracking

amazonaws_rekognition.GetPersonTracking({
  "JobId": ""
}, context)

Input

Output

IndexFaces

amazonaws_rekognition.IndexFaces({
  "CollectionId": "",
  "Image": {}
}, context)

Input

Output

ListCollections

amazonaws_rekognition.ListCollections({}, context)

Input

Output

ListFaces

amazonaws_rekognition.ListFaces({
  "CollectionId": ""
}, context)

Input

Output

ListStreamProcessors

amazonaws_rekognition.ListStreamProcessors({}, context)

Input

Output

RecognizeCelebrities

amazonaws_rekognition.RecognizeCelebrities({
  "Image": {}
}, context)

Input

  • input object

Output

SearchFaces

amazonaws_rekognition.SearchFaces({
  "CollectionId": "",
  "FaceId": ""
}, context)

Input

Output

SearchFacesByImage

amazonaws_rekognition.SearchFacesByImage({
  "CollectionId": "",
  "Image": {}
}, context)

Input

Output

StartCelebrityRecognition

amazonaws_rekognition.StartCelebrityRecognition({
  "Video": {}
}, context)

Input

Output

StartContentModeration

amazonaws_rekognition.StartContentModeration({
  "Video": {}
}, context)

Input

Output

StartFaceDetection

amazonaws_rekognition.StartFaceDetection({
  "Video": {}
}, context)

Input

Output

StartFaceSearch

amazonaws_rekognition.StartFaceSearch({
  "Video": {},
  "CollectionId": ""
}, context)

Input

Output

StartLabelDetection

amazonaws_rekognition.StartLabelDetection({
  "Video": {}
}, context)

Input

Output

StartPersonTracking

amazonaws_rekognition.StartPersonTracking({
  "Video": {}
}, context)

Input

Output

StartStreamProcessor

amazonaws_rekognition.StartStreamProcessor({
  "Name": ""
}, context)

Input

Output

StopStreamProcessor

amazonaws_rekognition.StopStreamProcessor({
  "Name": ""
}, context)

Input

Output

Definitions

AccessDeniedException

  • AccessDeniedException object: You are not authorized to perform the action.

AgeRange

  • AgeRange object: Structure containing the estimated age range, in years, for a face. Rekognition estimates an age-range for faces detected in the input image. Estimated age ranges can overlap; a face of a 5 year old may have an estimated range of 4-6 whilst the face of a 6 year old may have an estimated range of 4-8.

Attribute

  • Attribute string (values: DEFAULT, ALL)

Attributes

Beard

  • Beard object: Indicates whether or not the face has a beard, and the confidence level in the determination.

Boolean

  • Boolean boolean

BoundingBox

  • BoundingBox object: Identifies the bounding box around the object, face or text. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0). The top and left values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200). The width and height values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left or top values.

Celebrity

CelebrityDetail

CelebrityList

CelebrityRecognition

  • CelebrityRecognition object: Information about a detected celebrity and the time the celebrity was detected in a stored video. For more information, see .

CelebrityRecognitionSortBy

  • CelebrityRecognitionSortBy string (values: ID, TIMESTAMP)

CelebrityRecognitions

ClientRequestToken

  • ClientRequestToken string

CollectionId

  • CollectionId string

CollectionIdList

CompareFacesMatch

  • CompareFacesMatch object: Provides information about a face in a target image that matches the source image face analysed by CompareFaces. The Face property contains the bounding box of the face in the target image. The Similarity property is the confidence that the source image face matches the face in the bounding box.

CompareFacesMatchList

CompareFacesRequest

  • CompareFacesRequest object

CompareFacesResponse

CompareFacesUnmatchList

ComparedFace

  • ComparedFace object: Provides face metadata for target image faces that are analysed by CompareFaces and RecognizeCelebrities.

ComparedFaceList

ComparedSourceImageFace

  • ComparedSourceImageFace object: Type that describes the face Amazon Rekognition chose to compare with the faces in the target. This contains a bounding box for the selected face and confidence level that the bounding box contains a face. Note that Amazon Rekognition selects the largest face in the source image for this comparison.

ContentModerationDetection

  • ContentModerationDetection object: Information about a moderation label detection in a stored video.

ContentModerationDetections

ContentModerationSortBy

  • ContentModerationSortBy string (values: NAME, TIMESTAMP)

CreateCollectionRequest

  • CreateCollectionRequest object

CreateCollectionResponse

CreateStreamProcessorRequest

CreateStreamProcessorResponse

DateTime

  • DateTime string

Degree

  • Degree number

DeleteCollectionRequest

  • DeleteCollectionRequest object

DeleteCollectionResponse

  • DeleteCollectionResponse object

DeleteFacesRequest

DeleteFacesResponse

DeleteStreamProcessorRequest

DeleteStreamProcessorResponse

  • DeleteStreamProcessorResponse object

DescribeStreamProcessorRequest

DescribeStreamProcessorResponse

DetectFacesRequest

DetectFacesResponse

DetectLabelsRequest

DetectLabelsResponse

DetectModerationLabelsRequest

  • DetectModerationLabelsRequest object

DetectModerationLabelsResponse

DetectTextRequest

  • DetectTextRequest object

DetectTextResponse

Emotion

  • Emotion object: The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

EmotionName

  • EmotionName string (values: HAPPY, SAD, ANGRY, CONFUSED, DISGUSTED, SURPRISED, CALM, UNKNOWN)

Emotions

ExternalImageId

  • ExternalImageId string

EyeOpen

  • EyeOpen object: Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

Eyeglasses

  • Eyeglasses object: Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

Face

  • Face object: Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

FaceAttributes

  • FaceAttributes string (values: DEFAULT, ALL)

FaceDetail

FaceDetailList

FaceDetection

  • FaceDetection object: Information about a face detected in a video analysis request and the time the face was detected in the video.

FaceDetections

FaceId

  • FaceId string

FaceIdList

FaceList

  • FaceList array

FaceMatch

  • FaceMatch object: Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.

FaceMatchList

FaceModelVersionList

  • FaceModelVersionList array

FaceRecord

  • FaceRecord object: Object containing both the face metadata (stored in the back-end database) and facial attributes that are detected but aren't stored in the database.

FaceRecordList

FaceSearchSettings

  • FaceSearchSettings object: Input face recognition parameters for an Amazon Rekognition stream processor. FaceRecognitionSettings is a request parameter for .

FaceSearchSortBy

  • FaceSearchSortBy string (values: INDEX, TIMESTAMP)

Float

  • Float number

Gender

  • Gender object: Gender of the face and the confidence level in the determination.

GenderType

  • GenderType string (values: Male, Female)

Geometry

  • Geometry object: Information about where text detected by is located on an image.

GetCelebrityInfoRequest

GetCelebrityInfoResponse

  • GetCelebrityInfoResponse object

GetCelebrityRecognitionRequest

GetCelebrityRecognitionResponse

GetContentModerationRequest

GetContentModerationResponse

GetFaceDetectionRequest

GetFaceDetectionResponse

GetFaceSearchRequest

GetFaceSearchResponse

GetLabelDetectionRequest

GetLabelDetectionResponse

GetPersonTrackingRequest

GetPersonTrackingResponse

IdempotentParameterMismatchException

  • IdempotentParameterMismatchException object: A ClientRequestToken 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.

Image

  • Image object: Provides the input image either as bytes or an S3 object. You pass image bytes to a Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Rekognition API operations. For more information, see images-bytes. You pass images stored in an S3 bucket to a Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded. The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property. For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see manage-access-resource-policies.

ImageBlob

  • ImageBlob string

ImageId

  • ImageId string

ImageQuality

  • ImageQuality object: Identifies face image brightness and sharpness.

ImageTooLargeException

  • ImageTooLargeException object: The input image size exceeds the allowed limit. For more information, see limits.

IndexFacesRequest

IndexFacesResponse

InternalServerError

  • InternalServerError object: Amazon Rekognition experienced a service issue. Try your call again.

InvalidImageFormatException

  • InvalidImageFormatException object: The provided image format is not supported.

InvalidPaginationTokenException

  • InvalidPaginationTokenException object: Pagination token in the request is not valid.

InvalidParameterException

  • InvalidParameterException object: Input parameter violated a constraint. Validate your parameter before calling the API operation again.

InvalidS3ObjectException

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

JobId

  • JobId string

JobTag

  • JobTag string

KinesisDataArn

  • KinesisDataArn string

KinesisDataStream

  • KinesisDataStream object: The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see .

KinesisVideoArn

  • KinesisVideoArn string

KinesisVideoStream

  • KinesisVideoStream object: Kinesis video stream stream that provides the source streaming video for a Rekognition Video stream processor. For more information, see .

Label

  • Label object: Structure containing details about the detected label, including name, and level of confidence.

LabelDetection

  • LabelDetection object: Information about a label detected in a video analysis request and the time the label was detected in the video.

LabelDetectionSortBy

  • LabelDetectionSortBy string (values: NAME, TIMESTAMP)

LabelDetections

Labels

Landmark

LandmarkType

  • LandmarkType string (values: 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)

Landmarks

LimitExceededException

  • LimitExceededException object:

ListCollectionsRequest

ListCollectionsResponse

ListFacesRequest

ListFacesResponse

ListStreamProcessorsRequest

ListStreamProcessorsResponse

MaxFaces

  • MaxFaces integer

MaxResults

  • MaxResults integer

ModerationLabel

  • ModerationLabel object: Provides information about a single type of moderated content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see moderation.

ModerationLabels

MouthOpen

  • MouthOpen object: Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

Mustache

  • Mustache object: Indicates whether or not the face has a mustache, and the confidence level in the determination.

NotificationChannel

  • NotificationChannel object: The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.

OrientationCorrection

  • OrientationCorrection string (values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270)

PageSize

  • PageSize integer

PaginationToken

  • PaginationToken string

Percent

  • Percent number

PersonDetail

PersonDetection

  • PersonDetection object: Details and tracking information for a single time a person is tracked in a video. Amazon Rekognition operations that track persons return an array of PersonDetection objects with elements for each time a person is tracked in a video. For more information, see .

PersonDetections

PersonIndex

  • PersonIndex integer

PersonMatch

  • PersonMatch object: Information about a person whose face matches a face(s) in a Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (,information about the person (PersonDetail) and the timestamp for when the person was detected in a video. An array of PersonMatch objects is returned by .

PersonMatches

PersonTrackingSortBy

  • PersonTrackingSortBy string (values: INDEX, TIMESTAMP)

Point

  • Point object: The X and Y coordinates of a point on an image. The X and Y values returned are ratios of the overall image size. For example, if the input image is 700x200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image. An array of Point objects, Polygon, is returned by . Polygon represents a fine-grained polygon around detected text. For more information, see .

Polygon

Pose

  • Pose object: Indicates the pose of the face as determined by its pitch, roll, and yaw.

ProvisionedThroughputExceededException

  • ProvisionedThroughputExceededException object: The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

RecognizeCelebritiesRequest

  • RecognizeCelebritiesRequest object

RecognizeCelebritiesResponse

RekognitionUniqueId

  • RekognitionUniqueId string

ResourceAlreadyExistsException

  • ResourceAlreadyExistsException object: A collection with the specified ID already exists.

ResourceInUseException

  • ResourceInUseException object:

ResourceNotFoundException

  • ResourceNotFoundException object: The collection specified in the request cannot be found.

RoleArn

  • RoleArn string

S3Bucket

  • S3Bucket string

S3Object

  • S3Object object: Provides the S3 bucket name and object name. The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations. For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see manage-access-resource-policies.

S3ObjectName

  • S3ObjectName string

S3ObjectVersion

  • S3ObjectVersion string

SNSTopicArn

  • SNSTopicArn string

SearchFacesByImageRequest

SearchFacesByImageResponse

SearchFacesRequest

SearchFacesResponse

Smile

  • Smile object: Indicates whether or not the face is smiling, and the confidence level in the determination.

StartCelebrityRecognitionRequest

StartCelebrityRecognitionResponse

  • StartCelebrityRecognitionResponse object

StartContentModerationRequest

StartContentModerationResponse

  • StartContentModerationResponse object

StartFaceDetectionRequest

StartFaceDetectionResponse

  • StartFaceDetectionResponse object

StartFaceSearchRequest

StartFaceSearchResponse

  • StartFaceSearchResponse object

StartLabelDetectionRequest

StartLabelDetectionResponse

  • StartLabelDetectionResponse object

StartPersonTrackingRequest

StartPersonTrackingResponse

  • StartPersonTrackingResponse object

StartStreamProcessorRequest

StartStreamProcessorResponse

  • StartStreamProcessorResponse object

StatusMessage

  • StatusMessage string

StopStreamProcessorRequest

StopStreamProcessorResponse

  • StopStreamProcessorResponse object

StreamProcessor

  • StreamProcessor object: An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to . The request parameters for CreateStreamProcessor describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.

StreamProcessorArn

  • StreamProcessorArn string

StreamProcessorInput

  • StreamProcessorInput object: Information about the source streaming video.

StreamProcessorList

StreamProcessorName

  • StreamProcessorName string

StreamProcessorOutput

  • StreamProcessorOutput object: Information about the Amazon Kinesis Data Streams stream to which a Rekognition Video stream processor streams the results of a video analysis. For more information, see .

StreamProcessorSettings

  • StreamProcessorSettings object: Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.

StreamProcessorStatus

  • StreamProcessorStatus string (values: STOPPED, STARTING, RUNNING, FAILED, STOPPING)

String

  • String string

Sunglasses

  • Sunglasses object: Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

TextDetection

  • TextDetection object: Information about a word or line of text detected by . The DetectedText field contains the text that Amazon Rekognition detected in the image. Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier (ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words. For more information, see text-detection.

TextDetectionList

TextTypes

  • TextTypes string (values: LINE, WORD)

ThrottlingException

  • ThrottlingException object: Amazon Rekognition is temporarily unable to process the request. Try your call again.

Timestamp

  • Timestamp integer

UInteger

  • UInteger integer

ULong

  • ULong integer

Url

  • Url string

Urls

  • Urls array

Video

  • Video object: Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

VideoJobStatus

  • VideoJobStatus string (values: IN_PROGRESS, SUCCEEDED, FAILED)

VideoMetadata

  • VideoMetadata object: Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

VideoTooLargeException

  • VideoTooLargeException object: The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

7 years ago

4.0.0

8 years ago

3.0.4

8 years ago

3.0.3

8 years ago

3.0.2

8 years ago

3.0.1

8 years ago

3.0.0

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago