Class: Aws::Kendra::Types::DescribeExperienceResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::DescribeExperienceResponse
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#configuration ⇒ Types::ExperienceConfiguration
Shows the configuration information for your Amazon Kendra experience.
-
#created_at ⇒ Time
Shows the date-time your Amazon Kendra experience was created.
-
#description ⇒ String
Shows the description for your Amazon Kendra experience.
-
#endpoints ⇒ Array<Types::ExperienceEndpoint>
Shows the endpoint URLs for your Amazon Kendra experiences.
-
#error_message ⇒ String
The reason your Amazon Kendra experience could not properly process.
-
#id ⇒ String
Shows the identifier of your Amazon Kendra experience.
-
#index_id ⇒ String
Shows the identifier of the index for your Amazon Kendra experience.
-
#name ⇒ String
Shows the name of your Amazon Kendra experience.
-
#role_arn ⇒ String
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. -
#status ⇒ String
The current processing status of your Amazon Kendra experience.
-
#updated_at ⇒ Time
Shows the date-time your Amazon Kendra experience was last updated.
Instance Attribute Details
#configuration ⇒ Types::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.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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_at ⇒ Time
Shows the date-time your Amazon Kendra experience was created.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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 |
#description ⇒ String
Shows the description for your Amazon Kendra experience.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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 |
#endpoints ⇒ Array<Types::ExperienceEndpoint>
Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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_message ⇒ String
The reason your Amazon Kendra experience could not properly process.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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 |
#id ⇒ String
Shows the identifier of your Amazon Kendra experience.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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_id ⇒ String
Shows the identifier of the index for your Amazon Kendra experience.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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 |
#name ⇒ String
Shows the name of your Amazon Kendra experience.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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_arn ⇒ String
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.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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 |
#status ⇒ String
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.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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_at ⇒ Time
Shows the date-time your Amazon Kendra experience was last updated.
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3086 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 |