Skip to content

CreateFaceLivenessSessionRequest

Source code in docs_src/capo_rekognition/types/create_face_liveness_session_request.py
class CreateFaceLivenessSessionRequest(TypedDict, closed=True):
    kms_key_id: NotRequired["capo_rekognition.types.kms_key_id.KmsKeyId"]
    """<p> The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.</p>"""
    settings: NotRequired[
        "capo_rekognition.types.create_face_liveness_session_request_settings.CreateFaceLivenessSessionRequestSettings"
    ]
    """<p>A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts <code>OutputConfig</code> and <code>AuditImagesLimit</code>.</p>"""
    client_request_token: NotRequired[
        "capo_rekognition.types.client_request_token.ClientRequestToken"
    ]
    """<p>Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple <code>CreateFaceLivenessSession</code> requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple CreateFaceLivenessSession requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.

settings instance-attribute

A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts OutputConfig and AuditImagesLimit.