Class: Aws::Rekognition::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::Rekognition::Client

Includes:

ClientStubs

Defined in:

gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/client.rb

Overview

An API client for Rekognition. To construct a client, you need to configure a :region and :credentials.

client = Aws::Rekognition::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations

• #associate_faces(params = {}) ⇒ Types::AssociateFacesResponse

  Associates one or more faces with an existing UserID.

• #compare_faces(params = {}) ⇒ Types::CompareFacesResponse

  Compares a face in the source input image with each of the 100 largest faces detected in the target input image.

• #copy_project_version(params = {}) ⇒ Types::CopyProjectVersionResponse

  This operation applies only to Amazon Rekognition Custom Labels.

• #create_collection(params = {}) ⇒ Types::CreateCollectionResponse

  Creates a collection in an AWS Region.

• #create_dataset(params = {}) ⇒ Types::CreateDatasetResponse

  This operation applies only to Amazon Rekognition Custom Labels.

• #create_face_liveness_session(params = {}) ⇒ Types::CreateFaceLivenessSessionResponse

  This API operation initiates a Face Liveness session.

• #create_project(params = {}) ⇒ Types::CreateProjectResponse

  Creates a new Amazon Rekognition project.

• #create_project_version(params = {}) ⇒ Types::CreateProjectVersionResponse

  Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training.

• #create_stream_processor(params = {}) ⇒ Types::CreateStreamProcessorResponse

  Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.

• #create_user(params = {}) ⇒ Struct

  Creates a new User within a collection specified by CollectionId.

• #delete_collection(params = {}) ⇒ Types::DeleteCollectionResponse

  Deletes the specified collection.

• #delete_dataset(params = {}) ⇒ Struct

  This operation applies only to Amazon Rekognition Custom Labels.

• #delete_faces(params = {}) ⇒ Types::DeleteFacesResponse

  Deletes faces from a collection.

• #delete_project(params = {}) ⇒ Types::DeleteProjectResponse

  Deletes a Amazon Rekognition project.

• #delete_project_policy(params = {}) ⇒ Struct

  This operation applies only to Amazon Rekognition Custom Labels.

• #delete_project_version(params = {}) ⇒ Types::DeleteProjectVersionResponse

  Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter.

• #delete_stream_processor(params = {}) ⇒ Struct

  Deletes the stream processor identified by Name.

• #delete_user(params = {}) ⇒ Struct

  Deletes the specified UserID within the collection.

• #describe_collection(params = {}) ⇒ Types::DescribeCollectionResponse

  Describes the specified collection.

• #describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse

  This operation applies only to Amazon Rekognition Custom Labels.

• #describe_project_versions(params = {}) ⇒ Types::DescribeProjectVersionsResponse

  Lists and describes the versions of an Amazon Rekognition project.

• #describe_projects(params = {}) ⇒ Types::DescribeProjectsResponse

  Gets information about your Rekognition projects.

• #describe_stream_processor(params = {}) ⇒ Types::DescribeStreamProcessorResponse

  Provides information about a stream processor created by CreateStreamProcessor.

• #detect_custom_labels(params = {}) ⇒ Types::DetectCustomLabelsResponse

  This operation applies only to Amazon Rekognition Custom Labels.

• #detect_faces(params = {}) ⇒ Types::DetectFacesResponse

  Detects faces within an image that is provided as input.

• #detect_labels(params = {}) ⇒ Types::DetectLabelsResponse

  Detects instances of real-world entities within an image (JPEG or PNG) provided as input.

• #detect_moderation_labels(params = {}) ⇒ Types::DetectModerationLabelsResponse

  Detects unsafe content in a specified JPEG or PNG format image.

• #detect_protective_equipment(params = {}) ⇒ Types::DetectProtectiveEquipmentResponse

  Detects Personal Protective Equipment (PPE) worn by people detected in an image.

• #detect_text(params = {}) ⇒ Types::DetectTextResponse

  Detects text in the input image and converts it into machine-readable text.

• #disassociate_faces(params = {}) ⇒ Types::DisassociateFacesResponse

  Removes the association between a Face supplied in an array of FaceIds and the User.

• #distribute_dataset_entries(params = {}) ⇒ Struct

  This operation applies only to Amazon Rekognition Custom Labels.