Skip to content

AssociateFacesRequest

Source code in docs_src/capo_rekognition/types/associate_faces_request.py
class AssociateFacesRequest(TypedDict, closed=True):
    collection_id: "capo_rekognition.types.collection_id.CollectionId"
    """<p>The ID of an existing collection containing the UserID.</p>"""
    user_id: "capo_rekognition.types.user_id.UserId"
    """<p>The ID for the existing UserID.</p>"""
    face_ids: "capo_rekognition.types.user_face_id_list.UserFaceIdList"
    """<p>An array of FaceIDs to associate with the UserID.</p>"""
    user_match_threshold: NotRequired["capo_rekognition.types.percent.Percent"]
    """<p>An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.</p>"""
    client_request_token: NotRequired[
        "capo_rekognition.types.client_request_token.ClientRequestToken"
    ]
    """<p>Idempotent token used to identify the request to <code>AssociateFaces</code>. If you use the same token with multiple <code>AssociateFaces</code> requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

collection_id instance-attribute

collection_id: CollectionId

The ID of an existing collection containing the UserID.

face_ids instance-attribute

face_ids: UserFaceIdList

An array of FaceIDs to associate with the UserID.

user_id instance-attribute

user_id: UserId

The ID for the existing UserID.

user_match_threshold instance-attribute

user_match_threshold: NotRequired[Percent]

An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.