describe_evaluation_form ¶

def describe_evaluation_form(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    evaluation_form_id: "capo_connect.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    evaluation_form_version: Optional[
        "capo_connect.types.version_number.VersionNumber"
    ] = None,
) -> "capo_connect.types.describe_evaluation_form_response.DescribeEvaluationFormResponse":
    """<p>Describes an evaluation form in the specified Connect Customer instance. If the version property is not provided, the latest version of the evaluation form is described.</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>A unique identifier for the contact evaluation.</p>
        evaluation_form_version: <p>A version of the evaluation form.</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_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.describe_evaluation_form_request.DescribeEvaluationFormRequest]",
    ) -> OperationResponse[
        "capo_connect.types.describe_evaluation_form_response.DescribeEvaluationFormResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.describe_evaluation_form

        output, http_response = (
            capo_connect._operations.amazon_connect_service.describe_evaluation_form.describe_evaluation_form(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEvaluationForm")
    )
    input_: capo_connect.types.describe_evaluation_form_request.DescribeEvaluationFormRequest = {
        "instance_id": instance_id,
        "evaluation_form_id": evaluation_form_id,
    }
    if evaluation_form_version is not None:
        input_["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