ConnectCases / Client / get_merge_cases_status

get_merge_cases_status

ConnectCases.Client.get_merge_cases_status(**kwargs)

Returns the merge status of a case. Use this operation to track a merge that you started with StartMergeCases, or to check whether a case is part of a merge before you modify it.

The operation returns the following, depending on the case:

  • For the primary case or the secondary case of a merge that is running, it returns IN_PROGRESS.

  • For a case that was merged into another case as the secondary case, it returns COMPLETED.

  • For any other case, it returns a ResourceNotFoundException. This includes the primary case after its merge finishes.

Endpoints: See Connect Customer endpoints and quotas.

See also: AWS API Documentation

Request Syntax

response = client.get_merge_cases_status(
    domainId='string',
    caseId='string'
)
Parameters:

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • caseId (string) –

    [REQUIRED]

    The unique identifier of the case. This can be the primary case or the secondary case of a merge.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'IN_PROGRESS'|'COMPLETED',
    'primaryCaseId': 'string',
    'secondaryCaseIds': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • status (string) –

      The merge status of the case.

    • primaryCaseId (string) –

      The unique identifier of the primary case of the merge.

    • secondaryCaseIds (list) –

      The unique identifiers of the secondary cases of the merge.

      • (string) –

Exceptions