Class: Aws::Kendra::Types::DescribeExperienceResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configurationTypes::ExperienceConfiguration

Shows the 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.



5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

Shows the date-time your Amazon Kendra experience was created.

Returns:

  • (Time)


5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

Shows the description for your Amazon Kendra experience.

Returns:

  • (String)


5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#endpointsArray<Types::ExperienceEndpoint>

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

Returns:



5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

The reason your Amazon Kendra experience could not properly process.

Returns:

  • (String)


5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#idString

Shows the identifier of your Amazon Kendra experience.

Returns:

  • (String)


5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

Shows the identifier of the index for your Amazon Kendra experience.

Returns:

  • (String)


5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

Shows the name of your Amazon Kendra experience.

Returns:

  • (String)


5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.

Returns:

  • (String)


5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

Returns:

  • (String)


5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

Shows the date-time your Amazon Kendra experience was last updated.

Returns:

  • (Time)


5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5613

class DescribeExperienceResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :endpoints,
  :configuration,
  :created_at,
  :updated_at,
  :description,
  :status,
  :role_arn,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end