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(
    nextToken='string',
    maxResults=123,
    knowledgeBaseId='string'
)

Parameters:

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

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

• knowledgeBaseId (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'quickResponseSummaries': [
        {
            'quickResponseArn': 'string',
            'quickResponseId': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'name': 'string',
            'contentType': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
            'createdTime': datetime(2015, 1, 1),
            'lastModifiedTime': datetime(2015, 1, 1),
            'description': 'string',
            'lastModifiedBy': 'string',
            'isActive': True|False,
            'channels': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • quickResponseSummaries (list) –

    Summary information about the quick responses.

    • (dict) –

      The summary information about the quick response.

      • quickResponseArn (string) –

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

      • quickResponseId (string) –

        The identifier of the quick response.

      • knowledgeBaseArn (string) –

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

      • knowledgeBaseId (string) –

        The identifier of the knowledge base.

      • name (string) –

        The name of the quick response.

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

      • status (string) –

        The resource status of the quick response.

      • createdTime (datetime) –

        The timestamp when the quick response was created.

      • lastModifiedTime (datetime) –

        The timestamp when the quick response summary was last modified.

      • description (string) –

        The description of the quick response.

      • lastModifiedBy (string) –

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

      • isActive (boolean) –

        Whether the quick response is active.

      • channels (list) –

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

        • (string) –

      • tags (dict) –

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

        • (string) –

          • (string) –

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

Exceptions

• QConnect.Client.exceptions.ValidationException

• QConnect.Client.exceptions.AccessDeniedException

• QConnect.Client.exceptions.ResourceNotFoundException