com.amazonaws.services.connect.model

Class StartContactRecordingRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.StartContactRecordingRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StartContactRecordingRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Starts recording the contact:

• If the API is called before the agent joins the call, recording starts when the agent joins the call.

• If the API is called after the agent joins the call, recording starts at the time of the API call.

StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartContactRecordingRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getContactId() The identifier of the contact.
java.lang.String	getInitialContactId() The identifier of the contact.
java.lang.String	getInstanceId() The identifier of the Amazon Connect instance.
VoiceRecordingConfiguration	getVoiceRecordingConfiguration() The person being recorded.
int	hashCode()
void	setContactId(java.lang.String contactId) The identifier of the contact.
void	setInitialContactId(java.lang.String initialContactId) The identifier of the contact.
void	setInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
void	setVoiceRecordingConfiguration(VoiceRecordingConfiguration voiceRecordingConfiguration) The person being recorded.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartContactRecordingRequest	withContactId(java.lang.String contactId) The identifier of the contact.
StartContactRecordingRequest	withInitialContactId(java.lang.String initialContactId) The identifier of the contact.
StartContactRecordingRequest	withInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
StartContactRecordingRequest	withVoiceRecordingConfiguration(VoiceRecordingConfiguration voiceRecordingConfiguration) The person being recorded.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartContactRecordingRequest

public StartContactRecordingRequest()

Method Detail

getInstanceId

public java.lang.String getInstanceId()

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

Constraints:
Length: 1 - 100

Returns:

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

setInstanceId

public void setInstanceId(java.lang.String instanceId)

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

Constraints:
Length: 1 - 100

Parameters:

instanceId -

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

withInstanceId

public StartContactRecordingRequest withInstanceId(java.lang.String instanceId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

instanceId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getContactId

public java.lang.String getContactId()

The identifier of the contact.

Constraints:
Length: 1 - 256

Returns:

The identifier of the contact.

setContactId

public void setContactId(java.lang.String contactId)

The identifier of the contact.

Constraints:
Length: 1 - 256

Parameters:

contactId -

The identifier of the contact.

withContactId

public StartContactRecordingRequest withContactId(java.lang.String contactId)

The identifier of the contact.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

contactId -

The identifier of the contact.

Returns:

A reference to this updated object so that method calls can be chained together.

getInitialContactId

public java.lang.String getInitialContactId()

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

Constraints:
Length: 1 - 256

Returns:

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

setInitialContactId

public void setInitialContactId(java.lang.String initialContactId)

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

Constraints:
Length: 1 - 256

Parameters:

initialContactId -

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

withInitialContactId

public StartContactRecordingRequest withInitialContactId(java.lang.String initialContactId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

initialContactId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getVoiceRecordingConfiguration

public VoiceRecordingConfiguration getVoiceRecordingConfiguration()

The person being recorded.

Returns:

The person being recorded.

setVoiceRecordingConfiguration

public void setVoiceRecordingConfiguration(VoiceRecordingConfiguration voiceRecordingConfiguration)

The person being recorded.

Parameters:

voiceRecordingConfiguration -

The person being recorded.

withVoiceRecordingConfiguration

public StartContactRecordingRequest withVoiceRecordingConfiguration(VoiceRecordingConfiguration voiceRecordingConfiguration)

The person being recorded.

Returns a reference to this object so that method calls can be chained together.

Parameters:

voiceRecordingConfiguration -

The person being recorded.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object