/** * 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 #include #include namespace Aws { namespace kendra { namespace Model { /** */ class UpdateIndexRequest : public KendraRequest { public: AWS_KENDRA_API UpdateIndexRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "UpdateIndex"; } AWS_KENDRA_API Aws::String SerializePayload() const override; AWS_KENDRA_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The identifier of the index you want to update.

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

The identifier of the index you want to update.

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

The identifier of the index you want to update.

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

The identifier of the index you want to update.

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

The identifier of the index you want to update.

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

The identifier of the index you want to update.

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

The identifier of the index you want to update.

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

The identifier of the index you want to update.

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

The name of the index you want to update.

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

The name of the index you want to update.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the index you want to update.

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

The name of the index you want to update.

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

The name of the index you want to update.

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

The name of the index you want to update.

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

The name of the index you want to update.

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

The name of the index you want to update.

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

An Identity and Access Management (IAM) role that gives Amazon Kendra * permission to access Amazon CloudWatch logs and metrics.

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

An Identity and Access Management (IAM) role that gives Amazon Kendra * permission to access Amazon CloudWatch logs and metrics.

*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

An Identity and Access Management (IAM) role that gives Amazon Kendra * permission to access Amazon CloudWatch logs and metrics.

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

An Identity and Access Management (IAM) role that gives Amazon Kendra * permission to access Amazon CloudWatch logs and metrics.

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

An Identity and Access Management (IAM) role that gives Amazon Kendra * permission to access Amazon CloudWatch logs and metrics.

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

An Identity and Access Management (IAM) role that gives Amazon Kendra * permission to access Amazon CloudWatch logs and metrics.

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

An Identity and Access Management (IAM) role that gives Amazon Kendra * permission to access Amazon CloudWatch logs and metrics.

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

An Identity and Access Management (IAM) role that gives Amazon Kendra * permission to access Amazon CloudWatch logs and metrics.

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

A new description for the index.

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

A new description for the index.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A new description for the index.

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

A new description for the index.

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

A new description for the index.

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

A new description for the index.

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

A new description for the index.

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

A new description for the index.

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

The document metadata configuration you want to update for the index. * Document metadata are fields or attributes associated with your documents. For * example, the company department name associated with each document.

