software.amazon.awssdk.services.kendra.model

Class CreateExperienceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.CreateExperienceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateExperienceRequest.Builder,CreateExperienceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateExperienceRequest
extends KendraRequest
implements ToCopyableBuilder<CreateExperienceRequest.Builder,CreateExperienceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateExperienceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateExperienceRequest.Builder	builder()
String	clientToken() A token that you provide to identify the request to create your Amazon Kendra experience.
ExperienceConfiguration	configuration() Configuration information for your Amazon Kendra experience.
String	description() A description for your Amazon Kendra experience.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexId() The identifier of the index for your Amazon Kendra experience.
String	name() A name for your Amazon Kendra experience.
String	roleArn() The Amazon Resource Name (ARN) of an IAM role with permission to access Query API, GetQuerySuggestions API, and other required APIs.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateExperienceRequest.Builder>	serializableBuilderClass()
CreateExperienceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

A name for your Amazon Kendra experience.

Returns:

A name for your Amazon Kendra experience.

indexId

public final String indexId()

The identifier of the index for your Amazon Kendra experience.

Returns:

The identifier of the index for your Amazon Kendra experience.

roleArn

public final 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.

Returns:

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.

configuration

public final 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.

Returns:

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.

description

public final String description()

A description for your Amazon Kendra experience.

Returns:

A description for your Amazon Kendra experience.

clientToken

public final 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.

Returns:

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.

toBuilder

public CreateExperienceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateExperienceRequest.Builder,CreateExperienceRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static CreateExperienceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateExperienceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo