Skip to content

QuickResponseSearchResultData

Source code in docs_src/capo_qconnect/types/quick_response_search_result_data.py
class QuickResponseSearchResultData(TypedDict, closed=True):
    quick_response_arn: "capo_qconnect.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the quick response.</p>"""
    quick_response_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the quick response.</p>"""
    knowledge_base_arn: "capo_qconnect.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the knowledge base.</p>"""
    knowledge_base_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    name: "capo_qconnect.types.quick_response_name.QuickResponseName"
    """<p>The name of the quick response.</p>"""
    content_type: "capo_qconnect.types.quick_response_type.QuickResponseType"
    """<p>The media type of the quick response content.</p> <ul> <li> <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p> </li> <li> <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p> </li> </ul>"""
    status: "capo_qconnect.types.quick_response_status.QuickResponseStatus"
    """<p>The resource status of the quick response.</p>"""
    contents: "capo_qconnect.types.quick_response_contents.QuickResponseContents"
    """<p>The contents of the quick response.</p>"""
    created_time: "datetime.datetime"
    """<p>The timestamp when the quick response was created.</p>"""
    last_modified_time: "datetime.datetime"
    """<p>The timestamp when the quick response search result data was last modified.</p>"""
    is_active: "bool"
    """<p>Whether the quick response is active.</p>"""
    description: NotRequired[
        "capo_qconnect.types.quick_response_description.QuickResponseDescription"
    ]
    """<p>The description of the quick response.</p>"""
    grouping_configuration: NotRequired[
        "capo_qconnect.types.grouping_configuration.GroupingConfiguration"
    ]
    """<p>The configuration information of the user groups that the quick response is accessible to.</p>"""
    shortcut_key: NotRequired["capo_qconnect.types.short_cut_key.ShortCutKey"]
    """<p>The shortcut key of the quick response. The value should be unique across the knowledge base.</p>"""
    last_modified_by: NotRequired["capo_qconnect.types.generic_arn.GenericArn"]
    """<p>The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.</p>"""
    channels: NotRequired["capo_qconnect.types.channels.Channels"]
    """<p>The Connect Customer contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>"""
    language: NotRequired["capo_qconnect.types.language_code.LanguageCode"]
    """<p>The language code value for the language in which the quick response is written.</p>"""
    attributes_not_interpolated: NotRequired[
        "capo_qconnect.types.contact_attribute_keys.ContactAttributeKeys"
    ]
    """<p>The user defined contact attributes that are not resolved when the search result is returned.</p>"""
    attributes_interpolated: NotRequired[
        "capo_qconnect.types.contact_attribute_keys.ContactAttributeKeys"
    ]
    """<p>The user defined contact attributes that are resolved when the search result is returned.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

attributes_interpolated instance-attribute

attributes_interpolated: NotRequired[ContactAttributeKeys]

The user defined contact attributes that are resolved when the search result is returned.

attributes_not_interpolated instance-attribute

attributes_not_interpolated: NotRequired[ContactAttributeKeys]

The user defined contact attributes that are not resolved when the search result is returned.

channels instance-attribute

channels: NotRequired[Channels]

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

content_type instance-attribute

content_type: QuickResponseType

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.

contents instance-attribute

The contents of the quick response.

created_time instance-attribute

created_time: datetime

The timestamp when the quick response was created.

description instance-attribute

description: NotRequired[QuickResponseDescription]

The description of the quick response.

grouping_configuration instance-attribute

grouping_configuration: NotRequired[GroupingConfiguration]

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

is_active instance-attribute

is_active: bool

Whether the quick response is active.

knowledge_base_arn instance-attribute

knowledge_base_arn: Arn

The Amazon Resource Name (ARN) of the knowledge base.

knowledge_base_id instance-attribute

knowledge_base_id: Uuid

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

language instance-attribute

language: NotRequired[LanguageCode]

The language code value for the language in which the quick response is written.

last_modified_by instance-attribute

last_modified_by: NotRequired[GenericArn]

The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.

last_modified_time instance-attribute

last_modified_time: datetime

The timestamp when the quick response search result data was last modified.

name instance-attribute

The name of the quick response.

quick_response_arn instance-attribute

quick_response_arn: Arn

The Amazon Resource Name (ARN) of the quick response.

quick_response_id instance-attribute

quick_response_id: Uuid

The identifier of the quick response.

shortcut_key instance-attribute

shortcut_key: NotRequired[ShortCutKey]

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

status instance-attribute

The resource status of the quick response.

tags instance-attribute

tags: NotRequired[Tags]

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