ExAws.Rekognition v0.6.0 ExAws.Rekognition View Source

Operations on ExAws Rekognition

Link to this section Summary

Functions

Link to this section Types

Link to this type

compare_faces_opt()

View Source
compare_faces_opt() :: {:similarity_threshold, 0..100}
Link to this type

create_stream_processor_opt()

View Source
create_stream_processor_opt() ::
  {:collection_id, binary()} | {:face_match_threshold, 0..100}
Link to this type

detect_faces_opt()

View Source
detect_faces_opt() :: {:attributes, [binary()]}
Link to this type

detect_labels_opt()

View Source
detect_labels_opt() ::
  {:max_labels, non_neg_integer()} | {:min_confidence, 0..100}
Link to this type

detect_moderation_labels_opt()

View Source
detect_moderation_labels_opt() :: {:min_confidence, 0..100}
Link to this type

get_celebrity_recognition_opt()

View Source
get_celebrity_recognition_opt() :: get_opt() | {:sort_by, :id | :timestamp}
Link to this type

get_content_moderation_opt()

View Source
get_content_moderation_opt() :: get_opt() | {:sort_by, :name | :timestamp}
Link to this type

get_face_detection_opt()

View Source
get_face_detection_opt() :: get_opt()
Link to this type

get_face_search_opt()

View Source
get_face_search_opt() :: get_opt() | {:sort_by, :index | :timestamp}
Link to this type

get_label_detection_opt()

View Source
get_label_detection_opt() :: get_opt() | {:sort_by, :name | :timestamp}
Link to this type

get_opt()

View Source
get_opt() :: {:max_results, pos_integer()} | {:next_token, binary()}
Link to this type

get_person_tracking_opt()

View Source
get_person_tracking_opt() :: get_opt() | {:sort_by, :index | :timestamp}
Link to this type

index_faces_opt()

View Source
index_faces_opt() ::
  {:external_image_id, binary()}
  | {:detection_attributes, [binary()]}
  | {:max_faces, pos_integer()}
  | {:quality_filter, :auto | :none}
Link to this type

list_collections_opt()

View Source
list_collections_opt() :: list_opt()
Link to this type

list_faces_opt()

View Source
list_faces_opt() :: list_opt()
Link to this type

list_opt()

View Source
list_opt() :: {:max_results, 0..4096} | {:next_token, binary()}
Link to this type

list_stream_processors_opt()

View Source
list_stream_processors_opt() :: list_opt()
Link to this type

search_faces_by_image_opt()

View Source
search_faces_by_image_opt() :: search_faces_opt()
Link to this type

search_faces_opt()

View Source
search_faces_opt() :: {:face_match_threshold, 0..100} | {:max_faces, 1..4096}
Link to this type

start_celebrity_recognition_opt()

View Source
start_celebrity_recognition_opt() :: start_opt()
Link to this type

start_content_moderation_opt()

View Source
start_content_moderation_opt() :: start_opt() | {:min_confidence, 0..100}
Link to this type

start_face_detection_opt()

View Source
start_face_detection_opt() :: start_opt() | {:face_attributes, :default | :all}
Link to this type

start_face_search_opt()

View Source
start_face_search_opt() :: start_opt() | {:face_match_threshold, 0..100}
Link to this type

start_label_detection_opt()

View Source
start_label_detection_opt() :: start_opt() | {:min_confidence, 0..100}
Link to this type

start_opt()

View Source
start_opt() ::
  {:client_request_token, binary()}
  | {:job_tag, binary()}
  | {:notification_channel, ExAws.Rekognition.NotificationChannelObject.t()}
Link to this type

start_person_tracking_opt()

View Source
start_person_tracking_opt() :: start_opt()

Link to this section Functions

Link to this function

compare_faces(source_image, target_image, opts \\ [])

View Source
compare_faces(image(), image(), [compare_faces_opt()]) ::
  ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_CompareFaces.html

NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition

Link to this function

create_collection(collection_id)

View Source
create_collection(binary()) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_CreateCollection.html

Link to this function

create_stream_processor(input, output, name, role_arn, opts \\ [])

View Source
create_stream_processor(binary(), binary(), binary(), binary(), [
  create_stream_processor_opt()
]) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_CreateStreamProcessor.html

Link to this function

delete_collection(collection_id)