*/ inline const Aws::Vector& GetDocumentMetadataConfigurationUpdates() const{ return m_documentMetadataConfigurationUpdates; } /** *

The document metadata configuration you want to update for the index. * Document metadata are fields or attributes associated with your documents. For * example, the company department name associated with each document.

*/ inline bool DocumentMetadataConfigurationUpdatesHasBeenSet() const { return m_documentMetadataConfigurationUpdatesHasBeenSet; } /** *

The document metadata configuration you want to update for the index. * Document metadata are fields or attributes associated with your documents. For * example, the company department name associated with each document.

*/ inline void SetDocumentMetadataConfigurationUpdates(const Aws::Vector& value) { m_documentMetadataConfigurationUpdatesHasBeenSet = true; m_documentMetadataConfigurationUpdates = value; } /** *

The document metadata configuration you want to update for the index. * Document metadata are fields or attributes associated with your documents. For * example, the company department name associated with each document.

*/ inline void SetDocumentMetadataConfigurationUpdates(Aws::Vector&& value) { m_documentMetadataConfigurationUpdatesHasBeenSet = true; m_documentMetadataConfigurationUpdates = std::move(value); } /** *

The document metadata configuration you want to update for the index. * Document metadata are fields or attributes associated with your documents. For * example, the company department name associated with each document.

*/ inline UpdateIndexRequest& WithDocumentMetadataConfigurationUpdates(const Aws::Vector& value) { SetDocumentMetadataConfigurationUpdates(value); return *this;} /** *

The document metadata configuration you want to update for the index. * Document metadata are fields or attributes associated with your documents. For * example, the company department name associated with each document.

*/ inline UpdateIndexRequest& WithDocumentMetadataConfigurationUpdates(Aws::Vector&& value) { SetDocumentMetadataConfigurationUpdates(std::move(value)); return *this;} /** *

The document metadata configuration you want to update for the index. * Document metadata are fields or attributes associated with your documents. For * example, the company department name associated with each document.

*/ inline UpdateIndexRequest& AddDocumentMetadataConfigurationUpdates(const DocumentMetadataConfiguration& value) { m_documentMetadataConfigurationUpdatesHasBeenSet = true; m_documentMetadataConfigurationUpdates.push_back(value); return *this; } /** *

The document metadata configuration you want to update for the index. * Document metadata are fields or attributes associated with your documents. For * example, the company department name associated with each document.

*/ inline UpdateIndexRequest& AddDocumentMetadataConfigurationUpdates(DocumentMetadataConfiguration&& value) { m_documentMetadataConfigurationUpdatesHasBeenSet = true; m_documentMetadataConfigurationUpdates.push_back(std::move(value)); return *this; } /** *

Sets the number of additional document storage and query capacity units that * should be used by the index. You can change the capacity of the index up to 5 * times per day, or make 5 API calls.

If you are using extra storage units, * you can't reduce the storage capacity below what is required to meet the storage * needs for your index.

*/ inline const CapacityUnitsConfiguration& GetCapacityUnits() const{ return m_capacityUnits; } /** *

Sets the number of additional document storage and query capacity units that * should be used by the index. You can change the capacity of the index up to 5 * times per day, or make 5 API calls.

If you are using extra storage units, * you can't reduce the storage capacity below what is required to meet the storage * needs for your index.

*/ inline bool CapacityUnitsHasBeenSet() const { return m_capacityUnitsHasBeenSet; } /** *

Sets the number of additional document storage and query capacity units that * should be used by the index. You can change the capacity of the index up to 5 * times per day, or make 5 API calls.

If you are using extra storage units, * you can't reduce the storage capacity below what is required to meet the storage * needs for your index.

*/ inline void SetCapacityUnits(const CapacityUnitsConfiguration& value) { m_capacityUnitsHasBeenSet = true; m_capacityUnits = value; } /** *

Sets the number of additional document storage and query capacity units that * should be used by the index. You can change the capacity of the index up to 5 * times per day, or make 5 API calls.

If you are using extra storage units, * you can't reduce the storage capacity below what is required to meet the storage * needs for your index.

*/ inline void SetCapacityUnits(CapacityUnitsConfiguration&& value) { m_capacityUnitsHasBeenSet = true; m_capacityUnits = std::move(value); } /** *

Sets the number of additional document storage and query capacity units that * should be used by the index. You can change the capacity of the index up to 5 * times per day, or make 5 API calls.

If you are using extra storage units, * you can't reduce the storage capacity below what is required to meet the storage * needs for your index.

*/ inline UpdateIndexRequest& WithCapacityUnits(const CapacityUnitsConfiguration& value) { SetCapacityUnits(value); return *this;} /** *

Sets the number of additional document storage and query capacity units that * should be used by the index. You can change the capacity of the index up to 5 * times per day, or make 5 API calls.

If you are using extra storage units, * you can't reduce the storage capacity below what is required to meet the storage * needs for your index.

*/ inline UpdateIndexRequest& WithCapacityUnits(CapacityUnitsConfiguration&& value) { SetCapacityUnits(std::move(value)); return *this;} /** *

The user token configuration.

*/ inline const Aws::Vector& GetUserTokenConfigurations() const{ return m_userTokenConfigurations; } /** *

The user token configuration.

*/ inline bool UserTokenConfigurationsHasBeenSet() const { return m_userTokenConfigurationsHasBeenSet; } /** *

The user token configuration.

*/ inline void SetUserTokenConfigurations(const Aws::Vector& value) { m_userTokenConfigurationsHasBeenSet = true; m_userTokenConfigurations = value; } /** *

The user token configuration.

*/ inline void SetUserTokenConfigurations(Aws::Vector&& value) { m_userTokenConfigurationsHasBeenSet = true; m_userTokenConfigurations = std::move(value); } /** *

The user token configuration.

*/ inline UpdateIndexRequest& WithUserTokenConfigurations(const Aws::Vector& value) { SetUserTokenConfigurations(value); return *this;} /** *

The user token configuration.

*/ inline UpdateIndexRequest& WithUserTokenConfigurations(Aws::Vector&& value) { SetUserTokenConfigurations(std::move(value)); return *this;} /** *

The user token configuration.

*/ inline UpdateIndexRequest& AddUserTokenConfigurations(const UserTokenConfiguration& value) { m_userTokenConfigurationsHasBeenSet = true; m_userTokenConfigurations.push_back(value); return *this; } /** *

The user token configuration.

*/ inline UpdateIndexRequest& AddUserTokenConfigurations(UserTokenConfiguration&& value) { m_userTokenConfigurationsHasBeenSet = true; m_userTokenConfigurations.push_back(std::move(value)); return *this; } /** *

The user context policy.

*/ inline const UserContextPolicy& GetUserContextPolicy() const{ return m_userContextPolicy; } /** *

The user context policy.

*/ inline bool UserContextPolicyHasBeenSet() const { return m_userContextPolicyHasBeenSet; } /** *

The user context policy.

*/ inline void SetUserContextPolicy(const UserContextPolicy& value) { m_userContextPolicyHasBeenSet = true; m_userContextPolicy = value; } /** *

The user context policy.

*/ inline void SetUserContextPolicy(UserContextPolicy&& value) { m_userContextPolicyHasBeenSet = true; m_userContextPolicy = std::move(value); } /** *

The user context policy.

*/ inline UpdateIndexRequest& WithUserContextPolicy(const UserContextPolicy& value) { SetUserContextPolicy(value); return *this;} /** *

The user context policy.

*/ inline UpdateIndexRequest& WithUserContextPolicy(UserContextPolicy&& value) { SetUserContextPolicy(std::move(value)); return *this;} /** *

Enables fetching access levels of groups and users from an IAM Identity * Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.

*/ inline const UserGroupResolutionConfiguration& GetUserGroupResolutionConfiguration() const{ return m_userGroupResolutionConfiguration; } /** *

Enables fetching access levels of groups and users from an IAM Identity * Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.

*/ inline bool UserGroupResolutionConfigurationHasBeenSet() const { return m_userGroupResolutionConfigurationHasBeenSet; } /** *

Enables fetching access levels of groups and users from an IAM Identity * Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.

*/ inline void SetUserGroupResolutionConfiguration(const UserGroupResolutionConfiguration& value) { m_userGroupResolutionConfigurationHasBeenSet = true; m_userGroupResolutionConfiguration = value; } /** *

Enables fetching access levels of groups and users from an IAM Identity * Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.

*/ inline void SetUserGroupResolutionConfiguration(UserGroupResolutionConfiguration&& value) { m_userGroupResolutionConfigurationHasBeenSet = true; m_userGroupResolutionConfiguration = std::move(value); } /** *

Enables fetching access levels of groups and users from an IAM Identity * Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.

*/ inline UpdateIndexRequest& WithUserGroupResolutionConfiguration(const UserGroupResolutionConfiguration& value) { SetUserGroupResolutionConfiguration(value); return *this;} /** *

Enables fetching access levels of groups and users from an IAM Identity * Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.

*/ inline UpdateIndexRequest& WithUserGroupResolutionConfiguration(UserGroupResolutionConfiguration&& value) { SetUserGroupResolutionConfiguration(std::move(value)); return *this;} private: Aws::String m_id; bool m_idHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::Vector m_documentMetadataConfigurationUpdates; bool m_documentMetadataConfigurationUpdatesHasBeenSet = false; CapacityUnitsConfiguration m_capacityUnits; bool m_capacityUnitsHasBeenSet = false; Aws::Vector m_userTokenConfigurations; bool m_userTokenConfigurationsHasBeenSet = false; UserContextPolicy m_userContextPolicy; bool m_userContextPolicyHasBeenSet = false; UserGroupResolutionConfiguration m_userGroupResolutionConfiguration; bool m_userGroupResolutionConfigurationHasBeenSet = false; }; } // namespace Model } // namespace kendra } // namespace Aws