aws_sdk_kendra/client/
describe_experience.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeExperience`](crate::operation::describe_experience::builders::DescribeExperienceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::describe_experience::builders::DescribeExperienceFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::describe_experience::builders::DescribeExperienceFluentBuilder::set_id):<br>required: **true**<br><p>The identifier of your Amazon Kendra experience you want to get information on.</p><br>
7    ///   - [`index_id(impl Into<String>)`](crate::operation::describe_experience::builders::DescribeExperienceFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::describe_experience::builders::DescribeExperienceFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index for your Amazon Kendra experience.</p><br>
8    /// - On success, responds with [`DescribeExperienceOutput`](crate::operation::describe_experience::DescribeExperienceOutput) with field(s):
9    ///   - [`id(Option<String>)`](crate::operation::describe_experience::DescribeExperienceOutput::id): <p>Shows the identifier of your Amazon Kendra experience.</p>
10    ///   - [`index_id(Option<String>)`](crate::operation::describe_experience::DescribeExperienceOutput::index_id): <p>Shows the identifier of the index for your Amazon Kendra experience.</p>
11    ///   - [`name(Option<String>)`](crate::operation::describe_experience::DescribeExperienceOutput::name): <p>Shows the name of your Amazon Kendra experience.</p>
12    ///   - [`endpoints(Option<Vec::<ExperienceEndpoint>>)`](crate::operation::describe_experience::DescribeExperienceOutput::endpoints): <p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>
13    ///   - [`configuration(Option<ExperienceConfiguration>)`](crate::operation::describe_experience::DescribeExperienceOutput::configuration): <p>Shows the configuration information for your Amazon Kendra experience. This includes <code>ContentSourceConfiguration</code>, which specifies the data source IDs and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the user or group information to grant access to your Amazon Kendra experience.</p>
14    ///   - [`created_at(Option<DateTime>)`](crate::operation::describe_experience::DescribeExperienceOutput::created_at): <p>The Unix timestamp when your Amazon Kendra experience was created.</p>
15    ///   - [`updated_at(Option<DateTime>)`](crate::operation::describe_experience::DescribeExperienceOutput::updated_at): <p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>
16    ///   - [`description(Option<String>)`](crate::operation::describe_experience::DescribeExperienceOutput::description): <p>Shows the description for your Amazon Kendra experience.</p>
17    ///   - [`status(Option<ExperienceStatus>)`](crate::operation::describe_experience::DescribeExperienceOutput::status): <p>The current processing status of your Amazon Kendra experience. When the status is <code>ACTIVE</code>, your Amazon Kendra experience is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that this failed.</p>
18    ///   - [`role_arn(Option<String>)`](crate::operation::describe_experience::DescribeExperienceOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM role with permission to access the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code> API, and IAM Identity Center that stores your users and groups information.</p>
19    ///   - [`error_message(Option<String>)`](crate::operation::describe_experience::DescribeExperienceOutput::error_message): <p>The reason your Amazon Kendra experience could not properly process.</p>
20    /// - On failure, responds with [`SdkError<DescribeExperienceError>`](crate::operation::describe_experience::DescribeExperienceError)
21    pub fn describe_experience(&self) -> crate::operation::describe_experience::builders::DescribeExperienceFluentBuilder {
22        crate::operation::describe_experience::builders::DescribeExperienceFluentBuilder::new(self.handle.clone())
23    }
24}
aws_sdk_kendra/client/describe_experience.rs

aws_sdk_kendra/client/
describe_experience.rs
