Interface CreateFaceLivenessSessionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateFaceLivenessSessionRequest.Builder,CreateFaceLivenessSessionRequest>, RekognitionRequest.Builder, SdkBuilder<CreateFaceLivenessSessionRequest.Builder,CreateFaceLivenessSessionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateFaceLivenessSessionRequest

public static interface CreateFaceLivenessSessionRequest.Builder
extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<CreateFaceLivenessSessionRequest.Builder,CreateFaceLivenessSessionRequest>

Method Summary

Modifier and Type	Method	Description
CreateFaceLivenessSessionRequest.Builder	clientRequestToken(String clientRequestToken)	Idempotent token is used to recognize the Face Liveness request.
CreateFaceLivenessSessionRequest.Builder	kmsKeyId(String kmsKeyId)	The identifier for your AWS Key Management Service key (AWS KMS key).
CreateFaceLivenessSessionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateFaceLivenessSessionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateFaceLivenessSessionRequest.Builder	settings(Consumer<CreateFaceLivenessSessionRequestSettings.Builder> settings)	A session settings object.
CreateFaceLivenessSessionRequest.Builder	settings(CreateFaceLivenessSessionRequestSettings settings)	A session settings object.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

kmsKeyId

CreateFaceLivenessSessionRequest.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

settings

CreateFaceLivenessSessionRequest.Builder settings(CreateFaceLivenessSessionRequestSettings settings)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

settings

default CreateFaceLivenessSessionRequest.Builder settings(Consumer<CreateFaceLivenessSessionRequestSettings.Builder> settings)

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

This is a convenience method that creates an instance of the CreateFaceLivenessSessionRequestSettings.Builder avoiding the need to create one manually via CreateFaceLivenessSessionRequestSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(CreateFaceLivenessSessionRequestSettings).

Parameters:

settings - a consumer that will call methods on CreateFaceLivenessSessionRequestSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• settings(CreateFaceLivenessSessionRequestSettings)

clientRequestToken

CreateFaceLivenessSessionRequest.Builder clientRequestToken(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateFaceLivenessSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateFaceLivenessSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.