pub struct UpdateIndexFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateIndex
.
Updates an Amazon Kendra index.
Implementations§
Source§impl UpdateIndexFluentBuilder
impl UpdateIndexFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateIndexInputBuilder
pub fn as_input(&self) -> &UpdateIndexInputBuilder
Access the UpdateIndex as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateIndexOutput, SdkError<UpdateIndexError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateIndexOutput, SdkError<UpdateIndexError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateIndexOutput, UpdateIndexError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateIndexOutput, UpdateIndexError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The identifier of the index you want to update.
Sourcepub fn set_id(self, input: Option<String>) -> Self
pub fn set_id(self, input: Option<String>) -> Self
The identifier of the index you want to update.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A new description for the index.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A new description for the index.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A new description for the index.
Sourcepub fn document_metadata_configuration_updates(
self,
input: DocumentMetadataConfiguration,
) -> Self
pub fn document_metadata_configuration_updates( self, input: DocumentMetadataConfiguration, ) -> Self
Appends an item to DocumentMetadataConfigurationUpdates
.
To override the contents of this collection use set_document_metadata_configuration_updates
.
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.
Sourcepub fn set_document_metadata_configuration_updates(
self,
input: Option<Vec<DocumentMetadataConfiguration>>,
) -> Self
pub fn set_document_metadata_configuration_updates( self, input: Option<Vec<DocumentMetadataConfiguration>>, ) -> Self
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.
Sourcepub fn get_document_metadata_configuration_updates(
&self,
) -> &Option<Vec<DocumentMetadataConfiguration>>
pub fn get_document_metadata_configuration_updates( &self, ) -> &Option<Vec<DocumentMetadataConfiguration>>
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.
Sourcepub fn capacity_units(self, input: CapacityUnitsConfiguration) -> Self
pub fn capacity_units(self, input: CapacityUnitsConfiguration) -> Self
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.
Sourcepub fn set_capacity_units(
self,
input: Option<CapacityUnitsConfiguration>,
) -> Self
pub fn set_capacity_units( self, input: Option<CapacityUnitsConfiguration>, ) -> Self
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.
Sourcepub fn get_capacity_units(&self) -> &Option<CapacityUnitsConfiguration>
pub fn get_capacity_units(&self) -> &Option<CapacityUnitsConfiguration>
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.
Sourcepub fn user_token_configurations(self, input: UserTokenConfiguration) -> Self
pub fn user_token_configurations(self, input: UserTokenConfiguration) -> Self
Appends an item to UserTokenConfigurations
.
To override the contents of this collection use set_user_token_configurations
.
The user token configuration.
If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations
to configure user context policy, Amazon Kendra returns a ValidationException
error.
Sourcepub fn set_user_token_configurations(
self,
input: Option<Vec<UserTokenConfiguration>>,
) -> Self
pub fn set_user_token_configurations( self, input: Option<Vec<UserTokenConfiguration>>, ) -> Self
The user token configuration.
If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations
to configure user context policy, Amazon Kendra returns a ValidationException
error.
Sourcepub fn get_user_token_configurations(
&self,
) -> &Option<Vec<UserTokenConfiguration>>
pub fn get_user_token_configurations( &self, ) -> &Option<Vec<UserTokenConfiguration>>
The user token configuration.
If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations
to configure user context policy, Amazon Kendra returns a ValidationException
error.
Sourcepub fn user_context_policy(self, input: UserContextPolicy) -> Self
pub fn user_context_policy(self, input: UserContextPolicy) -> Self
The user context policy.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER
to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN
to configure user context policy, Amazon Kendra returns a ValidationException
error.
Sourcepub fn set_user_context_policy(self, input: Option<UserContextPolicy>) -> Self
pub fn set_user_context_policy(self, input: Option<UserContextPolicy>) -> Self
The user context policy.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER
to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN
to configure user context policy, Amazon Kendra returns a ValidationException
error.
Sourcepub fn get_user_context_policy(&self) -> &Option<UserContextPolicy>
pub fn get_user_context_policy(&self) -> &Option<UserContextPolicy>
The user context policy.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER
to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN
to configure user context policy, Amazon Kendra returns a ValidationException
error.
Sourcepub fn user_group_resolution_configuration(
self,
input: UserGroupResolutionConfiguration,
) -> Self
pub fn user_group_resolution_configuration( self, input: UserGroupResolutionConfiguration, ) -> Self
Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration
isn't supported.
Sourcepub fn set_user_group_resolution_configuration(
self,
input: Option<UserGroupResolutionConfiguration>,
) -> Self
pub fn set_user_group_resolution_configuration( self, input: Option<UserGroupResolutionConfiguration>, ) -> Self
Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration
isn't supported.
Sourcepub fn get_user_group_resolution_configuration(
&self,
) -> &Option<UserGroupResolutionConfiguration>
pub fn get_user_group_resolution_configuration( &self, ) -> &Option<UserGroupResolutionConfiguration>
Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration
isn't supported.
Trait Implementations§
Source§impl Clone for UpdateIndexFluentBuilder
impl Clone for UpdateIndexFluentBuilder
Source§fn clone(&self) -> UpdateIndexFluentBuilder
fn clone(&self) -> UpdateIndexFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateIndexFluentBuilder
impl !RefUnwindSafe for UpdateIndexFluentBuilder
impl Send for UpdateIndexFluentBuilder
impl Sync for UpdateIndexFluentBuilder
impl Unpin for UpdateIndexFluentBuilder
impl !UnwindSafe for UpdateIndexFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);