Class: Aws::QConnect::Types::CreateAssistantRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


817
818
819
820
821
822
823
824
825
826
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 817

class CreateAssistantRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :server_side_encryption_configuration,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the assistant.

Returns:

  • (String) 


817
818
819
820
821
822
823
824
825
826
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 817

class CreateAssistantRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :server_side_encryption_configuration,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the assistant.

Returns:

  • (String) 


817
818
819
820
821
822
823
824
825
826
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 817

class CreateAssistantRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :server_side_encryption_configuration,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

The configuration information for the customer managed key used for encryption.

The customer managed key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

Returns:



817
818
819
820
821
822
823
824
825
826
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 817

class CreateAssistantRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :server_side_encryption_configuration,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

  • (Hash<String,String>) 


817
818
819
820
821
822
823
824
825
826
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 817

class CreateAssistantRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :server_side_encryption_configuration,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of assistant.

Returns:

  • (String) 


817
818
819
820
821
822
823
824
825
826
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 817

class CreateAssistantRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :server_side_encryption_configuration,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end