Class: Aws::MailManager::Types::DeliverToQBusinessAction

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb

Overview

The action to deliver incoming emails to an Amazon Q Business application for indexing.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_failure_policy ⇒ String

A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.

Returns:

  • (String) 


1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1061

class DeliverToQBusinessAction < Struct.new(
  :action_failure_policy,
  :application_id,
  :index_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#application_id ⇒ String

The unique identifier of the Amazon Q Business application instance where the email content will be delivered.

Returns:

  • (String) 


1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1061

class DeliverToQBusinessAction < Struct.new(
  :action_failure_policy,
  :application_id,
  :index_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.

Returns:

  • (String) 


1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1061

class DeliverToQBusinessAction < Struct.new(
  :action_failure_policy,
  :application_id,
  :index_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.

Returns:

  • (String) 


1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1061

class DeliverToQBusinessAction < Struct.new(
  :action_failure_policy,
  :application_id,
  :index_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end