Class: Aws::QConnect::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb

Overview

An API client for QConnect. To construct a client, you need to configure a :region and :credentials.

client = Aws::QConnect::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::QConnect::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::QConnect::EndpointParameters

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



440
441
442
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 440

def initialize(*args)
  super
end

Instance Method Details

#create_assistant(params = {}) ⇒ Types::CreateAssistantResponse

Creates an Amazon Q in Connect assistant.

Examples:

Request syntax with placeholder values


resp = client.create_assistant({
  client_token: "ClientToken",
  description: "Description",
  name: "Name", # required
  server_side_encryption_configuration: {
    kms_key_id: "NonEmptyString",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  type: "AGENT", # required, accepts AGENT
})

Response structure


resp.assistant.assistant_arn #=> String
resp.assistant.assistant_id #=> String
resp.assistant.capability_configuration.type #=> String, one of "V1", "V2"
resp.assistant.description #=> String
resp.assistant.integration_configuration.topic_integration_arn #=> String
resp.assistant.name #=> String
resp.assistant.server_side_encryption_configuration.kms_key_id #=> String
resp.assistant.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.assistant.tags #=> Hash
resp.assistant.tags["TagKey"] #=> String
resp.assistant.type #=> String, one of "AGENT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :description (String) —

    The description of the assistant.

  • :name (required, String) —

    The name of the assistant.

  • :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.

  • :tags (Hash<String,String>) —

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

  • :type (required, String) —

    The type of assistant.

Returns:

See Also:



530
531
532
533
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 530

def create_assistant(params = {}, options = {})
  req = build_request(:create_assistant, params)
  req.send_request(options)
end

#create_assistant_association(params = {}) ⇒ Types::CreateAssistantAssociationResponse

Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

Examples:

Request syntax with placeholder values


resp = client.create_assistant_association({
  assistant_id: "UuidOrArn", # required
  association: { # required
    knowledge_base_id: "Uuid",
  },
  association_type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.assistant_association.assistant_arn #=> String
resp.assistant_association.assistant_association_arn #=> String
resp.assistant_association.assistant_association_id #=> String
resp.assistant_association.assistant_id #=> String
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_arn #=> String
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_id #=> String
resp.assistant_association.association_type #=> String, one of "KNOWLEDGE_BASE"
resp.assistant_association.tags #=> Hash
resp.assistant_association.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :association (required, Types::AssistantAssociationInputData) —

    The identifier of the associated resource.

  • :association_type (required, String) —

    The type of association.

  • :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.**

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



599
600
601
602
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 599

def create_assistant_association(params = {}, options = {})
  req = build_request(:create_assistant_association, params)
  req.send_request(options)
end

#create_content(params = {}) ⇒ Types::CreateContentResponse

Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

Examples:

Request syntax with placeholder values


resp = client.create_content({
  client_token: "NonEmptyString",
  knowledge_base_id: "UuidOrArn", # required
  metadata: {
    "NonEmptyString" => "NonEmptyString",
  },
  name: "Name", # required
  override_link_out_uri: "Uri",
  tags: {
    "TagKey" => "TagValue",
  },
  title: "ContentTitle",
  upload_id: "UploadId", # required
})

Response structure


resp.content.content_arn #=> String
resp.content.content_id #=> String
resp.content.content_type #=> String
resp.content.knowledge_base_arn #=> String
resp.content.knowledge_base_id #=> String
resp.content.link_out_uri #=> String
resp.content.metadata #=> Hash
resp.content.metadata["NonEmptyString"] #=> String
resp.content.name #=> String
resp.content.revision_id #=> String
resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content.tags #=> Hash
resp.content.tags["TagKey"] #=> String
resp.content.title #=> String
resp.content.url #=> String
resp.content.url_expiry #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :metadata (Hash<String,String>) —

    A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

  • :name (required, String) —

    The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.

  • :override_link_out_uri (String) —

    The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.

  • :tags (Hash<String,String>) —

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

  • :title (String) —

    The title of the content. If not set, the title is equal to the name.

  • :upload_id (required, String) —

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

Returns:

See Also:



707
708
709
710
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 707

def create_content(params = {}, options = {})
  req = build_request(:create_content, params)
  req.send_request(options)
end

#create_content_association(params = {}) ⇒ Types::CreateContentAssociationResponse

Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.

After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.

Note the following limitations:

  • You can create only one content association for each content resource in a knowledge base.

  • You can associate a step-by-step guide with multiple content resources.

For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_content_association({
  association: { # required
    amazon_connect_guide_association: {
      flow_id: "GenericArn",
    },
  },
  association_type: "AMAZON_CONNECT_GUIDE", # required, accepts AMAZON_CONNECT_GUIDE
  client_token: "ClientToken",
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.content_association.association_data.amazon_connect_guide_association.flow_id #=> String
resp.content_association.association_type #=> String, one of "AMAZON_CONNECT_GUIDE"
resp.content_association.content_arn #=> String
resp.content_association.content_association_arn #=> String
resp.content_association.content_association_id #=> String
resp.content_association.content_id #=> String
resp.content_association.knowledge_base_arn #=> String
resp.content_association.knowledge_base_id #=> String
resp.content_association.tags #=> Hash
resp.content_association.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :association (required, Types::ContentAssociationContents) —

    The identifier of the associated resource.

  • :association_type (required, String) —

    The type of association.

  • :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.**

  • :content_id (required, String) —

    The identifier of the content.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base.

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



804
805
806
807
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 804

def create_content_association(params = {}, options = {})
  req = build_request(:create_content_association, params)
  req.send_request(options)
end

#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

  1. Call DeleteKnowledgeBase.

  2. Call DeleteDataIntegration.

  3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.

  4. Call CreateKnowledgeBase.

Examples:

Request syntax with placeholder values


resp = client.create_knowledge_base({
  client_token: "NonEmptyString",
  description: "Description",
  knowledge_base_type: "EXTERNAL", # required, accepts EXTERNAL, CUSTOM, QUICK_RESPONSES
  name: "Name", # required
  rendering_configuration: {
    template_uri: "Uri",
  },
  server_side_encryption_configuration: {
    kms_key_id: "NonEmptyString",
  },
  source_configuration: {
    app_integrations: {
      app_integration_arn: "GenericArn", # required
      object_fields: ["NonEmptyString"],
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.knowledge_base.description #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
resp.knowledge_base.last_content_modification_time #=> Time
resp.knowledge_base.name #=> String
resp.knowledge_base.rendering_configuration.template_uri #=> String
resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> String
resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base.tags #=> Hash
resp.knowledge_base.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :description (String) —

    The description.

  • :knowledge_base_type (required, String) —

    The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

  • :name (required, String) —

    The name of the knowledge base.

  • :rendering_configuration (Types::RenderingConfiguration) —

    Information about how to render the content.

  • :server_side_encryption_configuration (Types::ServerSideEncryptionConfiguration) —

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

    This KMS 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.

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

  • :source_configuration (Types::SourceConfiguration) —

    The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



937
938
939
940
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 937

def create_knowledge_base(params = {}, options = {})
  req = build_request(:create_knowledge_base, params)
  req.send_request(options)
end

#create_quick_response(params = {}) ⇒ Types::CreateQuickResponseResponse

Creates an Amazon Q in Connect quick response.

Examples:

Request syntax with placeholder values


resp = client.create_quick_response({
  channels: ["Channel"],
  client_token: "NonEmptyString",
  content: { # required
    content: "QuickResponseContent",
  },
  content_type: "QuickResponseType",
  description: "QuickResponseDescription",
  grouping_configuration: {
    criteria: "GroupingCriteria",
    values: ["GroupingValue"],
  },
  is_active: false,
  knowledge_base_id: "UuidOrArn", # required
  language: "LanguageCode",
  name: "QuickResponseName", # required
  shortcut_key: "ShortCutKey",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.quick_response.channels #=> Array
resp.quick_response.channels[0] #=> String
resp.quick_response.content_type #=> String
resp.quick_response.contents.markdown.content #=> String
resp.quick_response.contents.plain_text.content #=> String
resp.quick_response.created_time #=> Time
resp.quick_response.description #=> String
resp.quick_response.grouping_configuration.criteria #=> String
resp.quick_response.grouping_configuration.values #=> Array
resp.quick_response.grouping_configuration.values[0] #=> String
resp.quick_response.is_active #=> Boolean
resp.quick_response.knowledge_base_arn #=> String
resp.quick_response.knowledge_base_id #=> String
resp.quick_response.language #=> String
resp.quick_response.last_modified_by #=> String
resp.quick_response.last_modified_time #=> Time
resp.quick_response.name #=> String
resp.quick_response.quick_response_arn #=> String
resp.quick_response.quick_response_id #=> String
resp.quick_response.shortcut_key #=> String
resp.quick_response.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.quick_response.tags #=> Hash
resp.quick_response.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channels (Array<String>) —

    The Amazon Connect channels this quick response applies to.

  • :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.**

  • :content (required, Types::QuickResponseDataProvider) —

    The content of the quick response.

  • :content_type (String) —

    The media type of the quick response content.

    • Use application/x.quickresponse;format=plain for a quick response written in plain text.

    • Use application/x.quickresponse;format=markdown for a quick response written in richtext.

  • :description (String) —

    The description of the quick response.

  • :grouping_configuration (Types::GroupingConfiguration) —

    The configuration information of the user groups that the quick response is accessible to.

  • :is_active (Boolean) —

    Whether the quick response is active.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :language (String) —

    The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

  • :name (required, String) —

    The name of the quick response.

  • :shortcut_key (String) —

    The shortcut key of the quick response. The value should be unique across the knowledge base.

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



1060
1061
1062
1063
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1060

def create_quick_response(params = {}, options = {})
  req = build_request(:create_quick_response, params)
  req.send_request(options)
end

#create_session(params = {}) ⇒ Types::CreateSessionResponse

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

Examples:

Request syntax with placeholder values


resp = client.create_session({
  assistant_id: "UuidOrArn", # required
  client_token: "ClientToken",
  description: "Description",
  name: "Name", # required
  tag_filter: {
    and_conditions: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
    or_conditions: [
      {
        and_conditions: [
          {
            key: "TagKey", # required
            value: "TagValue",
          },
        ],
        tag_condition: {
          key: "TagKey", # required
          value: "TagValue",
        },
      },
    ],
    tag_condition: {
      key: "TagKey", # required
      value: "TagValue",
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.session.description #=> String
resp.session.integration_configuration.topic_integration_arn #=> String
resp.session.name #=> String
resp.session.session_arn #=> String
resp.session.session_id #=> String
resp.session.tag_filter.and_conditions #=> Array
resp.session.tag_filter.and_conditions[0].key #=> String
resp.session.tag_filter.and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
resp.session.tag_filter.tag_condition.key #=> String
resp.session.tag_filter.tag_condition.value #=> String
resp.session.tags #=> Hash
resp.session.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :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.**

  • :description (String) —

    The description.

  • :name (required, String) —

    The name of the session.

  • :tag_filter (Types::TagFilter) —

    An object that can be used to specify Tag conditions.

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



1166
1167
1168
1169
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1166

def create_session(params = {}, options = {})
  req = build_request(:create_session, params)
  req.send_request(options)
end

#delete_assistant(params = {}) ⇒ Struct

Deletes an assistant.

Examples:

Request syntax with placeholder values


resp = client.delete_assistant({
  assistant_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1189
1190
1191
1192
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1189

def delete_assistant(params = {}, options = {})
  req = build_request(:delete_assistant, params)
  req.send_request(options)
end

#delete_assistant_association(params = {}) ⇒ Struct

Deletes an assistant association.

Examples:

Request syntax with placeholder values


resp = client.delete_assistant_association({
  assistant_association_id: "UuidOrArn", # required
  assistant_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_association_id (required, String) —

    The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1217
1218
1219
1220
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1217

def delete_assistant_association(params = {}, options = {})
  req = build_request(:delete_assistant_association, params)
  req.send_request(options)
end

#delete_content(params = {}) ⇒ Struct

Deletes the content.

Examples:

Request syntax with placeholder values


resp = client.delete_content({
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_id (required, String) —

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1245
1246
1247
1248
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1245

def delete_content(params = {}, options = {})
  req = build_request(:delete_content, params)
  req.send_request(options)
end

#delete_content_association(params = {}) ⇒ Struct

Deletes the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_content_association({
  content_association_id: "UuidOrArn", # required
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_association_id (required, String) —

    The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :content_id (required, String) —

    The identifier of the content.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1284
1285
1286
1287
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1284

def delete_content_association(params = {}, options = {})
  req = build_request(:delete_content_association, params)
  req.send_request(options)
end

#delete_import_job(params = {}) ⇒ Struct

Deletes the quick response import job.

Examples:

Request syntax with placeholder values


resp = client.delete_import_job({
  import_job_id: "Uuid", # required
  knowledge_base_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :import_job_id (required, String) —

    The identifier of the import job to be deleted.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1310
1311
1312
1313
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1310

def delete_import_job(params = {}, options = {})
  req = build_request(:delete_import_job, params)
  req.send_request(options)
end

#delete_knowledge_base(params = {}) ⇒ Struct

Deletes the knowledge base.

When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.

Examples:

Request syntax with placeholder values


resp = client.delete_knowledge_base({
  knowledge_base_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1349
1350
1351
1352
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1349

def delete_knowledge_base(params = {}, options = {})
  req = build_request(:delete_knowledge_base, params)
  req.send_request(options)
end

#delete_quick_response(params = {}) ⇒ Struct

Deletes a quick response.

Examples:

Request syntax with placeholder values


resp = client.delete_quick_response({
  knowledge_base_id: "UuidOrArn", # required
  quick_response_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The knowledge base from which the quick response is deleted. The identifier of the knowledge base.

  • :quick_response_id (required, String) —

    The identifier of the quick response to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1376
1377
1378
1379
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1376

def delete_quick_response(params = {}, options = {})
  req = build_request(:delete_quick_response, params)
  req.send_request(options)
end

#get_assistant(params = {}) ⇒ Types::GetAssistantResponse

Retrieves information about an assistant.

Examples:

Request syntax with placeholder values


resp = client.get_assistant({
  assistant_id: "UuidOrArn", # required
})

Response structure


resp.assistant.assistant_arn #=> String
resp.assistant.assistant_id #=> String
resp.assistant.capability_configuration.type #=> String, one of "V1", "V2"
resp.assistant.description #=> String
resp.assistant.integration_configuration.topic_integration_arn #=> String
resp.assistant.name #=> String
resp.assistant.server_side_encryption_configuration.kms_key_id #=> String
resp.assistant.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.assistant.tags #=> Hash
resp.assistant.tags["TagKey"] #=> String
resp.assistant.type #=> String, one of "AGENT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



1415
1416
1417
1418
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1415

def get_assistant(params = {}, options = {})
  req = build_request(:get_assistant, params)
  req.send_request(options)
end

#get_assistant_association(params = {}) ⇒ Types::GetAssistantAssociationResponse

Retrieves information about an assistant association.

Examples:

Request syntax with placeholder values


resp = client.get_assistant_association({
  assistant_association_id: "UuidOrArn", # required
  assistant_id: "UuidOrArn", # required
})

Response structure


resp.assistant_association.assistant_arn #=> String
resp.assistant_association.assistant_association_arn #=> String
resp.assistant_association.assistant_association_id #=> String
resp.assistant_association.assistant_id #=> String
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_arn #=> String
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_id #=> String
resp.assistant_association.association_type #=> String, one of "KNOWLEDGE_BASE"
resp.assistant_association.tags #=> Hash
resp.assistant_association.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_association_id (required, String) —

    The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



1457
1458
1459
1460
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1457

def get_assistant_association(params = {}, options = {})
  req = build_request(:get_assistant_association, params)
  req.send_request(options)
end

#get_content(params = {}) ⇒ Types::GetContentResponse

Retrieves content, including a pre-signed URL to download the content.

Examples:

Request syntax with placeholder values


resp = client.get_content({
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.content.content_arn #=> String
resp.content.content_id #=> String
resp.content.content_type #=> String
resp.content.knowledge_base_arn #=> String
resp.content.knowledge_base_id #=> String
resp.content.link_out_uri #=> String
resp.content.metadata #=> Hash
resp.content.metadata["NonEmptyString"] #=> String
resp.content.name #=> String
resp.content.revision_id #=> String
resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content.tags #=> Hash
resp.content.tags["TagKey"] #=> String
resp.content.title #=> String
resp.content.url #=> String
resp.content.url_expiry #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_id (required, String) —

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



1507
1508
1509
1510
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1507

def get_content(params = {}, options = {})
  req = build_request(:get_content, params)
  req.send_request(options)
end

#get_content_association(params = {}) ⇒ Types::GetContentAssociationResponse

Returns the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.get_content_association({
  content_association_id: "UuidOrArn", # required
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.content_association.association_data.amazon_connect_guide_association.flow_id #=> String
resp.content_association.association_type #=> String, one of "AMAZON_CONNECT_GUIDE"
resp.content_association.content_arn #=> String
resp.content_association.content_association_arn #=> String
resp.content_association.content_association_id #=> String
resp.content_association.content_id #=> String
resp.content_association.knowledge_base_arn #=> String
resp.content_association.knowledge_base_id #=> String
resp.content_association.tags #=> Hash
resp.content_association.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_association_id (required, String) —

    The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :content_id (required, String) —

    The identifier of the content.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base.

Returns:

See Also:



1561
1562
1563
1564
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1561

def get_content_association(params = {}, options = {})
  req = build_request(:get_content_association, params)
  req.send_request(options)
end

#get_content_summary(params = {}) ⇒ Types::GetContentSummaryResponse

Retrieves summary information about the content.

Examples:

Request syntax with placeholder values


resp = client.get_content_summary({
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.content_summary.content_arn #=> String
resp.content_summary.content_id #=> String
resp.content_summary.content_type #=> String
resp.content_summary.knowledge_base_arn #=> String
resp.content_summary.knowledge_base_id #=> String
resp.content_summary.metadata #=> Hash
resp.content_summary.metadata["NonEmptyString"] #=> String
resp.content_summary.name #=> String
resp.content_summary.revision_id #=> String
resp.content_summary.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content_summary.tags #=> Hash
resp.content_summary.tags["TagKey"] #=> String
resp.content_summary.title #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_id (required, String) —

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



1607
1608
1609
1610
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1607

def get_content_summary(params = {}, options = {})
  req = build_request(:get_content_summary, params)
  req.send_request(options)
end

#get_import_job(params = {}) ⇒ Types::GetImportJobResponse

Retrieves the started import job.

Examples:

Request syntax with placeholder values


resp = client.get_import_job({
  import_job_id: "Uuid", # required
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.import_job.created_time #=> Time
resp.import_job.external_source_configuration.configuration.connect_configuration.instance_id #=> String
resp.import_job.external_source_configuration.source #=> String, one of "AMAZON_CONNECT"
resp.import_job.failed_record_report #=> String
resp.import_job.import_job_id #=> String
resp.import_job.import_job_type #=> String, one of "QUICK_RESPONSES"
resp.import_job.knowledge_base_arn #=> String
resp.import_job.knowledge_base_id #=> String
resp.import_job.last_modified_time #=> Time
resp.import_job.metadata #=> Hash
resp.import_job.metadata["NonEmptyString"] #=> String
resp.import_job.status #=> String, one of "START_IN_PROGRESS", "FAILED", "COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.import_job.upload_id #=> String
resp.import_job.url #=> String
resp.import_job.url_expiry #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :import_job_id (required, String) —

    The identifier of the import job to retrieve.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base that the import job belongs to.

Returns:

See Also:



1653
1654
1655
1656
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1653

def get_import_job(params = {}, options = {})
  req = build_request(:get_import_job, params)
  req.send_request(options)
end

#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse

Retrieves information about the knowledge base.

Examples:

Request syntax with placeholder values


resp = client.get_knowledge_base({
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.knowledge_base.description #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
resp.knowledge_base.last_content_modification_time #=> Time
resp.knowledge_base.name #=> String
resp.knowledge_base.rendering_configuration.template_uri #=> String
resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> String
resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base.tags #=> Hash
resp.knowledge_base.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



1695
1696
1697
1698
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1695

def get_knowledge_base(params = {}, options = {})
  req = build_request(:get_knowledge_base, params)
  req.send_request(options)
end

#get_quick_response(params = {}) ⇒ Types::GetQuickResponseResponse

Retrieves the quick response.

Examples:

Request syntax with placeholder values


resp = client.get_quick_response({
  knowledge_base_id: "UuidOrArn", # required
  quick_response_id: "UuidOrArn", # required
})

Response structure


resp.quick_response.channels #=> Array
resp.quick_response.channels[0] #=> String
resp.quick_response.content_type #=> String
resp.quick_response.contents.markdown.content #=> String
resp.quick_response.contents.plain_text.content #=> String
resp.quick_response.created_time #=> Time
resp.quick_response.description #=> String
resp.quick_response.grouping_configuration.criteria #=> String
resp.quick_response.grouping_configuration.values #=> Array
resp.quick_response.grouping_configuration.values[0] #=> String
resp.quick_response.is_active #=> Boolean
resp.quick_response.knowledge_base_arn #=> String
resp.quick_response.knowledge_base_id #=> String
resp.quick_response.language #=> String
resp.quick_response.last_modified_by #=> String
resp.quick_response.last_modified_time #=> Time
resp.quick_response.name #=> String
resp.quick_response.quick_response_arn #=> String
resp.quick_response.quick_response_id #=> String
resp.quick_response.shortcut_key #=> String
resp.quick_response.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.quick_response.tags #=> Hash
resp.quick_response.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

  • :quick_response_id (required, String) —

    The identifier of the quick response.

Returns:

See Also:



1750
1751
1752
1753
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1750

def get_quick_response(params = {}, options = {})
  req = build_request(:get_quick_response, params)
  req.send_request(options)
end

#get_recommendations(params = {}) ⇒ Types::GetRecommendationsResponse

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

Examples:

Request syntax with placeholder values


resp = client.get_recommendations({
  assistant_id: "UuidOrArn", # required
  max_results: 1,
  session_id: "UuidOrArn", # required
  wait_time_seconds: 1,
})

Response structure


resp.recommendations #=> Array
resp.recommendations[0].data.details.content_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.recommendations[0].data.details.content_data.ranking_data.relevance_score #=> Float
resp.recommendations[0].data.details.content_data.text_data.excerpt.highlights #=> Array
resp.recommendations[0].data.details.content_data.text_data.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].data.details.content_data.text_data.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].data.details.content_data.text_data.excerpt.text #=> String
resp.recommendations[0].data.details.content_data.text_data.title.highlights #=> Array
resp.recommendations[0].data.details.content_data.text_data.title.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].data.details.content_data.text_data.title.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].data.details.content_data.text_data.title.text #=> String
resp.recommendations[0].data.details.generative_data.completion #=> String
resp.recommendations[0].data.details.generative_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.recommendations[0].data.details.generative_data.ranking_data.relevance_score #=> Float
resp.recommendations[0].data.details.generative_data.references #=> Array
resp.recommendations[0].data.details.generative_data.references[0] #=> Types::DataSummary
resp.recommendations[0].data.details.source_content_data.id #=> String
resp.recommendations[0].data.details.source_content_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.recommendations[0].data.details.source_content_data.ranking_data.relevance_score #=> Float
resp.recommendations[0].data.details.source_content_data.text_data.excerpt.highlights #=> Array
resp.recommendations[0].data.details.source_content_data.text_data.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].data.details.source_content_data.text_data.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].data.details.source_content_data.text_data.excerpt.text #=> String
resp.recommendations[0].data.details.source_content_data.text_data.title.highlights #=> Array
resp.recommendations[0].data.details.source_content_data.text_data.title.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].data.details.source_content_data.text_data.title.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].data.details.source_content_data.text_data.title.text #=> String
resp.recommendations[0].data.details.source_content_data.type #=> String, one of "KNOWLEDGE_CONTENT"
resp.recommendations[0].data.reference.content_reference.content_arn #=> String
resp.recommendations[0].data.reference.content_reference.content_id #=> String
resp.recommendations[0].data.reference.content_reference.knowledge_base_arn #=> String
resp.recommendations[0].data.reference.content_reference.knowledge_base_id #=> String
resp.recommendations[0].data.reference.generative_reference.generation_id #=> String
resp.recommendations[0].data.reference.generative_reference.model_id #=> String
resp.recommendations[0].document.content_reference.content_arn #=> String
resp.recommendations[0].document.content_reference.content_id #=> String
resp.recommendations[0].document.content_reference.knowledge_base_arn #=> String
resp.recommendations[0].document.content_reference.knowledge_base_id #=> String
resp.recommendations[0].document.excerpt.highlights #=> Array
resp.recommendations[0].document.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].document.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].document.excerpt.text #=> String
resp.recommendations[0].document.title.highlights #=> Array
resp.recommendations[0].document.title.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].document.title.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].document.title.text #=> String
resp.recommendations[0].recommendation_id #=> String
resp.recommendations[0].relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.recommendations[0].relevance_score #=> Float
resp.recommendations[0].type #=> String, one of "KNOWLEDGE_CONTENT", "GENERATIVE_RESPONSE", "GENERATIVE_ANSWER"
resp.triggers #=> Array
resp.triggers[0].data.query.text #=> String
resp.triggers[0].id #=> String
resp.triggers[0].recommendation_ids #=> Array
resp.triggers[0].recommendation_ids[0] #=> String
resp.triggers[0].source #=> String, one of "ISSUE_DETECTION", "RULE_EVALUATION", "OTHER"
resp.triggers[0].type #=> String, one of "QUERY", "GENERATIVE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :session_id (required, String) —

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :wait_time_seconds (Integer) —

    The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

Returns:

See Also:



1870
1871
1872
1873
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1870

def get_recommendations(params = {}, options = {})
  req = build_request(:get_recommendations, params)
  req.send_request(options)
end

#get_session(params = {}) ⇒ Types::GetSessionResponse

Retrieves information for a specified session.

Examples:

Request syntax with placeholder values


resp = client.get_session({
  assistant_id: "UuidOrArn", # required
  session_id: "UuidOrArn", # required
})

Response structure


resp.session.description #=> String
resp.session.integration_configuration.topic_integration_arn #=> String
resp.session.name #=> String
resp.session.session_arn #=> String
resp.session.session_id #=> String
resp.session.tag_filter.and_conditions #=> Array
resp.session.tag_filter.and_conditions[0].key #=> String
resp.session.tag_filter.and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
resp.session.tag_filter.tag_condition.key #=> String
resp.session.tag_filter.tag_condition.value #=> String
resp.session.tags #=> Hash
resp.session.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :session_id (required, String) —

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



1921
1922
1923
1924
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1921

def get_session(params = {}, options = {})
  req = build_request(:get_session, params)
  req.send_request(options)
end

#list_assistant_associations(params = {}) ⇒ Types::ListAssistantAssociationsResponse

Lists information about assistant associations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_assistant_associations({
  assistant_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.assistant_association_summaries #=> Array
resp.assistant_association_summaries[0].assistant_arn #=> String
resp.assistant_association_summaries[0].assistant_association_arn #=> String
resp.assistant_association_summaries[0].assistant_association_id #=> String
resp.assistant_association_summaries[0].assistant_id #=> String
resp.assistant_association_summaries[0].association_data.knowledge_base_association.knowledge_base_arn #=> String
resp.assistant_association_summaries[0].association_data.knowledge_base_association.knowledge_base_id #=> String
resp.assistant_association_summaries[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.assistant_association_summaries[0].tags #=> Hash
resp.assistant_association_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



1973
1974
1975
1976
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1973

def list_assistant_associations(params = {}, options = {})
  req = build_request(:list_assistant_associations, params)
  req.send_request(options)
end

#list_assistants(params = {}) ⇒ Types::ListAssistantsResponse

Lists information about assistants.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_assistants({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.assistant_summaries #=> Array
resp.assistant_summaries[0].assistant_arn #=> String
resp.assistant_summaries[0].assistant_id #=> String
resp.assistant_summaries[0].capability_configuration.type #=> String, one of "V1", "V2"
resp.assistant_summaries[0].description #=> String
resp.assistant_summaries[0].integration_configuration.topic_integration_arn #=> String
resp.assistant_summaries[0].name #=> String
resp.assistant_summaries[0].server_side_encryption_configuration.kms_key_id #=> String
resp.assistant_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.assistant_summaries[0].tags #=> Hash
resp.assistant_summaries[0].tags["TagKey"] #=> String
resp.assistant_summaries[0].type #=> String, one of "AGENT"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



2022
2023
2024
2025
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2022

def list_assistants(params = {}, options = {})
  req = build_request(:list_assistants, params)
  req.send_request(options)
end

#list_content_associations(params = {}) ⇒ Types::ListContentAssociationsResponse

Lists the content associations.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_content_associations({
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.content_association_summaries #=> Array
resp.content_association_summaries[0].association_data.amazon_connect_guide_association.flow_id #=> String
resp.content_association_summaries[0].association_type #=> String, one of "AMAZON_CONNECT_GUIDE"
resp.content_association_summaries[0].content_arn #=> String
resp.content_association_summaries[0].content_association_arn #=> String
resp.content_association_summaries[0].content_association_id #=> String
resp.content_association_summaries[0].content_id #=> String
resp.content_association_summaries[0].knowledge_base_arn #=> String
resp.content_association_summaries[0].knowledge_base_id #=> String
resp.content_association_summaries[0].tags #=> Hash
resp.content_association_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_id (required, String) —

    The identifier of the content.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



2086
2087
2088
2089
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2086

def list_content_associations(params = {}, options = {})
  req = build_request(:list_content_associations, params)
  req.send_request(options)
end

#list_contents(params = {}) ⇒ Types::ListContentsResponse

Lists the content.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_contents({
  knowledge_base_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.content_summaries #=> Array
resp.content_summaries[0].content_arn #=> String
resp.content_summaries[0].content_id #=> String
resp.content_summaries[0].content_type #=> String
resp.content_summaries[0].knowledge_base_arn #=> String
resp.content_summaries[0].knowledge_base_id #=> String
resp.content_summaries[0].metadata #=> Hash
resp.content_summaries[0].metadata["NonEmptyString"] #=> String
resp.content_summaries[0].name #=> String
resp.content_summaries[0].revision_id #=> String
resp.content_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content_summaries[0].tags #=> Hash
resp.content_summaries[0].tags["TagKey"] #=> String
resp.content_summaries[0].title #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



2143
2144
2145
2146
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2143

def list_contents(params = {}, options = {})
  req = build_request(:list_contents, params)
  req.send_request(options)
end

#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse

Lists information about import jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_import_jobs({
  knowledge_base_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NonEmptyString",
})

Response structure


resp.import_job_summaries #=> Array
resp.import_job_summaries[0].created_time #=> Time
resp.import_job_summaries[0].external_source_configuration.configuration.connect_configuration.instance_id #=> String
resp.import_job_summaries[0].external_source_configuration.source #=> String, one of "AMAZON_CONNECT"
resp.import_job_summaries[0].import_job_id #=> String
resp.import_job_summaries[0].import_job_type #=> String, one of "QUICK_RESPONSES"
resp.import_job_summaries[0].knowledge_base_arn #=> String
resp.import_job_summaries[0].knowledge_base_id #=> String
resp.import_job_summaries[0].last_modified_time #=> Time
resp.import_job_summaries[0].metadata #=> Hash
resp.import_job_summaries[0].metadata["NonEmptyString"] #=> String
resp.import_job_summaries[0].status #=> String, one of "START_IN_PROGRESS", "FAILED", "COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.import_job_summaries[0].upload_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



2198
2199
2200
2201
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2198

def list_import_jobs(params = {}, options = {})
  req = build_request(:list_import_jobs, params)
  req.send_request(options)
end

#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse

Lists the knowledge bases.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_knowledge_bases({
  max_results: 1,
  next_token: "NonEmptyString",
})

Response structure


resp.knowledge_base_summaries #=> Array
resp.knowledge_base_summaries[0].description #=> String
resp.knowledge_base_summaries[0].knowledge_base_arn #=> String
resp.knowledge_base_summaries[0].knowledge_base_id #=> String
resp.knowledge_base_summaries[0].knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
resp.knowledge_base_summaries[0].name #=> String
resp.knowledge_base_summaries[0].rendering_configuration.template_uri #=> String
resp.knowledge_base_summaries[0].server_side_encryption_configuration.kms_key_id #=> String
resp.knowledge_base_summaries[0].source_configuration.app_integrations.app_integration_arn #=> String
resp.knowledge_base_summaries[0].source_configuration.app_integrations.object_fields #=> Array
resp.knowledge_base_summaries[0].source_configuration.app_integrations.object_fields[0] #=> String
resp.knowledge_base_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base_summaries[0].tags #=> Hash
resp.knowledge_base_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



2249
2250
2251
2252
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2249

def list_knowledge_bases(params = {}, options = {})
  req = build_request(:list_knowledge_bases, params)
  req.send_request(options)
end

#list_quick_responses(params = {}) ⇒ Types::ListQuickResponsesResponse

Lists information about quick response.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_quick_responses({
  knowledge_base_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NonEmptyString",
})

Response structure


resp.next_token #=> String
resp.quick_response_summaries #=> Array
resp.quick_response_summaries[0].channels #=> Array
resp.quick_response_summaries[0].channels[0] #=> String
resp.quick_response_summaries[0].content_type #=> String
resp.quick_response_summaries[0].created_time #=> Time
resp.quick_response_summaries[0].description #=> String
resp.quick_response_summaries[0].is_active #=> Boolean
resp.quick_response_summaries[0].knowledge_base_arn #=> String
resp.quick_response_summaries[0].knowledge_base_id #=> String
resp.quick_response_summaries[0].last_modified_by #=> String
resp.quick_response_summaries[0].last_modified_time #=> Time
resp.quick_response_summaries[0].name #=> String
resp.quick_response_summaries[0].quick_response_arn #=> String
resp.quick_response_summaries[0].quick_response_id #=> String
resp.quick_response_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.quick_response_summaries[0].tags #=> Hash
resp.quick_response_summaries[0].tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

See Also:



2308
2309
2310
2311
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2308

def list_quick_responses(params = {}, options = {})
  req = build_request(:list_quick_responses, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



2337
2338
2339
2340
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2337

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#notify_recommendations_received(params = {}) ⇒ Types::NotifyRecommendationsReceivedResponse

Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

Examples:

Request syntax with placeholder values


resp = client.notify_recommendations_received({
  assistant_id: "UuidOrArn", # required
  recommendation_ids: ["RecommendationId"], # required
  session_id: "UuidOrArn", # required
})

Response structure


resp.errors #=> Array
resp.errors[0].message #=> String
resp.errors[0].recommendation_id #=> String
resp.recommendation_ids #=> Array
resp.recommendation_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :recommendation_ids (required, Array<String>) —

    The identifiers of the recommendations.

  • :session_id (required, String) —

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



2387
2388
2389
2390
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2387

def notify_recommendations_received(params = {}, options = {})
  req = build_request(:notify_recommendations_received, params)
  req.send_request(options)
end

#put_feedback(params = {}) ⇒ Types::PutFeedbackResponse

Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

Examples:

Request syntax with placeholder values


resp = client.put_feedback({
  assistant_id: "UuidOrArn", # required
  content_feedback: { # required
    generative_content_feedback_data: {
      relevance: "HELPFUL", # required, accepts HELPFUL, NOT_HELPFUL
    },
  },
  target_id: "Uuid", # required
  target_type: "RECOMMENDATION", # required, accepts RECOMMENDATION, RESULT
})

Response structure


resp.assistant_arn #=> String
resp.assistant_id #=> String
resp.content_feedback.generative_content_feedback_data.relevance #=> String, one of "HELPFUL", "NOT_HELPFUL"
resp.target_id #=> String
resp.target_type #=> String, one of "RECOMMENDATION", "RESULT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant.

  • :content_feedback (required, Types::ContentFeedbackData) —

    Information about the feedback provided.

  • :target_id (required, String) —

    The identifier of the feedback target.

  • :target_type (required, String) —

    The type of the feedback target.

Returns:

See Also:



2440
2441
2442
2443
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2440

def put_feedback(params = {}, options = {})
  req = build_request(:put_feedback, params)
  req.send_request(options)
end

#query_assistant(params = {}) ⇒ Types::QueryAssistantResponse

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.query_assistant({
  assistant_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
  query_condition: [
    {
      single: {
        comparator: "EQUALS", # required, accepts EQUALS
        field: "RESULT_TYPE", # required, accepts RESULT_TYPE
        value: "NonEmptyString", # required
      },
    },
  ],
  query_text: "QueryText", # required
  session_id: "UuidOrArn",
})

Response structure


resp.next_token #=> String
resp.results #=> Array
resp.results[0].data.details.content_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.results[0].data.details.content_data.ranking_data.relevance_score #=> Float
resp.results[0].data.details.content_data.text_data.excerpt.highlights #=> Array
resp.results[0].data.details.content_data.text_data.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].data.details.content_data.text_data.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].data.details.content_data.text_data.excerpt.text #=> String
resp.results[0].data.details.content_data.text_data.title.highlights #=> Array
resp.results[0].data.details.content_data.text_data.title.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].data.details.content_data.text_data.title.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].data.details.content_data.text_data.title.text #=> String
resp.results[0].data.details.generative_data.completion #=> String
resp.results[0].data.details.generative_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.results[0].data.details.generative_data.ranking_data.relevance_score #=> Float
resp.results[0].data.details.generative_data.references #=> Array
resp.results[0].data.details.generative_data.references[0] #=> Types::DataSummary
resp.results[0].data.details.source_content_data.id #=> String
resp.results[0].data.details.source_content_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.results[0].data.details.source_content_data.ranking_data.relevance_score #=> Float
resp.results[0].data.details.source_content_data.text_data.excerpt.highlights #=> Array
resp.results[0].data.details.source_content_data.text_data.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].data.details.source_content_data.text_data.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].data.details.source_content_data.text_data.excerpt.text #=> String
resp.results[0].data.details.source_content_data.text_data.title.highlights #=> Array
resp.results[0].data.details.source_content_data.text_data.title.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].data.details.source_content_data.text_data.title.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].data.details.source_content_data.text_data.title.text #=> String
resp.results[0].data.details.source_content_data.type #=> String, one of "KNOWLEDGE_CONTENT"
resp.results[0].data.reference.content_reference.content_arn #=> String
resp.results[0].data.reference.content_reference.content_id #=> String
resp.results[0].data.reference.content_reference.knowledge_base_arn #=> String
resp.results[0].data.reference.content_reference.knowledge_base_id #=> String
resp.results[0].data.reference.generative_reference.generation_id #=> String
resp.results[0].data.reference.generative_reference.model_id #=> String
resp.results[0].document.content_reference.content_arn #=> String
resp.results[0].document.content_reference.content_id #=> String
resp.results[0].document.content_reference.knowledge_base_arn #=> String
resp.results[0].document.content_reference.knowledge_base_id #=> String
resp.results[0].document.excerpt.highlights #=> Array
resp.results[0].document.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].document.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].document.excerpt.text #=> String
resp.results[0].document.title.highlights #=> Array
resp.results[0].document.title.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].document.title.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].document.title.text #=> String
resp.results[0].relevance_score #=> Float
resp.results[0].result_id #=> String
resp.results[0].type #=> String, one of "KNOWLEDGE_CONTENT", "GENERATIVE_ANSWER"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :query_condition (Array<Types::QueryCondition>) —

    Information about how to query content.

  • :query_text (required, String) —

    The text to search for.

  • :session_id (String) —

    The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



2563
2564
2565
2566
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2563

def query_assistant(params = {}, options = {})
  req = build_request(:query_assistant, params)
  req.send_request(options)
end

#remove_knowledge_base_template_uri(params = {}) ⇒ Struct

Removes a URI template from a knowledge base.

Examples:

Request syntax with placeholder values


resp = client.remove_knowledge_base_template_uri({
  knowledge_base_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2586
2587
2588
2589
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2586

def remove_knowledge_base_template_uri(params = {}, options = {})
  req = build_request(:remove_knowledge_base_template_uri, params)
  req.send_request(options)
end

#search_content(params = {}) ⇒ Types::SearchContentResponse

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_content({
  knowledge_base_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
  search_expression: { # required
    filters: [ # required
      {
        field: "NAME", # required, accepts NAME
        operator: "EQUALS", # required, accepts EQUALS
        value: "NonEmptyString", # required
      },
    ],
  },
})

Response structure


resp.content_summaries #=> Array
resp.content_summaries[0].content_arn #=> String
resp.content_summaries[0].content_id #=> String
resp.content_summaries[0].content_type #=> String
resp.content_summaries[0].knowledge_base_arn #=> String
resp.content_summaries[0].knowledge_base_id #=> String
resp.content_summaries[0].metadata #=> Hash
resp.content_summaries[0].metadata["NonEmptyString"] #=> String
resp.content_summaries[0].name #=> String
resp.content_summaries[0].revision_id #=> String
resp.content_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content_summaries[0].tags #=> Hash
resp.content_summaries[0].tags["TagKey"] #=> String
resp.content_summaries[0].title #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :search_expression (required, Types::SearchExpression) —

    The search expression to filter results.

Returns:

See Also:



2656
2657
2658
2659
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2656

def search_content(params = {}, options = {})
  req = build_request(:search_content, params)
  req.send_request(options)
end

#search_quick_responses(params = {}) ⇒ Types::SearchQuickResponsesResponse

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_quick_responses({
  attributes: {
    "ContactAttributeKey" => "ContactAttributeValue",
  },
  knowledge_base_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NonEmptyString",
  search_expression: { # required
    filters: [
      {
        include_no_existence: false,
        name: "NonEmptyString", # required
        operator: "EQUALS", # required, accepts EQUALS, PREFIX
        values: ["QuickResponseFilterValue"],
      },
    ],
    order_on_field: {
      name: "NonEmptyString", # required
      order: "ASC", # accepts ASC, DESC
    },
    queries: [
      {
        allow_fuzziness: false,
        name: "NonEmptyString", # required
        operator: "CONTAINS", # required, accepts CONTAINS, CONTAINS_AND_PREFIX
        priority: "HIGH", # accepts HIGH, MEDIUM, LOW
        values: ["QuickResponseQueryValue"], # required
      },
    ],
  },
})

Response structure


resp.next_token #=> String
resp.results #=> Array
resp.results[0].attributes_interpolated #=> Array
resp.results[0].attributes_interpolated[0] #=> String
resp.results[0].attributes_not_interpolated #=> Array
resp.results[0].attributes_not_interpolated[0] #=> String
resp.results[0].channels #=> Array
resp.results[0].channels[0] #=> String
resp.results[0].content_type #=> String
resp.results[0].contents.markdown.content #=> String
resp.results[0].contents.plain_text.content #=> String
resp.results[0].created_time #=> Time
resp.results[0].description #=> String
resp.results[0].grouping_configuration.criteria #=> String
resp.results[0].grouping_configuration.values #=> Array
resp.results[0].grouping_configuration.values[0] #=> String
resp.results[0].is_active #=> Boolean
resp.results[0].knowledge_base_arn #=> String
resp.results[0].knowledge_base_id #=> String
resp.results[0].language #=> String
resp.results[0].last_modified_by #=> String
resp.results[0].last_modified_time #=> Time
resp.results[0].name #=> String
resp.results[0].quick_response_arn #=> String
resp.results[0].quick_response_id #=> String
resp.results[0].shortcut_key #=> String
resp.results[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.results[0].tags #=> Hash
resp.results[0].tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attributes (Hash<String,String>) —

    The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :search_expression (required, Types::QuickResponseSearchExpression) —

    The search expression for querying the quick response.

Returns:

See Also:



2765
2766
2767
2768
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2765

def search_quick_responses(params = {}, options = {})
  req = build_request(:search_quick_responses, params)
  req.send_request(options)
end

#search_sessions(params = {}) ⇒ Types::SearchSessionsResponse

Searches for sessions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_sessions({
  assistant_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
  search_expression: { # required
    filters: [ # required
      {
        field: "NAME", # required, accepts NAME
        operator: "EQUALS", # required, accepts EQUALS
        value: "NonEmptyString", # required
      },
    ],
  },
})

Response structure


resp.next_token #=> String
resp.session_summaries #=> Array
resp.session_summaries[0].assistant_arn #=> String
resp.session_summaries[0].assistant_id #=> String
resp.session_summaries[0].session_arn #=> String
resp.session_summaries[0].session_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :search_expression (required, Types::SearchExpression) —

    The search expression to filter results.

Returns:

See Also:



2824
2825
2826
2827
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2824

def search_sessions(params = {}, options = {})
  req = build_request(:search_sessions, params)
  req.send_request(options)
end

#start_content_upload(params = {}) ⇒ Types::StartContentUploadResponse

Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

Examples:

Request syntax with placeholder values


resp = client.start_content_upload({
  content_type: "ContentType", # required
  knowledge_base_id: "UuidOrArn", # required
  presigned_url_time_to_live: 1,
})

Response structure


resp.headers_to_include #=> Hash
resp.headers_to_include["NonEmptyString"] #=> String
resp.upload_id #=> String
resp.url #=> String
resp.url_expiry #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_type (required, String) —

    The type of content to upload.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :presigned_url_time_to_live (Integer) —

    The expected expiration time of the generated presigned URL, specified in minutes.

Returns:

See Also:



2879
2880
2881
2882
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2879

def start_content_upload(params = {}, options = {})
  req = build_request(:start_content_upload, params)
  req.send_request(options)
end

#start_import_job(params = {}) ⇒ Types::StartImportJobResponse

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.

  • For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

^

Examples:

Request syntax with placeholder values


resp = client.start_import_job({
  client_token: "NonEmptyString",
  external_source_configuration: {
    configuration: { # required
      connect_configuration: {
        instance_id: "NonEmptyString",
      },
    },
    source: "AMAZON_CONNECT", # required, accepts AMAZON_CONNECT
  },
  import_job_type: "QUICK_RESPONSES", # required, accepts QUICK_RESPONSES
  knowledge_base_id: "UuidOrArn", # required
  metadata: {
    "NonEmptyString" => "NonEmptyString",
  },
  upload_id: "UploadId", # required
})

Response structure


resp.import_job.created_time #=> Time
resp.import_job.external_source_configuration.configuration.connect_configuration.instance_id #=> String
resp.import_job.external_source_configuration.source #=> String, one of "AMAZON_CONNECT"
resp.import_job.failed_record_report #=> String
resp.import_job.import_job_id #=> String
resp.import_job.import_job_type #=> String, one of "QUICK_RESPONSES"
resp.import_job.knowledge_base_arn #=> String
resp.import_job.knowledge_base_id #=> String
resp.import_job.last_modified_time #=> Time
resp.import_job.metadata #=> Hash
resp.import_job.metadata["NonEmptyString"] #=> String
resp.import_job.status #=> String, one of "START_IN_PROGRESS", "FAILED", "COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.import_job.upload_id #=> String
resp.import_job.url #=> String
resp.import_job.url_expiry #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

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

  • :external_source_configuration (Types::ExternalSourceConfiguration) —

    The configuration information of the external source that the resource data are imported from.

  • :import_job_type (required, String) —

    The type of the import job.

    • For importing quick response resource, set the value to QUICK_RESPONSES.

    ^

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    • For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES type knowledge base.

    ^

  • :metadata (Hash<String,String>) —

    The metadata fields of the imported Amazon Q in Connect resources.

  • :upload_id (required, String) —

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

Returns:

See Also:



2985
2986
2987
2988
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2985

def start_import_job(params = {}, options = {})
  req = build_request(:start_import_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds the specified tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3013
3014
3015
3016
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3013

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>) —

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3039
3040
3041
3042
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3039

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_content(params = {}) ⇒ Types::UpdateContentResponse

Updates information about the content.

Examples:

Request syntax with placeholder values


resp = client.update_content({
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
  metadata: {
    "NonEmptyString" => "NonEmptyString",
  },
  override_link_out_uri: "Uri",
  remove_override_link_out_uri: false,
  revision_id: "NonEmptyString",
  title: "ContentTitle",
  upload_id: "UploadId",
})

Response structure


resp.content.content_arn #=> String
resp.content.content_id #=> String
resp.content.content_type #=> String
resp.content.knowledge_base_arn #=> String
resp.content.knowledge_base_id #=> String
resp.content.link_out_uri #=> String
resp.content.metadata #=> Hash
resp.content.metadata["NonEmptyString"] #=> String
resp.content.name #=> String
resp.content.revision_id #=> String
resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content.tags #=> Hash
resp.content.tags["TagKey"] #=> String
resp.content.title #=> String
resp.content.url #=> String
resp.content.url_expiry #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_id (required, String) —

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN

  • :metadata (Hash<String,String>) —

    A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

  • :override_link_out_uri (String) —

    The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.

  • :remove_override_link_out_uri (Boolean) —

    Unset the existing overrideLinkOutUri if it exists.

  • :revision_id (String) —

    The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.

  • :title (String) —

    The title of the content.

  • :upload_id (String) —

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

Returns:

See Also:



3129
3130
3131
3132
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3129

def update_content(params = {}, options = {})
  req = build_request(:update_content, params)
  req.send_request(options)
end

#update_knowledge_base_template_uri(params = {}) ⇒ Types::UpdateKnowledgeBaseTemplateUriResponse

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in $\{variable\} format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*/view.

Examples:

Request syntax with placeholder values


resp = client.update_knowledge_base_template_uri({
  knowledge_base_id: "UuidOrArn", # required
  template_uri: "Uri", # required
})

Response structure


resp.knowledge_base.description #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES"
resp.knowledge_base.last_content_modification_time #=> Time
resp.knowledge_base.name #=> String
resp.knowledge_base.rendering_configuration.template_uri #=> String
resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> String
resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base.tags #=> Hash
resp.knowledge_base.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :template_uri (required, String) —

    The template URI to update.

Returns:

See Also:



3181
3182
3183
3184
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3181

def update_knowledge_base_template_uri(params = {}, options = {})
  req = build_request(:update_knowledge_base_template_uri, params)
  req.send_request(options)
end

#update_quick_response(params = {}) ⇒ Types::UpdateQuickResponseResponse

Updates an existing Amazon Q in Connect quick response.

Examples:

Request syntax with placeholder values


resp = client.update_quick_response({
  channels: ["Channel"],
  content: {
    content: "QuickResponseContent",
  },
  content_type: "QuickResponseType",
  description: "QuickResponseDescription",
  grouping_configuration: {
    criteria: "GroupingCriteria",
    values: ["GroupingValue"],
  },
  is_active: false,
  knowledge_base_id: "UuidOrArn", # required
  language: "LanguageCode",
  name: "QuickResponseName",
  quick_response_id: "UuidOrArn", # required
  remove_description: false,
  remove_grouping_configuration: false,
  remove_shortcut_key: false,
  shortcut_key: "ShortCutKey",
})

Response structure


resp.quick_response.channels #=> Array
resp.quick_response.channels[0] #=> String
resp.quick_response.content_type #=> String
resp.quick_response.contents.markdown.content #=> String
resp.quick_response.contents.plain_text.content #=> String
resp.quick_response.created_time #=> Time
resp.quick_response.description #=> String
resp.quick_response.grouping_configuration.criteria #=> String
resp.quick_response.grouping_configuration.values #=> Array
resp.quick_response.grouping_configuration.values[0] #=> String
resp.quick_response.is_active #=> Boolean
resp.quick_response.knowledge_base_arn #=> String
resp.quick_response.knowledge_base_id #=> String
resp.quick_response.language #=> String
resp.quick_response.last_modified_by #=> String
resp.quick_response.last_modified_time #=> Time
resp.quick_response.name #=> String
resp.quick_response.quick_response_arn #=> String
resp.quick_response.quick_response_id #=> String
resp.quick_response.shortcut_key #=> String
resp.quick_response.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.quick_response.tags #=> Hash
resp.quick_response.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :channels (Array<String>) —

    The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

  • :content (Types::QuickResponseDataProvider) —

    The updated content of the quick response.

  • :content_type (String) —

    The media type of the quick response content.

    • Use application/x.quickresponse;format=plain for quick response written in plain text.

    • Use application/x.quickresponse;format=markdown for quick response written in richtext.

  • :description (String) —

    The updated description of the quick response.

  • :grouping_configuration (Types::GroupingConfiguration) —

    The updated grouping configuration of the quick response.

  • :is_active (Boolean) —

    Whether the quick response is active.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :language (String) —

    The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

  • :name (String) —

    The name of the quick response.

  • :quick_response_id (required, String) —

    The identifier of the quick response.

  • :remove_description (Boolean) —

    Whether to remove the description from the quick response.

  • :remove_grouping_configuration (Boolean) —

    Whether to remove the grouping configuration of the quick response.

  • :remove_shortcut_key (Boolean) —

    Whether to remove the shortcut key of the quick response.

  • :shortcut_key (String) —

    The shortcut key of the quick response. The value should be unique across the knowledge base.

Returns:

See Also:



3300
3301
3302
3303
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3300

def update_quick_response(params = {}, options = {})
  req = build_request(:update_quick_response, params)
  req.send_request(options)
end

#update_session(params = {}) ⇒ Types::UpdateSessionResponse

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

Examples:

Request syntax with placeholder values


resp = client.update_session({
  assistant_id: "UuidOrArn", # required
  description: "Description",
  session_id: "UuidOrArn", # required
  tag_filter: {
    and_conditions: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
    or_conditions: [
      {
        and_conditions: [
          {
            key: "TagKey", # required
            value: "TagValue",
          },
        ],
        tag_condition: {
          key: "TagKey", # required
          value: "TagValue",
        },
      },
    ],
    tag_condition: {
      key: "TagKey", # required
      value: "TagValue",
    },
  },
})

Response structure


resp.session.description #=> String
resp.session.integration_configuration.topic_integration_arn #=> String
resp.session.name #=> String
resp.session.session_arn #=> String
resp.session.session_id #=> String
resp.session.tag_filter.and_conditions #=> Array
resp.session.tag_filter.and_conditions[0].key #=> String
resp.session.tag_filter.and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
resp.session.tag_filter.tag_condition.key #=> String
resp.session.tag_filter.tag_condition.value #=> String
resp.session.tags #=> Hash
resp.session.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :description (String) —

    The description.

  • :session_id (required, String) —

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :tag_filter (Types::TagFilter) —

    An object that can be used to specify Tag conditions.

Returns:

See Also:



3387
3388
3389
3390
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3387

def update_session(params = {}, options = {})
  req = build_request(:update_session, params)
  req.send_request(options)
end