Skip to content

CreateQuickResponseRequest

Source code in docs_src/capo_qconnect/types/create_quick_response_request.py
class CreateQuickResponseRequest(TypedDict, closed=True):
    knowledge_base_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<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: (
        "capo_qconnect.types.quick_response_data_provider.QuickResponseDataProvider"
    )
    """<p>The content of the quick response.</p>"""
    content_type: NotRequired[
        "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 a quick response written in plain text.</p> </li> <li> <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response written in richtext.</p> </li> </ul>"""
    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>"""
    description: NotRequired[
        "capo_qconnect.types.quick_response_description.QuickResponseDescription"
    ]
    """<p>The description of the quick response.</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>"""
    is_active: NotRequired["bool"]
    """<p>Whether the quick response is active.</p>"""
    channels: NotRequired["capo_qconnect.types.channels.Channels"]
    """<p>The Connect Customer channels this quick response applies to.</p>"""
    language: NotRequired["capo_qconnect.types.language_code.LanguageCode"]
    """<p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>"""
    client_token: NotRequired["capo_qconnect.types.non_empty_string.NonEmptyString"]
    """<p>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 <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

channels instance-attribute

channels: NotRequired[Channels]

The Connect Customer channels this quick response applies to.

client_token instance-attribute

client_token: NotRequired[NonEmptyString]

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.

content instance-attribute

The content of the quick response.

content_type instance-attribute

content_type: NotRequired[QuickResponseType]

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 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: NotRequired[bool]

Whether the quick response is active.

knowledge_base_id instance-attribute

knowledge_base_id: UuidOrArn

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. 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 instance-attribute

The name 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.

tags instance-attribute

tags: NotRequired[Tags]

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