QConnect / Client / list_quick_responses

list_quick_responses#

QConnect.Client.list_quick_responses(**kwargs)#

Lists information about quick response.

See also: AWS API Documentation

Request Syntax

response = client.list_quick_responses(
    knowledgeBaseId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:
  • knowledgeBaseId (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of results to return per page.

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

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'quickResponseSummaries': [
        {
            'channels': [
                'string',
            ],
            'contentType': 'string',
            'createdTime': datetime(2015, 1, 1),
            'description': 'string',
            'isActive': True|False,
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'lastModifiedBy': 'string',
            'lastModifiedTime': datetime(2015, 1, 1),
            'name': 'string',
            'quickResponseArn': 'string',
            'quickResponseId': '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) –

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

    • quickResponseSummaries (list) –

      Summary information about the quick responses.

      • (dict) –

        The summary information about 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.

        • createdTime (datetime) –

          The timestamp when the quick response was created.

        • description (string) –

          The description of the quick response.

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

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

        • status (string) –

          The resource status of the quick response.

        • tags (dict) –

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

          • (string) –

            • (string) –

Exceptions

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException