Struct aws_sdk_kendra::operation::create_faq::CreateFaqInput

#[non_exhaustive]
pub struct CreateFaqInput {
    pub index_id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub s3_path: Option<S3Path>,
    pub role_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub file_format: Option<FaqFileFormat>,
    pub client_token: Option<String>,
    pub language_code: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

index_id: Option<String>

The identifier of the index for the FAQ.

name: Option<String>

A name for the FAQ.

description: Option<String>

A description for the FAQ.

s3_path: Option<S3Path>

The path to the FAQ file in S3.

role_arn: Option<String>

The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.

tags: Option<Vec<Tag>>

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

file_format: Option<FaqFileFormat>

The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The default format is CSV.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

client_token: Option<String>

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

language_code: Option<String>

The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Implementations

impl CreateFaqInput

pub fn index_id(&self) -> Option<&str>

The identifier of the index for the FAQ.

pub fn name(&self) -> Option<&str>

A name for the FAQ.

pub fn description(&self) -> Option<&str>

A description for the FAQ.

pub fn s3_path(&self) -> Option<&S3Path>

The path to the FAQ file in S3.

pub fn role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.

pub fn tags(&self) -> &[Tag]

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn file_format(&self) -> Option<&FaqFileFormat>

The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The default format is CSV.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

pub fn client_token(&self) -> Option<&str>

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

pub fn language_code(&self) -> Option<&str>

The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

impl CreateFaqInput

pub fn builder() -> CreateFaqInputBuilder

Creates a new builder-style object to manufacture CreateFaqInput.

Trait Implementations

impl Clone for CreateFaqInput

fn clone(&self) -> CreateFaqInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateFaqInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateFaqInput

fn eq(&self, other: &CreateFaqInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateFaqInput