Skip to content

update_participant_role_config async

update_participant_role_config(
    instance_id: InstanceId,
    contact_id: ContactId,
    channel_configuration: UpdateParticipantRoleConfigChannelInfo,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> UpdateParticipantRoleConfigResponse

Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:

  • Customer idle timeout

  • Customer auto-disconnect timeout

  • Agent idle timeout

  • Agent auto-disconnect timeout

For more information about how chat timeouts work, see Set up chat timeouts for human participants.

Parameters:

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def update_participant_role_config(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    contact_id: "capo_connect.types.contact_id.ContactId",
    channel_configuration: "capo_connect.types.update_participant_role_config_channel_info.UpdateParticipantRoleConfigChannelInfo",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> "capo_connect.types.update_participant_role_config_response.UpdateParticipantRoleConfigResponse":
    """<p>Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:</p> <ul> <li> <p>Customer idle timeout</p> </li> <li> <p>Customer auto-disconnect timeout</p> </li> <li> <p>Agent idle timeout</p> </li> <li> <p>Agent auto-disconnect timeout</p> </li> </ul> <p>For more information about how chat timeouts work, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </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>
        channel_configuration: <p>The Connect Customer channel you want to configure.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        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.invalid_request_exception.InvalidRequestException: <p>The request is 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.update_participant_role_config_request.UpdateParticipantRoleConfigRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.update_participant_role_config_response.UpdateParticipantRoleConfigResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.update_participant_role_config

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateParticipantRoleConfig")
    )
    input_: capo_connect.types.update_participant_role_config_request.UpdateParticipantRoleConfigRequest = {
        "instance_id": instance_id,
        "contact_id": contact_id,
        "channel_configuration": channel_configuration,
    }

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