delete_evaluation_form `async` ¶

delete_evaluation_form(
    instance_id: InstanceId,
    evaluation_form_id: ResourceId,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    evaluation_form_version: Optional[VersionNumber] = None,
) -> None

Deletes an evaluation form in the specified Connect Customer instance.

If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.

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 (Optional[VersionNumber], default: None ) –

The unique identifier for the evaluation form.

Raises:

InternalServiceException –

Request processing failed because of an error or failure with the service.
InvalidParameterException –

One or more of the specified parameters are not valid.
ResourceConflictException –

A resource already has that name.
ResourceNotFoundException –

The specified resource was not found.
ThrottlingException –

The throttling limit has been exceeded.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_connect/_services/async_connect.py

async def delete_evaluation_form(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    evaluation_form_id: "capo_connect.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    evaluation_form_version: Optional[
        "capo_connect.types.version_number.VersionNumber"
    ] = None,
) -> None:
    """<p>Deletes an evaluation form in the specified Connect Customer instance. </p> <ul> <li> <p>If the version property is provided, only the specified version of the evaluation form is deleted.</p> </li> <li> <p>If no version is provided, then the full form (all versions) is deleted.</p> </li> </ul>

    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 unique identifier for 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_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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.delete_evaluation_form_request.DeleteEvaluationFormRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_connect._operations.amazon_connect_service.delete_evaluation_form

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.delete_evaluation_form.async_delete_evaluation_form(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteEvaluationForm")
    )
    input_: capo_connect.types.delete_evaluation_form_request.DeleteEvaluationFormRequest = {
        "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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_evaluation_form async ¶

delete_evaluation_form `async` ¶