View Source
delete_collection(binary()) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_DeleteCollection.html

Link to this function

delete_faces(collection_id, face_ids)

View Source
delete_faces(binary(), [binary()]) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_DeleteFaces.html

Link to this function

delete_stream_processor(name)

View Source
delete_stream_processor(binary()) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_DeleteStreamProcessor.html

Link to this function

describe_collection(collection_id)

View Source
describe_collection(binary()) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_DescribeCollection.html

Link to this function

describe_stream_processor(name)

View Source
describe_stream_processor(binary()) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_DescribeStreamProcessor.html

Link to this function

detect_faces(image, opts \\ [])

View Source
detect_faces(image(), [detect_faces_opt()]) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectFaces.html

NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition

Link to this function

detect_labels(image, opts \\ [])

View Source
detect_labels(image(), [detect_labels_opt()]) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectLabels.html

NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition

Link to this function

detect_moderation_labels(image, opts \\ [])

View Source
detect_moderation_labels(image(), [detect_moderation_labels_opt()]) ::
  ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectModerationLabels.html

NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectText.html

NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition

Link to this function

get_celebrity_info(id)

View Source
get_celebrity_info(binary()) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetCelebrityInfo.html

Link to this function

get_celebrity_recognition(job_id, opts \\ [])

View Source
get_celebrity_recognition(binary(), [get_celebrity_recognition_opt()]) ::
  ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetCelebrityRecognition.html

Link to this function

get_content_moderation(job_id, opts \\ [])

View Source
get_content_moderation(binary(), [get_content_moderation_opt()]) ::
  ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetContentModeration.html

Link to this function

get_face_detection(job_id, opts \\ [])

View Source
get_face_detection(binary(), [get_face_detection_opt()]) ::
  ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetFaceDetection.html

Link to this function

get_face_search(job_id, opts \\ [])

View Source
get_face_search(binary(), [get_face_search_opt()]) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetFaceSearch.html

Link to this function

get_label_detection(job_id, opts \\ [])

View Source
get_label_detection(binary(), [get_label_detection_opt()]) ::
  ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetLabelDetection.html

Link to this function

get_person_tracking(job_id, opts \\ [])

View Source
get_person_tracking(binary(), [get_person_tracking_opt()]) ::
  ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetPersonTracking.html

Link to this function

index_faces(collection_id, image, opts \\ [])

View Source
index_faces(binary(), image(), [index_faces_opt()]) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_IndexFaces.html

NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition

Link to this function

list_collections(opts \\ [])

View Source
list_collections([list_collections_opt()]) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_ListCollections.html

Link to this function

list_faces(collection_id, opts \\ [])

View Source
list_faces(binary(), [list_faces_opt()]) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_ListFaces.html

Link to this function

list_stream_processors(opts \\ [])

View Source
list_stream_processors([list_stream_processors_opt()]) ::
  ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_ListStreamProcessors.html

Link to this function

recognize_celebrities(image)

View Source
recognize_celebrities(image()) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_RecognizeCelebrities.html

Link to this function

search_faces(collection_id, face_id, opts \\ [])

View Source
search_faces(binary(), binary(), [search_faces_opt()]) ::
  ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_SearchFaces.html

Link to this function

search_faces_by_image(collection_id, image, opts \\ [])

View Source
search_faces_by_image(binary(), image(), [search_faces_by_image_opt()]) ::
  ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_SearchFacesByImage.html

NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition.

Link to this function

start_celebrity_recognition(video, opts \\ [])

View Source

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartCelebrityRecognition.html

Link to this function

start_content_moderation(video, opts \\ [])

View Source

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartContentModeration.html

Link to this function

start_face_detection(video, opts \\ [])

View Source

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartFaceDetection.html

Link to this function

start_face_search(video, collection_id, opts \\ [])

View Source

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartFaceSearch.html

Link to this function

start_label_detection(video, opts \\ [])

View Source

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartLabelDetection.html

Link to this function

start_person_tracking(video, opts \\ [])

View Source

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartPersonTracking.html

Link to this function

start_stream_processor(name)

View Source
start_stream_processor(binary()) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartStreamProcessor.html

Link to this function

stop_stream_processor(name)

View Source
stop_stream_processor(binary()) :: ExAws.Operation.JSON.t()

https://docs.aws.amazon.com/rekognition/latest/dg/API_StopStreamProcessor.html