Connect / Client / deactivate_evaluation_form

deactivate_evaluation_form#

Connect.Client.deactivate_evaluation_form(**kwargs)#

Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

Request Syntax

response = client.deactivate_evaluation_form(
    InstanceId='string',
    EvaluationFormId='string',
    EvaluationFormVersion=123
)

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.
EvaluationFormId (string) –
[REQUIRED]

The unique identifier for the evaluation form.
EvaluationFormVersion (integer) –
[REQUIRED]

A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.

Return type:

dict

Returns:

Response Syntax

{
    'EvaluationFormId': 'string',
    'EvaluationFormArn': 'string',
    'EvaluationFormVersion': 123
}

Response Structure

(dict) –
- EvaluationFormId (string) –
  
  The unique identifier for the evaluation form.
- EvaluationFormArn (string) –
  
  The Amazon Resource Name (ARN) for the evaluation form resource.
- EvaluationFormVersion (integer) –
  
  The version of the deactivated evaluation form resource.

Exceptions

Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException
Connect.Client.exceptions.ResourceConflictException