Struct aws_sdk_qconnect::types::builders::AppIntegrationsConfigurationBuilder

#[non_exhaustive]
pub struct AppIntegrationsConfigurationBuilder { /* private fields */ }

A builder for AppIntegrationsConfiguration.

Implementations

impl AppIntegrationsConfigurationBuilder

pub fn app_integration_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

• For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

• For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

• For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

• For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

• For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

  The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.

This field is required.

pub fn set_app_integration_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

• For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

• For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

• For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

• For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

• For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

  The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.

pub fn get_app_integration_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

• For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

• For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

• For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

• For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

• For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

  The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.

pub fn object_fields(self, input: impl Into<String>) -> Self

Appends an item to object_fields.

To override the contents of this collection use set_object_fields.

The fields from the source that are made available to your agents in Amazon Q. Optional if ObjectConfiguration is included in the provided DataIntegration.

• For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

• For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

• For Zendesk, you must include at least id, title, updated_at, and draft.

Make sure to include additional fields. These fields are indexed and used to source recommendations.

pub fn set_object_fields(self, input: Option<Vec<String>>) -> Self

The fields from the source that are made available to your agents in Amazon Q. Optional if ObjectConfiguration is included in the provided DataIntegration.

• For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

• For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

• For Zendesk, you must include at least id, title, updated_at, and draft.

Make sure to include additional fields. These fields are indexed and used to source recommendations.

pub fn get_object_fields(&self) -> &Option<Vec<String>>

The fields from the source that are made available to your agents in Amazon Q. Optional if ObjectConfiguration is included in the provided DataIntegration.

• For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

• For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

• For Zendesk, you must include at least id, title, updated_at, and draft.

Make sure to include additional fields. These fields are indexed and used to source recommendations.

pub fn build(self) -> Result<AppIntegrationsConfiguration, BuildError>

Consumes the builder and constructs a AppIntegrationsConfiguration. This method will fail if any of the following fields are not set:

• app_integration_arn

Trait Implementations

impl Clone for AppIntegrationsConfigurationBuilder

fn clone(&self) -> AppIntegrationsConfigurationBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppIntegrationsConfigurationBuilder

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

Formats the value using the given formatter.

impl Default for AppIntegrationsConfigurationBuilder

fn default() -> AppIntegrationsConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for AppIntegrationsConfigurationBuilder

fn eq(&self, other: &AppIntegrationsConfigurationBuilder) -> 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 AppIntegrationsConfigurationBuilder