pub struct CreateIndexFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateIndex
.
Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status
field returned from a call to DescribeIndex
. The Status
field is set to ACTIVE
when the index is ready to use.
Once the index is active, you can index your documents using the BatchPutDocument
API or using one of the supported data sources.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
Implementations§
Source§impl CreateIndexFluentBuilder
impl CreateIndexFluentBuilder
Sourcepub fn as_input(&self) -> &CreateIndexInputBuilder
pub fn as_input(&self) -> &CreateIndexInputBuilder
Access the CreateIndex as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateIndexOutput, SdkError<CreateIndexError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateIndexOutput, SdkError<CreateIndexError, 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<CreateIndexOutput, CreateIndexError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateIndexOutput, CreateIndexError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn edition(self, input: IndexEdition) -> Self
pub fn edition(self, input: IndexEdition) -> Self
The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION
for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION
for production. Use GEN_AI_ENTERPRISE_EDITION
for creating generative AI applications. Once you set the edition for an index, it can't be changed.
The Edition
parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION
.
For more information on quota limits for Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, see Quotas.
Sourcepub fn set_edition(self, input: Option<IndexEdition>) -> Self
pub fn set_edition(self, input: Option<IndexEdition>) -> Self
The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION
for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION
for production. Use GEN_AI_ENTERPRISE_EDITION
for creating generative AI applications. Once you set the edition for an index, it can't be changed.
The Edition
parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION
.
For more information on quota limits for Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, see Quotas.
Sourcepub fn get_edition(&self) -> &Option<IndexEdition>
pub fn get_edition(&self) -> &Option<IndexEdition>
The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION
for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION
for production. Use GEN_AI_ENTERPRISE_EDITION
for creating generative AI applications. Once you set the edition for an index, it can't be changed.
The Edition
parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION
.
For more information on quota limits for Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, see Quotas.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.
Sourcepub fn server_side_encryption_configuration(
self,
input: ServerSideEncryptionConfiguration,
) -> Self
pub fn server_side_encryption_configuration( self, input: ServerSideEncryptionConfiguration, ) -> Self
The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
Sourcepub fn set_server_side_encryption_configuration(
self,
input: Option<ServerSideEncryptionConfiguration>,
) -> Self
pub fn set_server_side_encryption_configuration( self, input: Option<ServerSideEncryptionConfiguration>, ) -> Self
The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
Sourcepub fn get_server_side_encryption_configuration(
&self,
) -> &Option<ServerSideEncryptionConfiguration>
pub fn get_server_side_encryption_configuration( &self, ) -> &Option<ServerSideEncryptionConfiguration>
The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description for the index.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description for the index.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description for the index.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex
API with the same client token will create only one index.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex
API with the same client token will create only one index.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex
API with the same client token will create only one index.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
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.
- ATTRIBUTE_FILTER
-
All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of
_user_id
and_group_ids
or you can provide user and group information inUserContext
. - USER_TOKEN
-
Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
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.
- ATTRIBUTE_FILTER
-
All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of
_user_id
and_group_ids
or you can provide user and group information inUserContext
. - USER_TOKEN
-
Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
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.
- ATTRIBUTE_FILTER
-
All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of
_user_id
and_group_ids
or you can provide user and group information inUserContext
. - USER_TOKEN
-
Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
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 CreateIndexFluentBuilder
impl Clone for CreateIndexFluentBuilder
Source§fn clone(&self) -> CreateIndexFluentBuilder
fn clone(&self) -> CreateIndexFluentBuilder
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 CreateIndexFluentBuilder
impl !RefUnwindSafe for CreateIndexFluentBuilder
impl Send for CreateIndexFluentBuilder
impl Sync for CreateIndexFluentBuilder
impl Unpin for CreateIndexFluentBuilder
impl !UnwindSafe for CreateIndexFluentBuilder
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);