software.amazon.awssdk.services.kendra.model

Interface CreateExperienceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateExperienceRequest.Builder,CreateExperienceRequest>, KendraRequest.Builder, SdkBuilder<CreateExperienceRequest.Builder,CreateExperienceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateExperienceRequest

public static interface CreateExperienceRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<CreateExperienceRequest.Builder,CreateExperienceRequest>

Method Summary

Modifier and Type	Method and Description
CreateExperienceRequest.Builder	clientToken(String clientToken) A token that you provide to identify the request to create your Amazon Kendra experience.
default CreateExperienceRequest.Builder	configuration(Consumer<ExperienceConfiguration.Builder> configuration) Configuration information for your Amazon Kendra experience.
CreateExperienceRequest.Builder	configuration(ExperienceConfiguration configuration) Configuration information for your Amazon Kendra experience.
CreateExperienceRequest.Builder	description(String description) A description for your Amazon Kendra experience.
CreateExperienceRequest.Builder	indexId(String indexId) The identifier of the index for your Amazon Kendra experience.
CreateExperienceRequest.Builder	name(String name) A name for your Amazon Kendra experience.
CreateExperienceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateExperienceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateExperienceRequest.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role with permission to access Query API, GetQuerySuggestions API, and other required APIs.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

CreateExperienceRequest.Builder name(String name)

A name for your Amazon Kendra experience.

Parameters:

name - A name for your Amazon Kendra experience.

Returns:

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

indexId

CreateExperienceRequest.Builder indexId(String indexId)

The identifier of the index for your Amazon Kendra experience.

Parameters:

indexId - The identifier of the index for your Amazon Kendra experience.

Returns:

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

roleArn

CreateExperienceRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access Query API, GetQuerySuggestions API, and other required APIs. The role also must include permission to access IAM Identity Center (successor to Single Sign-On) that stores your user and group information. For more information, see IAM access roles for Amazon Kendra.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access Query API, GetQuerySuggestions API, and other required APIs. The role also must include permission to access IAM Identity Center (successor to Single Sign-On) that stores your user and group information. For more information, see IAM access roles for Amazon Kendra.

Returns:

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

configuration

CreateExperienceRequest.Builder configuration(ExperienceConfiguration configuration)

Configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

Parameters:

configuration - Configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

Returns:

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

configuration

default CreateExperienceRequest.Builder configuration(Consumer<ExperienceConfiguration.Builder> configuration)

Configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

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

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

Parameters:

configuration - a consumer that will call methods on ExperienceConfiguration.Builder

Returns:

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

See Also:

configuration(ExperienceConfiguration)

description

CreateExperienceRequest.Builder description(String description)

A description for your Amazon Kendra experience.

Parameters:

description - A description for your Amazon Kendra experience.

Returns:

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

clientToken

CreateExperienceRequest.Builder clientToken(String clientToken)

A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience API with the same client token creates only one Amazon Kendra experience.

Parameters:

clientToken - A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience API with the same client token creates only one Amazon Kendra experience.

Returns:

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

overrideConfiguration

CreateExperienceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder