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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CreateExperienceRequest.BuilderclientToken(String clientToken)A token that you provide to identify the request to create your Amazon Kendra experience.default CreateExperienceRequest.Builderconfiguration(Consumer<ExperienceConfiguration.Builder> configuration)Configuration information for your Amazon Kendra experience.CreateExperienceRequest.Builderconfiguration(ExperienceConfiguration configuration)Configuration information for your Amazon Kendra experience.CreateExperienceRequest.Builderdescription(String description)A description for your Amazon Kendra experience.CreateExperienceRequest.BuilderindexId(String indexId)The identifier of the index for your Amazon Kendra experience.CreateExperienceRequest.Buildername(String name)A name for your Amazon Kendra experience.CreateExperienceRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateExperienceRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateExperienceRequest.BuilderroleArn(String roleArn)The Amazon Resource Name (ARN) of an IAM role with permission to accessQueryAPI,GetQuerySuggestionsAPI, and other required APIs.-
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.kendra.model.KendraRequest.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 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
QueryAPI,GetQuerySuggestionsAPI, and other required APIs. The role also must include permission to access IAM Identity Center 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 accessQueryAPI,GetQuerySuggestionsAPI, and other required APIs. The role also must include permission to access IAM Identity Center 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, andUserIdentityConfiguration, 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 includesContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, andUserIdentityConfiguration, 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
This is a convenience method that creates an instance of theContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, andUserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.ExperienceConfiguration.Builderavoiding the need to create one manually viaExperienceConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toconfiguration(ExperienceConfiguration).- Parameters:
configuration- a consumer that will call methods onExperienceConfiguration.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
CreateExperienceAPI 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 theCreateExperienceAPI 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:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateExperienceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-