QConnect / Client / create_quick_response

create_quick_response#

QConnect.Client.create_quick_response(**kwargs)#

Creates an Amazon Q in Connect quick response.

See also: AWS API Documentation

Request Syntax

response = client.create_quick_response(
    channels=[
        'string',
    ],
    clientToken='string',
    content={
        'content': 'string'
    },
    contentType='string',
    description='string',
    groupingConfiguration={
        'criteria': 'string',
        'values': [
            'string',
        ]
    },
    isActive=True|False,
    knowledgeBaseId='string',
    language='string',
    name='string',
    shortcutKey='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • channels (list) –

    The Amazon Connect channels this quick response applies to.

    • (string) –

  • clientToken (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.

    This field is autopopulated if not provided.

  • content (dict) –

    [REQUIRED]

    The content of the quick response.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: content.

    • content (string) –

      The content of the quick response.

  • contentType (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.

  • groupingConfiguration (dict) –

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

    • criteria (string) –

      The criteria used for grouping Amazon Q in Connect users.

      The following is the list of supported criteria values.

    • values (list) –

      The list of values that define different groups of Amazon Q in Connect users.

      • (string) –

  • isActive (boolean) – Whether the quick response is active.

  • knowledgeBaseId (string) –

    [REQUIRED]

    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) –

    [REQUIRED]

    The name of the quick response.

  • shortcutKey (string) – The shortcut key of the quick response. The value should be unique across the knowledge base.

  • tags (dict) –

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'quickResponse': {
        'channels': [
            'string',
        ],
        'contentType': 'string',
        'contents': {
            'markdown': {
                'content': 'string'
            },
            'plainText': {
                'content': 'string'
            }
        },
        'createdTime': datetime(2015, 1, 1),
        'description': 'string',
        'groupingConfiguration': {
            'criteria': 'string',
            'values': [
                'string',
            ]
        },
        'isActive': True|False,
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'language': 'string',
        'lastModifiedBy': 'string',
        'lastModifiedTime': datetime(2015, 1, 1),
        'name': 'string',
        'quickResponseArn': 'string',
        'quickResponseId': 'string',
        'shortcutKey': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • quickResponse (dict) –

      The quick response.

      • channels (list) –

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

        • (string) –

      • contentType (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.

      • contents (dict) –

        The contents of the quick response.

        • markdown (dict) –

          The container quick response content.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: content. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • content (string) –

            The content of the quick response.

        • plainText (dict) –

          The container quick response content.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: content. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • content (string) –

            The content of the quick response.

      • createdTime (datetime) –

        The timestamp when the quick response was created.

      • description (string) –

        The description of the quick response.

      • groupingConfiguration (dict) –

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

        • criteria (string) –

          The criteria used for grouping Amazon Q in Connect users.

          The following is the list of supported criteria values.

        • values (list) –

          The list of values that define different groups of Amazon Q in Connect users.

          • (string) –

      • isActive (boolean) –

        Whether the quick response is active.

      • knowledgeBaseArn (string) –

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

      • knowledgeBaseId (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

      • lastModifiedBy (string) –

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

      • lastModifiedTime (datetime) –

        The timestamp when the quick response data was last modified.

      • name (string) –

        The name of the quick response.

      • quickResponseArn (string) –

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

      • quickResponseId (string) –

        The identifier of the quick response.

      • shortcutKey (string) –

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

      • status (string) –

        The status of the quick response data.

      • tags (dict) –

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

        • (string) –

          • (string) –

Exceptions