Activates an evaluation form in the specified Connect Customer instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
Parameters:
-
instance_id
(InstanceId)
–
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
-
evaluation_form_id
(ResourceId)
–
The unique identifier for the evaluation form.
-
evaluation_form_version
(VersionNumber)
–
The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.
Raises:
Source code in docs_src/capo_connect/_services/connect.py
| def activate_evaluation_form(
self,
instance_id: "capo_connect.types.instance_id.InstanceId",
evaluation_form_id: "capo_connect.types.resource_id.ResourceId",
evaluation_form_version: "capo_connect.types.version_number.VersionNumber",
*,
config_overrides: Optional[ConnectClientConfig] = None,
) -> "capo_connect.types.activate_evaluation_form_response.ActivateEvaluationFormResponse":
"""<p>Activates an evaluation form in the specified Connect Customer instance. After the evaluation form is activated, it is available to start new evaluations based on the form. </p>
Args:
instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
evaluation_form_id: <p>The unique identifier for the evaluation form.</p>
evaluation_form_version: <p>The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.</p>
Raises:
capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
capo_connect.errors.resource_conflict_exception.ResourceConflictException: <p>A resource already has that name.</p>
capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_connect.types.activate_evaluation_form_request.ActivateEvaluationFormRequest]",
) -> OperationResponse[
"capo_connect.types.activate_evaluation_form_response.ActivateEvaluationFormResponse"
]:
import capo_connect._operations.amazon_connect_service.activate_evaluation_form
output, http_response = (
capo_connect._operations.amazon_connect_service.activate_evaluation_form.activate_evaluation_form(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ActivateEvaluationForm")
)
input_: capo_connect.types.activate_evaluation_form_request.ActivateEvaluationFormRequest = {
"instance_id": instance_id,
"evaluation_form_id": evaluation_form_id,
"evaluation_form_version": evaluation_form_version,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|