Class: Aws::Kendra::Types::UpdateExperienceRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::UpdateExperienceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #configuration ⇒ Types::ExperienceConfiguration

  Configuration information you want to update for your Amazon Kendra experience.

• #description ⇒ String

  A new description for your Amazon Kendra experience.

• #id ⇒ String

  The identifier of your Amazon Kendra experience you want to update.

• #index_id ⇒ String

  The identifier of the index for your Amazon Kendra experience.

• #name ⇒ String

  A new name for your Amazon Kendra experience.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of an IAM role with permission to access the ‘Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and IAM Identity Center that stores your users and groups information.

Instance Attribute Details

#configuration ⇒ Types::ExperienceConfiguration

Configuration information you want to update for your Amazon Kendra experience.

Returns:

• (Types::ExperienceConfiguration)

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

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

#description ⇒ String

A new description for your Amazon Kendra experience.

Returns:

• (String)

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

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

#id ⇒ String

The identifier of your Amazon Kendra experience you want to update.

Returns:

• (String)

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

class UpdateExperienceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :role_arn,
  :configuration,
  :description)
  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 10680

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

#name ⇒ String

A new name for your Amazon Kendra experience.

Returns:

• (String)

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

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

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role with permission to access the ‘Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and IAM Identity Center that stores your users and groups information. For more information, see [IAM 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 10680

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