Connect / Client / suspend_contact_recording

suspend_contact_recording#

Connect.Client.suspend_contact_recording(**kwargs)#

When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.

The period of time that the recording is suspended is filled with silence in the final recording.

Voice and screen recordings are supported.

See also: AWS API Documentation

Request Syntax

response = client.suspend_contact_recording(
    InstanceId='string',
    ContactId='string',
    InitialContactId='string',
    ContactRecordingType='AGENT'|'IVR'|'SCREEN'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactId (string) –

    [REQUIRED]

    The identifier of the contact.

  • InitialContactId (string) –

    [REQUIRED]

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • ContactRecordingType (string) – The type of recording being operated on.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException