rekognition: Amazon Rekognition
In paws: Amazon Web Services Software Development Kit

rekognition

R Documentation

Amazon Rekognition

Description

This is the API Reference for Amazon Rekognition Image, Amazon Rekognition Custom Labels, Amazon Rekognition Stored Video, Amazon Rekognition Streaming Video. It provides descriptions of actions, data types, common parameters, and common errors.

Amazon Rekognition Image

associate_faces
compare_faces
create_collection
create_user
delete_collection
delete_faces
delete_user
describe_collection
detect_faces
detect_labels
detect_moderation_labels
detect_protective_equipment
detect_text
disassociate_faces
get_celebrity_info
index_faces
list_collections
list_faces
list_users
recognize_celebrities
search_faces
search_faces_by_image
search_users
search_users_by_image

Amazon Rekognition Custom Labels

copy_project_version
create_dataset
create_project
create_project_version
delete_dataset
delete_project
delete_project_policy
delete_project_version
describe_dataset
describe_projects
describe_project_versions
detect_custom_labels
distribute_dataset_entries
list_dataset_entries
list_dataset_labels
list_project_policies
put_project_policy
start_project_version
stop_project_version
update_dataset_entries

Amazon Rekognition Video Stored Video

get_celebrity_recognition
get_content_moderation
get_face_detection
get_face_search
get_label_detection
get_person_tracking
get_segment_detection
get_text_detection
start_celebrity_recognition
start_content_moderation
start_face_detection
start_face_search
start_label_detection
start_person_tracking
start_segment_detection
start_text_detection

Amazon Rekognition Video Streaming Video

create_stream_processor
delete_stream_processor
describe_stream_processor
list_stream_processors
start_stream_processor
stop_stream_processor
update_stream_processor

Usage

rekognition(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

`config`	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to `true` to force the request to use path-style addressing, i.e. `⁠http://s3.amazonaws.com/BUCKET/KEY⁠`. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
`credentials`	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
`endpoint`	Optional shorthand for complete URL to use for the constructed client.
`region`	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- rekognition(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

associate_faces	Associates one or more faces with an existing UserID
compare_faces	Compares a face in the source input image with each of the 100 largest faces detected in the target input image
copy_project_version	Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project
create_collection	Creates a collection in an AWS Region
create_dataset	Creates a new Amazon Rekognition Custom Labels dataset
create_face_liveness_session	This API operation initiates a Face Liveness session
create_project	Creates a new Amazon Rekognition Custom Labels project
create_project_version	Creates a new version of a model and begins training
create_stream_processor	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	Creates a new User within a collection specified by CollectionId
delete_collection	Deletes the specified collection
delete_dataset	Deletes an existing Amazon Rekognition Custom Labels dataset
delete_faces	Deletes faces from a collection
delete_project	Deletes an Amazon Rekognition Custom Labels project
delete_project_policy	Deletes an existing project policy
delete_project_version	Deletes an Amazon Rekognition Custom Labels model
delete_stream_processor	Deletes the stream processor identified by Name
delete_user	Deletes the specified UserID within the collection
describe_collection	Describes the specified collection
describe_dataset	Describes an Amazon Rekognition Custom Labels dataset
describe_projects	Gets information about your Amazon Rekognition Custom Labels projects
describe_project_versions	Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project
describe_stream_processor	Provides information about a stream processor created by CreateStreamProcessor
detect_custom_labels	Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model
detect_faces	Detects faces within an image that is provided as input
detect_labels	Detects instances of real-world entities within an image (JPEG or PNG) provided as input
detect_moderation_labels	Detects unsafe content in a specified JPEG or PNG format image
detect_protective_equipment	Detects Personal Protective Equipment (PPE) worn by people detected in an image
detect_text	Detects text in the input image and converts it into machine-readable text
disassociate_faces	Removes the association between a Face supplied in an array of FaceIds and the User
distribute_dataset_entries	Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project
get_celebrity_info	Gets the name and additional information about a celebrity based on their Amazon Rekognition ID
get_celebrity_recognition	Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition
get_content_moderation	Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration
get_face_detection	Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection
get_face_liveness_session_results	Retrieves the results of a specific Face Liveness session
get_face_search	Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch
get_label_detection	Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection
get_person_tracking	Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking
get_segment_detection	Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection
get_text_detection	Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection
index_faces	Detects faces in the input image and adds them to the specified collection
list_collections	Returns list of collection IDs in your account
list_dataset_entries	Lists the entries (images) within a dataset
list_dataset_labels	Lists the labels in a dataset
list_faces	Returns metadata for faces in the specified collection
list_project_policies	Gets a list of the project policies attached to a project
list_stream_processors	Gets a list of stream processors that you have created with CreateStreamProcessor
list_tags_for_resource	Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model
list_users	Returns metadata of the User such as UserID in the specified collection
put_project_policy	Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account
recognize_celebrities	Returns an array of celebrities recognized in the input image
search_faces	For a given input face ID, searches for matching faces in the collection the face belongs to
search_faces_by_image	For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces
search_users	Searches for UserIDs within a collection based on a FaceId or UserId
search_users_by_image	Searches for UserIDs using a supplied image
start_celebrity_recognition	Starts asynchronous recognition of celebrities in a stored video
start_content_moderation	Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video
start_face_detection	Starts asynchronous detection of faces in a stored video
start_face_search	Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video
start_label_detection	Starts asynchronous detection of labels in a stored video
start_person_tracking	Starts the asynchronous tracking of a person's path in a stored video
start_project_version	Starts the running of the version of a model
start_segment_detection	Starts asynchronous detection of segment detection in a stored video
start_stream_processor	Starts processing a stream processor
start_text_detection	Starts asynchronous detection of text in a stored video
stop_project_version	Stops a running model
stop_stream_processor	Stops a running stream processor that was created by CreateStreamProcessor
tag_resource	Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model
untag_resource	Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model
update_dataset_entries	Adds or updates one or more entries (images) in a dataset
update_stream_processor	Allows you to update a stream processor

Examples

## Not run: 
svc <- rekognition()
# This operation associates one or more faces with an existing UserID.
svc$associate_faces(
  ClientRequestToken = "550e8400-e29b-41d4-a716-446655440002",
  CollectionId = "MyCollection",
  FaceIds = list(
    "f5817d37-94f6-4335-bfee-6cf79a3d806e",
    "851cb847-dccc-4fea-9309-9f4805967855",
    "35ebbb41-7f67-4263-908d-dd0ecba05ab9"
  ),
  UserId = "DemoUser",
  UserMatchThreshold = 70L
)

## End(Not run)

paws documentation built on Sept. 15, 2023, 5:06 p.m.