Class: Aws::Kendra::Types::CreateExperienceRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::CreateExperienceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A token that you provide to identify the request to create your Amazon Kendra experience.

• #configuration ⇒ Types::ExperienceConfiguration

  Configuration information for your Amazon Kendra experience.

• #description ⇒ String

  A description for your Amazon Kendra experience.

• #index_id ⇒ String

  The identifier of the index for your Amazon Kendra experience.

• #name ⇒ String

  A name for your Amazon Kendra experience.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of an IAM role with permission to access ‘Query` API, `GetQuerySuggestions` API, and other required APIs.

Instance Attribute Details

#client_token ⇒ String

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.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 2124

class CreateExperienceRequest < Struct.new(
  :name,
  :index_id,
  :role_arn,
  :configuration,
  :description,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::ExperienceConfiguration

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:

• (Types::ExperienceConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 2124

class CreateExperienceRequest < Struct.new(
  :name,
  :index_id,
  :role_arn,
  :configuration,
  :description,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for your Amazon Kendra experience.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 2124

class CreateExperienceRequest < Struct.new(
  :name,
  :index_id,
  :role_arn,
  :configuration,
  :description,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index for your Amazon Kendra experience.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 2124

class CreateExperienceRequest < Struct.new(
  :name,
  :index_id,
  :role_arn,
  :configuration,
  :description,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for your Amazon Kendra experience.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 2124

class CreateExperienceRequest < Struct.new(
  :name,
  :index_id,
  :role_arn,
  :configuration,
  :description,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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 that stores your user and group information. For more information, see [IAM access roles for Amazon Kendra].

[1]: docs.aws.amazon.com/kendra/latest/dg/iam-roles.html

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 2124

class CreateExperienceRequest < Struct.new(
  :name,
  :index_id,
  :role_arn,
  :configuration,
  :description,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end