ConnectCases / Client / list_cases_for_contact

list_cases_for_contact#

ConnectCases.Client.list_cases_for_contact(**kwargs)#

Lists cases for a given contact.

See also: AWS API Documentation

Request Syntax

response = client.list_cases_for_contact(
    contactArn='string',
    domainId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • contactArn (string) –

    [REQUIRED]

    A unique identifier of a contact in Amazon Connect.

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • 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

{
    'cases': [
        {
            'caseId': 'string',
            'templateId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • cases (list) –

      A list of Case summary information.

      • (dict) –

        Case summary information.

        • caseId (string) –

          A unique identifier of the case.

        • templateId (string) –

          A unique identifier of a template.

    • nextToken (string) –

      The token for the next set of results. This is null if there are no more results to return.

Exceptions