/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace kendra { namespace Model { class DescribeExperienceResult { public: AWS_KENDRA_API DescribeExperienceResult(); AWS_KENDRA_API DescribeExperienceResult(const Aws::AmazonWebServiceResult& result); AWS_KENDRA_API DescribeExperienceResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

Shows the identifier of your Amazon Kendra experience.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

Shows the identifier of your Amazon Kendra experience.

*/ inline void SetId(const Aws::String& value) { m_id = value; } /** *

Shows the identifier of your Amazon Kendra experience.

*/ inline void SetId(Aws::String&& value) { m_id = std::move(value); } /** *

Shows the identifier of your Amazon Kendra experience.

*/ inline void SetId(const char* value) { m_id.assign(value); } /** *

Shows the identifier of your Amazon Kendra experience.

*/ inline DescribeExperienceResult& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

Shows the identifier of your Amazon Kendra experience.

*/ inline DescribeExperienceResult& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

Shows the identifier of your Amazon Kendra experience.

*/ inline DescribeExperienceResult& WithId(const char* value) { SetId(value); return *this;} /** *

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

*/ inline const Aws::String& GetIndexId() const{ return m_indexId; } /** *

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

*/ inline void SetIndexId(const Aws::String& value) { m_indexId = value; } /** *

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

*/ inline void SetIndexId(Aws::String&& value) { m_indexId = std::move(value); } /** *

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

*/ inline void SetIndexId(const char* value) { m_indexId.assign(value); } /** *

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

*/ inline DescribeExperienceResult& WithIndexId(const Aws::String& value) { SetIndexId(value); return *this;} /** *

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

*/ inline DescribeExperienceResult& WithIndexId(Aws::String&& value) { SetIndexId(std::move(value)); return *this;} /** *

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

*/ inline DescribeExperienceResult& WithIndexId(const char* value) { SetIndexId(value); return *this;} /** *

Shows the name of your Amazon Kendra experience.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

Shows the name of your Amazon Kendra experience.

*/ inline void SetName(const Aws::String& value) { m_name = value; } /** *

Shows the name of your Amazon Kendra experience.

*/ inline void SetName(Aws::String&& value) { m_name = std::move(value); } /** *

Shows the name of your Amazon Kendra experience.

*/ inline void SetName(const char* value) { m_name.assign(value); } /** *

Shows the name of your Amazon Kendra experience.

*/ inline DescribeExperienceResult& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

Shows the name of your Amazon Kendra experience.

*/ inline DescribeExperienceResult& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

Shows the name of your Amazon Kendra experience.

*/ inline DescribeExperienceResult& WithName(const char* value) { SetName(value); return *this;} /** *

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

*/ inline const Aws::Vector& GetEndpoints() const{ return m_endpoints; } /** *

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

*/ inline void SetEndpoints(const Aws::Vector& value) { m_endpoints = value; } /** *

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

*/ inline void SetEndpoints(Aws::Vector&& value) { m_endpoints = std::move(value); } /** *

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

*/ inline DescribeExperienceResult& WithEndpoints(const Aws::Vector& value) { SetEndpoints(value); return *this;} /** *

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

*/ inline DescribeExperienceResult& WithEndpoints(Aws::Vector&& value) { SetEndpoints(std::move(value)); return *this;} /** *

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

*/ inline DescribeExperienceResult& AddEndpoints(const ExperienceEndpoint& value) { m_endpoints.push_back(value); return *this; } /** *

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

*/ inline DescribeExperienceResult& AddEndpoints(ExperienceEndpoint&& value) { m_endpoints.push_back(std::move(value)); return *this; } /** *

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.

*/ inline const ExperienceConfiguration& GetConfiguration() const{ return m_configuration; } /** *

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.

*/ inline void SetConfiguration(const ExperienceConfiguration& value) { m_configuration = value; } /** *

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.

*/ inline void SetConfiguration(ExperienceConfiguration&& value) { m_configuration = std::move(value); } /** *

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.

*/ inline DescribeExperienceResult& WithConfiguration(const ExperienceConfiguration& value) { SetConfiguration(value); return *this;} /** *

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.

*/ inline DescribeExperienceResult& WithConfiguration(ExperienceConfiguration&& value) { SetConfiguration(std::move(value)); return *this;} /** *

The Unix timestamp when your Amazon Kendra experience was created.

*/ inline const Aws::Utils::DateTime& GetCreatedAt() const{ return m_createdAt; } /** *

The Unix timestamp when your Amazon Kendra experience was created.

*/ inline void SetCreatedAt(const Aws::Utils::DateTime& value) { m_createdAt = value; } /** *

The Unix timestamp when your Amazon Kendra experience was created.

*/ inline void SetCreatedAt(Aws::Utils::DateTime&& value) { m_createdAt = std::move(value); } /** *

The Unix timestamp when your Amazon Kendra experience was created.

*/ inline DescribeExperienceResult& WithCreatedAt(const Aws::Utils::DateTime& value) { SetCreatedAt(value); return *this;} /** *

The Unix timestamp when your Amazon Kendra experience was created.

*/ inline DescribeExperienceResult& WithCreatedAt(Aws::Utils::DateTime&& value) { SetCreatedAt(std::move(value)); return *this;} /** *

The Unix timestamp when your Amazon Kendra experience was last updated.

*/ inline const Aws::Utils::DateTime& GetUpdatedAt() const{ return m_updatedAt; } /** *

The Unix timestamp when your Amazon Kendra experience was last updated.

*/ inline void SetUpdatedAt(const Aws::Utils::DateTime& value) { m_updatedAt = value; } /** *

The Unix timestamp when your Amazon Kendra experience was last updated.

*/ inline void SetUpdatedAt(Aws::Utils::DateTime&& value) { m_updatedAt = std::move(value); } /** *

The Unix timestamp when your Amazon Kendra experience was last updated.

*/ inline DescribeExperienceResult& WithUpdatedAt(const Aws::Utils::DateTime& value) { SetUpdatedAt(value); return *this;} /** *

The Unix timestamp when your Amazon Kendra experience was last updated.

*/ inline DescribeExperienceResult& WithUpdatedAt(Aws::Utils::DateTime&& value) { SetUpdatedAt(std::move(value)); return *this;} /** *

Shows the description for your Amazon Kendra experience.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

Shows the description for your Amazon Kendra experience.

*/ inline void SetDescription(const Aws::String& value) { m_description = value; } /** *

Shows the description for your Amazon Kendra experience.

*/ inline void SetDescription(Aws::String&& value) { m_description = std::move(value); } /** *

Shows the description for your Amazon Kendra experience.

*/ inline void SetDescription(const char* value) { m_description.assign(value); } /** *

Shows the description for your Amazon Kendra experience.

*/ inline DescribeExperienceResult& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

Shows the description for your Amazon Kendra experience.

*/ inline DescribeExperienceResult& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

Shows the description for your Amazon Kendra experience.

*/ inline DescribeExperienceResult& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

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.

*/ inline const ExperienceStatus& GetStatus() const{ return m_status; } /** *

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.

*/ inline void SetStatus(const ExperienceStatus& value) { m_status = value; } /** *

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.

*/ inline void SetStatus(ExperienceStatus&& value) { m_status = std::move(value); } /** *

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.

*/ inline DescribeExperienceResult& WithStatus(const ExperienceStatus& value) { SetStatus(value); return *this;} /** *

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.

*/ inline DescribeExperienceResult& WithStatus(ExperienceStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

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.

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArn = value; } /** *

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.

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArn = std::move(value); } /** *

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.

*/ inline void SetRoleArn(const char* value) { m_roleArn.assign(value); } /** *

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.

*/ inline DescribeExperienceResult& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

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.

*/ inline DescribeExperienceResult& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

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.

*/ inline DescribeExperienceResult& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

The reason your Amazon Kendra experience could not properly process.

*/ inline const Aws::String& GetErrorMessage() const{ return m_errorMessage; } /** *

The reason your Amazon Kendra experience could not properly process.

*/ inline void SetErrorMessage(const Aws::String& value) { m_errorMessage = value; } /** *

The reason your Amazon Kendra experience could not properly process.

*/ inline void SetErrorMessage(Aws::String&& value) { m_errorMessage = std::move(value); } /** *

The reason your Amazon Kendra experience could not properly process.

*/ inline void SetErrorMessage(const char* value) { m_errorMessage.assign(value); } /** *

The reason your Amazon Kendra experience could not properly process.

*/ inline DescribeExperienceResult& WithErrorMessage(const Aws::String& value) { SetErrorMessage(value); return *this;} /** *

The reason your Amazon Kendra experience could not properly process.

*/ inline DescribeExperienceResult& WithErrorMessage(Aws::String&& value) { SetErrorMessage(std::move(value)); return *this;} /** *

The reason your Amazon Kendra experience could not properly process.

*/ inline DescribeExperienceResult& WithErrorMessage(const char* value) { SetErrorMessage(value); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeExperienceResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeExperienceResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeExperienceResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_id; Aws::String m_indexId; Aws::String m_name; Aws::Vector m_endpoints; ExperienceConfiguration m_configuration; Aws::Utils::DateTime m_createdAt; Aws::Utils::DateTime m_updatedAt; Aws::String m_description; ExperienceStatus m_status; Aws::String m_roleArn; Aws::String m_errorMessage; Aws::String m_requestId; }; } // namespace Model } // namespace kendra } // namespace Aws