Skip to content

list_contact_evaluations async

list_contact_evaluations(
    instance_id: InstanceId,
    contact_id: ContactId,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    next_token: Optional[NextToken] = None,
) -> ListContactEvaluationsResponse

Lists contact evaluations in the specified Connect Customer instance.

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.

  • contact_id (ContactId) –

    The identifier of the contact in this instance of Connect Customer.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    This is not expected to be set because the value returned in the previous response is always null.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def list_contact_evaluations(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    contact_id: "capo_connect.types.contact_id.ContactId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    next_token: Optional["capo_connect.types.next_token.NextToken"] = None,
) -> "capo_connect.types.list_contact_evaluations_response.ListContactEvaluationsResponse":
    """<p>Lists contact evaluations in the specified Connect Customer instance.</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>
        contact_id: <p>The identifier of the contact in this instance of Connect Customer. </p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p> <important> <p>This is not expected to be set because the value returned in the previous response is always null.</p> </important>

    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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.list_contact_evaluations_request.ListContactEvaluationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.list_contact_evaluations_response.ListContactEvaluationsResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_contact_evaluations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListContactEvaluations")
    )
    input_: capo_connect.types.list_contact_evaluations_request.ListContactEvaluationsRequest = {
        "instance_id": instance_id,
        "contact_id": contact_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output