Amazon Rekognition¶

Description¶

This is the API Reference for Amazon Rekognition Image, Amazon Rekognition Bulk Image Analysis, Amazon Rekognition Custom Labels, Amazon Rekognition Stored Video, Amazon Rekognition Face Liveness, 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 Bulk Image Analysis

get_media_analysis_job ListMediaAnalysisJob start_media_analysis_job

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 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 Face Liveness

create_face_liveness_session get_face_liveness_session_results StartFaceLivenessSession

Amazon Rekognition 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
  • use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.

• 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",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

Examples¶

svc <- rekognition()
# This operation compares the largest face detected in the source image
# with each face detected in the target image.
svc$compare_faces(
  SimilarityThreshold = 90L,
  SourceImage = list(
    S3Object = list(
      Bucket = "mybucket",
      Name = "mysourceimage"
    )
  ),
  TargetImage = list(
    S3Object = list(
      Bucket = "mybucket",
      Name = "mytargetimage"
    )
  )
)